This documentation supports the 20.08 version of BMC Digital Workplace Advanced, which is available only to BMC Helix subscribers (SaaS).
To view an earlier version, select the version from the Product Version menu.

TrueSight Orchestration (TSO) connector

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

External account requirements

You must have the BMC TrueSight Orchestration 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 MyIT Service Broker module in BMC TrueSight Orchestration 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:38080Specifies the URL to the BMC TrueSight Orchestration peer in the following format: https://host.name:port.
    Logintsoadmin

    Specifies the user name required to log in to the BMC TrueSight Orchestration 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.

Catalog import capabilities

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

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

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

When you import a service through the TSO connector, you import only the service description details. You must define a BMC Digital Workplace Catalog workflow that calls the TSO 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 BAO service

Use this action to request the available TSO services asynchronously.

Invoke BAO service input parametersJob Id—An ID of a service execution.
Invoke BAO service syncUse this action to request the available TSO services synchronously. Invoke BAO service input parametersJob Id—An ID of a service execution.
Get BAO service statusUse this action to request the statuses of previously requested TSO services.Get BAO 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 TSO service status

The following example workflow sends an in-app notification after invoking a TSO 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 in BMC Digital Workplace Catalog, 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 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 BAO service input parameters

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

Required

Service IdStringUnlock an account

A name of a TSO service to be invoked.

Note: The service name must match the one defined in the BMC MyIT Service Broker module configuration in BMC TrueSight Orchestration.

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 in BMC Digital Workplace Catalog.

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

Get BAO service status input parameters

RequiredParameter nameData typeExampleDescription

Required

Connection IdStringTSODefault Connection ID for the TSO connector.

Required

Job IdStringExampleID01An ID of a previously started TSO 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 in BMC Digital Workplace Catalog.

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