Note: This topic is relevant for ALM Synchronizer for Agile Manager only. For details about the NextGen Synchronizer see NextGen Synchronizer, or search using the NextGen Synchronizer filter.
If you are still using ALM Synchronizer, we recommend migrating to the more robust NextGen Synchronizer embedded in Agile Manager's configuration area.
Integrity checks identify possible problems that can occur during the synchronization process.
You must run an integrity check after making changes to a link and before you can enable the link and run synchronization tasks on it. Run integrity checks after creating a new link, modifying a link, or modifying the schema for one of the link's endpoints.
Integrity checks verify both general settings for the link, and the field mappings defined for the link. Each individual check within the integrity check can pass or fail. The integrity check passes only if none of the individual checks within it fail.
Caution: If you do not run an integrity check, or if the integrity check does not pass, the link remains unvalidated and cannot be enabled for synchronization. For more information about link states, see Enable or disable a link.
-
Select Run Task > Run Integrity Check or click Run
> Integrity Check. -
View details about the integrity check in the Execution pane at the bottom of the Synchronizer Client window. Click View Report to view the full, detailed report, with any extra error messages. You might want to view the detailed report if your integrity check failed, to determine specifically which checks failed and how to fix the link.
-
After you fix the link, run the integrity check again.
Click below for details about the checks performed during integrity checks, as displayed in the run report.
Checks performed on general link settings
|
Name, as listed in report |
Description |
|---|---|
|
Endpoint Connection |
Checks that Synchronizer can successfully connect to the endpoint using the settings defined. |
|
User permission check |
Checks that the user connecting to the endpoint has sufficient permissions to perform the required tasks. |
|
Endpoint parameters check |
Checks and validates additional parameters that may be defined for the endpoint. For example, if an alternate root folder is defined for requirements synchronization, checks that the folder exists in ALM. For details and guidelines for defining alternate root folders, see View or update connection settings for each endpoint |
|
Fetching endpoint schema |
Checks that Synchronizer can obtain the database schema for the endpoint. |
|
<requirement type> Subtype: Mapped fields check |
Performs checks on fields that are mapped for the endpoint. |
|
Specified filter exists |
If a filter is defined for the endpoint in the link, checks that the filter exists in the endpoint. |
|
Subtype exists check |
Checks that the mapped requirement type exists in the endpoint. |
|
Endpoint events check |
Checks the following:
|
|
Fields mapping defined |
Checks that a field mapping is defined between the endpoints and that it can be obtained by the Synchronizer. |
|
Consistency of mapping and endpoint events |
Checks that if a field mapping is defined from the endpoint, the link is set to handle record creation or updates in the other endpoint. Also checks that if the link is set to handle record creation or updates in the endpoint, a field mapping is defined to the endpoint. |
Checks performed on link field mappings
An integrity check performs the following checks on the field mappings you define for the link. Synchronizer also performs these checks when you check the field mappings when you create or configure a link. Depending on the type of field mapped, not all of these checks are performed for every identity mapping.
|
Name, as listed in report |
Description |
|---|---|
|
Required fields check |
Checks that required fields in the destination endpoint are mapped to a field in the source endpoint, or are assigned a constant value. If this is not the case, the check fails. In addition, checks that recommended fields in the destination endpoint are mapped to a field in the source endpoint, or are assigned a constant value. If this is not the case, the check passes with a warning. |
|
Field existence check |
Checks that the field exists in the endpoint. |
|
Field types match check |
Checks that if a mapping exists between fields of different types, the values can be converted between the types. |
|
Fields length match check |
For string type fields (String, Multi value list, Single value list, User list), checks that the maximum length for values for each of the fields in a mapping is the same. If the maximum length is different, the check passes with a warning that some values may be truncated. |
|
Fixed list mapping check |
Checks whether the source field of a mapping is not a verified list field, whereas the destination field is a verified list field. In such a case, the check passes with a warning as it is possible that values will be mapped to the destination that are not in its list. |
|
User list check |
Checks whether the source field of a mapping is not a user list field, whereas the destination field is a user list field. In such a case, the check passes with a warning as it is possible that values will be mapped to the destination that are not in its user list. |
|
Value mapping types check |
Checks that it is possible to convert between the type of the value mapped to a field and the type of the field. |
|
Values length match check |
For string type fields (String, Multi value list, Single value list, User list), checks that the length of values mapped to the field in a field value mapping is not greater that the maximum length for the field. If a value is mapped that is longer that the maximum length, the check passes with a warning that the value will be truncated. |
|
Values mapping in mandatory field check |
Checks that no field value mapping maps an empty string to a mandatory field. |
|
Fixed list values mapping check |
Checks that no field value mapping exists that maps values to a verified list field that are not in the list associated with the destination field. |
|
Read only check |
Checks that there is no mapping to read-only fields. |
