BMC Helix Business Workflows connection¶
Introduction¶
A BMC Helix Business Workflows connection, created using the BMC Helix Business Workflows connector, establishes access to BMC Helix Business Workflows. Once a connection is configured, you can create instances of BMC Helix Business Workflows activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Create or edit a BMC Helix Business Workflows connection¶
A new BMC Helix Business Workflows connection is created using the BMC Helix Business Workflows connector from one of these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The Global Connections page (see Create a global endpoint in Global Connections).
An existing BMC Helix Business Workflows connection can be edited from these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
- The Global Connections page (see Edit a global endpoint in Global Connections).
Configure a BMC Helix Business Workflows connection¶
Each user interface element of the BMC Helix Business Workflows connection configuration screen is described below.
Tip
Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [
into the field or by clicking the variable icon to display a list of the existing variables to choose from.
-
Connection Name: Enter a name to use to identify the connection. The name must be unique for each BMC Helix Business Workflows connection and must not contain forward slashes
/
or colons:
. This name is also used to identify the BMC Helix Business Workflows endpoint, which refers to both a specific connection and its activities. -
Host: Enter the host name URL.
-
Username: Enter the username.
-
Password: Enter the password.
-
Test: Click to verify the connection using the specified configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
-
Save Changes: Click to save and close the connection configuration.
-
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
-
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.
Next steps¶
After a BMC Helix Business Workflows connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.
These activity types are available:
-
Update Task: Updates a task at BMC Helix Business Workflows and is intended to be used as a target in an operation.
-
Search Cases: Searches for and retrieves cases at BMC Helix Business Workflows and is intended to be used as a source in an operation.
-
Create Case: Creates a case at BMC Helix Business Workflows and is intended to be used as a target in an operation.
-
Get Case: Retrieves a case from BMC Helix Business Workflows and is intended to be used as a source in an operation.
-
Update Case: Updates a case at BMC Helix Business Workflows and is intended to be used as a target in an operation.
-
Create Task: Creates a task at BMC Helix Business Workflows and is intended to be used as a target in an operation.
-
Get Task: Retrieves a task from BMC Helix Business Workflows and is intended to be used as a source in an operation.
-
Search Tasks: Searches for and retrieves tasks at BMC Helix Business Workflows and is intended to be used as a source in an operation.