Skip to main content

Celonis Product Documentation

Configuration Data Connection
EMS Upload
  • Send Data to EMS: Enable this option if the logged data should be pushed into the EMS, or set disable it if the events should only be stored locally in the parquet files

  • API Key Type: The type of the API key. SINCE 1.2.1

    Possible values:

    • App key: The API key is an application key, i.e. it is not bound to a specific EMS user. This option is the DefaultValue and matches the behavior of previous versions of the software.

    • User token: The API key is a user-bound API key.

  • Cloud API Key: The API key for the EMS instance where the data should be pushed to.

  • Data Pool ID: The ID of the data pool which should store the events.

  • EMS Team Subdomain: The subdomain of the EMS team (usually the first part of the URL).

  • Server ID: The id of the server (e.g. eu-1).

  • Target Table Name: The name of the database table in the EMS which should store the events.

  • Image Service Bucket ID: The ID of the Image Service bucket. SINCE 1.2.1

  • Update Cloud Period (in Minutes): Period (in minutes) for sending the events stored in parquet files to EMS.

Caching
  • Encrypt Local Data: Enable this option to encrypt files (logs and screenshots if enabled) that are temporarily stored on your local disk. SINCE 2.0.4

  • Path for Transfer File Cache: The directory where to store the temporary parquet files. If no valid directory is specified, the parquet files are stored in the user's temp folder (managed by Windows). Note: You can use Windows system variables (like %HOMEPATH% or %USERPROFILE%) to create a generic configuration file for different users.

  • Number of Entries Limit: The maximum number of events that should be cached. If the number of cached events exceeds this threshold, the cached events are written to a parquet file.

  • Timer Limit in Minutes: A time limit for writing cached events into parquet files (in minutes). After exceeding the time limit, all cached events are written to parquet.

  • Timeout in seconds: A time limit for uploading data to EMS before terminating the application. SINCE 2.0.4

  • Auto Upload Old Cached Files: Enable auto-upload of old cached files from previous runs and that failed to upload. Disabling this option will prevent checking for old cached files. SINCE 2.4.1

  • Maximum Cached File Age: A maximum number of days to keep cached files before deletion. Cached files will be deleted if the file age is exceeded. SINCE 2.4.1

  • Maximum Cached File Size: Maximum size of cached files in gigabytes. Cached files will be deleted if the maximum size is exceeded. SINCE 2.4.1

Compatibility
  • Use Old Data Push API: This flag activates the old data push API implementation. This flag should only be used if the new continuous push API is not available on your EMS cluster. This flag is only for downwards compatibility and will be removed in future releases. SINCE 1.1.1DEPRECATED (since 1.1.1)

  • Use Old Image Upload API: Use the old version of the image upload API. This is only recommended if the latest version of the API is not available on your EMS team. This flag is only for downwards compatibility and will be removed in future releases. SINCE 1.2.1DEPRECATED (since 1.2.1)