Skip to main content

ARIS Technical Help

Install and configure ARIS Connector for SAP Solutions

If you are using ARIS in a cloud scenario, such as ARIS Enterprise edition, you must install ARIS Connector for SAP Solutions to exchange data between ARIS and SAP® Solution Manager 7.2 without a VPN connection.

You must install the ARIS Connector for SAP Solutions connector on a server in the company network. The server must be permanently available. Never install the ARIS Connector for SAP Solutions connector on an end-user computer. Due to its small footprint, you can also install the connector on an existing computer. A dedicated server just for the connector is not required.

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).

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. Install ARIS Connector for SAP Solutions either on a Windows or Linux operating system.

  3. Create an ARIS Connector for SAP Solutions in ARIS Architect, copy the credentials, and paste them into a text file. You will need to paste them later for encryption.

    After you have installed ARIS Connector for SAP Solutions and copied the credentials from ARIS Architect, you must specify basic connection parameters before you start ARIS Connector for SAP Solutions for the first time. You can find the configuration files in the <ARIS Connector for SAP Solutions installation directory>\conf folder.

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

    1. To do so, 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.

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

      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).

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

  5. Configure a connection to ARIS.

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

      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.

    3. Save the file.

  6. Configure a connection to the SAP system.

    1. 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" : ""
      
    2. 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.

      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>), for example, https://sapsolman72.us.co.abc:50001.

      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",
      

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

          "password" : "password_set_with_configure_connector",
      

      You must not specify your 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",
      

      Code for the language that is used to log on to the SAP® system.

      Examples

      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.

    3. Save the file.

  7. Encrypt the missing credentials.

    All required connection parameters and encrypted credentials are specified in the configuration files. Finally, you must update the ARISConfiguration.json and SAPConfiguration.json files on the command line.

    You must not edit the ARISConfiguration.json and SAPConfiguration.json files manually.

    To update the configuration, in the command prompt window or a Linux terminal that you opened earlier, enter: .\ConfigureConnector.bat -upd or ./ConfigureConnector.sh -upd.

    All entries are checked and configuration files are updated. If any issues occurred, the command line interface shows error messages. The links lead you to the problem solution.

  8. Update the configuration.

    All required connection parameters and encrypted credentials are specified in the configuration files. Finally, you must update the ARISConfiguration.json and SAPConfiguration.json files on the command line.

    You must not edit the ARISConfiguration.json and SAPConfiguration.json files manually.

    To update the configuration, in the command prompt window or a Linux terminal that you opened earlier, enter: .\ConfigureConnector.bat -upd or ./ConfigureConnector.sh -upd.

    All entries are checked and configuration files are updated. If any issues occurred, the command line interface shows error messages. The links lead you to the problem solution.

ARIS Connector for SAP Solutions is running and the connections are set and tested. 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 ARIS Connector for SAP Solutions is not yet available in ARIS Architect, check the status of the connector, review the logged messages, or refresh (F5) the view. Use the connector to create solution configurations or restore them from a related ARIS database. You can migrate solution configurations to be used with ARIS Connector for SAP Solutions or vice versa.

If your ARIS Connector for SAP Solutions configuration requires changes, use the ConfigureConnector.bat or ConfigureConnector.sh script to start the command-line interface.