ALM Octane connector powered by Jitterbit

Use the BMC Helix iPaaS ALM Octane connector to configure associated ALM Octane activities that interact with the connection as a source or target within an operation. A specific ALM Octane connection and its activities together are referred to as an ALM Octane endpoint.

Use the connector to perform the following actions:  

• Create, get, update, and search ALM Octane entities
• Add comments to the ALM Octane entities

The connector supports ALM Octane version 15.1.60 or later.

Supported API versions and prerequisites

The ALM Octane connector uses the  ALM Octane Rest API v15.1.60 . For more information about the schema fields, see the API documentation.

The ALM Octane 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.

To configure the ALM Octane connection

Configure the ALM Octane connection by using the ALM Octane connector. After a connection is established with the ALM Octane endpoint, you can configure one or more ALM Octane 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 an ALM Octane 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 ALM Octane connection, use the Show list to filter on Connectors, and then click the ALM Octane connector block.
     
   • To configure an existing ALM Octane connection, use the Show list to filter on Endpoints, and then double-click the ALM Octane connector block.
     

3. On the configuration screen for the ALM Octane 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 ALM Octane connection. The name must be unique for each ALM Octane connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the ALM Octane endpoint, which refers to both a specific connection and its activities.
   HOST	Enter the URL of your ALM Octane instance.
   Client ID	Enter the client ID generated for your ALM Octane instance. For more information about setting up API access for ALM Octane, see Set up API Access .
   Client Secret	Enter the client secret generated for your ALM Octane instance.
   Space ID	Enter the ID of your ALM Octane space.
   Workspace ID	Enter the ID of the workspace in the selected ALM Octane space.

   
   

   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 an ALM Octane activity.

To create an ALM Octane activity  

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

2. Use the Show list to filter on Endpoints, and then click the ALM Octane connection block to display activities that are available to be used with an ALM Octane connection.
   
   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 an ALM Octane endpoint and is intended to be used as a target in an operation.
   Update	Inserts an entity into an ALM Octane endpoint and is intended to be used as a target in an operation.
   Delete	Deletes entities from an ALM Octane endpoint and is intended to be used as a target in an operation.
   Search	Searches for entities from an ALM Octane endpoint and is intended to be used as a source in an operation.
   Add Comment	Adds a comment to an ALM Octane entity.

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 an ALM Octane Create activity 

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

To configure an ALM Octane 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 ALM Octane Create activity. The name must be unique for each ALM Octane Create activity and must not contain forward slashes (`/`) or colons (`:`).
   Select an Entity to proceed the operation	This section displays issue types available in the ALM Octane endpoint. When reopening an existing activity configuration, only the selected issue class is displayed instead of reloading the entire issue class list. Selected Entity—After an issue type is selected, it is listed here. Search—Enter any part of the issue type into the search box to filter the list of issue types. The search is not case-sensitive. If issue types are already displayed within the table, the table results are filtered in real time with each keystroke. To reload issue types from the endpoint when searching, enter search criteria, and then click Refresh. Refresh—Click the refresh icon  or the word Refresh to reload issue types from the ALM Octane endpoint. This may be useful if you have recently added issue types to ALM Octane. This action refreshes all metadata used to build the table of issue types displayed in the configuration. Selected an issue type—Within the table, click anywhere on a row to select an issue type. Only one issue class can be selected. The information available for each issue type is fetched from the ALM Octane endpoint: Action—The issue class name from ALM Octane. Description—The issue class type from ALM Octane. Important: If the table does not populate with available issue types, the ALM Octane connection might not be successful. Make sure the ALM Octane 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 ALM Octane 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, see  Transformations .

5. Click Finished.
   After an ALM Octane 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 . 

ALM Octane Create operation patterns

ALM Octane 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 an ALM Octane Create activity in the Two-Transformation Pattern. In this example, the first transformation (ALM Octane Create Request) creates a request structure that is passed to the ALM Octane Create activity. The second transformation (ALM Octane Create Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write ALM Octane Create Response) and a message is then logged by the Write to Operation Log script:

To configure an ALM Octane Update activity 

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

