Review and adapt the data in your endpoints

Before synchronizing records between ALM Octane and ALM, adapt the data in either endpoint to match the fields supported in the other endpoint, as well as synchronization requirements.

For example, ALM Octane defects can also be associated with a feature. To synchronize this field, you must create a corresponding user-defined field in ALM.

Optional: In both endpoints, create corresponding ID fields

In both endpoints, we recommend creating user-defined or custom fields to represent the record ID in the other endpoint. Define these fields as Number or Numeric fields.

  • In ALM, create a field named ALM Octane ID.

  • In ALM Octane, create a field named ALM or QC ID.

Later, map these corresponding fields in the link's Field Mapping tab. For details, see Edit field mapping.

Back to top

In ALM, create or modify fields

In ALM, modify the fields listed in the following table. If a field does not already exist in ALM, create a user-defined field to correspond to this data in ALM Octane. For details about mapping fields after setting up your link, see Edit field mapping.

Defining fields as Lookup List fields enables you to have empty lists, but still use this field for grouping in ALM.

Field name Description
Application module

Define as a Lookup List field.

Configure ALM to Allow Multiple Values and not to verify this value.

Tip: Alternatively, when editing your link, map the ALM Octane Application module field to the ALM Product field.

Owner

Define as a User List field.
Blocked Define as a String field.
Feature

Define as a Lookup List field.

Configure ALM not to verify this value.

Rank Define as a Number field.
Story points Define as a Number field.
Phase

Define as a Lookup List field.

Configure ALM not to verify this value.

Team

Define as a Lookup List field.

Configure ALM not to verify this value.

Tip: You may want to create an additional user-defined field to distinguish between entities created directly in ALM and those synchronized from ALM Octane.

To do so, create a field in ALM named Creation Method. Later, when you are mapping fields, assign a constant value of created by ALM Octane Synchronizer. For details about assigning constant values, see Edit field mapping.

Back to top

Notes for attachments

Note: Avoid special characters (~!@#$%()^&) in attachment names, as these may cause unexpected behavior during synchronization.

Back to top

Notes about maximum record sizes

ALM Octane Synchronizer supports a maximum record size of 12 MB. This means that synchronizing records larger than 12 MB will cause errors.

If you have records that are larger than 12 MB, move some of the data from the Description, Comment, or any other custom free text field, to a separate file. Then, add the file to the record as an attachment. Attachment sizes are not included in the maximum record size, though they are synchronized between the endpoints.

Back to top

Next steps: