Data sources for BMC HelixGPT


BMC HelixGPT offers a few out-of-the-box data sources. The following data sources are not available out-of-the-box. You must first enable them to create new data connections. To learn more about enabling data sources, see Adding data sources in BMC HelixGPT.

  • Confluence
  • Microsoft SharePoint Online
  • Helix Customer Service Management
  • Web
  • Salesforce Knowledge
  • Elastic
  • Splunk
  • Jira
  • ServiceNow
  • xMatters
  • PagerDuty

Confluence

Specify connection details for Confluence by inputting the following details:

FieldDescription
Connection nameName of the connection.
Source typeConnection type. You cannot change this value.
Default: Confluence
URLURL of the Confluence website that you want to index.
Page IDPage 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 typeValues to enter
NoneNA
Personal Access TokenAccess token — access token that is required to access the page and website. Learn how to find the access token in Using Personal AccessTokens.
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.

Example: Confluence connection details
FieldAuthentication typeToken typeValue
Connection nameNANAConfluence Connector
Source typeConfluence
URLhttps://confluence.bmc.com
Page ID369941352
Authentication typeNoneNone
Personal Access TokenAccess Token: MDM0MjM5NDc2MDxxxxxxxxxxxxxxxxxxxxx
OauthAccess Token: 1234567890abcdef1234567890abcdef
Access Token Secret: abcdef1234567890abcdef1234567890
Consumer Key: confluence-oauth-client
Key Certificate:

-----BEGIN RSA PRIVATE KEY-----

MIICXAIBAAKBgQDYZ9Xv+Z1Zk9vZxKjKjU1ZKjKjU1ZKjKjU1ZKjKjU1ZKjKjU1ZK

...

-----END RSA PRIVATE KEY-----

Oauth2Access tokenAccess Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Client ID: confluence-cloud-client-id
Bearer tokenBearer Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjb25mbHVlbnNlX3VzZXIiLCJleHAiOjE2ODg4ODg4ODgsImlhdCI6MTY4ODg4ODg4OH0.abc123def456ghi789
Client ID: confluence-cloud-client-id
ID tokenID Token: eyJraWQiOiJrZXlfaWQiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwczovL2lkLmF0bGFzc2lhbi5jb20vIiwiYXVkIjoiY29uZmx1ZW5jZS1jbG91ZC1jbGllbnQifQ.signature
Client ID: confluence-cloud-client-id
Refresh tokenRefresh Token: dGhpcyBpcyBhIHNhbXBsZSByZWZyZXNoIHRva2Vu...
Client ID: confluence-cloud-client-id
BasicNAUser name: confluence_user
Password: <Password for the respective user>
CustomCustom Headers: { "Authorization": "Bearer <access_token>", "Content-Type": "application/json" }

 

Microsoft SharePoint Online

Specify connection details for SharePoint by inputting details from the following table:

Warning

Important:

  • The Microsoft SharePoint Online connection is available for use only if it is enabled in your environment.
  • You can have only one active Microsoft SharePoint Online connection at a time.
  • If you use Microsoft SharePoint Online as a data source in a skill, the system prompts you to sign in once and then honors the access setting.
FieldDescription
Connection nameName of the connection.
Source typeConnection type. You cannot change this value.
Default: Microsoft SharePoint Online
Client IDThe unique identifier of your Azure AD-registered application used for authentication. Learn how to find the Client ID in
Registering an application.
Client secretA secret key used with the client ID for secure authentication.
SiteSharePoint site that you want to index.
Tenant IDThe unique identifier of your Microsoft 365 tenant (directory).
TenantTenant name used to access SharePoint.
Example: SharePoint connection details
FieldValue
Connection nameHelixGPTWebinar
Source typeMicrosoft SharePoint Online
Client IDae1cfdef-1ea9-4525-b634-59df395f51b0
Client secret5hF8Q~A.6gUxGaqW5cn1DnxAjXje7PAlHdopob8n
Sitehelixvirtualagent.sharepoint.com/sites/HelixGPTWebinar
Tenant ID0eaae44d-9585-433b-8366-13bf26167b53
TenantBMC

 