To configure an ALM Octane 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 issue type for the activity.

   

   Field name	Action
   Name	Enter a name to use to identify the ALM Octane Update activity. The name must be unique for each ALM Octane Update activity and must not contain forward slashes (/) or colons (:).
   Select an Entity to proceed the operation	This section displays issue types available in the ALM Octane endpoint. When reopening an existing activity configuration, only the selected issue class is displayed instead of reloading the entire issue class list. Selected Entity—After an issue type is selected, it is listed here. Search—Enter any part of the issue type into the search box to filter the list of issue types. The search is not case-sensitive. If issue types are already displayed within the table, the table results are filtered in real time with each keystroke. To reload issue types from the endpoint when searching, enter search criteria and then refresh, as described below. Refresh—Click the refresh icon  or the word Refresh to reload issue types from the ALM Octane endpoint. This may be useful if you have recently added issue types to ALM Octane. This action refreshes all metadata used to build the table of issue types displayed in the configuration. Selected an issue type—Within the table, click anywhere on a row to select an issue type. Only one issue class can be selected. The information available for each issue type is fetched from the ALM Octane endpoint: Action—The issue class name from ALM Octane. Description—The issue class type from ALM Octane. Important: If the table does not populate with available issue types, the ALM Octane connection might not be successful. Make sure the ALM Octane 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 ALM Octane instance. 
   The data schemas list the fields available for the ALM Octane 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 . 

ALM Octane Update operation patterns

ALM Octane 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 an ALM Octane Update activity in the Two-Transformation Pattern. In this example, the first transformation (ALM Octane Update Request) creates a request structure that is passed to the ALM Octane Update activity. The second transformation (ALM Octane Update Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write ALM Octane Update Response) and a message is then logged by the Write to Operation Log script:

To configure an ALM Octane Search activity 

An ALM Octane Search activity searches for entities from an ALM Octane endpoint and is intended to be used as a source to provide data in an operation. After configuring an ALM Octane connection, you can configure as many ALM Octane activities as you like for each ALM Octane connection.

