BMC Helix for Communication Service Provider (CSP) connector powered by Jitterbit

To configure the BMC Helix for CSP connection

Configure the BMC Helix for CSP connection by using the BMC Helix for CSP connector. After a connection is established with the BMC Helix for CSP endpoint, you can configure one or more BMC Helix for CSP 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. 

To configure a BMC Helix for CSP connection, complete the following steps:

1. From the design canvas, open the Connectivity tab  of the design component palette.
2. Perform one of the following actions:
   • To configure a new BMC Helix for CSP connection, use the Show list to filter on Connectors, and then click the BMC Helix for CSP connector block.
     
   • To configure an existing BMC Helix for CSP connection, use the Show list to filter on Endpoints, and then double-click the BMC Helix for CSP connector block.
     

3. On the configuration screen for the BMC Helix for CSP connection, enter the following configuration values:

   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
   Endpoint Name	Enter a name to identify the BMC Helix for CSP connection. The name must be unique for each BMC Helix for CSP connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the BMC Helix for CSP endpoint, which refers to both a specific connection and its activities.
   HOST	Enter the URL of your BMC Helix for CSP instance.
   Username	Enter the user name to access your BMC Helix for CSP instance.
   Password	Enter the password for your BMC Helix for CSP instance.

   

   Important

   If you click  Delete  while creating a new connection, an error is displayed. For more information, see Component Dependencies, Deletion, and Removal.

4. Click Save Changes.
   After configuring the connection, configure one or more activities associated with that connection. For more information about creating an activity, see Creating a BMC Helix for CSP activity .

To create a BMC Helix for CSP activity 

1. From the design canvas, open the Connectivity tab  of the design component palette.

2. to display activities that are available to be used with a BMC Helix for CSP connection, use the Show list to filter on Endpoints, and then click the BMC Helix for CSP connection block.
   The following activities are available. For more information about configuring these activities, see the specific activity sections.

   Activity Name	Description
   Create	Inserts an entity into a BMC Helix for CSP endpoint and is intended to be used as a target in an operation.
   Get	Retrieves data from a BMC Helix for CSP endpoint and is intended to be used as a source in an operation.
   Query	Retrieves entities from a BMC Helix for CSP endpoint and is intended to be used as a source in an operation.
   Update	Updates data into a BMC Helix for CSP endpoint and is intended to be used as a target in an operation.

   

3. 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. 

To configure a BMC Helix for CSP Create activity 

A BMC Helix for CSP Create activity inserts an entity into a BMC Helix for CSP endpoint and is intended to be used as a target to consume data in an operation. After configuring a BMC Helix for CSP connection, you can configure as many BMC Helix for CSP activities as you like for each connection. 

To configure a BMC Helix for CSP Create activity, complete the following steps:

1. After you add the activity to an operation, double-click the activity block.

2. On the configuration screen, enter a name and select the action for the activity.

   Field name	Action
   Name	Enter a name to identify the BMC Helix for CSP Create activity. The name must be unique for each BMC Helix for CSP Create activity and must not contain forward slashes (`/`) or colons (`:`).
   Select an Object for the resource	This section displays entity types available in the BMC Helix for CSP endpoint. When reopening an existing activity configuration, only the selected entity class is displayed instead of reloading the entire entity class list. Selected Entity: After an entity type is selected, it is listed here. Search: Enter any part of the entity type into the search box to filter the list of entity types. The search is not case-sensitive. If entity types are already displayed within the table, the table results are filtered in real time with each keystroke. To reload entity types from the endpoint when searching, enter search criteria, and then click Refresh. Refresh: Click the refresh icon  or the word Refresh to reload entity types from the BMC Helix for CSP endpoint. You may need to perform this action if you have recently added entity types to BMC Helix for CSP. This action refreshes all metadata used to build the table of entity types displayed in the configuration. Selected Object: Within the table, click anywhere on a row to select an entity type. Only one entity class can be selected. The information available for each entity type is fetched from the BMC Helix for CSP endpoint: Name: The entity class name from BMC Helix for CSP. Description: The description of the entity class type from BMC Helix for CSP. Important: If the table does not populate with available entity types, the BMC Helix for CSP connection might not be successful. Make sure the BMC Helix for CSP connection is configured correctly by reopening the connection and retesting the credentials.

   

3. Click Next.

4. Review the request and response data schemas.
   The data schemas list the fields available for the BMC Helix for CSP Create activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
   For more information about transformations, seeTransformations.

5. Click Finished.
   After a BMC Helix for CSP activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu.

To complete the configuration of the operation, add and configure other activities, transformations, or scripts as steps in an operation. You can also configure an operation's settings, which include the ability to chain operations together that are in the same or different workflows. When the workflows are ready, deploy and run the operation and validate behavior by checking the operation logs. 

BMC Helix for CSP Create operation patterns

BMC Helix for CSP Create activities can be used as a target with these operation patterns:

