Creating search filters for BMC applications
BMC Helix Knowledge Management by ComAround supports creating filters to narrow down search results in BMC applications based on predefined conditions. These filters use article tags as filtering criteria. A single filter can combine multiple article tags by using the AND or OR operators. When users search for knowledge articles in a BMC application that uses a specific filter, the search results return only the articles that include a tag or a combination of tags defined in the filter.
You can create and use search filters for the following BMC applications:
- BMC Helix Virtual Agent
- BMC Helix Digital Workplace Advanced
- BMC HelixGPT
As an administrator of BMC Helix Innovation Studio, you can create search filters for supported BMC applications. After you create a search filter in BMC Helix Innovation Studio, you must enable it in the BMC application. For more information about enabling search filters for the required chatbot instance in BMC Helix Virtual Agent, see Defining a knowledge search provider for chatbot. Learn how to enable search filters for BMC Helix Digital Workplace Advanced in Configuring search.
The following image shows the benefits of using search filters:
Static and dynamic tags
When you create search filters in BMC Helix Innovation Studio, you can use the following types of tags:
Tag type | Definition | Example |
---|---|---|
Static | Static tags are predefined and fixed descriptive labels or keywords assigned to articles in BMC Helix Knowledge Management by ComAround. | For example, Line of business=HR is a static tag. If the search filter uses this tag as filtering criteria, the search results return only the knowledge articles that include the Line of business=HR tag. |
Dynamic | Dynamic tags are constructed on-the-fly based on custom processes that query CTM forms. These processes obtain information specific to a current user from a CTM form and use this information to construct the tag. Dynamic tags are generated for each user, and they have different output for each user. However, the structure of dynamic tags is fixed. Dynamic tags consist of an attribute of the tag and the tag value. For example, Line of business (attribute)=Finance (value). During the search, the generated dynamic tag is compared with static tags assigned to articles inBMC Helix Knowledge Management by ComAround. Only the articles that contain a static tag identical to the generated dynamic tag are returned in the search. Therefore, static tags must follow the same syntax as dynamic tags for successful tag mapping during the search. Note: You can distinguish dynamic tags by the presence of the cogwheel icon next to the tag name A predefined set of dynamic tags is available by default. However, as an administrator of BMC Helix Innovation Studio, you can create custom dynamic tags. For more information, see (Optional) To create a process that constructs a dynamic tag. | For example, Get Region is a dynamic tag. Region is an attribute of the tag, and the tag value is determined dynamically. This tag is based on the custom process definition that queries the CTM:People form and determines a region to which a specific user belongs. For example, if a user belongs to the Europe region, the Region=Europe tag is generated in real time. If another user belongs to the US region, the Region=US tag is generated. If the search filter uses this tag as filtering criteria, it maps this dynamic tag to static tags added to the knowledge articles and returns only the articles that include the identical static tag. If you add Region=Europe static tag to articles about vacation policies in Europe and the Region=US tag to articles about vacation policies in the US, the search filter maps the generated dynamic tags to these static tags and returns articles with the Region=Europe tag for the user from Europe and articles with the Region=US tag for the user from the US. |
The following table provides information about dynamic tags available by default, and their structure. You can also find information about the formatting patterns that static tags in the knowledge articles must follow for proper mapping with each dynamic tag.
Dynamic tag | Description | Dynamic tag structure | Required syntax of static tags |
---|---|---|---|
Get Company | Obtains information about the company of a current user by using the CTM:People form from BMC Helix ITSM | Company=Company of a current user | Company=Company name For example, Company=Apex Global |
Get Department | Obtains information about the department of a current user by using the CTM:People form from BMC Helix ITSM | Department=Department of a current user | Department=Department name For example, Department=Payroll |
Get Knowledge Set | Obtains information about the knowledge set of a current user by using the following forms:
| Knowledge Set=Knowledge set of a current user | Knowledge Set=Knowledge Set name For example, Knowledge Set=Policy |
Get Line of Business | Obtains information about the line of business of a current user by using the following forms:
| Line of business=Line of business of a current user | Line of business=Line of business name For example, Line of Business=Human Resource |
Get Region | Obtains information about the region of a current user by using the CTM:People form from BMC Helix ITSM | Region=Region of a current user | Region=Region name For example, Region=Europe |
Get Site | Obtains information about the site of a current user by using the CTM:People form from BMC Helix ITSM | Site=Site of a current user | Site=Site name For example, Site=Tel Hai |
Get Support groups | Obtains information about the support group of a current user by using the CTM:Support Group Functional Role People Assoc Join form from BMC Helix ITSM. It is a join form between CTM:SupportGroupFuncRoleLookUp and CTM:People. | Support Group=Support group of a current user | Support Group=Group name For example, Support Group=BMCOpsMonitoring Support Group1 |
Scenarios for creating search filters
The following scenario describes how a company creates and uses a search filter that includes static tags for BMC Helix Digital Workplace Advanced. However, the process of creating and utilizing search filters with static tags is identical for BMC Helix Virtual Agent.
The following scenario describes how a company creates and uses a search filter that includes a dynamic tag for BMC Helix Virtual Agent. However, the process of creating and utilizing search filters with dynamic tags is identical for BMC Helix Digital Workplace Advanced.
(Optional) To create a process that constructs a dynamic tag
As an administrator of BMC Helix Innovation Studio, you can create a process to construct a dynamic tag.
- Log in to BMC Helix Innovation Studio and navigate to the Workspace tab.
- Click the application for which you want to create a dynamic tag:
- To create a dynamic tag for BMC Helix Virtual Agent, click BMC Chatbot.
- To create a dynamic tag for BMC Helix Digital Workplace Advanced, click Digital Workplace.
- Click the Processes tab and click New.
- On the Process Properties pane, specify the following fields:
Name—enter a name for the process.
- Run as—Select Administrator.
- On the Process Properties pane, add the Output process variable required for the workflow.
- In the VARIABLES section, click Add/ Remove Variables.
- Click Add Variable.
- In the Name field, enter tag.
- In Variable type field, select Output.
- From the Data Type list, select Text.
- Click Save.
- In Workflow designer, drag and drop the Get Records by Query element on to the canvas and map the required process input variables:
- On the GENERAL tab, in the INPUT MAP section, from the Record Definition Name list, select the CTM form you want to query. For example, select People.
- In the INPUT MAP section, click Click to build an expression and build the following expression that queries the selected CTM form:
This expression queries the selected CTM form for the current user. - In the OUTPUT MAP section, to add the process output parameter, click Add and specify the following output parameters:
- From the Name field, select tag.
- Click Click to build an expression for the Source parameter.
In the expression builder, construct an expression that will be returned as a tag. Enter the attribute of the tag as text and select the tag value from the list of available form values. See the following image for the example structure of the dynamic tag:
- Click Ok.
- Click Save.
The new dynamic tag is created. You can select it from the list of tags while creating a search filter.
(Optional) To edit the process of a predefined dynamic tag
As an administrator of BMC Helix Innovation Studio, you can edit processes that define dynamic tags provided by default.
- Log in to BMC Helix Innovation Studio and navigate to the Workspace tab.
- Click the BMC Chatbot application to edit the following predefined dynamic tags:
- Get Company
- Get Department
- Get Region
- Get Site
- Get Support groups
- Click the Shared Services application to edit Get Knowledge Set and Get Line of Business dynamic tags.
Click the Processes tab and select the process of the predefined dynamic tag that you want to edit. For example, select CONTENT TAG Get Region.
- On the canvas, click the Get Records by Query element.
- On the GENERAL tab, in the OUTPUT MAP section, to add the process output parameter, click Click to build an expression for the Source parameter.
- In the expression builder, edit the defined expression that is returned as a tag. See the following image for the example edited structure of the dynamic tag:
- Click Save.
To create a search filter
- Log in to BMC Helix Innovation Studio and click Administration.
- Select Knowledge management > Search filters.
On the Search filters page, click New search filter and specify the following fields:
Field
Action
Name
Enter the name for a search filter.
Relationship
Select one of the following logical operators to define the relationship between filtering criteria:
- AND—Returns articles that meet all filtering criteria. For example, Line of Business=HR and Operational Tier 1=People.
- OR—Returns articles that meet any filtering criterion. For example, Line of Business=Office Facilities or Knowledge Set=Office.
Important: You cannot combine AND and OR logical operators in a single filter. You can use only one operator to define the relationship between all selected filtering criteria. For example, you cannot define the following filtering expression: Company=Apex Global and Line of Business=Office Facilities or Knowledge Set=Office.
Tags
Select one or multiple article tags to be used as filtering criteria. You can combine static and dynamic tags in a search filter.
Important: Only existing static and dynamic tags are displayed in the list. However, you can add new static tags to the articles or create custom dynamic tags. For instructions on how to create a dynamic tag, see (Optional) To create a dynamic tag.
Tip: To see the list of predefined tags, click on a text input area of the Tags field. Alternatively, you can enter the tag name. When you begin entering the tag name, a list of suggested selections appears. You can distinguish dynamic tags by the presence of the cogwheel icon next to the tag name
.
To remove a selected tag, hover over the tag and click the Remove
icon.
The following image shows a sample search filter. In the example scenario described in this topic, Jordan creates the same filter for the HR chatbot.
- Click Save.
You have created the search filter. This filter is displayed on the Search filters page. To modify this or other created filters, open the filter by clicking its name.
Where to go from here
After you create a search filter, you must enable it for your BMC application.
Action | Reference |
---|---|
To enable the search filter for BMC Helix Virtual Agent | |
To enable the search filter for BMC Helix Digital Workplace Advanced |