Skip to main content

ARIS Technical Help

Command line interface

You can use the command line interface to do the following:

  • Change the SAP password in the UpdateSAPConfiguration.json file.

  • Change the credentials in the UpdateARISConfiguration.json file.

  • Test the configuration.

  • Activate configurations (Update).

Start the command line interface using the configureConnector.bat or configureConnector.sh script. The scripts are located in the <ARIS Connector for SAP Solutions installation>\bin\ directory.

The UpdateSAPConfiguration.json and UpdateARISConfiguration.json files are located in the <ARIS Connector for SAP Solutions installation>\conf\ directory. The parameters are described in the corresponding .md files.

Warning

Do not edit the SAPConfiguration.json and ARISConfiguration.json files located in the <ARIS Connector for SAP Solutions installation>\conf\ directory. You can check and update these files only using the command line interface.

The ConnectorConfiguration.json file contains start parameters for ARIS Connector for SAP Solutions. You can change settings manually, such as the port number. Changes made in this file require an ARIS Connector for SAP Solutions restart.

Command line help

-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 system alias and SAP system user.

Password is needed twice (password and confirmation).

-crd, --credentials <credentials>

Change credentials.

-chk,--check-configurations

Check configurations.

-upd,--update-configurations

Update configurations.

-sys,--system <arg>

Specify SAP system alias.

-usr,--user <arg>

Specify SAP system user.

User actions

Print help: configureConnector -h

  • Print version number: configureConnector -v

  • Change SAP system password: configureConnector -sys <sap_system> -usr <name> -pwd [<password> <password_conformation>]

  • Change ARIS credentials: configureConnector -crd <credentials copied from ARIS Architect>

  • Check current configurations: configureConnector -chk

  • Update current configuration(s), that is, reload current configuration file(s): configureConnector -upd

If any issues occurred, the command line interface shows error messages. The links lead you to the problem solution.