Skip to main content

Get help for ARIS Process Mining functions and services

Command Line Interface (CLI)

You can use the configureExtractor Command Line Interface (CLI) to

  • Change the SAP- and JDBC-system password in the UpdateSourceSystemConfiguration.json file.

  • Change the credentials of ARIS Process Mining in the UpdateProcessMiningConfiguration.json file.

  • Test the SAP and JDBC configuration of the UpdateSourceSystemConfiguration.json file.

  • Test the ARIS Process Mining configuration of the UpdateProcessMiningConfiguration.json file.

  • Activate configurations (Update).

  • Support multiple languages (The language parameter is optional. If the parameter is missing, the OS language is used.)

You can start the command line interface (CLI) using the configureExtractor batch or shell-script that are provided with the ARIS Process Mining installation.

This tool is located in the <Process Extractor installation>\bin\ directory.

The UpdateSourceSystemConfiguration.json and UpdateProcessMiningConfiguration.json files are located in the <ARIS Process Mining installation>\conf\ directory.

Warning

Do not edit the SourceSystemConfiguration.json and ProcessMiningConfiguration.json files located in the <Process Extractor installation>\conf\ directory. (These files are only updated by the CLI tool.)

Command line help

usage: configureExtractor

-h,--help: Print usage instructions and exit.

-?: Print usage instructions and exit.

-v: Print version number and exit.

-pwd,--password <arg>: Change password for SAP/JDBC-system alias and SAP/JDBC-system user.

Password is needed twice (password and confirmation).

-crd,--credentials <credentials>: Change credentials for ARIS Process Mining system.

-chk,--check-configurations: Check configurations.

-upd,--update-configurations: Update configurations.

-sys,--system <arg>: Specify SAP/JDBC-system alias.

-usr,--user <arg>: Specify SAP/JDBC-system user.

-lg,--language <arg>: Specify language.

The ExtractorConfiguration.json file is not updated by the CLI tool and you can edit it manually. Changes of this configuration requires a restart of Process Extractor.

User actions

  • Print help

    configureExtractor -h

  • Print version number

    configureExtractor -v

  • Change SAP-system password (in the source system update configuration file)

    configureExtractor -sys <sap_system> -usr <name> -pwd [<password> <password_conformation>]

  • Change JDBC-system password (in the source system update configuration file)

    configureExtractor -sys <jdbc_configurationAlias> -usr <dbUser> -pwd [<dbPassword> <password_confirmation>]

  • Change ARIS Process Mining credentials (in ARIS Process Mining update configuration file)

    configureExtractor -crd <credentials>

  • Check current configurations (SAP-, JDBC, and ARIS Process Mining connection checks and validations)

    configureExtractor -chk

  • Update current configuration(s), that is, reload current configuration file(s)

    configureExtractor -upd