Set up ALM-ALM Octane Integration

This topic describes how to set up the ALM-ALM Octane integration.

Configure the integration on the ALM Octane side

The configuration on the ALM Octane side includes the following.

  1. Create a release in ALM Octane that is identical to your release in ALM.
  2. To set up the integration, you must have the permissions to access the server. ALM Octane grants this permission with an API access key.

For details, see the ALM Octane help.

Configure the integration on the ALM side

The configuration on the ALM side includes the following.

Enable ALM-Octane integration
  1. In Site Administration, click the Site Configuration tab.

  2. Set OCTANE_INTEGRATION_ENABLED to Y.

    For details, see Set configuration parameters and Site Parameters.
Schedule ALM-Octane integration

Determine how often the run results of ALM test sets will be synced to ALM Octane.

  1. In Site Administration, click the Site Configuration tab.

  2. Set OCTANE_INTEGRATION_JOB_INTERVAL to a preferred value.

    For details, see Set configuration parameters and Site Parameters.

Back to top

Configure octane-int-config.xml file

Configure the octane-int-config.xml file that is located in the {ALM repository}\sa\DomsInfo\CommonData\octane-integration\ directory.

You should not change the file name. Otherwise, the file does not work.

In the octane-int-config.xml file, you specify the following information. For instructions and examples of the configuration, go to the octane-int-config.template.xml template file for references. See octane-int-config.template.xml.

Proxy

Required? No
Description

host: IP address of the host where the HTTP-based proxy server is located.

port: Proxy port number.

username: Your username for the proxy.

password: Your password for the proxy.
Example 
<proxy>
  <host>your-web-proxy.net</host>
  <port>8080</port>
  <username>sa</username>
  <password>sa</password>
</proxy>

ALM Octane server

Required? Yes
Description

clientId: Client ID that's generated by ALM Octane for API access.

clientSecret: Client Secret that's generated by ALM Octane for API access.

serverUrl: URL of the ALM Octane server.

sharedSpaceId: ALM Octane shared space ID

For details about creating Octane API access keys, see the ALM Octane Help Center.

Example 
<octane>
  <clientId>your-octane-client-ID</clientId>  
  <clientSecret>your-client-secret</clientSecret>
  <serverUrl>http://your-alm-octane-server-URL/</serverUrl>
  <sharedSpaceId>1001</sharedSpaceId>
</octane>

ALM and ALM Octane projects mapping

Required? Yes
Description

domain: ALM domain name

project: ALM project name

workspaceId: Workspace ID of the ALM Octane project
Example 
<projects>
  <project>
    <domain>DEFAULT</domain>
    <project>first</project>
    <workspaceId>1002</workspaceId>
    ... 
  </project>
</projects>

ALM test instance filters

Required? No
Description

If you want to have the test runs of only some test instances synched to ALM Octane, specify the test instance filters. Otherwise, test runs of all test instances are synched to ALM Octane.

You can do so by copying the filter settings from the ALM project. For details, see Filter Dialog Box.

Example 
<projects>
  <project>
    <domain>DEFAULT</domain>
    <project>first</project>
    <workspaceId>1002</workspaceId>
    <filters>    
      <filter>
      <![CDATA[[Filter]{       
         TableName:TESTCYCL,  
         ColumnName:TC_SUBTYPE_ID,
         LogicalFilter:\0000001e\Not hp.qc.test-instance.MANUAL,
         VisualFilter:\0000001e\Not hp.qc.test-instance.MANUAL,
         NO_CASE:
         }
         ]]>
       </filter>
      </filters>
	
... 
  </project>
</projects>

ALM and ALM Octane field mapping and field value mapping

Required? No
Description

almDbFieldName: The ALM field name (database column name)

octaneName: The ALM Octane field name.

almValue: Field value of the ALM project

octaneValue: Field value of the ALM Octane project
Example 
<projects>
  <project>
    <domain>DEFAULT</domain>
    <project>first</project>
    <workspaceId>1002</workspaceId>
  <fields>
    <field almDbFieldName="RN_STATUS" octaneName="status">
       <values>
         <value almValue="Passed" octaneValue="Passed"/>
         <value almValue="Bypassed" octaneValue="Skipped"/>
	  <value almValue="Failed" octaneValue="Failed"/>
       </values>
    </field>
     <field almDbFieldName="TS_TYPE" octaneName="Testing_Tool_Type">	
       <values>
          <value almValue="FLOW" octaneValue="FLOW-TEST" />
       </values>
     </field>
  </fields>
...
  </project>
</projects>

The following table lists the supported ALM-Octane field mappings.

ALM field Octane field Notes
RN_STATUS status

Map ALM run statuses to ALM Octane run statuses.

ALM Octane run status values that are supported for mapping are: Passed, Failed, Planned, and Skipped.

  • ALM "Passed" status is automatically mapped to ALM Octane's "Passed" status. You cannot map the ALM "Passed" status to any other ALM Octane status.
  • ALM "Failed" status is automatically mapped to ALM Octane's "Failed" status. You cannot map the ALM "Failed" status to any other ALM Octane status.
  • ALM "No Run" status is automatically mapped to ALM Octane's "No Run" status. You cannot map the ALM "No Run" status to any other ALM Octane status.
  • If you want to map an ALM run status to the ALM Octane run status "Skipped", you should map an ALM user-defined status to "Skipped".

TS_TYPE

Testing_Tool_Type

 

Map ALM test types to ALM Octane test types.

If an ALM test type is not mapped to an ALM Octane test type, when the tests of that type are synched to ALM Octane, the test type will be automatically added to the ALM Octane test type list and assigned to the corresponding tests in ALM Octane.

<system field>

or

<user-defined field>

 class

Map an ALM system field or a user-defined field of the Test, Test Set, Run, or Test Configuration entity to the ALM Octane's field "class".

The ALM field type should be string.

It does not need field value mapping.

Enable auto-fix

Required? Yes
Description

Whether or not to enable auto-fix for the value of the Octane Test Suite URL field in ALM. When an ALM test set is synched to ALM Octane, ALM will check whether the field value is valid in the format and whether auto-fix for this field is enabled.

  • true: Enables auto-fix. If the field value is invalid, when the sync runs, it will create a new test suite in ALM Octane, and fill the field with the URL of the new test suite.

    Note: If the URL in the Octane Test Suite URL field is correct in the format, but a test suite cannot be found in ALM Octane by the URL , the URL will not be auto-fixed.

  • false: Disables auto-fix. If the field value is invalid, when the sync runs, it will not update the field value.
Example 
<projects>
  <project>
    <domain>DEFAULT</domain>
    <project>first</project>
    <workspaceId>1002</workspaceId>
  <fields>
     <field almDbFieldName="Testing_Tool_Type" octaneName="TS_TYPE">	
       <values>
          <value almValue="FLOW" octaneValue="FLOW-TEST" />
       </values>
     </field>
  </fields>
...
<isAutoFix>true</isAutoFix>
...
  </project>
</projects>

Back to top