Unsupported content

 

This version of the product is in limited support. However, the documentation is available for your convenience. You will not be able to leave comments.

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.

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 Open link

Setting the record definition for named lists

Facilitating data entry through named lists Open link

Adding permissions for new or existing record definitions

Creating or modifying regular record definitions Open link

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:

  1. Navigate to installLocation/sb/env/set_script_variables.sh.
  2. Find the ALLOWED_CROSS_ORIGIN_SOURCES parameter in the file.
  3. 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.
  4. 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:

  • Empowering BMC Digital Workplace Advanced users to create cases in BMC Helix Business Workflows Open link
  • Additional functional roles Open link
  • Enabling automatic case creation from BMC Helix Digital Workplace Advanced service requests Open link

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.

Loginuser@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 Certificatestrue-

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:

ActionDescriptionInput 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

RequiredConnection IdStringConnection > BMC Helix PlatformDefault Connection ID for this connector.
Required

Sub-catalog ID

StringProcess 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.

RequiredService Request GUIDStringProcess context > Service Request > Service Request GUID Globally unique identifier for the Service Request.
RequiredService Request Display IDStringProcess context > Service Request > Service Request ID The Service Request identifier displayed to the user.
RequiredRequesterStringProcess context > Requested For User > Login NameName of the user who submitted the request.
OptionalTicket Template GUIDStringProcess variables > TemplateGUID of the ticket template to use.
OptionalContactStringProcess context > Requested By User > Login NameLogin ID of the user who submitted the request.
RequiredSummaryString

Process input > Text variable

Summary to be sent to the request handler.

OptionalDescriptionStringProcess input > Text variable

Details to be sent to the request handler.

Optional AttachmentsString

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 & AsString

Process context > Questions And Answers

String representation of all questions and responses, including those assigned to process inputs, and created questions.
Optional Process Correlation IdString

General > Process Correlation ID

System generated key that identifies the service request to the integration component. For more information, see Waiting for a response.

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments