Skip to main content

ARIS Technical Help

Install and pre-configure ARIS Connector for SAP Solutions

After you have created an upgrade ticket ARIS 10 Service Release 18 or later, the first step of the migration process is to install ARIS Connector for SAP Solutions and configure basic connection parameters.

To use ARIS Connector for SAP Solutions in your ARIS Cloud scenario, you can run ARIS Connector for SAP Solutions as a Windows service or as a Linux daemon. If you do so, ARIS Connector for SAP Solutions starts automatically when the operating system is started.

If you use multiple tenants together with ARIS for SAP Solutions, you must install one ARIS Connector for SAP Solutions instance for each tenant. If you install multiple instances on one machine, port conflicts result. If an ARIS Connector for SAP Solutions instance cannot be started due to port conflicts, change the port number in the ConnectorConfiguration.json file (<ARIS Connector for SAP Solutions installation directory>\conf).

Prerequisite

You have access to the purchased installation package.

Procedure. Procedure

  1. Download the appropriate archive file corresponding to your operating system, such as aris-cloud-connector-for-sap-solutions-<version number>-<OS>64.zip.

    To download the package, you need access to the ARIS Download Center where a login is required. The archive files are also contained in the related ARIS installation package <ARIS_Installation_and_Documentation-<version>> (see: ...Add-ons\Extension_pack_SAP\ARIS Connector for SAP Solutions).

  2. Create an ARIS Connector for SAP Solutions installation directory.

    Windows: Create a subfolder as an installation directory, such as C:\ ARIS\acc4sap.

    Do not create the folder on a substituted drive and avoid blanks in the folder name.

    Linux: Create a folder as an installation directory, such as /opt/acc4sap. Avoid blanks in the folder name.

  3. Unpack the contents of the downloaded archive file into the created folder. Make sure that the unpacking tool preserves the file permissions.

  4. Start ARIS Connector for SAP Solutions in console mode to test the installation.

    Depending on your operating system, open a command prompt window with administrator privileges or a Linux terminal in the <ARIS Connector for SAP Solutions installation directory>\bin folder.

  5. Execute the startup.bat or the startup.sh script.

    If ARIS Connector for SAP Solutions does not start due to port conflicts, change the port number in the ConnectorConfiguration.json file (<ARIS Connector for SAP Solutions installation directory>\conf).

    ARIS Connector for SAP Solutions is running. Error messages are prompted because the connector is not yet configured.

  6. Confirm that the connector is installed. You must confirm before the preferred upgrade date. SAG ARIS GmbH performs the upgrade on the agreed date and provides the corresponding information by the support ticket.

    Note that in your upgraded version, you cannot use SAP synchronization until you migrated your solution configurations in ARIS Architect.

  7. To configure a connection to ARIS, 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.

    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",
"clientCredentials" : "password_set_with_configure_connector"

      Warning

      For security reasons, you must not specify the clientCredentials you copied from ARIS Architect. Encrypted credentials will be generated and specified using the command line interface.

    1. Save the file.

    2. Configure a connection to the SAP system. Open the <ARIS Connector for SAP Solutions installation directory>\conf\UpdateSAPConfiguration.json file in a text editor. The parameters are described in the UpdateSAPConfiguration.md file. Do not edit the SAPConfiguration.json file.

      No values are specified:

      "alias" : ""
"serverUrl" : "",
"user" : "",
"password" : "",
"client" : "",
"language" : "",
"allowUntrusted" : ""

    3. Specify all highlighted values, such as:

        "alias" : "SM01"

        Enter the name of the related SAP system. If you use multiple SAP systems, you must specify a unique alias value for each SAP system.

          "serverUrl" : "https://sapsolman72.us.co.abc:50001",

          Enter the SAP server URL to SAP Solution Manager 7.2. (Syntax: https://<solution manager server name>:<port>). You can retrieve the SAP server URL from the corresponding SAP System using the SCIF or the SOLDOC executables. Just copy the URL up to the port number.

            "user" : "ARIS_SAP_SYNC_USER",

            Enter the user name which is used to log on to the SAP® system.

              "password" : "password_set_with_configure_connector",

              Warning

              You must not specify the SAP password. Encrypted credentials will be generated and specified using the command line interface.

              "client" : "",

              Enter the number of the SAP® Client. The number can be obtained from your SAP® administrator. Optionally connects to a different SAP Client other than the default client. If you do not enter a number, you are connected to the default client.

                "language" : "E",

                Enter the code for the language that is used to log on to the SAP® system (E = English, D = German, or F = French).

                  "allowUntrusted" : "false",

                  Defines whether Allow untrusted server access is enabled (true) or disabled (false). You are required to enable Allow untrusted server access only if connections fail due to a security certificate error but you use https on a trusted server. Security certificate errors can occur if you use self-signed certificates.

                  1. 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 YourPassword YourPassword

                      Warning

                      While you are entering your password, it will be visible.

                    After you received your upgrade information, you must migrate your solution configurations.