BMC Helix Multi-Cloud Broker connector for BMC Helix iPaaS, powered by Jitterbit
The BMC Helix Multi-Cloud Broker connector for Jitterbit Harmony Cloud Studio provides an interface for entering user-provided input such as credentials to create an authenticated BMC Helix Multi-Cloud Broker connection. That connection provides the foundation to configure associated BMC Helix Multi-Cloud Broker connector activities that interact with the connection. Together, a specific BMC Helix Multi-Cloud Broker connection and its activities are referred to as a BMC Helix Multi-Cloud Broker endpoint.
Supported API versions and prerequisites
The BMC Helix Multi-Cloud Broker connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.
Connector overview
This connector is used to first configure a BMC Helix Multi-Cloud Broker connection, establishing access to BMC Helix Multi-Cloud Broker, and then used to configure one or more BMC Helix Multi-Cloud Broker activities associated with that connection as a source or target within an operation:
- Get: Finds an object at a BMC Helix Multi-Cloud Broker endpoint and is intended to be used as a source in an operation.
- Get Attachments: Finds an object at a BMC Helix Multi-Cloud Broker endpoint and is intended to be used as a source in an operation.
- Create: Posts an object into a BMC Helix Multi-Cloud Broker endpoint and is intended to be used as a target in an operation.
- Update: Posts an object into a BMC Helix Multi-Cloud Broker endpoint and is intended to be used as a target in an operation.
Accessing the connector
The BMC Helix Multi-Cloud Broker connector is accessed from the Connectivity tab of the design component palette by using the Show dropdown to filter on Connectors.
Once a connection is configured, activities associated with the endpoint are available by using the Show dropdown to filter on Endpoints and then clicking theBMC Helix Multi-Cloud Broker connection block:
BMC Helix Multi-Cloud Broker connection
A BMC Helix Multi-Cloud Broker connection is configured using the BMC Helix Multi-Cloud Broker connector, establishing access to the BMC Helix Multi-Cloud Broker endpoint. Once a connection is established, you can configure one or moreBMC Helix Multi-Cloud Broker activities associated with that connection to be used either as a source to provide data to an operation or as a target to consume data in an operation.
Creating or editing a BMC Helix Multi-Cloud Broker connection
From the design canvas, open the Connectivity tab of the design component palette:
To configure a new BMC Helix Multi-Cloud Broker connection, use the Show option to filter the connectors. Then, click the BMC Helix Multi-Cloud Broker connector block:
To configure an existing BMC Helix Multi-Cloud Broker connection, use the Show option to filter the endpoints. Then, click the BMC Helix Multi-Cloud Broker connector block:
This opens the configuration screen for the BMC Helix Multi-Cloud Brokerconnection, covered next.
Configuring a BMC Helix Multi-Cloud Broker connection
Configuration of a BMC Helix Multi-Cloud Broker connection includes these fields:
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.
Field Name | Action | |
|---|---|---|
1 | Endpoint Name | Enter a name to identify the BMC Helix Multi-Cloud Broker connection. The name must be unique for each BMC Helix Multi-Cloud Broker connection and must not contain forward slashes (`/`) or colons (`:`). This name is also used to identify the BMC Helix Multi-Cloud Broker endpoint, which refers to both a specific connection and its activities. |
2 | Host | Enter the BMC Helix Multi-Cloud Broker host URL. |
3 | Username | Enter the user name to log in to BMC Helix Multi-Cloud Broker. |
4 | Password | Enter the password for the username to log in to BMC Helix Multi-Cloud Broker. |
5 | Test | Click to verify the connection using the provided credentials. |
6 | Save Changes | Click to save and close the connection configuration. |
7 | 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. |
8 | Delete | After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration. For more information, see Component Dependencies, Deletion, and Removal. A message asks you to confirm that you want to delete the connection. |
Next steps
After configuring a BMC Helix Multi-Cloud Broker connection, you can configure one or more BMC Helix Multi-Cloud Broker activities associated with that connection to be used either as a source (to provide data within an operation) or as a target (to consume data within an operation).
Use the Show dropdown to filter the Endpoints, and then click the BMC Helix Multi-Cloud Broker connection block to display activities that are available to be used with a BMC Helix Multi-Cloud Broker connection:
Creating a BMC Helix Multi-Cloud Broker activity
- From the design canvas, open the Connectivity tab of the design component palette:
- Use the Show dropdown to filter on Endpoints, and then click the BMC Helix Multi-Cloud Broker connection block to display activities that are available to be used with a BMC Helix Multi-Cloud Broker connection:
The following activities are available. For more information about configuring these activities, see the specific activity sections.- Get: Finds an object at a BMC Helix Multi-Cloud Broker endpoint and is intended to be used as a source in an operation.
- Get Attachments: Finds an object at a BMC Helix Multi-Cloud Broker endpoint and is intended to be used as a source in an operation.
- Create: Posts an object into a BMC Helix Multi-Cloud Broker endpoint and is intended to be used as a target in an operation.
- Update: Posts an object into a BMC Helix Multi-Cloud Broker endpoint and is intended to be used as a target in an operation.
To create an activity that can be configured, drag the activity block from the palette to the operation.
For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration .
Create activity
A BMC Helix Multi-Cloud Broker Create activity places an object into a BMC Helix Multi-Cloud Broker endpoint and is intended to be used as a target to consume data in an operation. After configuring a BMC Helix Multi-Cloud Broker connection, you can configure as many BMC Helix Multi-Cloud Broker activities as you like for each BMC Helix Multi-Cloud Broker connection. You can configure activities to create, get, and update BMC Helix IT Broker records, and get attachments.
The Create activity supports only the following objects:
- Incident
- Change
- Problem
- Work Order
- Known Error
- Vendor data
- Worklog
- Flow transaction
- Service unavailability
- Service notification
The Create activity also supports any custom fields for the supported list of objects.
Configuring a BMC Helix Multi-Cloud Broker Create Activity
Follow these steps to configure a BMC Helix Multi-Cloud Broker Create activity:
Step 1: Enter a Name and Specify Settings
Field Name | Action |
|---|---|
Name | Enter a name to use to identify the BMC Helix Multi-Cloud Broker Create activity. The name must be unique for each BMC Helix Multi-Cloud Broker Create activity and must not contain forward slashes (`/`) or colons (`:`). |
Select an Object for the resource | This section displays the objects available in the BMC Helix Multi-Cloud Broker endpoint. When reopening an existing activity configuration, only the selected service object is displayed instead of reloading the entire service code list. |
Selected Object | After an object is selected, it is listed here. Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the BMC Helix Multi-Cloud Broker endpoint:
Important: If the table does not populate with available objects, the BMC Helix Multi-Cloud Broker connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials |
Search | Enter any part of the object name into the search box to filter the list of objects. The search is not case-sensitive. If the objects are already displayed within |
Refresh | Click the refresh icon |
Save & Exit | If enabled, click to save the configuration for this step and close the activity configuration. |
Next | Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step. |
Discard Changes | After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes. |
or the word Refresh to reload the objects from the BMC Helix Multi-Cloud Broker endpoint. This may be useful if you have recently added objects to BMC Helix Multi-Cloud Broker Broker. This action refreshes all metadata used to build the table of objects displayed in the configuration.Step 2: Review the Data schemas
Field Name | Action |
|---|---|
Data Schema | The request and response data schemas for BMC Helix Multi-Cloud Broker are displayed. If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more. |
Refresh | Click the refresh icon |
Back | Click to temporarily store the configuration for this step and return to the previous step. |
Finished | Click to save the configuration for all steps and close the activity configuration. |
Discard Changes | After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes. |
Next steps
After configuring a BMC Helix Multi-Cloud Broker Create activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.
After a BMC Helix Multi-Cloud Broker activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.
BMC Helix Multi-Cloud Broker Create activities can be used as a target with these operation patterns:
Two-Transformation Pattern (as the first or second target)
Other patterns are not valid using BMC Helix Multi-Cloud Broker Create activities. See the validation patterns on the Operation Validity page.
A typical use case is to use a BMC Helix Multi-Cloud Broker Create activity in the Two-Transformation Pattern. In this example, the first transformation (BMC Helix Multi-Cloud Broker Create Request) creates a request structure that is passed to the BMC Helix Multi-Cloud Broker Create activity. The second transformation (BMC Helix Multi-Cloud Broker Create Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write BMC Helix Multi-Cloud Broker Create Response) and a message is then logged by the Write to Operation Log script:
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.
When ready, deploy and run the operation and validate behavior by checking the Operation logs.
Update activity
A BMC Helix Multi-Cloud Broker Update activity places an object into a BMC Helix Multi-Cloud Broker endpoint and is intended to be used as a target to consume data in an operation. After configuring a BMC Helix Multi-Cloud Broker connection, you can configure as many BMC Helix Multi-Cloud Broker activities as you like for each BMC Helix Multi-Cloud Broker connection.
The Update activity supports the following objects:
- Incident
- Change
- Problem
- Work Order
- Known Error
- Vendor data
The Update activity also supports any custom fields for the supported list of objects.
Configuring a BMC Helix Multi-Cloud Broker Update Activity
Follow these steps to configure a BMC Helix Multi-Cloud Broker Update activity:
Step 1: Enter a Name and Specify Settings
Field Name | Action |
|---|---|
Name | Enter a name to use to identify the BMC Helix Multi-Cloud Broker Update activity. The name must be unique for each BMC Helix Multi-Cloud Broker Update activity and must not contain forward slashes (`/`) or colons (`:`). |
TICKET ID | Enter the ID of the record or ticket that you want to update. The following list provides the value of Ticket ID for different ticket types:
|
Select an Object for the resource | This section displays the objects available in the BMC Helix Multi-Cloud Broker endpoint. When reopening an existing activity configuration, only the selected service code is displayed instead of reloading the entire service code list. |
Selected Object | After an object is selected, it is listed here. Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the BMC Helix Multi-Cloud Broker endpoint:
Important: If the table does not populate with available objects, the BMC Helix Multi-Cloud Broker connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials |
Save & Exit | If enabled, click to save the configuration for this step and close the activity configuration. |
Next | Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step. |
Discard Changes | After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes. |
Step 2: Review the Data Schemas
Field Name | Action |
|---|---|
Data Schema | The request and response data schemas for BMC Helix Multi-Cloud Broker are displayed. If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more. |
Refresh | Click the refresh icon |
Back | Click to temporarily store the configuration for this step and return to the previous step. |
Finished | Click to save the configuration for all steps and close the activity configuration. |
Discard Changes | After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes. |
Next Steps
After configuring a BMC Helix Multi-Cloud Broker Update activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.
After a BMC Helix Multi-Cloud Broker activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. See Activity Actions Menu for details.
BMC Helix Multi-Cloud Broker Update activities can be used as a target with these operation patterns:
Two-Transformation Pattern(as the first or second target)
Other patterns are not valid using BMC Helix Multi-Cloud Broker Update activities. See the validation patterns on the Operation Validity page.
A typical use case is to use a BMC Helix Multi-Cloud Broker Update activity in the Two-Transformation Pattern. In this example, the first transformation (BMC Helix Multi-Cloud Broker Update Request) creates a request structure that is passed to the BMC Helix Multi-Cloud Broker Update activity. The second transformation (BMC Helix Multi-Cloud Broker Update Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write BMC Helix Multi-Cloud Broker Update Response) and a message is then logged by the Write to Operation Log script:
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.
When ready, deploy and run the operation and validate behavior by checking the Operation Logs.
Get activity
A BMC Helix Multi-Cloud Broker Get activity finds an object at a BMC Helix Multi-Cloud Broker endpoint and is intended to be used as a source to provide data to an operation. After configuring a BMC Helix Multi-Cloud Broker connection, you can configure as many BMC Helix Multi-Cloud Broker activities as you like for each BMC Helix Multi-Cloud Broker connection.
The Get activity supports any object from the Ticket Brokering library in BMC Helix Multi-Cloud Broker.
Configuring a BMC Helix Multi-Cloud Broker Get Activity
Follow these steps to configure a BMC Helix Multi-Cloud Broker Get activity:
Step 1: Enter a Name and Specify Settings
Field Name | Action |
|---|---|
Name | Enter a name to use to identify the BMC Helix Multi-Cloud Broker Get activity. The name must be unique for each BMC Helix Multi-Cloud Broker Get activity and must not contain forward slashes (`/`) or colons (`:`). |
Ticket GUID | Enter the record instance ID for which you want to get the details. |
Select an Object for the resource | This section displays the objects available in the BMC Helix Multi-Cloud Broker endpoint. When reopening an existing activity configuration, only the selected service code is displayed instead of reloading the entire service code list. |
Selected Object | After an object is selected, it is listed here. Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the BMC Helix Multi-Cloud Broker endpoint:
Important: If the table does not populate with available objects, the BMC Helix Multi-Cloud Broker connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials |
Save & Exit | If enabled, click to save the configuration for this step and close the activity configuration. |
Next | Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step. |
Discard Changes | After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes. |
Step 2: Review the Data Schemas
Field Name | Action |
|---|---|
Data Schema | The request and response data schemas for BMC Helix Multi-Cloud Broker are displayed. If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more. |
Refresh | Click the refresh icon |
Back | Click to temporarily store the configuration for this step and return to the previous step. |
Finished | Click to save the configuration for all steps and close the activity configuration. |
Discard Changes | After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes. |
Next Steps
After configuring a BMC Helix Multi-Cloud Broker Get activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.
After a BMC Helix Multi-Cloud Broker activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. See Activity Actions Menu for details.
BMC Helix Multi-Cloud Broker Get activities can be used as a source with these operation patterns:
Two-Target Archive Pattern (as the first source only)
Two-Transformation Pattern (as the first or second source)
Other patterns are not valid using BMC Helix Multi-Cloud Broker Get activities. For more information about the validation patterns, see the Operation Validity
page.
A typical use case is to use a BMC Helix Multi-Cloud Broker Get activity in the Two-Transformation Pattern. In this example, the first transformation (BMC Helix Multi-Cloud Broker Get Request) creates a request structure that is passed to the BMC Helix Multi-Cloud Broker Get activity. The second transformation (BMC Helix Multi-Cloud Broker Get Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write BMC Helix Multi-Cloud Broker Get Response) and a message is then logged by the Write to Operation Log script:
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.
When ready, deploy and run the operation and validate behavior by checking the Operation Logs.
Get Attachments activity
A BMC Helix Multi-Cloud Broker Get Attachments activity finds an attachment at a BMC Helix Multi-Cloud Broker endpoint and is intended to be used as a source to provide data to an operation. BMC Helix Multi-Cloud Broker extracts all the related attachments to the attachment group, by the attachment group ID. After configuring a BMC Helix Multi-Cloud Broker connection, you can configure as many BMC Helix Multi-Cloud Broker activities as you like for each BMC Helix Multi-Cloud Broker connection.
Configuring a BMC Helix Multi-Cloud Broker Get Attachments Activity
Follow these steps to configure a BMC Helix Multi-Cloud Broker Get Attachments activity:
Step 1: Enter a Name and Specify Settings
Field Name | Action |
|---|---|
Name | Enter a name to identify the BMC Helix Multi-Cloud Broker Get Attachments activity. The name must be unique for each BMC Helix Multi-Cloud Broker Get Attachments activity and must not contain forward slashes (`/`) or colons (`:`). |
Attachment Group ID | When a work note with an attachment is created in a ticket, an entry in the worklog record definition in BMC Helix Multi-Cloud Broker is also created. The entry in the worklog record contains an ID for the attachments. |
Save & Exit | If enabled, click to save the configuration for this step and close the activity configuration. |
Next | Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step. |
Discard Changes | After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes. |
Step 2: Review the Data Schemas
Field Name | Action |
|---|---|
Data Schema | The request and response data schemas for BMC Helix Multi-Cloud Broker are displayed. If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more. |
Refresh | Click the refresh icon |
Back | Click to temporarily store the configuration for this step and return to the previous step. |
Finished | Click to save the configuration for all steps and close the activity configuration. |
Discard Changes | After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes. |
Next Steps
After configuring a BMC Helix Multi-Cloud Broker Get Attachments activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.
After a BMC Helix Multi-Cloud Broker activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. See Activity Actions Menu for details.
BMC Helix Multi-Cloud Broker Get Attachments activities can be used as a source with these operation patterns:
Two-Target Archive Pattern (as the first source only)
Two-Transformation Pattern (as the first or second source)
Other patterns are not valid using BMC Helix Multi-Cloud Broker Get Attachments activities. See the validation patterns on the Operation Validity page.
A typical use case is to use a BMC Helix Multi-Cloud Broker Get Attachments activity in the Two-Transformation Pattern. In this example, the first transformation (BMC Helix Multi-Cloud Broker Get Attachments Request) creates a request structure that is passed to the BMC Helix Multi-Cloud Broker Get Attachments activity. The second transformation (BMC Helix Multi-Cloud Broker Get Attachments Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write BMC Helix Multi-Cloud Broker Get Attachments Response) and a message is then logged by the Write to Operation Log script:
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.
When ready, deploy and run the operation and validate behavior by checking the operation logs.