Knowledge Capture

Overview

Knowledge Capture is an enterprise knowledge management module that allows you to capture, structure, and manage knowledge related to your plant equipment. It supports multiple input methods including text, voice recording, and file attachments, and uses AI to automatically generate structured knowledge content.

Please click on the Knowledge Capture submenu under the Agents menu to enter the Knowledge Capture management page.

Knowledge List

The Knowledge Capture main page displays all captured knowledge in a card-based grid layout. Each knowledge card shows:

• Knowledge Type - Color-coded label indicating the category (e.g., Troubleshooting, Procedure, Tip)

• Title - The name of the knowledge capture

• Summary - A brief preview of the raw content

• Associated Plant Model - The equipment path linked to this knowledge

• Update Time - When the knowledge was last modified

Search Knowledge

To search for specific knowledge, enter keywords in the search box at the top of the page. The system will filter knowledge items by title in real-time as you type.

Create Knowledge Capture

Please click the Capture Knowledge button in the upper right corner to start creating a new knowledge capture. The knowledge capture process consists of three steps.

Step 1: Select Context

In the first step, you need to select the context for your knowledge:

1. Select Plant Model Node - Choose the equipment or location that this knowledge relates to from the plant model tree.

2. Select Knowledge Type - Choose the category that best describes this knowledge (see Knowledge Types Reference section for details).

After making your selections, click Next to proceed to the content capture step.

Step 2: Capture Raw Content

In the second step, you will enter the raw knowledge content. The system supports multiple input methods:

Text Input

Enter your knowledge content directly in the text area. The maximum character limit is 2000 characters.

Voice Recording

1. Click the microphone icon button to start recording.

2. Speak your knowledge content clearly.

3. Click the button again to stop recording.

4. The system will automatically transcribe your speech to text.

File Attachments

You can attach supporting files to your knowledge capture:

• Click the Attach Files button or drag and drop files into the upload area.

• Supported formats: PDF, XLS, XLSX, DOC, DOCX, PPT, PPTX, JPG, PNG, MP4, WMV

• Attached files will be listed below the upload area with options to view or delete.

Enter a Title for your knowledge capture, then click Next to proceed to the review step.

Step 3: Generate Structured Content

In the final step, the system uses AI to generate structured content from your raw input:

1. The system will automatically start generating structured content based on your raw content and the selected knowledge type.

2. You can view the AI-generated content in real-time as it streams.

3. Once generation is complete, you can edit the structured content using the Markdown editor.

4. Click Save Draft to save without publishing, or click Publish to make the knowledge available to all users.

View and Edit Knowledge

View Knowledge Details

To view the details of a published knowledge item:

1. Click on any knowledge card in the list to open the detail page.

2. The detail page displays the knowledge title, type, creation/update timestamps, and associated plant model.

3. Use the tabs to switch between Structured Content, Attachments, and Raw Content.

Edit Title

To edit the knowledge title, click the pencil icon next to the title on the detail page. After modifying the title, press Enter or click outside the input field to save.

Edit Structured Content

1. Navigate to the Structured Content tab.

2. Click the Edit button to enter editing mode.

3. Modify the content using the Markdown editor.

4. Click Save to save your changes as a draft, or Publish to publish the updated content.

Manage Attachments

The Attachments tab displays all files associated with the knowledge. From here you can:

• Preview - Click on a file to preview its content

• Download - Click the download button to save the file locally

Regenerate Structured Content

If you want the AI to regenerate the structured content based on the raw content:

1. Navigate to the Structured Content tab.

2. Click the Generate button.

3. The system will use AI to create new structured content from the original raw content.

4. Review and edit the generated content as needed, then save or publish.

Publish Knowledge

To publish a draft knowledge item and make it available to all users:

1. Ensure the structured content is complete and accurate.

2. Click the Publish button.

3. After publishing, the knowledge status will change from "Draft" to "Published".

Delete Knowledge

To delete a knowledge item, click the Delete button (trash icon) on the knowledge card in the list page, or on the detail page.

A confirmation dialog will appear. Click Yes, Delete It! to confirm the deletion. The knowledge item will be permanently removed from the system.

Knowledge Types Reference

The system supports the following knowledge types, each with a distinct color code for easy identification:

Important Notes

Supported File Formats

The following file formats are supported for attachments:

• Documents: PDF, XLS, XLSX, DOC, DOCX, PPT, PPTX

• Images: JPG, JPEG, PNG

• Videos: MP4, WMV

Knowledge Status Workflow

Knowledge items follow a simple status workflow:

• Draft - Knowledge is being created or edited. Only visible to the creator.

• Published - Knowledge is finalized and available to all users with access to the Knowledge Capture.

Permissions

To access the Knowledge Capture, you must have the agent:read permission assigned to your role. Please contact your administrator if you cannot access this module.

Best Practices

• Use descriptive titles that clearly indicate the knowledge topic.

• Select the most appropriate knowledge type to help users find relevant information.

• Associate knowledge with the correct plant model node for accurate context.

• Review AI-generated structured content before publishing to ensure accuracy.

• Attach supporting documents, images, or videos to provide comprehensive information.