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:
- Install the BMC MyIT Service Broker module in BMC TrueSight Orchestration as described in Installing BMC MyIT Service Broker module .
- Configure adapters and modules required for the integration, as described in Configuring TrueSight Orchestration Content .
Configure a connection, as described in Configuring service connectors.
The following table describes the parameters required to create a connection:Parameter Examples Description URL https://clm-pun-001234.clm-mgmt.clm.bmc.com:38080 Specifies the URL to the BMC TrueSight Orchestration peer in the following format: https://host.name:port. Login tsoadmin Specifies the user name required to log in to the BMC TrueSight Orchestration environment.
Password tsoAdmin! Specifies the password that matches the user name. Trust Self-Signed Certificates true 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:
Action | Description | Input parameters | Possible output |
---|---|---|---|
Invoke BAO service | Use this action to request the available TSO services asynchronously. | Invoke BAO service input parameters | Job Id—An ID of a service execution. |
Invoke BAO service sync | Use this action to request the available TSO services synchronously. | Invoke BAO service input parameters | Job Id—An ID of a service execution. |
Get BAO service status | Use this action to request the statuses of previously requested TSO services. | Get BAO service status input parameters |
|
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:
In the workflow designer in BMC Digital Workplace Catalog, set a workflow name (for example, Invoke BAO Send SMS).
Add two text variables to the inputs of the workflow: Message and Phone Number.
Drag and drop the following actions onto the canvas:
Build Input Set
Invoke BAO Service
Get BAO Service Status
Send In App Notification
Provide the following input values to the actions:
Build Input Set:
Key Value Message Message input parameter Phone Number Phone Number input parameter Invoke BAO Service:
Parameter Value Connection Id ID of the TSO connector’s connection object. Taken from the workflow’s Connection Id variable. Service Id Send SMS Input Parameters Inputs property of the Build Input Set action
Get BAO Service Status:
Parameter Value Connection Id ID 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:
Parameter Value Receiver hannah_admin Title TSO Send SMS Status Content Status property of the Get BAO Service Status action’s output
- Save the workflow.
For more information about configuring services in BMC Digital Workplace Catalog, see the following references:
Task | Reference |
---|---|
To create service a workflow | Workflows for service fulfillment |
To create a service questionnaire | Creating service questionnaires |
To add a service | Adding and updating services |
Invoke BAO service input parameters
Required | Parameter name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | TSO | Default Connection ID for the TSO connector. |
Required | Service Id | String | Unlock 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 Parameters | Map | configuration 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
Required | Parameter name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | TSO | Default Connection ID for the TSO connector. |
Required | Job Id | String | ExampleID01 | An ID of a previously started TSO service execution. |
Conditional* *Required if a service expects mandatory input parameters | Input Parameters | Map | configuration 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. |
Comments
It would be more helpful , if DWP can extract output parameters of the AO Process in future versions. Idea Submitted: https://communities.bmc.com/ideas/21555
Thanks for your comment Raghuram Guggilam, and submitting that BMC Communities Idea.
Thanks,
Ravee
Log in or register to comment.