ALM Octane Synchronizer FAQs and troubleshooting
See the following common questions about ALM Octane Synchronizer below.
New field values created in a destination endpoint during synchronization are automatically sent back the record in the source endpoint.
So, for example, when you create a record in ALM and synchronize it to ALM Octane, that new record is created in ALM Octane, and assigned an ALM Octane ID.
ALM Octane Synchronizer recognizes this new ID field value, and sends it back to ALM, adding it to the source record.
This last step is the update you see in your run history.
The following types of synchronization runs are removed from the run history after subsequent synchronizations are run:
Run description | Details |
---|---|
Runs that:
|
An empty run is only displayed in the run history when it is the latest run, and was run in the last 10 days. |
Runs that:
|
Runs with errors that have not yet been resolved are displayed in the run history until the related records are synchronized successfully. Previous runs that contain errors, which also appeared in later runs, are deleted when they are more than 10 days old. |
Fatal runs that are more than 10 days old | For synchronizations run in the last 10 days, only the last 20 runs are displayed. |
If your link is in automatic mode, and a synchronization ran with errors, the records with errors are not necessarily fixed in subsequent runs.
This may happen if the errors occurred because of changes outside of the link configuration, such as if the schema changed, but the field mapping was not updated. If you fix the cause of the error (such as refreshing the Field Mapping tab and map the new fields), ALM Octane Synchronizer will re-synchronize those records if changes in the actual record are detected.
ALM Octane Synchronizer also periodically re-synchronizes all records, including those that had run with errors, but have had no subsequent changes.
To ensure that records that ran with errors are re-synchronized in the next upcoming run, manually set the link to re-synchronize those records.
For details, see Re-synchronizing records with fixed errors (automatic mode only).
To improve synchronization performance between ALM Octane and ALM, add indices to your ALM project schema as follows, depending on the type of database you use for ALM:
Microsoft SQL |
CREATE INDEX BG_VTS_IDX ON [td].[BUG] (BG_VTS, BG_BUG_ID); CREATE INDEX RQ_VTS_IDX ON [td].[REQ] (RQ_VTS); CREATE INDEX RT_VTS_IDX ON [td].[REQ_TRACE] (RT_VTS); CREATE INDEX RT_CREATION_DATE_IDX ON [td].[REQ_TRACE] (RT_CREATION_DATE); CREATE INDEX LN_CREATION_DATE_IDX ON [td].[LINK] (LN_CREATION_DATE); |
Oracle |
CREATE INDEX BG_VTS_IDX ON BUG (BG_VTS, BG_BUG_ID); CREATE INDEX RQ_VTS_IDX ON REQ (RQ_VTS); CREATE INDEX RT_VTS_IDX ON REQ_TRACE (RT_VTS); CREATE INDEX RT_CREATION_DATE_IDX ON REQ_TRACE (RT_CREATION_DATE); CREATE INDEX LN_CREATION_DATE_IDX ON LINK (LN_CREATION_DATE); |
You cannot search in the link tree when a link is in edit mode. Save any changes or click Cancel Edit to enable the search box.
In certain cases you may try to open Synchronizer and a login page appears but you cannot log in. In this case you need to modify your authentication cookies setting, as described in Define additional properties.
-
After a link is synchronized, you can no longer remove mapped requirement types. You can still add types that are not yet mapped.
-
To edit requirement type mapping you must be in edit mode. For details see Edit requirement type mapping (ALM synchronization only).
When synchronization fails because of unmapped users, check if the missing users exist. If they do not, you can create them in ALM Octane (either as active users, or inactive). When you run synchronization again, the ALM users that were missing will be mapped to the newly-created users in ALM Octane. For details on adding or activating users in ALM Octane, see Roles and permissions and Roles and permissions.
This error indicates that user defined fields were removed from ALM Octane, which were mapped in a synchronization link. The list of missing fields is displayed in the UI.
Edit the relevant link within the Synchronizer UI, and click Refresh fields and field values in the Field mapping tab. All the removed fields will be removed from field mapping. Run an integrity check to verify that records will be synchronized correctly.
This error indicates that you removed user defined fields from ALM Octane, which were used in a Synchronizer filter within a particular synchronization link.
Either edit the existing filter, or create a new filter without the user defined fields that no longer exist. If you create a new filter, within the Synchronizer UI edit the appropriate link and change the Synchronizer filter in the General tab. Run an integrity check to verify that records will be synchronized correctly.
If inexplicable errors occur, such as an inability to read run reports, constant synchronization failures, errors while creating links, verify that you are synchronizing with a supported version of ALM. For details, see Supported versions.
If your version of ALM is supported, there may be too many files concurrently open on the ALM Octane server.
If this is the case:
-
The following error will appear in the ALM Octane log files:
java.net.SocketException: Too many open files
-
The maximum number of open files allowed by the operating system is too low, and must be increased.
Contact customer support (Help > Send Us Feedback > Open ticket).
Check the list of custom fields defined in ALM Octane:
- In Settings , click Spaces and select a shared space or a workspace.
- In Entities, click User-defined Fields and select the entity whose fields you want to check.
Make sure that the field in question still defined for the workspace you are synchronizing.
This may happen if an ALM entity has an attachment whose name contains special characters (~!@#$%()^&
).
Workaround: On ALM Octane, remove the added attachment. On ALM, rename the attachment so that it does not contain special characters.
If you configured Issue notifications but you are not receiving emails as expected, define values for FROM_EMAIL_ADDRESS & MAIL_SERVER_HOST in the sync_sa schema.