Skip to main content

Celonis Product Documentation

Task Templates

A task template is a generalized task (extraction or transformation) which is useful if you want to reuse a task. A common use case is using the same extractions and transformations for multiple systems.

Working with templates
How to create a template

You can create a template in two ways:

  • Use the context menu entry "Convert to template" in any existing task.

  • Use the "New Task Template" button in the "Task Template" section and choose the respective job and task through two drop-downs.

Converting a task template back to a normal task

If you would like to create a normal task from a template you can use the context menu entry "Copy to normal task" which leaves the template instance untouched and it creates a new task with the same content as the template.

How to add a template to a job

If you would like to add an existing template to an existing job, you need to click on "New extraction" or "New transformation" respectively in the job in question. Then, you need to choose the template to be added in the first drop down that appears in the modal. By clicking "Save" you add the task to the job.

Please note the following aspects:

  • You cannot modify the name or the description of the template here.

  • If you choose "None" you will have the possibility again to create a new "normal" task.

How to edit a template

To change the name or the description of a template you can use the context menu of the template in the task template section or the context menu of a template instance within one job. In the latter case, you are presented with affected instances and you need to confirm your change.

To edit the content of an existing template a specific instance has to be selected to define the scope of the extraction or transformation. For example, choosing an instance defines what tables are available in the data connection of the job.

There are multiple ways to choose a specific instance to edit a template:

  • Task template section: Click on the template you wish to edit and then choose an instance from the list which is shown afterwards.

  • Within a job: Click on the template instance within a specific job

After you have entered the specific instance of a template, editing it works exactly like for normal non-template tasks. The only difference occurs when you save your changes. You will then be prompted with confirmation modal where you see which instances are affected by your change. After you confirm your changes, all instances will be immediately updated.

How to remove and delete a template

If you wish to remove a template from a particular job, but you would like to keep the template, you simply need to delete the task in the respective job.

If you wish to delete the template and all its instances across the complete data pool you can delete the template in the "Task Template" section. If it is still in use, you will be shown a list of tasks which use the template. Then, you need to confirm the deletion.

Working with parameters

Templates can have one or multiple parameters like "normal" tasks. There is one major difference though: For each parameter templates have a default value and an instance value. Both are specified separately. As the name suggests, the instance value or just "value" is specific to each instance of a template. That is how a common template can be used, but differences can be dealt with by using different instance values for the same parameter.

Example: You define an extraction of the table TABLE1. The filter column to be used is COMPANY_CODE. You would like to reuse the extraction in three different systems, but in every system, another company code should be selected. In this case, you should define a parameter COMPANY_CODES (depending on the source system possibly as a text list or as a simple text) and then each instance uses a different set of company codes. So this is how it would look like:

System

Filter

Default value for parameter COMPANY_CODES

Value for parameter COMPANY_CODES

Sys 1

(defined in template)

(defined in template)

A032, B056

Sys 2

(defined in template)

(defined in template)

A011, C074

Sys 3

(defined in template)

(defined in template)

D088

The filter as defined in the template would be COMPANY_CODE IN <%= COMPANY_CODES %> and the default value could be e.g. A100. This only needs to be specified once and if the filter is modified to include another column, for example, all instances would be updated accordingly.

Visibility levels

Templates have three different visibility levels which can only be changed by Celonis admin users:

  • open

  • viewable

  • locked

  • protected

By default, all templates are open which means that anyone can view and edit the template.

A template with the state "viewable" cannot be edited except for the instance value of a parameter. The content can be viewed, however.

A locked template cannot be viewed or modified. The only change that can be made is the same as for the viewable templates.

A protected template cannot be viewed or modified by default. However, you can click on it and after acknowledging the legal notice you can view and edit the template.

Task Template Section
57542153.png
  1. Create a new task template from an existing task

  2. The tabs allow you to switch between the extraction and transformation templates.

  3. If you have selected any template, you can clear the selection.

  4. Delete all selected templates.

  5. It is displayed how many instances of this templates exist in the Data Pool.

  6. You can edit, rename, duplicate or delete a task template with the protection status open.