Adding data sources in BMC HelixGPT

To get started with BMC HelixGPT for the chatbot, knowledge article search, and summarization use cases, as an administrator, you must first define the data sources in the BMC HelixGPT Manager. You must define the required parameters for the new data sources to connect the data source with the database into which data will be ingested.

Data sources for BMC HelixGPT

The following data sources are available out-of-the-box in BMC 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

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 
• XWiki

You can add multiple connections for Confluence, Microsoft SharePoint Online, Salesforce Knowledge, and Web data sources.

Before you begin

Make sure you have the BMC HelixGPT Administrator role to add data or edit sources and data connections. 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:

• Review the existing out-of-the-box connections
• Enable data sources from record definitions
• Add data sources to BMC HelixGPT
• Create multiple connections for data sources

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. 

1. In BMC HelixGPTManager, click Settings .
2. Select HelixGPT > Connections > Information sources.
3. To open a connection, click the connection name.
4. In the Edit Connection pane, modify the following details:
   • Connection name
   • User name
5. Click Save.

To enable data sources

1. As a HelixGPT Manager Admin user, log in to BMC Helix Innovation Studio.
2. On the Workspace tab, click HelixGPT Manager. 
3. On the Records tab, select the check box for the DataSource record definition and click Edit data, as shown in the following image:
   
4. 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:
   
5. In the Edit record pane, change the status to Enabled and click Save.
6. Repeat steps 4 and 5 to enable Confluence, Helix Customer Service Management, Salesforce Knowledge, and Web data sources.

To add data sources to BMC HelixGPT

After enabling the data sources, you can add a new data connection in BMC HelixGPT Manager.

1. In BMC HelixGPT Manager, click Settings .
2. Select HelixGPT > Connections > Information sources.
3. To add a new connection, click + Add connection.
4. From the Connection type list, select one of the following options:
   • Confluence
   • Microsoft SharePoint Online
   • Helix Customer Service Management
   • Salesforce Knowledge
   • Web
5. Click Add.

6. 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 want to add. 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 want to add. You cannot change this value.
   Client ID	Client ID that is used to access SharePoint. Learn how to find the Client ID in Registering an application with Microsoft.
   Client secret	The client secret that is used to access SharePoint.
   Site	SharePoint website that you want to index.
   Tenant ID	Tenant ID used to access SharePoint.
   Tenant	Tenant name used to access SharePoint.
   Helix Customer Service Management details
   Connection name	Name of the connection.
   Source type	Connection type that you want to add. You cannot change this value.
   User name	User account that is used to connect to the data source.
   Web details
   Connection name	Name of the connection.
   Source type	Connection type that you want to add.
   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 want to add.
   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
   Source type	Connection type that you want to add.
   Connection name	Custom connection name.
   URL	Elasticsearch URL.
   Secret	Password for the User ID.
   User ID	User name to access the data source.
   Splunk details
   Source type	Connection type that you want to add.
   Connection name	Custom connection name.
   URL	Splunk URL.
   Secret	Password for the User ID.
   User ID	User name to access the data source.
   Jira details
   Source type	Connection type that you want to add.
   Connection name	Custom connection name.
   Authentication type	Authentication types required to access Jira. Authentication type Values None None. Personal Access Token Access token to access Jira. 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. 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.
   Access Token	Required to access Jira.
   ServiceNow details
   Source type	Connection type that you want to add.
   Connection name	Custom connection name.
   URL	ServiceNow URL
   Secret	Password
   User ID	User name
   xMatters details
   User name	Indicates the user ID used to authenticate with the xMatters environment.
   Password	Specifies the authentication password required to connect to the xMatters data source.
   URL	Defines the endpoint URL of the xMatters instance to establish the connection.
   XWiki details
   Connection name	Custom connection name.
   URL	XWiki URL. For example: https://mywiki.domain.com/wiki
   Authentication type	Anonymous Select this option if you do not require authentication to access the XWiki data connection. Basic   User name: XWiki username with appropriate access rights. Password: The password of the user. Custom  Custom headers:  JSON format headers for authentication. Provide this value if your XWiki server has a defined custom authentication method. For example — { "Authorization": "Bearer xwiki:XWiki..."}
   Wiki name (Optional)	Name of the wiki space. Default: XWiki Provide this value if you have changed the default value or your XWiki site has more than one wiki name.
   Space	The XWiki space to be crawled. For example: If your URL is: https://wiki.domain.com/xwiki/bin/view/Main/:  Your space is: Main.   If your URL is: https://wiki.domain.com/xwiki/bin/view/Main/Sub-Space Your space is: Main/Sub-Space.
   Ignore spaces (Optional)	The spaces to be excluded from the crawler. Provide a comma-separated list of spaces to be ignored by the crawler.
   Configuration (Optional)	Configuration determines how child pages are identified during crawling. Default: Nested Pages model ("hierarchy": "nestedpages") If your XWiki instance uses the Parent-Child model, update the configuration to: {"hierarchy": "parentchild"}

7. Click Save.

To edit a data connection

1. In BMC HelixGPT Manager, click Settings .
2. Select HelixGPT > Connections > Information sources.
3. Select the connection name that you want to edit.
4. 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
5. 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

Ingesting-data-into-BMC-HelixGPT

Related topics

BMC HelixGPT architecture

Setting up and going live