Command line interface

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

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

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

If any issues occurred, the command line interface shows error messages. The messages are logged in the ConnectorCLI.log file.

The links lead you to the problem solution.

SAP_CONFIGURATION_DIFFERENT_USERS

You tried to encrypt and enter the SAP password into the UpdateSAPConfiguration.json file, but the user specified in the command is not specified in the file. Make sure to use the value of the related user parameter specified in the UpdateSAPConfiguration.json file for encryption.

CONFIG_FILE_MISSING_P_CFG_NAME

The required configuration file is missing in the <ARIS Connector for SAP Solutions installation directory>/conf folder.

CONFIG_FILE_INVALID_P_CFG_NAME

A file operation related to the corresponding configuration file failed. The exception was added to the log file.

CONFIG_VALUE_OUT_OF_BOUNDS_P_CFG_NAME_P_NAME_P_VALUE_P_MIN_P_MAX

You specified a configuration parameter using a wrong minimum or maximum value. The error message contains the valid range. To get detailed information about the use of all parameters, open the related *.md file.

CONFIG_VALUE_NOT_SET_P_CFG_NAME_P_NAME

A mandatory configuration parameter is missing. The error message contains the missing parameter.

SAP_CONFIG_ALIAS_NOT_UNIQUE_P_CFG_NAME_P_ALIAS

You configured multiple SAP systems using identical alias values. For each SAP system, you must specify a unique alias value.

CONFIG_FILE_COULD_NOT_PERSIST

A save file operation related to the corresponding configuration file failed. The exception was added to the log file.

SAP_CONFIG_CONNECTION_PARAMETERS_NOT_CORRECT

You must specify a valid SAP server URL as a value for the serverUrl parameter and a capital letter as a value for the language parameter. The values are used to connect to the SAP system that is specified as an alias using the ARIS Connector for SAP Solutions. To get detailed information about the use of all parameters, open the UpdateSAPConfiguration.md file.

SAP_CONFIG_AUTHENTICATION_PARAMETERS_NOT_CORRECT

You specified SAP connection parameters that are not valid.

SAP_CONFIG_LANGUAGE_PARAMETER_NOT_CORRECT

You specified the value of the language parameter incorrectly. Make sure to use one capital letter. To get detailed information about the use of all parameters, open the UpdateSAPConfiguration.md file.

ARIS_CONFIG_URL_NOT_VALID

You specified the value of the arisCloudUrl parameter incorrectly. The URL has wrong syntax. To get detailed information about the use of all parameters, open the UpdateARISConfiguration.md file.

ARIS_CONFIG_CLIENT_CREDENTIALS_NOT_VALID

The value of the clientCredentials parameter is not valid. Copy the credentials of the related ARIS Connector for SAP Solutions from ARIS Architect. The value must have the syntax <client ID>/<client secret>. The value consists of the Client ID and the Client secret, separated by a forward slash (/).

ENCRYPTION_GENERAL

The stored encrypted password could no longer be decrypted using the key.secret file that is located in the <ARIS Connector for SAP Solutions installation directory>/conf folder. Most likely, the secret key was changed. This happens if you deleted the key.secret file and restarted ARIS Connector for SAP Solutions. In this case, a new key.secret file is created using a new key and you must encrypt all credentials again. To do so, use these commands: ConfigureConnector.bat -crd <Copied credential from ARIS Architect>, ConfigureConnector.bat -sys <alias> -usr <user> -pwd <password> <repeated password>, ConfigureConnector.bat -upd.

SAP_INSTALLATION_CHECK_ERROR

The connection to the SAP system failed due to a problem other than an authentication issue.

ARIS_AUTHORIZATION_ERROR and ARIS_AUTHENTICATION_FAILED_ERROR

The connection to ARIS failed. Possible causes can be a wrong arisCloudUrl, wrong clientCredentials, wrong certificate (cacerts, located in the <ARIS Connector for SAP Solutions installation>/jre/lib/security folder), network issues.

The log files are located in <ARIS Connector for SAP Solutions installation directory>\logs folder.

  • Connector.log contains information logged during the startup of ARIS Connector for SAP Solutions and about the connected SAP system.

  • ConnectorCLI.log contains messages logged by the command line interface.

  • ConnectorCommunication.log contains messages related to the communication between ARIS Connector for SAP Solutions and ARIS.

  • SCCService.log contains messages logged by the startup process.