Helix Customer Service Management

Specify connection details for Helix Customer Service Management by inputting the following details:

FieldDescription
Connection nameName of the connection.
Source typeConnection type. You cannot change this value.
Default: Helix Customer Service Management
User nameUser account that is used to connect to the data source.
Example: Helix Customer Service Management connection details
FieldValue
Connection name

CSM

Source typeHelix Customer Service Management
User nameAny logged in user or service account that can run jobs and has access permissions to the connection.
For example: admin

Web

Specify connection details for Web by inputting the following details:

FieldDescription
Connection nameName of the connection.
Source type

Connection type. You cannot change this value.

Default: Web

URLMain URL for the website to crawl.
HostThe domain name or IP address of the server where the website is hosted.
PortThe port is a number that specifies which service on the host should handle the request.
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 nameUsername for BASIC or DIGEST authentication.
PasswordPassword for BASIC or DIGEST authentication.
TokenToken for TOKEN authentication.
Custom Headers

JSON format headers for authentication.

Example — { "Custom-Header": "Value" }

Example: Web connection details
FieldAuth TypeValue
Connection nameNAHelixGPTWebinar
Source typeWeb
URLhttps://bmc.com
Hostbmc.com
Port80
Max Depth1
Use Robots.txtTrue
Crawl Budget500
Auth TypeNoneHost: bmc.com
Port: 80
Crawl Depth: 1
Crawl Budget: 500
Personal Access TokenAccess Token: ghp_16CharSampleToken1234
Host: api.example.com
Port: 443
Crawl Depth: 1
Crawl Budget: 500
BasicUser name: web_user
Password: <Password for the respective user>
Host: secure.example.com
Port: 443
Crawl Depth: 1
Crawl Budget: 500
DigestUser name: digest_user
Password: <Password for the respective user>
Host: digest.example.com
Port: 8080
Crawl Depth: 1
Crawl Budget: 500
CustomCustom Headers: { "Authorization": "Bearer eyJhbGciOiJIUzI1NiIs..." }
Host: custom.example.com
Port: 8443
Crawl Depth: 1
Crawl Budget: 500

 

Salesforce Knowledge

Specify connection details for Salesforce Knowledge by inputting the following details:

FieldDescription
Source typeConnection type. You cannot change this value.
Default: Salesforce Knowledge
Connection nameName of the connection.
URL

URL for Salesforce instance.

Example — login.salesforce.com

Security TokenToken generated by Salesforce for secure external access.
User nameSalesforce user name with appropriate access rights.
PasswordPassword for the user.
Domain

The Salesforce domain for login.

Examples:

  • (Default) login
  • test
Field MappingsJSON structure for mapping Salesforce fields.
Object NameThe main Salesforce object to run a query.
Example: Salesforce Knowledge connection details
FieldValue
Connection nameSalesforce Connection
Source typeSalesforce Knowledge
Salesforce URLhttps://mycompany.my.salesforce.com
Security TokenXyZ1234567890AbCdEfGhIjKlMnOpQrSt
User nameintegration.user@mycompany.com
Password<Password for the respective user>
Domainmycompany
Object NameKnowledgeArticleDetails
Field Mappings{
  "language": "en",
  "title": "Title",
  "web_url": "UrlName",
  "page_content": [
    "Summary",
    "sc_Answer__c",
    "sc_Cause__c",
    "sc_Detail__c",
    "sc_Problem__c",
    "sc_Question__c",
    "sc_Solution__c"
  ]
}

Elastic

Specify connection details for Elastic by inputting the following details:

FieldDescription
Source typeConnection type. You cannot change this value.
Default: Elastic
Connection nameName of the connection.
URLElastic URL.
SecretPassword for the User ID.
User IDUser name to access the data source.
Example: Elastic connection details
FieldValue
Source typeElastic
Connection nameElastic Connection
URLhttps://elastic.mycompany.com:9200
Secretelastic-secret-token-abc123
User IDelastic_user

Splunk

Specify connection details for Splunk by inputting the following details:

FieldDescription
Source type

Connection type. You cannot change this value.

Default: Splunk

Connection nameName of the connection.
URLSplunk URL.
SecretPassword for the User ID.
User IDUser name to access the data source.
Example: Splunk connection details
FieldValue
Source typeSplunk
Connection nameSplunk Connection
URLhttps://splunk.mycompany.com:8089
Secretsplunk-auth-token-xyz789
User IDsplunk_admin

 

Jira

Specify connection details for Jira by inputting the following details:

FieldDescription
Source type

Connection type. You cannot change this value.

Default: Jira

Connection nameName of the connection.
Authentication type

Authentication types required to access Jira.

Authentication typeValues
NoneNone.
Personal Access TokenAccess 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 TokenRequired to access Jira.
Example: Jira connection details
FieldAuthentication typeToken typeValue
Source typeNANAJira
Connection nameJIRA Connection
Authentication typeNoneNone
Personal Access TokenAccess Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
OAuth

Access Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Access Token Secret: abcdef1234567890abcdef1234567890
Consumer Key: jira-oauth-client
Key Certificate: -----BEGIN RSA PRIVATE KEY-----\nMIICXAIBAAKBgQDYZ9Xv+Z1Zk9vZxKjKjU1ZKjKjU1ZKjKjU1ZKjKjU1ZKjKjU1ZKjKjU1ZK\n...\n-----END RSA PRIVATE KEY-----
OAuth2Access tokenAccess Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.abc123def456ghi789
Client ID: jira-cloud-client-id-xyz123
Bearer tokenBearer Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.def456ghi789abc123
Client ID: jira-cloud-client-id-xyz123
ID tokenID Token: eyJraWQiOiJrZXlfaWQiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwczovL2lkLmF0bGFzc2lhbi5jb20vIiwiYXVkIjoiY29uZmx1ZW5jZS1jbG91ZC1jbGllbnQifQ.signature
Client ID: jira-cloud-client-id-xyz123
Refresh tokenRefresh Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ghi789abc123def456
Client ID: jira-cloud-client-id-xyz123

ServiceNow

Specify connection details for ServiceNow by inputting the following details:

FieldDescription
Source typeConnection type. You cannot change this value.
Default: ServiceNow
Connection nameName of the connection.
URLServiceNow URL.
Authentication typeAuthentication types required to access ServiceNow.
Auth SecretPassword.
Auth IDUser name.
Key CertificateThe client certificate.
Example: ServiceNow connection details
FieldAuthentication typeValue
Source typeNAServiceNow
Connection nameServiceNow Connection
URL
Authentication typeBasicAuth Secret: S3rvic3N0wP@ssw0rd!
Auth ID: servicenow_user
OAuthAuth Secret: servicenow-oauth-secret-456xyz
Auth ID: servicenow-client-id-123abc
Key Certificate: -----BEGIN CERTIFICATE-----
MIIDdzCCAl+gAwIBAgIEbG9vZzANBgkqhkiG9w0BAQsFADBvMQswCQYDVQQGEwJV
...
-----END CERTIFICATE-----

xMatters

Specify connection details for xMatters by inputting the following details:

FieldDescription
User nameUser ID used to authenticate with the xMatters environment.
PasswordAn authentication password required to connect to the xMatters data source.
URLThe endpoint URL of the xMatters instance to establish the connection.
Example: xMatters connection details
FieldValue
User name​​​​User name with appropriate access rights.
For example, teamsswarmingapp
Password<Password for the respective user>
URLhttps://bmc-np.hosted.xmatters.com

 

PagerDuty

Specify connection details for PagerDuty by inputting the following details:

FieldDescription
Connection nameCustom connection name for the PagerDuty connection.
URLThe endpoint URL of the PagerDuty instance to establish the connection.
TokenToken for TOKEN authentication. Token generated by PagerDuty to access the PagerDuty API.
Example: PagerDuty connection details
FieldValue
Connection namePagerDuty Connection
URLhttps://api.pagerduty.com
TokenToken generated by Pagerduty to access the PagerDuty API.
For example, y_NbAkKc66ryYTWUXYEu

 

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

BMC HelixGPT 25.4