Mapping Reference Fields from CA Agile Central with a Connector

Document ID : KB000047904
Last Modified Date : 14/02/2018
Show Technical Document Details

Issue

  • These fields are found in artifacts (Hierarchical Requirement, Defect, Test Case, etc.) and are basically URLs which point to the another artifact in CA Agile Central. However, in the other system, those fields may appear to the connector as a string containing the actual name.
  • For the following CA Agile Central reference fields, the connector has special syntax when they are to be mapped:
    • mapping Iteration
    • mapping Parent
    • mapping Project
    • mapping Release
    • mapping Requirement
    • mapping TestCase
    • mapping TestCaseResult
    • mapping TestFolder
    • mapping WorkProduct

Cause

  • In CA Agile Central, some fields within an object (an artifact) are string values while other fields are actually pointers (called a "reference") to other objects.?

Resolution

  • In order to map one of these fields:
  • Within the <Connector> section of the configuration file, specify the field to be mapped in the <FieldMapping> section
  • Within the <Connector> section of the configuration file, create a <RallyFieldHandlers> section
  • Within this section, specify the field in a <RallyReferenceFieldHandler> element
    • optionally, within this <RallyReferenceFieldHandler> element, specify a <ReferencedFieldLookupID> which will be used to represent this referenced object. Typical fields used here are "DisplayName", "FormattedID", "MiddleName", "Name", "ObjectID", etc. If this <ReferencedFieldLookupID> is not specified, then "Name" is used by default.

Example Syntax:
?
<Config>
? ? ? ? ....
? ? ? ? <Connector>
? ? ? ? ? ? ? ? <FieldMapping>
? ? ? ? ? ? ? ? ? ? ? ? <Field><CA Agile Central>Project</CA Agile Central><Other>BG_PROJECT</Other></Field>
? ? ? ? ? ? ? ? </FieldMapping>
? ? ? ? ? ? ? ? ....
? ? ? ? ? ? ? ? <RallyFieldHandlers>
? ? ? ? ? ? ? ? ? ? ? ? <RallyReferenceFieldHandler>
? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? <FieldName>Project</FieldName>
? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? <ReferencedFieldLookupID>Name</ReferencedFieldLookupID>
? ? ? ? ? ? ? ? ? ? ? ? </RallyReferenceFieldHandler>
? ? ? ? ? ? ? ? </RallyFieldHandlers>
? ? ? ? </Connector>
? ? ? ? ....