To configure an ALM Octane Search 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 issue type for the activity. 

   Field name	Action
   Name	Enter a name to use to identify the ALM Octane Search activity. The name must be unique for each ALM Octane Search activity and must not contain forward slashes (/) or colons (:).
   Select an Entity to proceed the operation	This section displays issue types available in the ALM Octane endpoint. When reopening an existing activity configuration, only the selected issue class is displayed instead of reloading the entire issue class list. Selected Entity—After an issue type is selected, it is listed here. Search—Enter any part of the issue type into the search box to filter the list of issue types. The search is not case-sensitive. If issue types are already displayed within the table, the table results are filtered in real time with each keystroke. To reload issue types from the endpoint when searching, enter search criteria, and then click Refresh. Refresh—Click the refresh icon  or the word Refresh to reload issue types from the ALM Octane endpoint. This may be useful if you have recently added issue types to ALM Octane. This action refreshes all metadata used to build the table of issue types displayed in the configuration. Selected an issue type—Within the table, click anywhere on a row to select an issue type. Only one issue class can be selected. The information available for each issue type is fetched from the ALM Octane endpoint: Action—The issue class name from ALM Octane. Description—The issue class type from ALM Octane. Important—If the table does not populate with available issue types, the ALM Octane connection might not be successful. Make sure the ALM Octane connection is configured correctly by reopening the connection and retesting the credentials.
   Search Query	Enter the query to define the filters for the data to view. For more information about adding a query, see Query .
   Result Limit (Restricts the size of the result to the given limit)	Maximum number of results to display.
   OFFSET (Number of records you wish to skip before selecting records)	Enter an integer value for the first position to return from the results of the query. The default is 0, which starts the page at the first result. For example, if you have 250 defects in your system, and you set your offset to 40, the search displays results starting from the 41st record.
   Order By (Name, Severity, Creation_Time)	Enter the field to sort the results by.
   Optional Settings	Click to expand additional optional settings: JSON input (This issue definition overrides the prior selections): Enter the Key-Value pair for the alert fields. Use the {"Key": "Value"} or [{"Key": "Value"}] format. { "query":"id EQ 1001", "limit":"10", "offset"0", "orderBy":"name" } Important: 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.

   

3. Click Next.

4. Review the request and response data schemas for your ALM Octane instance. 
   The data schemas list the fields available for the ALM Octane Search 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 . 

ALM Octane Search operation patterns

ALM Octane Search 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 an ALM Octane Search activity in the Two-Transformation Pattern. In this example, the first transformation (ALM Octane Search Request) creates a request structure that is passed to the ALM Octane Search activity. The second transformation (ALM Octane Search Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write ALM Octane Search Response) and a message is then logged by the Write to Operation Log script:

To configure an ALM Octane Delete activity 

An ALM Octane Delete activity deletes entities from an ALM Octane endpoint and is intended to be used as a target to consume data in an operation. After configuring an ALM Octane connection, you can configure as many ALM Octane activities as you like for each ALM Octane connection.

To configure an ALM Octane Delete 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 issue type for the activity.
   

   Field name	Action
   Name	Enter a name to use to identify the ALM Octane Delete activity. The name must be unique for each ALM Octane Delete activity and must not contain forward slashes (/) or colons (:).
   Select an Entity to proceed the operation	This section displays issue types available in the ALM Octane endpoint. When reopening an existing activity configuration, only the selected issue class is displayed instead of reloading the entire issue class list. Selected Entity—After an issue type is selected, it is listed here. Search—Enter any part of the issue type into the search box to filter the list of issue types. The search is not case-sensitive. If issue types are already displayed within the table, the table results are filtered in real time with each keystroke. To reload issue types from the endpoint when searching, enter search criteria, and then click Refresh. Refresh—Click the refresh icon  or the word Refresh to reload issue types from the ALM Octane endpoint. This may be useful if you have recently added issue types to ALM Octane. This action refreshes all metadata used to build the table of issue types displayed in the configuration. Selected an issue type—Within the table, click anywhere on a row to select an issue type. Only one issue class can be selected. The information available for each issue type is fetched from the ALM Octane endpoint: Action—The issue class name from ALM Octane. Description—The issue class type from ALM Octane. Important: If the table does not populate with available issue types, the ALM Octane connection might not be successful. Make sure the ALM Octane 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 issues you want to delete.

3. Click Next.

4. Review the request and response data schemas. 
   The data schemas list the fields available for the ALM Octane Delete 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 . 

ALM Octane Delete operation patterns

ALM Octane Delete 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 an ALM Octane Delete activity in the Two-Transformation Pattern. In this example, the first transformation (ALM Octane Delete Request) creates a request structure that is passed to the ALM Octane Delete activity. The second transformation (ALM Octane Delete Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write ALM Octane Delete Response) and a message is then logged by the Write to Operation Log script:

To configure an ALM Octane Add Comment activity

An ALM Octane Add Comment activity adds a comment to an ALM Octane entity and is intended to be used as a target to consume data in an operation. After configuring an ALM Octane connection, you can configure as many ALM Octane activities as you like for each ALM Octane connection.

To configure an ALM Octane Add Comment activity, complete the following steps:

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

2. On the configuration screen, complete the fields for the activity as described in the following table:

   Field name	Action
   Name	Enter a name to identify the ALM Octane Add Comment activity. The name must be unique for each ALM Octane Add Comment activity and must not contain forward slashes (/) or colons (:).
   Comment	Enter the comment or select a variable that specifies a comment that you want to add to an ALM Octane entity.
   Entity ID	Enter the ID or select a variable to specify the ALM Octane entity in which you want to add a comment.
   Entity Type	Enter the type of entity or select a variable that specifies the entity type in which you want to add a comment.

   
   
   
   

3. Click Next.

4. Review the request and response data schemas for your ALM Octane instance. 
   The data schemas list the fields available for the ALM Octane Add Comment 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 . 

ALM Octane Add Comment operation patterns

ALM Octane Add Comment activity can be used as a target with these operation patterns:

• Transformation Pattern

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

For more information about the validation patterns, see the Operation Validity  page.

A typical workflow uses an ALM Octane Add Comment activity in the Two-Transformation Pattern. In this example, the first transformation (ALM Octane Add Comment Request) creates a request structure that is passed to the ALM Octane Add Comment activity. The second transformation (ALM Octane Add Comment Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write ALM Octane Add Comment Response) and a message is then logged by the Write to Operation Log script, as shown in the following image: