Tutorials and samples

1. Synchronization with Agent system

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.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.

2. Git Integration (CPI, API Mgmt). Repository initialization and getting changes from SAP Agent

Enable and configure Git integration on Agent.
Go back to Agents page and click button. It starts synchronization on chosen Agent. Once it’s done, check the folder with cloned Git repository, specified in Local Path To Repo:

Folders at root level are related to packages (CPI agents) or API Proxies (API Management agents). Some files are added automatically to repository during initialization: .gitignore-irt, build-irt.gradle, settings-irt.gradle, gradle-irt.properties. These files contains configuration modular structure and Figaf Gradle plugins. If you want to use them in your development workflow, remove irt suffix and save them as .gitignore, build.gradle, settings.gradle, gradle.properties. Or copy required configuration to existent files.
Now let’s make some changes in target object, for example CPI IFlow. We’ve added a Content Modifier from SAP UI. Then we need to process synchronization in Figaf Tool for chosen Agent. It can be done manually or by scheduled job if you have configured it. Once synchronization is finished, you can see a new commit with related changes:

3. IDE

Since of 2306 Figaf Tool supports possibility to edit and run Groovy code.

Follow steps to work in Groovy IDE:

Enable Enable IDE to run and upload scripts option on related CPI agent configuration page.
Configure OpenAI API Key , OpenAI Default Model and OpenAI Default Temperature settings on Application configuration page to enable Figaf Bot.
Go to tracked object page of Groovy script or XSLT mapping.
Click on icon to open IDE:
Then you can:
1. Groovy script only. Select Function from script. If it’s needed to refresh functions, click on .
  
  Figaf tool supports functions used in message mapping and groovy script step:
  
  If function is used in message mapping, it is possible to add test cases with defined Arguments, Headers, Properties After running a function, it’s possible to save a test case.
  
  If it’s a groovy script step, configure Input message, Headers, Properties.
  
  You can select Test Case and Message, then input data will be filled automatically.
2. Modify Script.
  
  You can get some help from Figaf Bot that triggers Open AIs API.
3. XSLT mapping only. Configure XSLT processing mode:
  
  Figaf Tool works fast and uses code in the application. This approach doesn’t support java functions and cpi extensions (like java:new() or cpi:setHeader).
  
  XSLT Executor IFlow updates and deploys XSLT_Executor IFlow and XSLT is executed in this IFlow. It usually takes around 10 seconds but it provides full XSLT processing support.
4. Run script click on Run button.
Result will be shown in right side: Output message, Headers and Properties.
If you want to save modified script, click on Upload button. It will update only a particular script (via public API) of related IFlow.

4. Use IFlow as a configurable template to create many IFlows (CPI)

If you have multiple organizations, like a sales division for Denmark, Germany, Sweden, and some flows may need to run for all organizations, you can develop the flow once and then configure it for multiple organizations using distribution configuration.

Open the IFlow details you want to use as a configurable template to create many IFlows.
Click on Create distribution configuration button. It creates distribution configuration that is used for configuring external configuration for target IFlows created from the selected IFlow.
Click on Add target IFlow to add target IFlows to the distribution configuration. It opens 'Add iFlows to distribution configuration' dialog box where you can configure target IFlows technical and displayed names:
If you want to change external configuration of target IFlows, deselect Inherit (source) for parameter, define values, and Save configuration:

You can Upload all IFlows or Update target IFlow (in of target IFlow).

If you want to deploy target IFlows, click on edit , enable Deploy uploaded objects, and click on save .

If you want to update target IFlows after source IFlow changes, click on edit , enable Update target objects automatically, and click on save . After that if source IFlow is updated (the changes are handled during synchronization), target IFlows will be updated automatically.

If you want to delete the distribution configuration, click on Delete button. It marks distribution configuration as deleted. If you want to delete distribution configuration that marked as deleted from CTT, click on Delete from CTT button.

IFlow can be linked only with one distribution configuration.

5. Browse and compare versions from different landscape items

Since of 2105 Figaf Tool supports possibility to browse and compare objects versions from different landscape items.

Requirements:

All required Agent Systems have been configured (see Agent Configuration to learn how to do that).
Synchronization of all required Agent Systems has been done (see Synchronization with Agent system section).
All required Landscapes have been configured (see that section to learn how to do that).

