Skip to main content

ARIS Technical Help

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.

  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. To change settings, edit the values after the parameter in quotation marks.

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

  3. "clientCredentials" : "password_set_with_configure_connector"

      Warning

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

    1. Save the file.

    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 submit the 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.

      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.

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

    Update the configuration.

    If your SAP password was changed or if you added another 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.