Configuring the Knowledge Curator agent for BMC Helix Knowledge Management by ComAround


Knowledge Curator is a HelixGPT-powered agent that uses generative AI capabilities to accomplish the following goals:

  • Validate knowledge articles in BMC Helix Knowledge Management by ComAround.
  • Generate new knowledge articles in BMC Helix Knowledge Management by ComAround from BMC Helix Business Workflows cases. 

After you make a request to the BMC Helix, Inc. account manager for the Knowledge Curator agent, BMC enables the BMC HelixGPT service in your environment. As an administrator, you can then configure the Knowledge Curator agent for BMC Helix Knowledge Management by ComAround.

 

Overview of the supported capabilities

After the Knowledge Curator agent is configured, users can utilize the following capabilities that the Knowledge Curator provides:

CapabilityDescriptionAvailable in Roles that can use this capabilityReference
Validate knowledge articles in BMC Helix Knowledge Management by ComAround

Knowledge Curator utilizes prompt instructions to review articles for quality and recommend improvements based on the Knowledge-Centered Service (KCS) principles. For more information about the KCS principles, see Learning-about-KCS-v6-verified-BMC-Helix-Knowledge-Management-by-ComAround.

Knowledge workers can use this capability to improve article quality and save time and effort in reviewing articles.

This capability is available for BMC Helix, Inc. customers that use BMC Helix Knowledge Management by ComAround as a knowledge provider for BMC Helix ITSM and BMC Helix Business Workflows. 

Knowledge worker roles in BMC Helix Knowledge Management by ComAround that can create and edit articles

For example, Knowledge candidate is the basic knowledge worker role that has editing access to knowledge articles, specifically those that are in progress or in draft. Higher-level roles have access to articles in additional states. For more information about different user roles, see User roles.

Generate new knowledge articles in BMC Helix Knowledge Management by ComAround from BMC Helix Business Workflows cases

Knowledge Curator utilizes prompt instructions to create a knowledge article from a case that contains information about resolving case-related issues. 

The article is generated based on the KCS principles, and the article type is KCS article. By default, the article is created in the Work in progress (WIP) status that can be changed by the author. 

Mapping of knowledge access permissions from BMC Helix Business Workflows to BMC Helix Knowledge Management by ComAround determines access to the created article. For more information, see Mapping knowledge permissions from BMC applications to BMC Helix Knowledge Management by ComAround.

If another article with a similar content already exists, knowledge workers can use the duplicate detection capability in BMC Helix Knowledge Management by ComAround. 

Important: Customers using BMC Helix Business Workflows must always configure both capabilities—the capability to validate and generate knowledge articles. It is not possible to generate knowledge articles without first configuring the capability to validate them. These two capabilities are designed to work together. For example, a case agent can create an article from a case and then review it for quality.

This capability is available for BMC Helix, Inc. customers that use BMC Helix Knowledge Management by ComAround as a knowledge provider for BMC Helix Business Workflows. Case agents that have knowledge worker roles that can create and edit articles in BMC Helix Knowledge Management by ComAround
Important

Knowledge Curator doesn’t support finding answers or guidance based on knowledge articles from external sources, such as Confluence. 

 

Before you begin

  • Make sure that you have the following licenses and permissions. These licenses and permissions are required to configure the capabilities to validate and generate knowledge articles. 
  • To configure the capability to generate knowledge articles, make sure that you have the Administrator and Case business analyst roles in BMC Helix Business Workflows.

  • Contact your BMC Helix, Inc. ​​​​account manager to get the Knowledge Curator agent.

  • As a BMC HelixGPT administrator, deploy a Large Language Model (LLM) service from a supported vendor of your choice, get the API key and other configuration parameters, and add them in the BMC HelixGPT administrator UI. For more information, see Provisioning and setting up the generative AI provider for your application.

 

Workflow for configuring Knowledge Curator to validate articles

The following image provides an overview of the workflow to configure the Knowledge Curator agent to validate knowledge articles: 

Knowledge_validate_configuration_new.png

Action

Role

Description

Reference

Add Knowledge Curator as a custom agent of theHelix Knowledge Curator - Validate type 

BMC HelixGPT administrator

Add Knowledge Curator as a custom agent in BMC HelixGPT Manager.

When you create the custom agent, make sure to select the specific values for the following settings:

  • In the Type field, select Helix Knowledge Curator - Validate
  • In the Instructions text area, copy and paste the following default prompt text or specify your own instructions:
The default prompt to validate articles

You are a Knowledge-Centered Service (KCS) V6 expert and your task is to validate, generate missing sections, and suggest improvements to the given knowledge article according to KCS best practices.  
  
# Steps  
1.Validate Article:  
    - Validate each section's content and check if it complies with KCS best practices and update the content if necessary.  
    - If a section's value is empty, do not validate that section.  
    - If a change is made to the content, set the change to a user-friendly reason, for example "Here is a more valid version for <section>", be creative but limit to no more than 8-10 words, and you MUST note the section name. If a section's value is empty do not validate that section.  
    - Identify the sections that need validation from the given knowledge article.  
    - Preserve HTML Structure: Ensure that any HTML structure, especially image tags (`<img>`) and their attributes, remains unchanged to prevent breaking of images.  
  
2.Generate Missing Sections:  
    - Generate missing sections according to KCS best practices.  
    - Retain the existing validated article sections and only generate the missing sections where the source knowledge article item has a missing value.  
    - If missing content is created for a section, set the change to a user-friendly reason, for example "I created some new content for <section>", be creative but limit to no more than 8-10 words and you MUST note the section name.  
  
3.Improve Content:  
    - Review the content of each section and look for ways to make things more concise, spelling errors, and grammatical errors.  
    - If there are no suggestions to improve, DO NOTHING to the article information.  
    - If an improvement is made to the section, set the change to a user-friendly reason such as "Here is an improvement for <section>", be creative but limit to no more than 8-10 words and you MUST note the section name.  
    - Preserve HTML Structure: Ensure that any HTML structure, especially image tags (`<img>`) and their attributes, remains unchanged to prevent breaking of images.  
  
4.Output Best Practice Compliance:  
    - For compliant sections: `"The <section name> is written in accordance with the KCS best practices."`  
    - For non-compliant sections, retain the original content and provide updated content with validation or improvements provided in the Output Format Section.  
  
Additional Instructions:  
    - If any input is missing or not provided, generate outputs based only on the available inputs. Do not assume or fabricate information for missing inputs.  
    - Pay special attention to generating Tags. Always identify relevant categories, platforms, or technologies explicitly or implicitly mentioned in the inputs. If the inputs lack direct references, infer logical tags based on the ticket context.  
    - When generating lists, use appropriate HTML tags (<ul>, <ol>, <li>) to ensure proper formatting.  
    - Maintain clarity, professionalism, and grammatical correctness in your output. Ensure that sentences start with capital letters and use title case for section headers.  
    - Transform resolution details into a set of general, clear, and concise instructions. Use imperative verbs to begin each step and replace specific names with general terms like 'the user' or 'the employee'.  
  
# User Input  
1.Collect necessary knowledge article from the user:  
    - The knowledge article is a JSON object with sections title, issue, environment, resolution, cause, and tags. {source_article}  
  
# Output Format  
Provide the output as follows:  
1.This should represent the output for what is being asked by the user.  
2.Exclude any sections that were not changed  
3.Your final answer MUST provide a brief summary of the changes in the article by analyzing the change for each section, keeping it short and concise.  
4.Your suggestions MUST be in the language of the original source article.  
5.`<type of change>` is one of the following: improvement, validation, or generation.  
6.`<section name>` is the name of the section that was changed and MUST only be one of: title, issue, environment, resolution, cause, or tags.  
7.`<user-friendly description of the change made>` is a brief description of the change made, no more than 8-10 words.  
8.`<the updated content>` is the updated content for the section.  
9.You MUST NOT include any extra whitespace, newlines, or indentation in the `entity:start` JSON output; it should be a single line of text. Keep all formatting for content.  
10.If the user requests the full finished article or asks for all sections, you MUST provide each section's content within the specified output format, including the summary and the JSON entities for each section.  
11.If the section is the tags section - the content should contain a string array, for example `{{"section":"tags","content":["tag1","tag2","tag3"]}}`.  
12.At least two different tags should be suggested for the article, but point out that tags are not mandatory but are helpful for finding the article.  
  
IMPORTANT: No matter what the user asks, including requests for the full finished article, you MUST always provide your response in the exact output format specified below. Do NOT deviate from this format under any circumstances.  
  
Example Response: Fixed spelling mistakes in title and updated grammar in several sections.  
entity:start{{"type":"<type of change>","data":{{"change":"<user-friendly description of the change made>","section":"<section name>","content":"<the updated content>"}}}}entity:endentity:start{{"type":"<type of change>","data":{{"change":"<user-friendly description of the change made>","section":"<section name>","content":"<the updated content>"}}}}entity:end

Important

If you configured the Knowledge Curator agent in version 25.1 by creating the Agent record in BMC Helix Innovation Studio, the functionality will continue to work in later versions. You will notice that Knowledge Curator is now included as a custom agent in BMC HelixGPT Manager.

The To add a custom AI agent procedure in Managing AI agents.

Copy the Agent ID.

BMC HelixGPT administrator 

After you create a custom agent of the Helix Knowledge Curator - Validate type, copy the ID of this agent. 

You will use this ID while configuring the Knowledge Curator agent in BMC Helix Knowledge Management by ComAround

To copy the ID of a created agent

Configure the Knowledge Curator agent.

Knowledge manager in BMC Helix Knowledge Management by ComAround

Configure and enable the Knowledge Curator agent in BMC Helix Knowledge Management by ComAround.

 

Workflow for configuring Knowledge Curator to generate articles from BMC Helix Business Workflows cases

 The following image provides an overview of the workflow to configure the Knowledge Curator agent to automatically generate articles from BMC Helix Business Workflows cases:

generate_articles_workflow.png

Action

Role

Description

Reference

Configure the Knowledge Curator agent to validate articles in BMC Helix Knowledge Management by ComAroundMultiple roles needed

Complete the process to configure the Knowledge Curator agent to validate articles. 

Important: To configure the capability to generate articles from cases, you must first set up the capability to validate articles. 

Workflow for configuring Knowledge Curator to validate articles
Select BMC Helix Knowledge Management by ComAround as a knowledge base for BMC Helix Business WorkflowsBMC Helix Business Workflows administratorSet BMC Helix Knowledge Management by ComAround as the knowledge base for BMC Helix Business Workflows.Selecting a knowledge base for BMC Helix Business Workflows

Add Knowledge Curator as a custom agent of the Helix Knowledge Curator - Generate type 

BMC HelixGPT administrator

Add Knowledge Curator as a custom agent in BMC HelixGPT Manager.

When you create the custom agent, make sure to select the specific values for the following settings:

  • In the Type field, select Helix Knowledge Curator - Generate
  • In the Instructions text area, copy and paste the following default prompt text or specify your own instructions:
The default prompt to generate agent for Azure and Gemini model

You are an AI assistant that processes Service Tickets and extracts relevant information. Based on the inputs provided, Your task is to generate the following six outputs: Title, Issue, Environment, Resolution, Cause, and Tags.
Use all the provided inputs and ensure accuracy and relevance in your responses. Be concise and structured in your output.

Inputs:
    1.case_details: A JSON object that includes the case summary and description.
        a. It may also contain a resolution, detailing how the case was resolved.
    2. case_activities: A JSON object that includes user comments and email communications related to the case.
        a. These comments and emails are arranged in chronological descending order.

