Synchronize with an Agent system

Synchronization fetches the objects of a PRO, CPI or Api Management Agent system into Change Tracking Tool, so that Figaf Tool starts tracking their versions. This page describes how to run it and what each of its options does.

Check that you’ve configured an Agent entry and tested integration with it. See Agent Configuration to learn how to do it.

You can run synchronization from 2 pages on UI: Tracked Objects page and Integration Objects page. They are configured a bit differently for PRO agents. Synchronization request on Integration Objects page includes only Integration Directory types for PRO system (see Supported business objects section), but synchronization request on Tracked Objects page includes both registries: Integration Directory and Enterprise Service Repository (ESR). Usually the total size of all objects in the ESR is much larger than in the Integration Directory. Initial synchronization can take even several hours depending on amount of data and computation resources. Once all objects are synchronized, further synchronizations are much faster, they depend on amount of changes during current period. If you work only with Testing Tool and don’t care about ESR tracking, just use synchronization from Integration Objects page.

1. Synchronization with Agent system step-by-step

Click on Change Tracking Tool on the side menu or click on the tile on the home page. It opens Tracked Objects page.

Select needed agent system and click on Synchronize button to run synchronization. It will synchronize all object types for current SAP system type listed in the Supported business objects section.

For PRO, CPI and Api Management Agent systems you can configure synchronization settings:

for PRO Agent system you are able to configure the following settings:

Check metadata of all existent objects (lookup without last change date filter) runs synchronization without last change date filter for CTT object types.

It is possible to clear this filter manually (see field Reset synchronization query on Edit Agent Dialog).

Rebuild links for the latest versions forcibly is required when you mix different synchronization settings. For example, first time you synchronize objects on Integration Objects page (that synchronization includes only Integration Directory types), then you synchronize them on Tracked Objects page to browse ESR objects in CTT. It’s related to the fact that all objects have only one-way links in the received metadata. An Integrated configuration object has links to Operation Mapping object, but Operation Mapping object doesn’t contain any links to Integrated configuration. So, if an Integrated Configuration object has been already synchronized, it won’t be possible to link it with currently synchronized Operation Mapping object having only Operation Mapping differences information. If the flag is enabled, synchronization algorithm will check all latest versions for chosen object types and build links between them properly.

Forcibly process payload dependent initializations for not updated objects makes synchronization process payload dependent operations (payload, in that case, can be loaded either from DB e.g. for ICO, CHANNEL, or from agent e.g. for ID_FILE_TRANSPORT, ID_CTS_CHILD_TRANSPORT, ESR_FILE_TRANSPORT, ESR_CTS_CHILD_TRANSPORT. Skipping that option makes Directory objects and transports synchronization faster. Use it for recovery purposes in case of some potential inconsistency.

Forcibly process child types for not updated compound ESR object types: External Definition, Service Interface, Function Module, Imported Archive enables checks of inner child objects for all objects of the listed types. Use it for recovery purposes in case of some potential inconsistency with related types.

Skip synchronization of ESR/File transports disables synchronization of transport object types. If enabled, then synchronization of transport object types will be completely skipped.

Skip synchronization of Data Types disables synchronization of data types. If enabled, then synchronization of data types will be completely skipped.

Synchronize used sap repository objects runs synchronization for used sap repository objects. If it is false, all sap repository objects will be synchronized.

Synchronize all dependent sap objects recursively runs synchronization for child sap objects even if the object hasn’t been changed/created/deleted. If it is false, child sap objects will be synchronized only if the object on the current level has been changed/created/deleted.

Synchronize used sap repository objects and Synchronize all dependent sap objects recursively settings are available only if Synchronize used sap repository objects on demand setting is enabled on Edit Agent Dialog.

ApplicationException: Duplicate tracked object identified. Recording already exists but has another groupId. error might occur during synchronization if Synchronize used sap repository objects on demand setting is enabled.

Synchronize only Integration Directory objects runs synchronization of Integration Directory objects.

for CPI Agent system you are able to configure the following settings:

Synchronize objects forcibly - use that function to remove cached values of last change dates for each tracked object types. These dates are used in synchronization algorithm to minimize amount of objects to check (checking only changed objects).

Rebuild links for the latest versions forcibly - if true, links will be rebuilt for the latest versions.

Initialize externalized parameters of deployed IFlows - if true, externalized parameters of deployed IFlows will be initialized and configurations for design-time and deployed versions will be compared fairly.

Synchronize all packages - if true, all packages will be synchronized. If false, you can select packages to be synchronized.
for Api Management Agent system you are able to configure the following settings:

Synchronize objects forcibly - use that function to remove cached values of last change dates for each tracked object types. These dates are used in synchronization algorithm to minimize amount of objects to check (checking only changed objects).

Once synchronization is started, you can see the dialog with progress information:

The dialog information is updated automatically time-to-time. Synchronization is finished when the Synchronization Stage field is equal to Synchronization finished.