BMC Helix Platform connector
Before you begin
Make sure the administrator and the end users have the following permissions:
- The administrator whose login name is used to configure this connector should have access to the required data objects in BMC Helix Platform. For more information, see Object definition scope.
- The permissions should allow another application (in this case, BMC Helix Digital Workplace Catalog) to work with the data objects in BMC Helix Platform. For more information, see Facilitating data entry through named lists.
- The record definition permissions should allow end users to see the data in the questionnaires. For more information, see Creating or modifying regular record definitions.
- A BMC Helix Platform tenant admin user account is required to use this connector. For more information on the required roles, see the following topics:
To configure the BMC Helix Platform connector
Before you can use the BMC Helix Platform connector to import services, or in workflows, you must configure a connection as described in Configuring-service-connectors. The following table describes the parameters required to create a connection:
Parameter | Examples | Description |
|---|---|---|
Server URL | http://bmchelixplatform-server.com:8008 | The BMC Helix Platform server URL. |
Login | user@domain.com | The Login name of the user that is used to configure this connector. This user must be a tenant admin with access to the required data objects in BMC Helix Platform. |
Password | ******* | The password for the user. |
Trust Self-Signed Certificates | true | - |
(Version 21.3.10 and later) Connect Timeout (ms) | 30000 | Time in milliseconds that the connector waits for a successful connection with the BMC Helix Platform instance before cancelling the connection attempt. Default value—30000 ms |
(Version 21.3.10 and later) Read Timeout (ms) (Applicable only when BMC Helix Business Workflows is integrated through this connector) | 30000 | Time in milliseconds that the connector waits to read the data from the BMC Helix Platform instance. For example, the timeout period is applied when the system loads data such as cases, templates, and so on. Default value—30000 ms |
(Version 21.3.10 and later) Long Read Timeout (ms) (Applicable only when BMC Helix Business Workflows is integrated through this connector) | 60000 | Time in milliseconds that the connector waits to read the data from BMC Helix Platform instance. This setting applies to the following actions:
Default value—60000 ms |
Resource mapping capabilities
The BMC Helix Platform connector exposes the following resources that can be mapped to the following selection type questions: checkbox, dropdown, multiselect dropdown, radio buttons, and lookup.
Resource | Description | Examples |
|---|---|---|
Forms | Map selection type questions or action triggers to Records in BMC Helix Platform. |
|
Dataset | Map selection type questions or action triggers to Named Lists in BMC Helix Platform. |
|
Workflow action available through the BMC Helix Platform connector
The following table provides an overview of the BMC Helix Platform connector action:
Action | Description | Input parameters |
|---|---|---|
Create Ticket | Use this action to create a record using Business Workflow forms in BMC Helix Platform. |
Create Ticket input parameters
Required | Parameter name | Data type | Examples | Description |
|---|---|---|---|---|
Required | Connection Id | String | Connection > BMC Helix Platform | Default Connection ID for this connector. |
Required | Sub-catalog ID | String | Process context >Service > Sub Catalog Id | The identifier for the subcatalog that contains this service. Note: If you assigned the service subcatalog ID from the Service Broker Context, ensure that the service belongs to the appropriate subcatalog. |
Required | Service Request GUID | String | Process context > Service Request > Service Request GUID | Globally unique identifier for the Service Request. |
Required | Service Request Display ID | String | Process context > Service Request > Service Request ID | The Service Request identifier displayed to the user. |
Required | Requester | String | Process context > Requested For User > Login Name | Name of the user who submitted the request. |
Optional | Ticket Template GUID | String | Process variables > Template | GUID of the ticket template to use. |
Optional | Contact | String | Process context > Requested By User > Login Name | Login ID of the user who submitted the request. |
Required | Summary | String | Process input > Text variable | Summary to be sent to the request handler. |
Optional | Description | String | Process input > Text variable | Details to be sent to the request handler. |
Optional | Attachments | String | Process input > Text variable | String array of attachment ID values that is submitted by using a Text process input. In the associated questionnaire, map the Text process input to an Attachment question. |
Optional | Q & As | String | Process context > Questions And Answers | String representation of all questions and responses, including those assigned to process inputs, and created questions. |
Optional | Process Correlation Id | String | General > Process Correlation ID | System generated key that identifies the service request to the integration component. For more information, see Waiting-for-a-response. |
Required licensing
SaaS subscribers who use BMC Helix ITSM or BMC-Helix-Virtual-Agent-Basic-service are entitled to this feature.