Overview
In the scope of Enterprise Architecture, Ardoq is used as the source of truth for applications that exist within an organization. Instead of setting up applications and IT systems in both Ardoq and CPM, and then managing both systems separately, you can instead export applications from Ardoq to CPM on a scheduled basis.
This way as new applications enter Ardoq, they can be effortlessly brought to CPM, where they can be attached to processes and activities. Finally, using the CPM Importer, you can bring back updated data from CPM back into Ardoq to complete the full cycle.
Connecting Ardoq to CPM
Configuring CPM to Accept Applications
Before we can export to CPM, we need to configure a custom attribute in CPM to store Ardoq OIDs to maintain synchronization. This configuration will expose a custom parameter on the CPM API that Ardoq will use to store custom IDs.
In CPM, switch to editor mode by clicking the pencil icon in the top-right corner.
Click the gear icon that appeared in the top-right corner.
Under the Configure tab, click on Extended configuration
Create a new attribute called
ardoqIDof the type Add singleline text attributeSelect the
ardoqIDattribute and turn on the following options in the sidepanel:Set Available in REST API to on
Set Language independent to on
Set Activate to on
Set Valid for types to Systems → Applications
Set Group to Details
Click Apply changes
This process can also be used to add additional custom attributes in CPM. Once configured in CPM, they can be selected in the mapping step of the exporter flow.
Disabling Hierarchy View for Improved Performance
If you're bringing in more than 1000 applications from Ardoq into CPM, we recommend disabling the default hierarchy view for IT systems to improve the performance of CPM.
You can do this with the following steps:
In CPM, switch to Editor mode by clicking the pencil icon in the top-right corner
Click the gear icon to go to the Admin page
Click on Features
In the list, enable the Method: Systems as a list (instead of architecture) option
Creating a Connection to CPM in Ardoq
When creating your API token in CPM, ensure that the token has author permissions.
From the main menu in Ardoq, select Home > Import and integration then navigate to the Celonis Process Management Exporter. On the next page, select the Connections tab, then select Create new connection and fill in the required details:
Connection name
The sub-domain at symbioweb.com
Symbio API Token
Collection
Storage
Preferred language (1033 for English)
For example, in the URL https://ardoq.symbioweb.com/ardoq/ArdoqShowcase:
Sub-domain:
ardoqCollection:
ardoqStorage:
ArdoqShowcase
Once completed, the connection will automatically appear in the CPM exporter connection field.
Exporting Applications
Selecting Components to Export
The CPM exporter only exports from one workspace at a time. Each export can bring over any component types within that workspace, to be configured separately.
By default, Ardoq pre-defines the following field to export to CPM based on existing component properties:
Component name
Ardoq OID
Description
You can also add a number of optional mappings that map Ardoq fields to CPM attributes. You will need to ensure that Ardoq field types match the CPM attribute types, e.g. a date field in Ardoq goes into a date field in CPM. Additionally, if using custom attributes in CPM, you will need to ensure they are properly configured and exposed to the CPM API.
Once your configuration is done, you'll see a preview of the components to be created or updated. Here you have the option to select if you wish to publish the applications in the In process status or the Valid status. You can tick the Set exported applications to published status box to ensure that the exported applications will have the Valid status.
Publishing to the Valid status requires that the API token you're using has the Administrator permission. Otherwise applications can only be exported to the In process status.
If the export finishes successfully, you'll be able to schedule the export on a daily or weekly basis to keep your applications up to date.