Go to Change Tracking Tool → Tracked Objects page.
Open a tracked object page clicking on object name.
Go to Tracked Object Change Log page clicking on Versions button.

Enable Show versions across landscape and select a landscape. Objects from different landscape items will be shown and you can browse and download payloads or compare the versions.

Objects from different landscape items are determined by the following rules:

For CPI and Api Management platforms objects are searched with the equal names.
For PRO platform the following strategies are used to determine objects names from other systems:
- transport configuration (the highest priority).
- scenario mapping (if transport configuration doesn’t exist).
- the same name (if neither transport configuration nor scenario mapping exist).

6. Restore last CPI object version after its deletion

Since of 2.14 Figaf Tool supports a possibility to restore last CPI object version of deleted IFlow and Value Mapping.

Requirements:

All required Agent Systems have been configured (see Agent Configuration to learn how to do that).
Synchronization of all required Agent Systems has been done (see Synchronization with Agent system section).
IFlows which you want to restore were deleted after the first synchronization in Figaf Tool. So it’s important to have these IFlows and Value Mappings synchronized earlier.

Go to Change Tracking Tool → Tracked Objects page.
Select CPI Agent.
Switch Browse deleted objects in order to view deleted objects.
Select IFlow(s) or(and) Value Mapping(s).
Click on Restore artifacts.
Check objects that will be restored.
Enable Deploy restored objects if you want this objects to be triggered for deployment.
Click on Upload.

7. Transform REST API/SOAP API objects to IFlows

Since of 2305 Figaf Tool supports a feature to transform REST API and SOAP API objects to IFlows. Follow the steps to transform objects:

Go to Change Tracking Tool → Tracked Objects page.
Select CPI Agent.
Click on and then click on Transform REST/SOAP API objects. It opens Transform REST/SOAP API objects page with list of objects:
Select objects you are going to transform.
Click on Transform to IFlow button. It opens confirmation dialog:
Choose required options:
1. Only create IFlows creates IFlows and doesn’t delete source object.
2. Create IFlows and delete/undeploy selected objects creates IFlows and undeploys snd deletes source objects.

Once the operation is completed, created IFlows will be synchronized automatically. After this transformation you can use the IFlows the same way as any IFlow.

8. Add groovy script or XSLT mapping to IFlow

Since of 2403 Figaf Tool supports creation of new groovy script or XSLT mapping. The feature works only for the latest versions.

Requirements:

Agent System has been configured (see Agent Configuration to learn how to do that).
Synchronization of required Agent System has been done (see Synchronization with Agent system section).

To open the dialog follow steps:

Go to Change Tracking Tool → Tracked Objects page.
Select CPI Agent.
Go to IFlow tracked object page.
Click on and then click on Add new script. It opens Add new script dialog where you should configure:
1. Script Type defines type of script that will be created: either Groovy or XSLT.
2. Only for Groovy script type Function Type defines type of groovy script: either Groovy Script Step or Use in Message Mapping.
3. Script name defines name of script.
Once configuration is submitted, Groovy IDE dialog will be opened.

9. Rename resources of IFlow

Since of 2403 Figaf Tool supports renaming of scripts and mapping objects (both XSLT and Message Mapping). The feature works only for the latest versions and only for IFlow children.

Requirements:

Agent System has been configured (see Agent Configuration to learn how to do that).
Synchronization of required Agent System has been done (see Synchronization with Agent system section).

To open the dialog follow steps:

Go to Change Tracking Tool → Tracked Objects page.
Select CPI Agent.
Go to script or mapping tracked object page.
Click on and then click on Rename resource. It opens the dialog where new name should be defined.

10. Browse linking between IFlows and Cloud Agreements based on the endpoints

Since of 2312 Figaf Tool supports linking between IFlows and Cloud Agreements based on the ProcessDirect/JMS endpoints. The feature works only for the latest versions.

Requirements:

Agent System has been configured (see Agent Configuration to learn how to do that).
Synchronization of required Agent System has been done (see Synchronization with Agent system section).

To open the dialog follow steps:

Go to Change Tracking Tool → Tracked Objects page.
Select CPI Agent.
Go to IFlow or Cloud Agreement tracked object page.
Click on and then click on Open CPI Endpoints.

Then endpoints dialog will be opened. There are source and target objects listed in the dialog.

An IFlow has a reference to itself if it has subprocesses using ProcessDirect/JMS for internal communication.

11. Select all Segments and Fields of MIG object

Since of 2401 Figaf Tool supports a feature to select all Segments and Fields of Message Implementation Guideline. To enable follow the steps:

Go to Change Tracking Tool → Tracked Objects page.
Select Integration Suite Agent.
Go to MIG tracked object page.
Click on and then click on Select all Segments and Fields. Once you confirm the action, Draft version of MIG with enabled segments and fields will be created if the latest version was Activated or Draft version will be updated if the latest version was Draft.

12. Management of Partner Directory parameters

Since of 2405 Figaf Tool supports management of Partner Directory parameters. To work with the feature go to Change Tracking Tool → Tracked Objects page, select CPI or Integration Suite Agent and go to Partner Directory parameters tab:

On this page you can:

Retrieve SAP TPM Pid parameters switch to hide and show SAP TPM Pid parameters.
Synchronize partner directory parameters.
Configure new partner clicking on related button.
Configure new partner
It opens Create and configure partner dialog where:

Select From Pid object.

Define New Pid.

Set Copy not defined binary parameters from chosen partner value. If true and related parameter value isn’t defined, parameter value from source Pid will be used. If false and related parameter value isn’t defined, empty value will be used.

Select parameters which should be copied.

Define parameter values by clicking on and then and defining new configuration.

Once everything is configured, save. Then new partner with all selected parameters will be created and automatically synchronized.
Create new parameter
Create parameter
To create new parameter follow the steps:

Go to Change Tracking Tool → Tracked Objects page.

Select CPI or Integration Suite Agent.

Go to Partner Directory parameters tab.

Click on Create button. It opens Create partner directory parameter dialog where should be configured:

Pid existing or new Pid.

Type is String, Binary, Interface Determination, Receiver Determination. String parameter will be saved as string parameter, Binary, Interface Determination and Receiver Determination will be saved as binary parameter.

Parameter Id should be new value. Not modifiable for Interface Determination and Receiver Determination.

for binary parameters Content Type defines content type. Not modifiable for Interface Determination and Receiver Determination.

for xsl content type Open IDE opens IDE.

for binary parameters Import file provides a possibility to load selected file.

for binary parameters Base64 format encodes or decodes to or from Base64 format. Not modifiable for zip, gz, zlib, crt content types.

Value is parameter value.

Once everything is configured, save. Then new parameter will be created and automatically synchronized.
Delete selected parameters.
Edit parameter.
Edit partner
To edit existing parameter follow the steps:

Go to Change Tracking Tool → Tracked Objects page.

Select CPI or Integration Suite Agent.

Go to Partner Directory parameters tab.

Click on button. It opens Edit partner directory parameter dialog where new configuration should be configured.

Once everything is configured, save. Then parameter will be updated and automatically synchronized.
Go to tracked object of the parameter.

13. Management of Security Content objects

Since of 2408 Figaf Tool supports management of Security Content objects. Management is supported for:

User Credentials:
1. User Credentials;
2. SuccessFactors;
OAuth2 Client Credentials;
Secure Parameter.

To work with the feature go to Change Tracking Tool → Tracked Objects page, select CPI or Integration Suite Agent and go to Security Content objects tab:

On this page you can:

Synchronize security content objects.
Create new security content object:
Create object
To create new security content object follow the steps:

Go to Change Tracking Tool → Tracked Objects page.

Select CPI or Integration Suite Agent.

Go to Security Content objects tab.

Click on Create button. It opens Create dialog where should be configured:

Object Type - one of supported types User Credentials, OAuth2 Client Credentials or Secure Parameter.

Other parameters related to selected Object Type.

Once everything is configured, save. Then new object will be created and automatically synchronized.
Delete object.
Edit object.
Edit object
To edit existing object follow the steps:

Go to Change Tracking Tool → Tracked Objects page.

Select CPI or Integration Suite Agent.

Go to Security Content objects tab.

Click on button. It opens Edit dialog where new configuration should be configured.

Once everything is configured, save. Then object will be updated and automatically synchronized.
Go to tracked object of the object.

14. Tag tracked objects

Since of 2112 Figaf Tool supports tagging of tracked objects. This feature helps to find tracked objects easier. You can create, edit and delete tags.

Requirements:

All required Agent Systems have been configured (see Agent Configuration to learn how to do that).
Synchronization of all required Agent Systems has been done (see Synchronization with Agent system section).

To create a tag follow steps:

Go to Tags page.
Click on Create Tag button.
Enter Name. Name must be unique.
Enter Description. It’s not required.
Save tag.

To attach tags to tracked objects follow steps:

Configure required tags.
Go to Change Tracking Tool → Tracked Objects page.
Select objects for which you are going to add tags.

If you select all objects, you can either attach tags to objects on all pages or to objects on current page.
Click on Attach Tags button.
Select tags in the dialog.
Apply selection.

It’s possible to attach tags to object from the tracked object page.
Once it’s done, you can filter tracked objects by Tags column in order to find required objects easier.

Once you attach object with tags to ticket, the same tags will be shown on the ticket page, so you will be able to filer tickets by Tags.

If you need to detach tags from tracked objects, do the same steps as during attaching tags to tracked objects but click on Detach Tags button.

15. Import tags

To import tags follow the steps:

Go to Tags page.
Click on Import Tags button.

Configure setting for import:

tags import dialog

CSV Payload - csv file with source data. Data should have at least the following columns: column(s) with object name and column(s) with tags.

PRO example

PI object	Tag1	Tag2
TEST\|TST\|Interface\|http://figaf.test.com/\|\|	Custom tag
TEST\|TST\|dummy1\|http://figaf.test.com\|\|	Custom tag	One more tag
TEST\|TST\|dummy2\|http://figaf.test.com\|\|	Dummy tag1
TEST\|TST\|dummy3\|http://figaf.test.com\|\|	Dummy tag2	One more tag

PI object

Tag1

Tag2

TEST|TST|Interface|http://figaf.test.com/||

Custom tag

TEST|TST|dummy1|http://figaf.test.com||

Custom tag

One more tag

TEST|TST|dummy2|http://figaf.test.com||

Dummy tag1

TEST|TST|dummy3|http://figaf.test.com||

Dummy tag2

One more tag

PRO example with several columns for object name

Sender Party	Sender Component	Interface Name	Interface Namespace	Tag1	Tag2	Tag3
TEST	TST	Interface	http://figaf.test.com/	Custom tag		Another tag1
TEST	TST	dummy1	http://figaf.test.com	Custom tag	One more tag
TEST	TST	dummy2	http://figaf.test.com	Dummy tag1	Another tag2
TEST	TST	dummy3	http://figaf.test.com	Dummy tag2	One more tag	Another tag2

Sender Party

Sender Component

Interface Name

Interface Namespace

Receiver Party

Receiver Service

Tag1

Tag2

Tag3

TEST

TST

Interface

http://figaf.test.com/

Custom tag

Another tag1

TEST

TST

dummy1

http://figaf.test.com

Custom tag

One more tag

TEST

TST

dummy2

http://figaf.test.com

Dummy tag1

Another tag2

TEST

TST

dummy3

http://figaf.test.com

Dummy tag2

One more tag

Another tag2

CPI example

Displayed Name	Tag1	Tag2
TestIflow_20251028	Custom tag
TestIFlow_20251103	Custom tag	One more tag
TestIflow_3_20251028	Dummy tag1
TestIFlow_4_20251103	Dummy tag2	One more tag

Displayed Name

Tag1

Tag2

TestIflow_20251028

Custom tag

TestIFlow_20251103

Custom tag

One more tag

TestIflow_3_20251028

Dummy tag1

TestIFlow_4_20251103

Dummy tag2

One more tag

Object Name Mapping Rules for CSV Payload - csv file with mapping rules between objects in csvPayload and objects from the specified target system. CSV file with mappings shouldn’t have columns header, it should have 2 columns, data must be divided by semicolon. Left column is a object name substring, right column is a replacement string.

Rules are checked in order of their occurrence in the file, and Figaf tool checks all rules for each object name. It’s done intentionally to be able to configure mapping in a few steps. For example, let’s assume that it’s applying the rule SOURCE;TARGET for object |SOURCE|ZVXX_TMSEI_CUSTMAS.ZVXX_TMSEI_CUSTMAS01|urn:sap-com:document:sap:idoc:messages||, then object is mapped to |TARGET|ZVXX_TMSEI_CUSTMAS.ZVXX_TMSEI_CUSTMAS01|urn:sap-com:document:sap:idoc:messages||. If there is a rule TMSEI_CUSTMAS01;TMSEI_TEST_CUSTMAS01 after the rule SOURCE;TARGET then previously mapped object |TARGET|ZVXX_TMSEI_CUSTMAS.ZVXX_TMSEI_CUSTMAS01|urn:sap-com:document:sap:idoc:messages|| is mapped again to |TARGET|ZVXX_TMSEI_CUSTMAS.ZVXX_TMSEI_TEST_CUSTMAS01|urn:sap-com:document:sap:idoc:messages||.

Has Header defines whether CSV Payload has headers or no.
Overwrite Links - if true, all existing links between tags from request and tracked objects will be deleted and created from scratch. By default, links will be appended.
Agent Platform is platform of the agent system.
System Agent Id - system id of agent.
Tag Name Column Names or Indexes defines an array of column names or indexes from CSV Payload file that is related to the tag names (determination by column name works only when csv has columns header and hasHeader is true).

For example, for determination by column name: Tag1, Tag2, Tag3, for determination by column index: 6, 7, 8. Column indexes are started from 0.
Integration Object Name Column Names or Indexes defines an array of column names or indexes. In case of PRO systems it’s a set of columns related to the name of ICO/SA/RA (Sender Party, Sender Component, Interface Name, Interface Namespace, Receiver Party, Receiver Service).

For example, for determination by column names: Sender Party, Sender Component, Interface Name, Interface Namespace, Receiver Party, Receiver Service, for determination by column indexes: 0, 1, 2, 3, 4, 5. Column names must match 1 to 1 to the names in CSV file, otherwise there will be the error.
only PRO Sender Channel Name Column Names Or Indexes defines a set of columns that relate to the name of the sender communication channel.

For example, for determination by column names: Sender Party Id, Sender Component, Sender Channel.
only PRO Receiver Channel Name Column Names Or Indexes defines a set of columns that relate to the name of the receiver communication channel.

For example, for determination by column names: Receiver Party, Receiver Component, Receiver Channel.

Once the settings are configured, click on Preview and browse tags that will be imported and linked with objects.
Click on Import.

Then unexisting tags will be created and all tags mentioned in CSV Report will be attached to the related existing objects.

16. Tagging Rules page

Since of 2402 Figaf Tool supports enhanced quering of tracked objects. The feature provides a possibility to define tagging rules that apply a condition (xpath/regex) to specified scope of objects to assign a technical tag, created together with the rule, to objects that match condition. You can create, update, import, export, delete tagging rules and process tagging.

16.1. Create tagging rule

To create new tagging rule follow steps:

Go to Tagging Rules page.
Click on . It opens Add tagging rule dialog:

Enter the fields:

Tag name defines technical tag name. This tag will be created during the tagging rule creation and attached to objects that match condition during tagging process. Tag name must be unique.
Displayed name defines displayed name of tagging rule.
Complexity rate defines numeric representation of estimate in some units (for example story points or days).
Platform defines platform.
Agents defines a list of agents.
Object type defines object types.

Script Collection and Cpi Function Libraries types aren’t supported.
Name pattern defines regex that check if matches the tracked object name.
Direction defines direction (Sender or Receiver) of Communication Channel.
Adapter type defines adapter type for Communication Channel. If there is no required type in the list, type the value manually.
Condition type defines condition type: either XPath or Regex.

Condition defines any valid XPath or Regex. It is possible to test the condition clicking on Test button. It will open the dialog where you can select Object to test and test your Expression.

Examples of supported XPath expressions:

/ns2:CommunicationChannel/MasterLanguage/text()
/ns2:CommunicationChannel/AdministrativeData/ResponsibleUserAccountID/text()
/ns2:CommunicationChannel/AdapterSpecificAttribute[Namespace]/Name/text()
/ns2:CommunicationChannel/AdapterSpecificAttribute[Namespace]/Name
/CommunicationChannel/AdapterSpecificAttribute[Namespace]/Name
/CommunicationChannel/MasterLanguage
count(/ns2:CommunicationChannel/AdapterSpecificAttribute)
substring(/ns2:CommunicationChannel/Description/text(), 1, 10)
/ns2:CommunicationChannel/AdapterSpecificAttribute[contains(Name, 'source')]/Value/text()
sum(/ns2:CommunicationChannel/AdapterSpecificAttribute[Name='file.pollInterval']/Value)
//brick[@path='/ADRMAS03/IDOC/E1ADRMAS/E1BPAD1VL/STREET']
//FolderPathID[text()="/my-folder/test/"]
//FolderPathID[.="/my-folder/test/"]
//ns2:CommunicationChannel[starts-with(AdministrativeData/LastChangeUserAccountID, 'user')]
//ns2:CommunicationChannel[ends-with(AdministrativeData/LastChangeUserAccountID, 'user')]
//ns2:CommunicationChannel[contains(AdministrativeData/LastChangeUserAccountID, 'user')]
//ns2:CommunicationChannel[matches(AdministrativeData/LastChangeUserAccountID, 'user')]