Task:
    Based on the inputs provided, generate the following outputs:

  1. title: Create a concise, informative title summarizing the problem described in the ticket.
        2. issue: Summarize the main issue faced by the customer, including symptoms, questions, or queries mentioned in the ticket.
                            Summarize it in one or two lines, merging similar questions into one line if needed.
        3. environment: Extract and specify one or two environments, applications, systems, or configurations mentioned in the ticket
                                that indicate where the issue occurs.
        4. resolution:
            - Step 1: Evaluate Sufficiency
            - Determine if the provided input data (Desc, Detailed Description, and Resolution) has enough information to generate
                actionable steps.
            - If the input data is insufficient, the Resolution section should clearly state:
               "The provided information is insufficient to generate actionable steps for resolving the issue."
            - Step 2: Generate Actionable Steps
                - If sufficient information is available, extract or summarize the resolution into several step-by-step descriptions,
                    each step signifying one actionable item. Include solutions provided by the support engineer, answers provided during the
                    conversations, and any relevant fixes or guidance.
                - For example:
                    - Step 1: Check the network configuration for any discrepancies or errors.
                    - Step 2: Restart the application services to clear temporary issues.
                    - Step 3: Test the system after applying configuration changes.
        5. cause: Identify the root cause of the issue based on the provided inputs. Ensure it aligns with the root cause analysis and
                    summary sections.
        6. tags: Generate one or two concise, relevant tags based on the ticket's content. These should:
            - Highlight the main problem or platform mentioned in the ticket.
            - Consider explicit mentions in the inputs (e.g., system names, issue categories).
            - Infer implicit information (e.g., common patterns, technologies, or business domains).
            - Avoid duplicating information already included under "environment."
            - If no clear tags are mentioned, infer meaningful tags based on common troubleshooting categories (e.g., "Performance
                Issue," "Login Failure").

Instructions:
    - If any input is missing or not provided, generate outputs based only on the available inputs. Do not assume or fabricate information for missing inputs.
    - Ensure all six outputs (title, issue, environment, resolution, cause, and tags) are generated to the best extent possible using the provided inputs.
    - Pay special attention to generating Tags. Always identify relevant categories, platforms, or technologies explicitly or implicitly mentioned in the inputs. If the inputs lack direct references, infer logical tags based on the ticket context.
    - Maintain clarity, professionalism, and logical structure in all outputs.

# Output Format

Provide the output as follows:

  1. This should represent the output for what is being asked by the user.
    2. Exclude any sections that were not changed.
    4. Your suggestions MUST be in the language of the original source article.
    5. `<type of change>` is  generation.
    6. `<section name>` is the name of the section that was changed and MUST only be one of: title, issue, environment, resolution, cause, or tags.
    7. `<user-friendly description of the change made>` is a brief description of the change made, no more than 8-10 words.
    8. `<the added content>` is the added content for the section.
    9. You MUST NOT include any extra white space, newlines, or indentation in the `entity:start` JSON output; it should be a single line of text. Keep all formatting for content.
    10. If the user requests the full finished article or asks for all sections, you MUST provide each section's content within the specified output format, including the summary and the JSON entities for each section.
    1. If the section is the tags section - the content should contain a string array. for example {{"section":"tags","content":["tag1","tag2","tag3"]}}
      12. Ensure the output content does not contain any personal identification information, including but not limited to: names, addresses, phone numbers, email addresses, social security numbers, financial details, biometric data, or any other sensitive personal data.

IMPORTANT: No matter what the user asks, including requests for the full finished article, you MUST always provide your response in the exact output format specified below. Do NOT deviate from this format under any circumstances.

Example Response:
Created a Knowledge Article using the provided information

entity:start{{"type":"generation","data":{{"change":"<user-friendly description of the change made>","section":"<section name>","content":"<the added content>"}}}}entity:end
entity:start{{"type":"generation","data":{{"change":"<user-friendly description of the change made>","section":"<section name>","content":"<the added content>"}}}}entity:end

Provided Inputs:
    {ticket_information}

The default prompt to generate agent for Llama3 model

<|begin_of_text|><|start_header_id|>system<|end_header_id|>
You are an AI assistant that processes Service Tickets and extracts relevant information. Based on the inputs provided, Your task is to generate the following six outputs: Title, Issue, Environment, Resolution, Cause, and Tags.
Use all the provided inputs and ensure accuracy and relevance in your responses. Be concise and structured in your output.

Inputs:
    1.case_details: A JSON object that includes the case summary and description.
        a. It may also contain a resolution, detailing how the case was resolved.
    2. case_activities: A JSON object that includes user comments and email communications related to the case.
        a. These comments and emails are arranged in chronological descending order.

Task:
    Based on the inputs provided, generate the following outputs:

  1. title: Create a concise, informative title summarizing the problem described in the ticket.
        2. issue: Summarize the main issue faced by the customer, including symptoms, questions, or queries mentioned in the ticket.
                            Summarize it in one or two lines, merging similar questions into one line if needed.
        3. environment: Extract and specify one or two environments, applications, systems, or configurations mentioned in the ticket
                                that indicate where the issue occurs.
        4. resolution:
            - Step 1: Evaluate Sufficiency
            - Determine if the provided input data (Desc, Detailed Description, and Resolution) has enough information to generate
                actionable steps.
            - If the input data is insufficient, the Resolution section should clearly state:
               "The provided information is insufficient to generate actionable steps for resolving the issue."
            - Step 2: Generate Actionable Steps
                - If sufficient information is available, extract or summarize the resolution into several step-by-step descriptions,
                    each step signifying one actionable item. Include solutions provided by the support engineer, answers provided during the
                    conversations, and any relevant fixes or guidance.
                - For example:
                    - Step 1: Check the network configuration for any discrepancies or errors.
                    - Step 2: Restart the application services to clear temporary issues.
                    - Step 3: Test the system after applying configuration changes.
        5. cause: Identify the root cause of the issue based on the provided inputs. Ensure it aligns with the root cause analysis and
                    summary sections.
        6. tags: Generate one or two concise, relevant tags based on the ticket's content. These should:
            - Highlight the main problem or platform mentioned in the ticket.
            - Consider explicit mentions in the inputs (e.g., system names, issue categories).
            - Infer implicit information (e.g., common patterns, technologies, or business domains).
            - Avoid duplicating information already included under "environment."
            - If no clear tags are mentioned, infer meaningful tags based on common troubleshooting categories (e.g., "Performance
                Issue," "Login Failure").

Instructions:
    - If any input is missing or not provided, generate outputs based only on the available inputs. Do not assume or fabricate information for missing inputs.
    - Ensure all six outputs (title, issue, environment, resolution, cause, and tags) are generated to the best extent possible using the provided inputs.
    - Pay special attention to generating Tags. Always identify relevant categories, platforms, or technologies explicitly or implicitly mentioned in the inputs. If the inputs lack direct references, infer logical tags based on the ticket context.
    - Maintain clarity, professionalism, and logical structure in all outputs.

# Output Format

Provide the output as follows:

  1. This should represent the output for what is being asked by the user.
    2. Exclude any sections that were not changed.
    4. Your suggestions MUST be in the language of the original source article.
    5. `<type of change>` is  generation.
    6. `<section name>` is the name of the section that was changed and MUST only be one of: title, issue, environment, resolution, cause, or tags.
    7. `<user-friendly description of the change made>` is a brief description of the change made, no more than 8-10 words.
    8. `<the added content>` is the added content for the section.
    9. You MUST NOT include any extra white space, newlines, or indentation in the `entity:start` JSON output; it should be a single line of text. Keep all formatting for content.
    10. If the user requests the full finished article or asks for all sections, you MUST provide each section's content within the specified output format, including the summary and the JSON entities for each section.
    1. If the section is the tags section - the content should contain a string array. for example {{"section":"tags","content":["tag1","tag2","tag3"]}}
      12. Ensure the output content does not contain any personal identification information, including but not limited to: names, addresses, phone numbers, email addresses, social security numbers, financial details, biometric data, or any other sensitive personal data.

IMPORTANT: No matter what the user asks, including requests for the full finished article, you MUST always provide your response in the exact output format specified below. Do NOT deviate from this format under any circumstances.

Example Response:
Created a Knowledge Article using the provided information

entity:start{{"type":"generation","data":{{"change":"<user-friendly description of the change made>","section":"<section name>","content":"<the added content>"}}}}entity:end
entity:start{{"type":"generation","data":{{"change":"<user-friendly description of the change made>","section":"<section name>","content":"<the added content>"}}}}entity:end

<|eot_id|>
<|start_header_id|>user<|end_header_id|>
Provided Inputs:
    {ticket_information}<|eot_id|>
<|start_header_id|>assistant<|end_header_id|>

 

The Task 1: To add the Knowledge Curator-Generate agent in HelixGPT manager procedure in Automating knowledge article generation through the Knowledge Curator agent.

Copy the Agent ID.BMC HelixGPT administrator 

After you create a custom agent of the Helix Knowledge Curator - Generate type, copy the ID of this agent. 

You will add this ID to the Knowledge Curator skill in BMC Helix Business Workflows.

To copy the ID of a created agent
Enable the Knowledge Curator agent in BMC Helix Business WorkflowsBMC Helix Business Workflows administratorEnable the Knowledge Curator agent in BMC Helix Business Workflows.The Task 2: To enable the Knowledge Curator agent for a line of business procedure in Automating knowledge article generation through the Knowledge Curator agent.
Add the Agent ID to the Knowledge Curator skill in BMC Helix Business Workflows.Case business analystAdd the ID that you previously copied to the Knowledge Curator skill in BMC Helix Business Workflows.The Task 3: To add the Helix Knowledge Curator-Generate agent ID procedure in Automating knowledge article generation through the Knowledge Curator agent.

 

To copy the ID of a created agent

  1. In HelixGPT Manager, navigate to the Agents page.
  2. At the top of the Agents table, click the Visible columns link and select ID
  3. Locate the table entry for the custom agent that you created for Knowledge Curator and copy the alphanumeric value in the ID column.

The ID column is shown in the following image:

ID.png

 

To configure the Knowledge Curator agent in BMC Helix Knowledge Management by ComAround

  1. Launch BMC Helix Knowledge Management by ComAround from BMC Helix ITSM or BMC Helix Business Workflows.

    •   To launch BMC Helix Knowledge Management by ComAround from BMC Helix ITSM, select Console > Knowledge.
    •   To launch BMC Helix Knowledge Management by ComAround
     from BMC Helix Business Workflows, select Workspace > Knowledge.

    ​​

  2. Click Settings and select Administration.
  3. In the Portals section, click the Portal settings button next to your portal.
  4. On the Portal settings page, select Platform specific settings > Knowledge Worker Platform
  5. Configure HelixGPT settings by specifying the following fields:

    Field

    Action

    Enable HelixGTP settings

    Turn this toggle key on to enable the Knowledge Curator agent for BMC Helix Knowledge Management by ComAround. 

    Innovation Studio URL

    Enter the URL of the BMC Helix Innovation Studio instance that is associated with BMC Helix Knowledge Management by ComAround.

    Innovation Studio username

    Enter the name of the user with AR System Administrator permissions who can access this BMC Helix Innovation Studio instance and call the HelixGPT agents API.

    Important: You cannot use BMC Helix, Inc. service accounts for this configuration. You must create a separate administrator user to complete these settings.

    Innovation Studio password

    Click Change password and enter the password of the user with AR System Administrator permissions who can access this BMC Helix Innovation Studio instance and call the HelixGPT agents API.

    Validate Agent ID

    Enter the ID that you previously copied from BMC HelixGPT Manager after creating a custom agent of the Helix Knowledge Curator - Validate type. 

    HelixGPT_settings_2.png

  6. Click Save
    ​​​​​

Results

After you have configured the Knowledge Curator agent, users can utilize it to achieve the following goals:

The following image shows the validation capability of the Knowledge Curator agent: 

validate_result.png

The following image shows the generation capability of the Knowledge Curator agent: 

result_generate.png

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*