Knowledge Base

From MintHCM Wiki

Knowledge Base
Name: Knowledge Base
Tech Name: AOK_KnowledgeBase
Class Name: AOK_KnowledgeBase
Type: Standard
Template: Security_groups, Assignable, Basic
Custom Module: No
Auditable: Yes
Importable: No
Reportable: Yes
Hide module on Main Page: No

Short Description

'Knowlege Base' module is designed to empower users to find answers to their questions and solve problems independently without having to contact customer support or other departments. It serves as a self-help tool that enhances the customer experience by enabling users to access information quickly and efficiently.


Screens


Business Description

Overview

The 'Knowledge Base' module is a useful component of MintHCM system, designed to centralize and manage information related to common issues and frequently asked questions. Its primary purpose is to provide a repository for recording solutions, tips, and answers to address various problems or inquiries within an organization. Each record in the Knowledge Base module consists of fields such as title, content, solution, and author, enabling easy organization and retrieval of relevant knowledge.

To empower users with quick access to valuable information, the 'My Knowledge Base' dashlet is available on the user's dashboard. This dashlet offers a concise display of relevant knowledge base records, allowing users to stay informed and find resolutions efficiently. For detailed instructions on utilizing and customizing this feature, please consult the My Knowledge Base Dashlet article.

For a visual representation of sample record creation/editing, detailed views, and related subpanels, as well as the module's list view, please refer to the attached screens. These screens will provide a visual guide to understanding the interface and functionality of the Knowledge Base module.

Fields

The 'Knowledge Base' module comprises several fields, each serving a specific purpose in capturing together with organizing knowledge and information. Here is a detailed explanation of each field:

Title This field represents the title of the 'Knowledge Base' module record. It provides a concise and descriptive name for the content to help users quickly identify the topic or subject of the article.
Status This dropdown field captures the current status of the 'Knowledge Base' module record. It offers a selection of predefined options such as "Draft," "Expired," "In review," "Private," or "Public." The status helps indicate the visibility and availability of the article to users.
Revision This field is used to track the version or revision number of the 'Knowledge Base' module record. It allows for easy identification and comparison of different iterations or updates made to the content over time.
Body This field captures the main content of the 'Knowledge Base' module article. It contains detailed information, instructions, explanations, or solutions related to a specific topic. The body is where the article provides value and knowledge to the users.
Resolution This field is typically used to document the resolution or solution to a specific issue or problem discussed the 'Knowledge Base' base article. It may include step-by-step instructions, troubleshooting tips, or best practices.
Date Created This field represents the date when the knowledge base article was initially created or added to the system. It helps establish a timeline for tracking the history of the article.
Date Created This field indicates the most recent date when any modifications or updates were made to the 'Knowledge Base' article. It allows for tracking and auditing changes made to the content over time.
Author This field captures the name or identity of the individual who created the 'Knowledge Base' article. It helps identify the original creator or contributor of the content.
Approver This field is used to indicate the name or identity of the person responsible for approving or reviewing the 'Knowledge Base' article. It helps track and assign accountability for the approval process, ensuring the accuracy and quality of the content.


Custom Actions

Processes

Related Processes

Related Process Steps

Related Features

Affected by

Initiating

Related Integrations


Structure

Fields


Name Type Required Validations Visible Editable
Approver relate No Yes Yes
Assigned to relate No Yes Yes
Author relate Yes Yes Yes
Body text No Yes Yes
Created By relate No Yes No
Date Created datetime No Yes No
Date Modified datetime No Yes No
Modified By Name relate No Yes No
Resolution text No Yes Yes
Revision varchar No Yes Yes
Status enum No Yes Yes
Title name Yes Yes Yes

Relationships

LaftTypeRightShort DescriptionRelationship
Usersone-to-manyKnowledge BaseSpecific Sugar user can modify many account records, but specific account record last modification was performed by specific user.Relationship: Users - AOK_KnowledgeBase
Usersone-to-manyKnowledge BaseSpecific Sugar user can create many account records, but specific account record can be created by only one user.Relationship: Users - AOK_KnowledgeBase
Usersone-to-manyKnowledge BaseSpecific Sugar user can be assigned to many account records, but specific account record can only have one user assigned.Relationship: Users - AOK_KnowledgeBase

Mentioned in other articles


Technical Description

Dev Notes