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.

TSO connector

The TSO connector enables BMC Helix Digital Workplace Catalog to use TrueSight Orchestration Platform services as a fulfillment engine. TrueSight Orchestration Platform invokes workflows that connect with third-party applications to fulfill a requested service. The integration requires TrueSight Orchestration Platform Content pack 20.16.02 and later.

External account requirements

You must have a TrueSight Orchestration Platform user account with the Grid Management, Development Studio, and workflow execution permissions for the required modules.

Configuration parameters for the TSO connector

Before you can use the TSO connector in workflows or to import services, you must perform the following steps:

  1. Install the BMC Helix Digital Workplace Catalog module in TrueSight Orchestration Platform as described in Installing BMC MyIT Service Broker module Open link .
  2. Configure adapters and modules required for the integration, as described in  Configuring TrueSight Orchestration Content Open link .
  3. Configure a connection, as described in Configuring service connectors.
    The following table describes the parameters required to create a connection:

    ParameterExamplesDescription
    URLhttps://clm-pun-001234.clm-mgmt.clm.bmc.com:38080

    Specifies the URL to the TrueSight Orchestration Platform peer in the following format: https://host.name:port.

    Logintsoadmin

    Specifies the user name required to log in to the TrueSight Orchestration Platform environment. 

    PasswordtsoAdmin!
    Specifies the password that matches the user name.
    Trust Self-Signed Certificatestrue

    Specifies whether to trust environments with self-signed certificates. The valid values are true (accept) or false (do not accept).

    Note: Any value that is different from true or false is interpreted as false.

    Connect Timeout30000

    Specifies the amount of time, in milliseconds, that the connector waits for a response before cancelling the connection attempt. If no value is specified, the default is 30000.

    Read Timeout30000

    Specifies the amount of time, in milliseconds, that the connector waits for a response before cancelling the read attempt. If no value is specified, the default is 30000.

Catalog import capabilities

By using the TSO connector, you can import workflows from TrueSight Orchestration Platform as services in BMC Helix Digital Workplace Catalog. The default integration provides the following TrueSight Orchestration Platform workflows that you can import as services or call from BMC Helix Digital Workplace Catalog workflow:

  • Unlock an account
  • Extend mailbox size
  • Onboard a new employee
  • Offboard an employee

Administrators can expose additional TrueSight Orchestration Platform workflows by editing the TrueSight Orchestration Platform server configuration.

When you import a service through the TSO connector, you import only the service description details. You must define a BMC Helix Digital Workplace Catalog workflow that calls the TrueSight Orchestration Platform service workflow and provides the required parameters, so that the service is fulfilled through the TSO connector. 

For more information about the import, see Importing service catalog items from external systems and Importing service categories.

Workflow actions available through the TSO connector

The following table provides an overview of all TSO connector actions:

ActionDescriptionInput parametersPossible output

Invoke TrueSight Orchestration Platform service

Use this action to request the available TrueSight Orchestration Platform services asynchronously.

Invoke TrueSight Orchestration Platform service input parametersJob Id—An ID of a service execution.

Invoke TrueSight Orchestration Platform service sync

Use this action to request the available TrueSight Orchestration Platform services synchronously.

Invoke TrueSight Orchestration Platform service input parametersJob Id—An ID of a service execution.

Get TrueSight Orchestration Platform service status

Use this action to request the statuses of previously requested TrueSight Orchestration Platform services.

Get TrueSight Orchestration Platform service status input parameters
  • Status—A service execution status.
    The possible values are:
    • Assigned—The process is started, running, or paused.
    • Completed—The process was executed successfully.
    • Compensated—The process failed to execute successfully.
    • Cancelled—The process was cancelled.
  • Params—The parsed output parameters of the service status response.

    Note: The parsed parameters have a dynamic structure and might change for different services.

Example: Workflow for a service that sends in-app notification about TrueSight Orchestration Platform service status

The following example workflow sends an in-app notification after invoking a TrueSight Orchestration Platform service and getting the status of the service request.

To build the workflow shown in the figure, perform the following steps:

  1. In the workflow designer, set a workflow name (for example, Invoke BAO Send SMS).

  2. Add two text variables to the inputs of the workflow: Message and Phone Number.

  3. Drag and drop the following actions onto the canvas:

    • Build Input Set

    • Invoke BAO Service

    • Get BAO Service Status

    • Send In App Notification

  4. Provide the following input values to the actions:

    • Build Input Set:

      KeyValue
      MessageMessage input parameter
      Phone NumberPhone Number input parameter
    • Invoke BAO Service:

      ParameterValue
      Connection IdID of the TSO connector’s connection object. Taken from the workflow’s Connection Id variable.
      Service Id 
      Send SMS
      Input ParametersInputs property of the Build Input Set action
    • Get BAO Service Status:

      ParameterValue
      Connection IdID of the TSO connector’s connection object. Taken from the workflow’s Connection Id variable.
      Job Id 
      Output property of the Invoke BAO Service action
    • Send In App Notification:

      ParameterValue
      Receiver 
      hannah_admin
      Title TSO Send SMS Status
      Content Status property of the Get BAO Service Status action’s output
  5. Save the workflow.

For more information about configuring services in BMC Helix Digital Workplace Catalog, see the following references:

TaskReference
To create service a workflowWorkflows for service fulfillment
To create a service questionnaireCreating service questionnaires
To add a serviceAdding and updating services

Invoke TrueSight Orchestration Platform service input parameters

RequiredParameter nameData typeExampleDescription
RequiredConnection IdStringTSODefault Connection ID for the TSO connector.

Required

Service IdStringUnlock an account

A name of a TrueSight Orchestration Platform service to be invoked.

Note: The service name must match the one defined in the BMC Helix Digital Workplace Catalog module configuration in TrueSight Orchestration Platform.

Conditional*

*Required if a service expects mandatory input parameters

Input ParametersMapconfiguration name=BMC_AR_System,incident number=INC000000000011

A mapping of input parameter names (questions) to values (answers).

Should be created with the Build Input Set action.

The Input Parameters name is different for each service, and can be discovered by requesting the service details.

Get TrueSight Orchestration Platform service status input parameters

RequiredParameter nameData typeExampleDescription

Required

Connection IdStringTSODefault Connection ID for the TSO connector.

Required

Job IdStringExampleID01

An ID of a previously started TrueSight Orchestration Platform service execution.

Conditional*

*Required if a service expects mandatory input parameters

Input ParametersMapconfiguration name=BMC_AR_System,incident number=INC000000000011

A mapping of input parameter names (questions) to values (answers).

Should be created with the Build Input Set action.

The Input Parameter name is different for each service, and can be discovered by requesting the service details.

Was this page helpful? Yes No Submitting... Thank you

Comments