Adding data sources in BMC HelixGPT
Applications and data sources for BMC HelixGPT
The following applications are available out-of-the-box inBMC HelixGPT. You can only edit the connection details for these data sources. You cannot delete these connections.:
- BMC Helix Business Workflows
- BMC Helix Knowledge Management by ComAround
- BMC Helix ITSM Knowledge Management
- BMC Helix ITSM
- BMC Helix Customer Service Management
The following data sources are not available out-of-the-box. You must first enable them to create new data connections:
- BMC Helix Customer Service Management
- Confluence
- Microsoft SharePoint Online
- Web
- Salesforce Knowledge
You can add multiple connections for Confluence, Microsoft SharePoint Online, Salesforce Knowledge, and Web data sources.
Before you begin
Make sure you have the HelixGPT Administrator role to add data sources. Learn more about roles in Roles-and-permissions.
Process for setting up BMC HelixGPT
The following image shows the process of setting up BMC HelixGPT and the current step that you are on:
Complete the following steps to configure data sources in BMC HelixGPT:
To review and edit an out-of-the-box data connection
Out-of-the-box data connections are available for BMC Helix Business Workflows, BMC Helix Knowledge Management by ComAround, BMC Helix ITSM Knowledge Management, and BMC Helix ITSM. You cannot delete these connections and can only edit the details.
- In BMC HelixGPT Manager, click Settings
.
- Select HelixGPT > Connections > Information sources.
- To open a connection, click the connection name.
- In the Edit Connection pane, modify the following details:
- Connection name
- User name
- Click Save.
To enable data sources
- As an HGM Admin user, log in to BMC Helix Innovation Studio.
- On the Workspace tab, click HelixGPT Manager.
- On the Records tab, select the check box for the DataSource record definition and click Edit data, as shown in the following image:
- On the Data editor (DataSource) page, select the checkbox of the Microsoft SharePoint Online data source, and click Edit as shown in the following image:
- In the Edit record pane, change the status to Enabled and click Save.
- Repeat steps 4 and 5 to enable the Confluence, Helix Customer Service Management, Salesforce Knowledge, and Web data sources.
To add data sources to HelixGPT
After enabling the data sources, you can add a new data connection in BMC HeliGPT Manager.
- In BMC HelixGPT Manager, click Settings
.
- Select HelixGPT > Connections > Information sources.
- To add a new connection, click + Add connection.
- From the Connection type list, select one of the following options:
- Confluence
- Microsoft SharePoint Online
- Helix Customer Service Management
- Salesforce Knowledge
- Web
- Click Add.
In the Add connection pane, specify the following information:
Field
Description
Confluence details
Connection name
Name of the connection
Source type
Connection type that you selected
You cannot change this value.
URL
URL of the Confluence website that you want to index
Page ID
Page ID of the website that you want to index
Learn how to find the Page ID of the website in How to get Confluence page ID
Authentication type
The type of authentication required to access the page
Authentication type
Values to enter
None
NA
Personal Access Token
Access token—access token that is required to access the page and website
Learn how to find the access token in Using Personal Access Tokens.
Oauth
- Access token—access token that is required to access the page and website
- Access Token Secret—the secret key
- Consumer Key—the consumer password
- Key Certificate—the client certificate
Learn how to manage Oauth tokens in OAuth access tokens.
Oauth2
- Token type—Select one of the following token types from the list
- Access token
- Bearer token
- ID token
- Refresh token
- Access/Bearer/ID/Refresh token—the token value based on the type of token selected
- Client ID—Client ID that is required to access the page and website
Learn about Oauth 2.0 protocol in OAuth 2.0 protocol.
SharePoint details
Connection name
Name of the connection
Source type
Connection type that you selected
You cannot change this value.
Client ID
Client ID that is required to access SharePoint
Learn how to find the Client ID in Registering an application with Microsoft.
Client secret
Client secret required to access SharePoint
Site
SharePoint website that you want to index
Tenant ID
Tenant ID required to access SharePoint
Tenant
Tenant name required to access SharePoint
Helix Customer Service Management details
Connection name
Name of the connection
Source type
Connection type that you selected
You cannot change this value.
User name
User account to connect to the data source
Web details
Connection name
Name of the connection
Source type
Connection type that you selected
URL
Main URL for the website to crawl.
Max Depth
The maximum depth for crawling within the website’s link hierarchy.
Example — 3
Use Robots.txt
Boolean indicating if robots.txt should be respected during crawling.
Example — True
Crawl Budget
The maximum number of pages to capture in a single crawl operation.
Example — 100
Auth Type
Authentication method.
Example — 0 (BASIC)
User name
Username for BASIC or DIGEST authentication.
Password
Password for BASIC or DIGEST authentication.
Token
Token for TOKEN authentication.
Custom Headers
JSON format headers for authentication.
Example — { "Custom-Header": "Value" }
Salesforce Knowledge details
Connection name
Name of the connection
Source type
Connection type that you selected
Salesforce URL
URL for Salesforce instance.
Example — login.salesforce.com
Security Token
Token generated by Salesforce for secure external access.
User name
Salesforce username with appropriate access rights.
Password
Password of the user
Domain
The Salesforce domain for login.
Examples:
- (Default) login
- test
Object Name
The main Salesforce object to run a query.
Field Mappings
JSON structure for mapping Salesforce fields.
Elasticsearch details
Important: Contact BMC Support to use this data source.
Source type
Connection type that you selected
Connection name
Custom connection name
URL
Elasticsearch URL
Secret
Password
User ID
User name
Splunk details
Important: Contact BMC Support to use this data source.
Source type
Connection type that you selected
Connection name
Custom connection name
URL
Splunk URL
Secret
Password
User ID
User name
- Click Save.
To edit a data connection
- In BMC HelixGPT Manager, click Settings
.
- Select HelixGPT > Connections > Information sources.
- Select the connection name.
- In the Edit Connection pane, modify the following details:
- Connection name
- Confluence: URL, Page ID, Access Token
- SharePoint: Client ID, Client Secret, Site, Tenant ID, Tenant
- Helix Customer Service Management: User name
- Web: URL
- Salesforce Knowledge: URL, Security Token, User name, Password
- Click Save.
Results
After the connection is successfully saved, a connection ID is generated. To note the Connection ID for the new data sources that you created, in the data connections table, from the Visible columns list, select ID.
The following image shows the Connection ID in the data sources table:
Use the connection ID while creating the data connection jobs to ingest data into the BMC HelixGPT database. You must create a new job for every Confluence, Microsoft SharePoint Online, Web, or Salesforce Knowledge data connection that you add.
Where to go from here