octane-int-config.template.xml

Here is the template you can refer to when configuring the octane-int-config.xml file for your ALM-ALM Octane integration.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configuration>
    <targets>
	    <!-- As Octane's API acess keys are defined an the shared space level, you should add one target for each shared space. -->
        <target>
            <!--If ALM is in Intranet but Octane is in an external network such as AWS, then need to configure the proxy -->
            <proxy>
                <host>web-test.my.com.net</host>
                <port>8080</port>
                <schema>http</schema>
                <username></username>
                <password></password>
            </proxy>
            <octane>
		     	<!-- Create API access keys in Octane to generate Client Id -->
                <clientId>test_p0g1qer8y11klil8n7evw3xl2</clientId>
				<!-- Create API access keys in Octane to generate Client Secret  -->
                <clientSecret>QCC:tNbmYxVYdicGbTO2Nwe+9AQfzV8PSCq6ABDzU4Nxg04NfGumGf/o2oRWVkMLX5hW</clientSecret>
				<!-- Octane server URL -->
                <serverUrl>http://octane-server-url:8081/</serverUrl>
				<!-- Octane shared space Id -->
                <sharedSpaceId>1001</sharedSpaceId>
            </octane>

			
            <projects>
                <!-- Define ALM and Octane project mappings that include project mapping, field mapping, and field value mapping.  -->
                <project>
				    <!-- ALM domain -->
                    <domain>DEFAULT</domain>
					<!-- ALM project name -->
                    <project>demo</project>
					<!-- Octane Workspace Id  -->
                    <workspaceId>1006</workspaceId>
                    <filters>
					    <!-- ALM test instance filters. Include the filter settings in <![CDATA[ ]]> to avoid XML parsing exceptions. You can define multiple filters and the relationship between them is OR -->
                        <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>

                    <fields>
				    	<!-- Fields available for mapping: class, run status, test_tool_type -->
					    <!-- e.g. almDbFieldName "RN_STATUS" is test run status in ALM, and octaneName "status" is the mapped status field in Octane. -->
                        <field octaneName="status" almDbFieldName="RN_STATUS">
                            <values>
							    <!-- Only support mapping ALM user defined run status values to Octane's statuses "Passed", "Failed", and "Skipped"  -->
                                <!-- e.g. The Octane's status "Skipped" is mapped to ALM's user defined run status "Bypassed" -->
								<value octaneValue="Skipped" almValue="Bypassed"/>
                            </values>
                        </field>

						<!-- Support mapping either an ALM system field or a user defined fields of the Test, Test Set, Run, Test Instance, or Test configuration entity to the Octane's field "class" -->
                        <field octaneName="class" almDbFieldName="TS_USER_01"/>

                        <field octaneName="Testing_Tool_Type" almDbFieldName="TS_TYPE">
                            <values>
								<value octaneValue="CREATED_BY_ALM" almValue="VAPI-XP-TEST"/>
                            </values>
                        </field>
                    </fields>

					<!-- If the value of the Octane Test suite URL field in an ALM test set is incorrect, "true" means it will create a new test suite in Octane after sync and update the field value with the URL of the new test suite, and "false" means it will not update the field value and the sync will fail. -->
                    <isAutoFix>true</isAutoFix>
                </project>
            </projects>
        </target>
    </targets>
</configuration>