This documentation supports the 22.1 version of BMC Helix Digital Workplace Basic and BMC Helix Digital Workplace Advanced. Icons distinguish capabilities available only for the Advanced and External license levels. For more information, see License-types-and-features.

BMC Helix Innovation Studio connector


The BMC Helix Innovation Studio connector enables catalog administrators to use service requests to create cases in BMC Helix Business Workflows. The catalog administrators can also create questions that use responses from the BMC Helix Innovation Studio record definitions and named lists. Use this connector to enable BMC Helix Business Workflows to use BMC Helix 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 Innovation Studio. The permissions should allow another application (in this case, BMC Helix Digital Workplace Catalog) to work with the data objects in BMC Helix Innovation Studio. The record definitions permissions should allow end users to see the data in the questionnaires.

For more information on...

See...

Defining the scope

Setting the record definition for named lists

Adding permissions for new or existing record definitions

External account requirements

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

Configuration parameters for the BMC Helix Innovation Studio connector

Best practice
Configure only one BMC Helix Innovation Studio connector at a time.

Before you can use the BMC Helix Innovation Studio 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://bmc-helix-innovation-studio-server.com:8008

The BMC Helix Innovation Studio 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 Innovation Studio.

Password

*******

The password for the user.

Trust Self-Signed Certificates

true

-

Connect Timeout (ms)
(Applicable only when BMC Helix Business Workflows is integrated through this connector)

30000

Time in milliseconds that the connector waits for a successful connection with the BMC Helix Innovation Studio instance before cancelling the connection attempt.

Default value—30000 ms

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 Innovation Studio instance. 

For example, the timeout period is applied when the system loads data such as cases, templates, and so on. 

Default value—30000 ms

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 Innovation Studio instance. This setting applies to the following actions: 

  • Create Ticket
  • Create Survey
  • Cancel Activity
  • Reopen Activity

Default value—60000 ms

Resource mapping capabilities

The BMC Helix Innovation Studio 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 Innovation Studio.

  • 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 Innovation Studio.

  • com.bmc.arsys.rx.foundation.Geography State
  • com.bmc.arsys.rx.foundation.Geography All States

Tip

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

Catalog export capabilities

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

Workflow action available through the BMC Helix Innovation Studio connector

The following table provides an overview of the BMC Helix Innovation Studio connector action:

Action

Description

Input parameters

Create Ticket

Use this action to create a record using BMC Helix Business Workflows forms in BMC Helix Innovation Studio.

Create Ticket input parameters

Required

Parameter name

Data type

Examples

Description

Required

Connection Id

String

Connection > BMC Helix Innovation Studio

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.

 

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