Skip to main content

Celonis Product Documentation

Configure Application.yml for Celonis Agent

Responsibility: Server/ infrastructure administrator (supported by Celonis team administrator)

Later Changes

It is still possible to change the name of the Agent and the limit of concurrent executions after setting up the Agent (Advanced application.yml configuration).

The Celonis Agent comes in a zip file together with an “application.yml” file which stores the configuration needed to register the Agent in the Celonis team. This tutorial is only relevant if you want to make more advanced/customized changes in the application.yml file. The automatic agent installer will already automatically include the minimum necessary information in the application.yml file, which is enough to get the agent up and running.

A Celonis team administrator has to provide the application key. The server/ infrastructure administrator has to update and save the application.yml file in the Agent package.

Configuration of application.yml file for Celonis Agent

The application.yml file that is part of the Celonis Agent package needs to be configured. Please see the example below:

application.yml

agent:
  name: #required; change to preferred name
  concurrent_executions: #optional: number - default 100

celonis:
  authentication:
    appKey: #required
    teamDomain: #required
    env: #required
  internal-proxy-config-path: #optional - file path of external proxy config
  proxy-config-path: #optional - file path of internal proxy config

vault:
  enabled: false
  file: #optional - file path of the vault config

connectors:
  http:
    enabled: true
    whitelisted-domains:
     # - ADD-DOMAIN-TO-WHITELIST
  smtp:
    enabled: true
  sap-rfc:
    enabled: true
  remote-script:
    enabled: true
    config:
      scripts:
        - name: #required
          path: #required
  file-downloader:
    enabled: true
    config:
      paths:
        - logs

Important

The config path must be provided without any quotation marks (" ").

teamDomain and env

The destination URL of requests originating from Celonis Agent is: https://<teamDomain>.<env>.celonis.cloud/*

e.g. https://testteam.eu-1.celonis.cloud/*

use the teamDomain and env in the yaml

Example of a fully configured application.yml file

agent:
  name: agent-007 # change to preferred name
  concurrent_executions: #optional: number - default 100

celonis:
  authentication:
    appKey: OWZjMjdiOTAtZmJjKLjkweoisd89KKLJJilkSeV67219KKjpR...
    teamDomain: testteam
    env: eu-1
  internal-proxy-config-path: #optional - file path of external proxy config
  proxy-config-path: #optional - file path of internal proxy config
#if in the host where agent is deployed outbound requests are not allowed and have to go through a proxy, please add the proxy details in this configuration

vault:
  enabled: false
  file: #optional - file path of the vault config

connectors:
  http:
    enabled: true
    whitelisted-domains:
     # - ADD-DOMAIN-TO-WHITELIST
  smtp:
    enabled: true
  sap-rfc:
    enabled: true
  remote-script:
    enabled: true
    config:
      scripts:
        - name: #required
          path: #required
  file-downloader:
    enabled: true
    config:
      paths:
        - logs

Spaces

Make sure that there is always at least one blank space before the comments starting with "#".

Incorrect: "name: agent-007#required"

Correct: "name: agent-007 #required"

Advanced application.yml configuration
1. Adjust concurrent executions limit

  1. Open the yml file.

  2. Adjust the yml file based on the example below.

  3. Restart the Agent.

Example:

agent:
  name: agent-007
  id: 12234-5556777...
  concurrent-executions: 200 #you can adjust the number of concurrent executions, default: 100
2. Enable debugging logs

  1. Open the yml file.

  2. Adjust the yml file based on the example below.

  3. Restart the Agent.

Example:

logging:
  level:
    root: debug #you can enable additional logs for the agent, these can be helpful when debugging errors, default: disabled
3. Whitelist domains for HTTP Connector

  1. Open the yml file.

  2. Adjust the yml file based on the example below.

  3. Restart the Agent.

Example:

connectors:
  http:
    enabled: true
        whitelisted-domains: 
                # optional - add domains which should be reachable for automations via Agent
                # if left empty, the agent will be capable of reaching any given domain
4. Rename the Agent

You can rename the Agent by following the steps below:

  1. Open the yml file.

  2. Adjust the name.

  3. Delete the id row.

  4. Restart the Agent.

Example:

agent:
  name: agent-007

The Agent will then register with the new name and a new id will be automatically created

Please note that the update can take some time before being effective.