Use the command line interface to set the encrypted credentials in the configuration files, such as the clientCredential parameter and the password parameter. The credentials are used to authenticate ARIS Connector for SAP Solutions against your ARIS Enterprise tenant and the SAP system.
Warning
Do not manually change the credentials in the UpdateARISConfiguration.json, ARISConfiguration.json, UpdateSAPConfiguration.json, or SAPConfiguration.json files.
Prerequisite
ARIS Connector for SAP Solutions is running.
Procedure
Open a command prompt box or a Linux terminal in the <ARIS Connector for SAP Solutions installation directory>\bin folder.
To encrypt and submit the missing clientCredentials value in the UpdateARISConfiguration.json file, enter:
ConfigureConnector.bat/.sh -crd <client-credentials key copied from ARIS Designer>
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
.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.
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.
The required configuration file is missing in the <ARIS Connector for SAP Solutions installation directory>/conf folder.
A file operation related to the corresponding configuration file failed. The exception was added to the log file.
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.
A mandatory configuration parameter is missing. The error message contains the missing parameter.
You configured multiple SAP systems using identical alias values. For each SAP system, you must specify a unique alias value.
A save file operation related to the corresponding configuration file failed. The exception was added to the log file.
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.
You specified SAP connection parameters that are not valid.
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.
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.
The value of the clientCredentials parameter is not valid. Copy the credentials of the related ARIS Connector for SAP Solutions from ARIS Designer. 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 (/).
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 Designer>, ConfigureConnector.bat -sys <alias> -usr <user> -pwd <password> <repeated password>, ConfigureConnector.bat -upd.
The connection to the SAP system failed due to a problem other than an authentication issue.
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.
To encrypt and enter the missing SAP password into the UpdateSAPConfiguration.json file, in the command prompt window or a Linux terminal, enter:
ConfigureConnector.bat/.sh -sys <value of the alias parameter> -usr <value of the user parameter> -pwd <password> <confirm password>
For example, for Windows: .\ConfigureConnector.bat -sys SM01 -usr ARIS_SAP_SYNC_USER -pwd ******** ********
While you are entering your password, it will be visible.
You have set the encrypted clientCredentials parameter used in the UpdateARISConfiguration.json file and the password parameter used in the UpdateSAPConfiguration.json file.