Change settings for the ARIS Server connection

After you have installed and configured ARIS Connector for SAP Solutions, you can modify the settings if required. To establish a connection between ARIS Server and ARIS Connector for SAP Solutions, you must specify the ARIS Cloud URL and the project room name. By default, you receive this information by e-mail from Software AG.

  1. Open the <ARIS Connector for SAP Solutions installation directory>\conf\UpdateARISConfiguration.json file in a text editor. The parameters are described in the UpdateARISConfiguration.md file. Do not edit the ARISConfiguration.json file.

  2. Specify only the ARIS Cloud URL and the project room name. By default, you received them by e-mail from Software AG. To change settings, edit the values after the parameter in quotation marks.

    "arisCloudUrl": "https://mc.ariscloud.com",

    "projectRoom": "default",

    "clientCredentials" : "password_set_with_configure_connector"

    For security reasons, you must not specify the clientCredentials value in this file.

  3. Save the file.

  4. If you only modified the arisCloudUrl or the projectRoom value, the clientCredentials are still valid. Only if ARIS Connector for SAP Solutions was deleted and added again, you must encrypt and enter the missing clientCredentials.

    To specify the missing credentials, you must encrypt and submit the clientCredentials value missing in the UpdateARISConfiguration.json file.

    1. In ARIS Architect, click ARIS > Show Administration Administration.

    2. Click Navigation Navigation in the bar panel if the Navigation bar is not activated yet.

    3. Open the folder Group SAP > ARIS Connectors for SAP Solutions.

    4. Select the related connector and in the Start tab bar, click Show Show credentials.

    5. Click Copy credentials and close the dialog.

    6. Open a command prompt box or a Linux terminal in the <ARIS Connector for SAP Solutions installation directory>\bin folder.

    7. To encrypt and submit the missing clientCredentials value in the UpdateARISConfiguration.json file, enter:

      ConfigureConnector.bat/.sh -crd <client-credentials key copied from ARIS Architect>

      For example, for Linux: ./ConfigureConnector.sh -crd 378ae18d-8d4d-499b-8579-1bd4601d30f0/15502484-88ab-4cb2-920f-153d21ab5915

      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.

      When you encrypt credentials, ARIS Connector for SAP Solutions creates a key.secret file in the <ARIS Connector for SAP Solutions installation directory>\conf folder. The key.secret file from now on is used for encryption.

      Make sure to back up this file. You must not change the key it contains. If you delete the key.secret file from the conf folder so that the encryption key is not stored with the encrypted credentials, you must be able to restore the file. This is because this file is mandatory when ARIS Connector for SAP Solutions is restarted. If you cannot recover the key.secret file that was used for encryption, you must re-encrypt and submit the credentials. Otherwise, connections cannot be established.

  5. Update the configuration.

    If your SAP password was changed or if you added anothwr SAP system to the ARIS Connector for SAP Solutions, you must encrypt and submit the password value missing in the UpdateSAPConfiguration.json file.

    1. Open a command prompt box or a Linux terminal in the <ARIS Connector for SAP Solutions installation directory>\bin folder.

    2. To update the ARISConfiguration.json file used by ARIS Connector for SAP Solutions, depending on your operating system, enter: .\configureConnector.bat -upd or ./configureConnector.sh -upd

The settings were changed. 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.