• Transformation Pattern
• Two-Transformation Pattern (as the first or second source)

A typical workflow uses a BMC Helix for CSP Create activity in the Two-Transformation Pattern. In this example, the first transformation (CSP Create Request) creates a request structure that is passed to the BMC Helix for CSP Create activity. The second transformation (CSP Create Response) receives the response structure, which is then written to a variable by a Variable Write activity (CSP Create Response) and a message is then logged by the Write to Operation Log script:

To configure a BMC Helix for CSP Get activity

A BMC Helix for CSP Get activity deletes entities from a BMC Helix for CSP endpoint and is intended to be used as a target to consume data in an operation. After configuring a BMC Helix for CSP connection, you can configure as many BMC Helix for CSP activities as you like for each BMC Helix for CSP connection.

To configure a BMC Helix for CSP Get activity, complete the following steps:

1. After you add the activity to an operation, double-click the activity block.

2. On the configuration screen, enter a name and select the entity type for the activity.

   Field name	Action
   Name	Enter a name to identify the BMC Helix for CSP Get activity. The name must be unique for each BMC Helix for CSP Get activity, and must not contain forward slashes (/) or colons (:).
   Select an Object for the resource	This section displays entity types available in the BMC Helix for CSP endpoint. When reopening an existing activity configuration, only the selected entity class is displayed instead of reloading the entire entity class list. Selected Object: After an entity type is selected, it is listed here. Search: Enter any part of the entity type into the search box to filter the list of entity types. The search is not case-sensitive. If entity types are already displayed within the table, the table results are filtered in real time with each keystroke. To reload entity types from the endpoint when searching, enter search criteria, and then click Refresh. Refresh: Click the refresh icon  or the word Refresh to reload entity types from the BMC Helix for CSP endpoint. You may need to perform this action if you have recently added entity types to BMC Helix for CSP. This action refreshes all metadata used to build the table of entity types displayed in the configuration. Selected Object: Within the table, click anywhere on a row to select an entity type. Only one entity class can be selected. The information available for each entity type is fetched from the BMC Helix for CSP endpoint: Name: The entity class name from BMC Helix for CSP. Description: The description of the entity class type from BMC Helix for CSP. Important: If the table does not populate with available entity types, the BMC Helix for CSP connection might not be successful. Make sure the BMC Helix for CSP connection is configured correctly by reopening the connection and retesting the credentials.
   ID (Comma separated ID of the entity to be deleted)	Enter comma separated values of the IDs of the entities you want to retrieve.

   

3. Click Next.

4. Review the request and response data schemas. 
   The data schemas list the fields available for the BMC Helix for CSP Get activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
   For more information about transformations, see Transformations.
5. Click Finished.
   After the activity is created, menu actions for that activity are accessible from the project pane in either the  Workflows  or the  Components  tab, and from the design canvas. For more information, seeActivity Actions Menu.

To complete the configuration of the operation, add and configure other activities, transformations, or scripts as steps in an operation. You can also configure an operation's settings, which include the ability to chain operations together that are in the same or different workflows. When the workflows are ready, deploy and run the operation and validate behavior by checking the operation logs. 

BMC Helix for CSP Get operation patterns

BMC Helix for CSP Get activities can be used as a target with these operation patterns:

• Transformation Pattern
• Two-Transformation Pattern (as the first or second source)

A typical workflow uses a BMC Helix for CSP Get activity in the Two-Transformation Pattern. In this example, the first transformation (CSP Get Request) creates a request structure that is passed to the BMC Helix for CSP Get activity. The second transformation (CSP Get Response) receives the response structure, which is then written to a variable by a Variable Write activity (CSP Get Response) and a message is then logged by the Write to Operation Log script:

To configure a BMC Helix for CSP Query activity

A BMC Helix for CSP Query activity searches for entities from a BMC Helix for CSP endpoint and is intended to be used as a source to provide data in an operation. After configuring a BMC Helix for CSP connection, you can configure as many BMC Helix for CSP activities as you like for each BMC Helix for CSP connection.

To configure a BMC Helix for CSP Query activity, complete the following steps:

1. After you add the activity to an operation, double-click the activity block.

2. On the configuration screen, enter a name and select the entity type for the activity. 

   Field name	Action
   Name	Enter a name to use to identify the BMC Helix for CSP Query activity. The name must be unique for each BMC Helix for CSP Query activity, and must not contain forward slashes (/) or colons (:).
   Select an object for the resource	This section displays entity types available in the BMC Helix for CSP endpoint. When reopening an existing activity configuration, only the selected entity class is displayed instead of reloading the entire entity class list. Selected Object: After an entity type is selected, it is listed here. Search: Enter any part of the entity type into the search box to filter the list of entity types. The search is not case-sensitive. If entity types are already displayed within the table, the table results are filtered in real time with each keystroke. To reload entity types from the endpoint when searching, enter search criteria, and then click Refresh. Refresh: Click the refresh icon  or the word Refresh to reload entity types from the BMC Helix for CSP endpoint. You may need to perform this action if you have recently added entity types to BMC Helix for CSP. This action refreshes all metadata used to build the table of entity types displayed in the configuration. Selected Object: Within the table, click anywhere on a row to select an entity type. Only one entity class can be selected. The information available for each entity type is fetched from the BMC Helix for CSP endpoint: Name: The entity class name from BMC Helix for CSP. Description: The description of the entity class type from BMC Helix for CSP. Important: If the table does not populate with available entity types, the BMC Helix for CSP connection might not be successful. Make sure the BMC Helix for CSP connection is configured correctly by reopening the connection and retesting the credentials.

   

3. Click Next.

4. Review the request and response data schemas for your BMC Helix for CSP instance. 
   The data schemas list the fields available for the BMC Helix for CSP Query activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
   For more information about transformations, see Transformations.

5. Click Finished.
   After the activity is created, menu actions for that activity are accessible from the project pane in either the  Workflows  or the  Components  tab, and from the design canvas. For more information, see Activity Actions Menu.

To complete the configuration of the operation, add and configure other activities, transformations, or scripts as steps in an operation. You can also configure an operation's settings, which include the ability to chain operations together that are in the same or different workflows. When the workflows are ready, deploy and run the operation and validate behavior by checking the operation logs . 

BMC Helix for CSP Query operation patterns

BMC Helix for CSP Query activities can be used as a target with these operation patterns:

• Transformation Pattern
• Two-Transformation Pattern (as the first or second source)

A typical workflow uses a BMC Helix for CSP Query activity in the Two-Transformation Pattern. In this example, the first transformation (CSP Query Request) creates a request structure that is passed to the BMC Helix for CSP Query activity. The second transformation (CSP Query Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write CSP Query Response) and a message is then logged by the Write to Operation Log script:

To configure a BMC Helix for CSP Update activity 

A BMC Helix for CSP Update activity inserts an entity into a BMC Helix for CSP endpoint and is intended to be used as a target to consume data in an operation. After configuring a BMC Helix for CSP connection, you can configure as many BMC Helix for CSP activities as you like for each BMC Helix for CSP connection. 

To configure a BMC Helix for CSP Update activity, complete the following steps:

1. After you add the activity to an operation, double-click the activity block.

2. On the configuration screen, enter a name and select an entity type for the activity.

   Field name	Action
   Name	Enter a name to use to identify the BMC Helix for CSP Update activity. The name must be unique for each BMC Helix for CSP Update activity, and must not contain forward slashes (/) or colons (:).
   Select an object for the resource	This section displays entity types available in the BMC Helix for CSP endpoint. When reopening an existing activity configuration, only the selected entity class is displayed instead of reloading the entire entity class list. Selected Object: After an entity type is selected, it is listed here. Search: Enter any part of the entity type into the search box to filter the list of entity types. The search is not case-sensitive. If entity types are already displayed within the table, the table results are filtered in real time with each keystroke. To reload entity types from the endpoint when searching, enter search criteria, and then click Refresh. Refresh: Click the refresh icon  or the word Refresh to reload entity types from the BMC Helix for CSP endpoint. You may need to perform this action if you have recently added entity types to BMC Helix for CSP. This action refreshes all metadata used to build the table of entity types displayed in the configuration. Selected Object: Within the table, click anywhere on a row to select an entity type. Only one entity class can be selected. The information available for each entity type is fetched from the BMC Helix for CSP endpoint: Name: The entity class name from BMC Helix for CSP. Description: The description of the entity class type from BMC Helix for CSP. Important: If the table does not populate with available entity types, the BMC Helix for CSP connection might not be successful. Make sure the BMC Helix for CSP connection is configured correctly by reopening the connection and retesting the credentials.
   ID (Comma separated ID of the entity to be updated)	Enter comma separated values of the IDs of the entities you want to update.

   

3. Click Next. 

4. Review the request and response data schemas for your BMC Helix for CSP instance. 
   The data schemas list the fields available for the BMC Helix for CSP Update activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
   For more information about transformations, see Transformations.

5. Click Finished. 
   After the activity is created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tab, and from the design canvas. For more information, see Activity Actions Menu.

To complete the configuration of the operation, add and configure other activities, transformations, or scripts as steps in an operation. You can also configure an operation's settings, which include the ability to chain operations together that are in the same or different workflows. When the workflows are ready, deploy and run the operation and validate behavior by checking the operation logs. 

BMC Helix for CSP Update operation patterns

BMC Helix for CSP Update activities can be used as a target with these operation patterns:

• Transformation Pattern
• Two-Transformation Pattern (as the first or second source)

A typical workflow uses a BMC Helix for CSP Update activity in the Two-Transformation Pattern. In this example, the first transformation (CSP Update Request) creates a request structure that is passed to the BMC Helix for CSP Update activity. The second transformation (CSP Update Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write CSP Update Response) and a message is then logged by the Write to Operation Log script: