BMC Helix Platform connector

The BMC Helix Platform connector enables catalog administrators to use service requests to create cases in Business Workflows. The catalog administrators can also create questions that use responses from the BMC Helix Platform record definitions and named lists. Use this connector to enable Business Workflows to use BMC Digital Workplace Catalog.

Related topics

Service connector overview

Service connector capabilities

Workflows for service fulfillment

Process context variable parameters reference

Before you begin

The user whose login name is used to configure this connector should have access to the required data objects in BMC Helix Platform. The permissions should allow another application (in this case, BMC Digital Workplace Catalog) to work with the data objects in BMC Helix Platform. The record definitions permissions should allow end users to see the data in the questionnaires.

For more information on...	See...
Defining the scope	Object definition scope
Setting the record definition for named lists	Facilitating data entry through named lists
Adding permissions for new or existing record definitions	Creating or modifying regular record definitions

If you are about to install or upgrade to BMC Digital Workplace Catalog 18.11 or later, use the ALLOWED_CROSS_ORIGIN_SOURCES parameter to provide the URL to Business Workflows on the BMC Helix Platform server, from which cross-launch into BMC Digital Workplace Catalog will be seamlessly allowed.

Tips

For fresh installations of BMC Digital Workplace Catalog 18.11 or later, see Creating a BMC Digital Workplace Catalog installation options file and BMC Digital Workplace Catalog installation parameter reference.

For upgrades to BMC Digital Workplace Catalog 18.11 or later, see Creating a BMC Digital Workplace Catalog upgrade options file.

If you did not provide the URL to Business Workflows while installing or upgrading, follow these steps:

Navigate to installLocation/sb/env/set_script_variables.sh.
Find the ALLOWED_CROSS_ORIGIN_SOURCES parameter in the file.
Enter the URL to the BMC Helix Business Workflows application on the BMC Helix Platform server, from which cross-launch into BMC Digital Workplace Catalog should be allowed seamlessly.
Restart the BMC Digital Workplace Catalog server.

External account requirements

A BMC Helix Platform tenant admin user account is required to use this connector with BMC Helix Platform. For more information on the required roles, see the following topics:

Configuration parameters for the BMC Helix Platform connector

Best practice

Configure only one BMC Helix Platform connector at a time, and use the URL specified for the ALLOWED_CROSS_ORIGIN_SOURCES parameter.

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	-

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.	com.bmc.arsys.rx.foundation.Geography City com.bmc.arsys.rx.foundation.Geography Country com.bmc.arsys.rx.foundation.Geography Country and States
Dataset	Map selection type questions or action triggers to Named Lists in BMC Helix Platform.	com.bmc.arsys.rx.foundation.Geography State com.bmc.arsys.rx.foundation.Geography All States

Tip

Select BMC Helix Platform from the filter to filter and display Records and Named Lists from BMC Helix Platform.

Catalog export capabilities

With the BMC Helix Platform connector, you can create cases in Business Workflows through BMC Digital Workplace Catalog service requests.

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

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.