Skip to main content

Celonis Process Management (Exporter)

A guide to configuring and using the Ardoq-to-CPM exporter to bring applications and IT systems from Ardoq to CPM.

G
Written by Gleb Nikonov

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.

  1. In CPM, switch to editor mode by clicking the pencil icon in the top-right corner.

  2. Click the gear icon that appeared in the top-right corner.

  3. Under the Configure tab, click on Extended configuration

  4. Create a new attribute called ardoqID of the type Add singleline text attribute

  5. Select the ardoqID attribute and turn on the following options in the sidepanel:

    1. Set Available in REST API to on

    2. Set Language independent to on

    3. Set Activate to on

    4. Set Valid for types to Systems → Applications

    5. Set Group to Details

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

  1. In CPM, switch to Editor mode by clicking the pencil icon in the top-right corner

  2. Click the gear icon to go to the Admin page

  3. Click on Features

  4. 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: ardoq

  • Collection: ardoq

  • Storage: 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:

  1. Component name

  2. Ardoq OID

  3. 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. For instance, you can export the Ardoq component URL to CPM as long as you have created a custom attribute of the link attribute type.

Adding Stereotypes

The optional stereotype mapping allows you to group your exported applications based on fields, references, parent components, or a constant value.

For example, using the field Lifecycle Phase as a stereotype, will look at the Lifecycle Phase of each component being exported and create a stereotype for it in the format [Field name]: [Field value] — for example, Lifecycle Phase: Live and Lifecycle Phase: Implementing. These stereotypes will then appear in CPM as a filterable option:

Note: Due to limitations in CPM, stereotypes will take approximately 24 hours to appear in CPM when exported from Ardoq.

You can label your exported applications with a constant value — for instance "Ardoq" to indicate the application came from Ardoq — by writing in the input field and clicking on the Create button with your input.

Exporting as In Process or Published

Once your configuration is done, the preview page will give you 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.

Excluded States

Several states in CPM — specifically, Ready for QA, Ready for Review, Ready for Approval, and Expired — can only be modified manually through approval within CPM.

If you're exporting applications from Ardoq that already exist in one of these states in CPM, then Ardoq will automatically exclude these elements from the export. You will need to transition their states manually and run another export later.

Did this answer your question?