Apply condition to internal payload enables possibility to define condition to internal payload for Function Library, Message Mapping and Mapping Template types.
Apply on synchronization enables automatic tagging rule process during synchronization. Default value is true.
Description defines description.

Save the data.

Once tagging rule is created, related technical tag will created automatically.

16.2. Import tagging rules

It is possible to import prepared JSON file with tagging rules configuration, e.g.

[{
  "tagName" : "Tag 1",
  "displayedName" : "Tagging Rule 1",
  "objectType" : "PACKAGE",
  "platform" : "CPI",
  "evaluatorType" : "REGEX",
  "condition": ".*",
  "description" : "Test Description",
  "agentSystemIds" : [ "cpi1", "cpi2" ]
}, {
  "tagName" : "Tag 2",
  "displayedName" : "Tagging Rule 2",
  "objectType" : "PACKAGE",
  "platform" : "CPI",
  "evaluatorType" : "REGEX",
  "condition": ".*",
  "description" : "Test Description",
  "objectScopeCriteria" : {
    "type" : "default-filter",
    "namePattern" : ".*"
  },
  "agentSystemIds" : [ "cpi1" ]
}, {
  "tagName" : "Tag 3",
  "displayedName" : "Tagging Rule 3",
  "objectType" : "CHANNEL",
  "platform" : "PRO",
  "evaluatorType" : "XPATH",
  "condition" : "//ns2:CommunicationChannel[starts-with(AdministrativeData/LastChangeUserAccountID, 'user')]",
  "objectScopeCriteria" : {
    "type" : "communication-channel-filter",
    "namePattern" : "test",
    "direction" : "RECEIVER",
    "adapterType" : "JMS"
  },
  "agentSystemIds" : [ "pro-1", "pro-2", "pro-3" ]
}, {
  "tagName" : "Tag 4",
  "displayedName" : "Tagging Rule 4",
  "complexityRate" : "44",
  "objectType" : "MESSAGE_MAPPING",
  "platform" : "PRO",
  "evaluatorType" : "XPATH",
  "condition" : "//generic/textInfo",
  "applyConditionToInternalPayload" : true,
  "applyOnSynchronization": false,
  "agentSystemIds" : [ "T75", "D75" ]
}]

To import tagging rules follow steps:

Prepare JSON file with tagging rules configuration.
Go to Tagging Rules page.
Click on Import and select the prepared file.
Select agents for each platform in Please select agents dialog and submit changes.

Then tagging rules and technical tags will be created.

16.3. Process tagging

To process tagging select tagging rules and click on Process tagging button. Then related technical tags will be attached to objects that match the condition and belong to defined scope (platform, agents, object type, name pattern, direction, adapter type).

17. Landscape Overview page

All objects in scope of CPI and Api Management composite landscapes can be browsed on Landscape Overview page.

Go to Change Tracking Tool → Landscape Overview page
Select CPI or Api Management composite landscape. Table with objects through the composite landscape will be shown:

is an object marked as deleted in CTT.
The following features are available:
1. (Only for CPI) Include Partner Directory loads partner directory objects as well.
2. (Only for CPI) Parameters report generates configuration parameters report for all IFlows or selected IFlows.
3. Export to CSV generates CSV report with the table data.
4. Compare versions clicking on . Then select objects for comparison and compare objects.
5. Show difference from target system - if true, only the iflows that have different version with target object are shown.
6. Go to tracked object page clicking on the object link.
7. Go to corresponding transport configuration page for objects with transport configuration clicking on the object link and selecting related option.
8. Batch deploy/undeploy of IFlows selecting them, clicking on and clicking on Deploy/Undeploy.