Specify options

Specify the connection parameters for the relevant SAP systems.

Procedure

  1. Start ARIS Architect.

  2. Click ARIS > Options. The Options dialog opens.

  3. Click SAP® options > Select server on the Selection tab.

  4. Disable the Use default server for running executable check box, if you want to use the server that is entered in the SAP Server system attribute each time you run an executable. If this attribute is not specified, the default server is used.

  5. Click SAP® options > Solution Manager on the Selection tab.

  6. Enable the Run executables with SAP® Solution Manager check box.

  7. Due to security reasons, enable the ARIS server option to connect to the SAP system.

    Warning

    You must not use the ARIS Architect option to synchronize productive data, such as large SAP projects containing a high number of documents. This carries a high risk that the resulting data will be inconsistent if connection problems have occurred.

  8. Select the ARIS server option if you are using a private cloud or you have installed ARIS server and you are using ARIS download client or locally installed ARIS clients. If a connection fails because of firewall restrictions or a VPN tunnel cannot be established, you must install 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.

    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

    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. You have received information on how to register and download the installation package from Software AG or your local Software AG sales organization. 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.

      1. Create a subfolder as an installation directory, such as C:\SoftwareAG\acc4sap.

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

      2. Unpack the contents of the downloaded archive file into the created folder.

      1. Create a folder as an installation directory, such as /opt/acc4sap. Avoid spaces in the folder name.

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

    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.

      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. In the Start tab bar, click New New > Connector.

      5. Enter the name of the connector.

      6. Enter a description text, to provide more details if required, and click OK. The connector is created and a dialog is displayed, showing the credentials that you must pass on later as an encrypted value.

      7. Click Copy credentials and close the dialog. You must later encrypt and specify the credentials using the command line interface. You can copy the credentials any time.

        We recommend that you paste the credentials into a text file. This speeds up the configuration and encryption process as described later in this procedure.

      The connector is created and listed in ARIS Architect. In ARIS Administration, the connector is represented as an application of the ARIS Connector for SAP Solutions scope.

      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.

      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.

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

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

      To add the missing credentials, you must encrypt and submit the credentials. These credentials are the clientCredentials value missing in the UpdateARISConfiguration.json file and the password value missing in the UpdateSAPConfiguration.json file.

      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 ******** ********

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

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

    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.

      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.

    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.

    You can install ARIS Connector for SAP Solutions as a Windows service.

    Procedure

    1. In the file browser, navigate to the ARIS Connector for SAP Solutions installation directory, such as C:\SoftwareAG\acc4sap\bin.

    2. Open a command prompt box with administrator privileges.

    3. Enter .\wrapper.bat install. The ARIS Connector for SAP Solutions service is installed. The startup type is Automatic. The service is not started. To start the service, run .\startup.bat from the command line.

    ARIS Connector for SAP Solutions is running and installed as a service.

    To stop the service, run .\shutdown.bat from the command line. To remove the service, run .\wrapper.bat remove.

    If you run ARIS Connector for SAP Solutions as a Linux daemon, ARIS Connector for SAP Solutions starts automatically when Linux starts.

    1. Open a terminal in the <ARIS Connector for SAP Solutions installation folder>/bin directory.

    2. Run sudo .\wrapper.sh install. The ARIS Connector for SAP Solutions daemon is installed. The daemon is configured to start automatically when the Linux system is started. The daemon is not started.

    3. To start the daemon, run .\startup.sh from the terminal.

    4. To stop the daemon, run .\shutdown.sh from the terminal.

    5. To remove the daemon, run sudo .\wrapper.sh remove.

    ARIS Connector for SAP Solutions runs as a Linux daemon.

    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.

    Project managers must create solution configurations so that all functions for exchanging data between ARIS and SAP® Solution Manager 7.2 are available to the users. All data transfer options are defined in these configurations for each branch of an SAP® solution. Users can change options only if you allow changes in the configuration.

    The way you create solution configurations depends on how data is transferred between ARIS and the SAP® Server. You can create solution configurations for ARIS Architect where data is transferred via HTTP. If you use ARIS in a cloud scenario, e.g. ARIS Enterprise edition, ARIS Connector for SAP Solutions is required to exchange data without a VPN connection.

    Prerequisite

    • You are a configuration administrator for this tenant.

    • If you are using ARIS in a cloud scenario, ARIS Connector for SAP Solutions must be started.

    Procedure

    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. Create a solution configuration used in ARIS Architect or in a cloud scenario.

      1. Open the folder Group SAP > Solution configurations (SAP Solution Manager 7.2).

      2. In the Start tab bar, click New New > SAP® Server. The Register SAP® Server dialog opens.

      3. Enter the server name to be displayed in the solution configuration.

      4. Enter the URL (syntax: https://<solution manager server name>:<port>), for example, https://sapsolman72.us.co.abc:50001.

        You can retrieve the URL from the corresponding SAP System using the SCIF or the SOLDOC executables. Just copy the URL up to the port number.

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

      6. If you use a proxy server, enter the parameter.

      7. Activate the Allow untrusted server access only if you use https on a trusted server and the certificate is unknown.

      8. Click OK. The SAP® Server is displayed in the table and in the navigation tree.

      9. Select the SAP® Server, and click New New > Solution. If you are not logged on, the SAP® logon dialog opens.

      10. Enter the credentials and select the language to be used for the transferred items in ARIS.

      11. Click OK. The Add solution dialog opens.

        You can also import the related solution configuration or restore it from n ARIS database you are logged in.

        You can import configurations from an XML file to make them available on other tenants.

        Prerequisite

        Procedure

        1. Open the solution configuration in ARIS Architect.

          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 Group SAP > Solution configurations (Solution Manager 7.2) folder. If you use ARIS Connector for SAP Solutions, open the Group SAP > ARIS Connectors for SAP Solutions folder. All registered SAP® Servers are displayed.

          4. Open the SAP® Server structure in which the solution is managed. The configurations on this SAP® Server are displayed.

        2. Select the SAP® Server or solution.

        3. Click Import Import in the Start tab bar. The Open dialog opens.

        4. Select the XML file in which the project configuration was previously exported.

        5. Click Open.

        The configuration was imported.

        You must activate the configuration to ensure that the defined functions are available to users.

        You can restore solution configurations that have been deleted.

        Prerequisites

        Procedure

        1. Open the solution configuration in ARIS Architect.

          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 Group SAP > Solution configurations (Solution Manager 7.2) folder. If you use ARIS Connector for SAP Solutions, open the Group SAP > ARIS Connectors for SAP Solutions folder. All registered SAP® Servers are displayed.

          4. Open the SAP® Server structure in which the solution is managed. The configurations on this SAP® Server are displayed.

        2. Click New New > SAP® system if the required SAP® Server is not listed.

        3. Select the SAP server icon SAP® Server or solution and click Resume Restore in the Start tab bar. The Restore configuration dialog opens.

        4. Select the database in which the branch is managed and select the configuration you wish to restore.

          You only need to select the database if you are logged into several databases for which configurations can be restored.

        5. Select the start object of the project or solution.

        6. Click OK. The SAP® logon dialog opens.

        7. If required, enter your login data, and click OK.

        The configuration has been restored.

        Activate the configuration.

      1. Open the folder Group SAP > ARIS Connectors for SAP Solutions. The connectors are displayed in the table and in the navigation tree.

      2. Select the connector, click the SAP server icon SAP® Server, and click New New > Solution. The Add solution dialog opens after ARIS Connector for SAP Solutions has retrieved all available solutions.

        You can also import the related solution configuration or restore it from n ARIS database you are logged in.

        You can import configurations from an XML file to make them available on other tenants.

        Prerequisite

        Procedure

        1. Open the solution configuration in ARIS Architect.

          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 Group SAP > Solution configurations (Solution Manager 7.2) folder. If you use ARIS Connector for SAP Solutions, open the Group SAP > ARIS Connectors for SAP Solutions folder. All registered SAP® Servers are displayed.

          4. Open the SAP® Server structure in which the solution is managed. The configurations on this SAP® Server are displayed.

        2. Select the SAP® Server or solution.

        3. Click Import Import in the Start tab bar. The Open dialog opens.

        4. Select the XML file in which the project configuration was previously exported.

        5. Click Open.

        The configuration was imported.

        You must activate the configuration to ensure that the defined functions are available to users.

        You can restore solution configurations that have been deleted.

        Prerequisites

        Procedure

        1. Open the solution configuration in ARIS Architect.

          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 Group SAP > Solution configurations (Solution Manager 7.2) folder. If you use ARIS Connector for SAP Solutions, open the Group SAP > ARIS Connectors for SAP Solutions folder. All registered SAP® Servers are displayed.

          4. Open the SAP® Server structure in which the solution is managed. The configurations on this SAP® Server are displayed.

        2. Click New New > SAP® system if the required SAP® Server is not listed.

        3. Select the SAP server icon SAP® Server or solution and click Resume Restore in the Start tab bar. The Restore configuration dialog opens.

        4. Select the database in which the branch is managed and select the configuration you wish to restore.

          You only need to select the database if you are logged into several databases for which configurations can be restored.

        5. Select the start object of the project or solution.

        6. Click OK. The SAP® logon dialog opens.

        7. If required, enter your login data, and click OK.

        The configuration has been restored.

        Activate the configuration.

    4. Select the corresponding solution, and click OK. The solution is displayed in the table and in the navigation tree.

    5. Add the required branches of the solution.

      1. Select the solution, and click New New > Branch. The Add branch dialog opens.

      2. Select the branch.

      3. Select the required scope of the branch. If no scope is available in SAP Solution Manager, the value Default scope is selected. Default scope means, that the branch itself is used.

      4. Click OK. The selected scope of the branch is added. If you have selected a different scope as the Default scope, the scope name is added to the solution name to indicate the scoped content.

      5. Double-click the branch in the navigation tree. The Branch configuration tab is activated. The overview displays all pages to be processed. Define the settings for data transfer available for all authorized users.

      6. Select the available document types for the branch.

        1. Click Document types. The overview of settings is displayed.

        2. Click Edit Edit. The Assign document types dialog opens.

        3. If document types are not yet displayed, click Import document types. All document types created in SAP® Solution Manager are transferred and are available for this tenant.

        4. In the Available document types box, select all types.

        5. Transfer your selection to the Selected document types box using the arrow key.

        6. Select the required document types in the Selected document types box and transfer your selection to the Allow to delete in SAP box using the arrow key. Documents that are managed in ARIS and base on these types can be deleted in SAP Solution Manager, using the SAP synchronization.

        7. Click OK. The document types are included when creating documents and synchronizing documents.

      7. Select the options for transferring data from SAP® Solution Manager to ARIS.

        1. Click the Transfer data to ARIS page in the Navigation bar. The default options selected are displayed in a table.

        2. Click Edit Edit. The Synchronization Wizard starts.

        3. If you want to prevent users from selecting custom synchronization settings, disable the corresponding option on the Allow changes page.

          Always keep in mind whether ARIS or SAP Solution Manager was defined as leading system. To prevent data from being overwritten unintentionally during synchronization, make sure to only allow actions accordingly. This prevents data from being edited in both systems and changes from being overwritten (see Security advice).

        4. Click Next, and select the settings for data synchronization of structural elements on the Transfer structural elements page.

        5. Click Next, and select the settings for data synchronization of executables on the Transfer executables and interfaces page.

        6. Click Next, and select the settings for data synchronization of process diagram variants on the Transfer models page.

        7. Click Next, and select the settings for data synchronization of deleted elements on the Delete elements page.

        8. Click Next, and select the settings for data synchronization of documents, master data, and organizational units on the Transfer assignments page.

        9. Click Next, and select the settings for data transfer of end user roles on the Transfer end user roles page.

      8. Select the options for transferring data from ARIS to SAP® Solution Manager.

        1. Click the Transfer data to SAP® Solution Manager page in the Navigation bar. The default options selected are displayed in a table.

        2. Click Edit Edit. The Synchronization Wizard starts.

        3. If you want to prevent users from selecting custom synchronization settings, disable the corresponding option on the Allow changes page.

          Always keep in mind whether ARIS or SAP Solution Manager was defined as leading system. To prevent data from being overwritten unintentionally during synchronization, make sure to only allow actions accordingly. This prevents data from being edited in both systems and changes from being overwritten (see Security advice).

        4. Click Next, and select the settings for data synchronization of structural elements on the Transfer structural elements page.

        5. Click Next, and select the settings for data synchronization of executables and the settings for the transfer of documents on the Transfer executables, documents, and interfaces page.

        6. Click Next, and select the settings for data synchronization of process models on the Transfer models page.

          Warning

          The target diagram type that you selected for the first model transfer defines the diagram type used in the SAP system. After the initial model transfer the target diagram type cannot be changed. If you change the target diagram type for another model transfer, this setting is ignored.

        7. Click Next, and select the settings for data synchronization of deleted elements on the Delete elements page.

        8. Click Next, and select the settings for data transfer of end user roles on the Transfer end user roles page.

        9. Click Next, and select settings on the Transfer model links page.

      9. Select the method configuration for the branch.

        1. Click Method configuration. The overview of settings is displayed.

        2. Click Edit Edit. The Edit method configuration dialog opens.

        3. Enable the Use method configuration check box and click Method configurations. The Method Configuration Wizard opens.

        4. Select the relevant symbol and model types, the allocation diagrams, and the BPMN lane assignment on the Blueprint page to map the Business Blueprint structure. You cannot change the Function object type.

        5. Click Next, and select the required object, symbol, and connection types to map the items that are managed in the Master data and Organizational units folders in the SAP® system.

        6. Click Next, and select the required object, symbol, and connection types to map the items that are managed on the End user roles tab in the SAP system.

        7. Click Next, and select the required object, symbol, and connection types to map the items that are managed on the listed tabs in the SAP system - General documentation, Project documentation, Test cases, and Training documentation.

        8. Click Next, and select the required object, symbol, and connection types to map the items that are managed on the System landscape tab in the SAP system.

        9. Click Next and verify your settings.

        10. Click Finish. The method configuration is created. This configuration is now applied whenever you download the SAP® synchronization for this project.

        11. Check the method configuration using a backed up database to rule out the possibility of unwanted changes.

      10. Select the attribute assignment for the branch.

        1. Click Attribute assignment. The overview of settings is displayed.

        2. Click Edit Edit.

        3. Click Import SAP® attributes.

          The SAP® attributes column displays all attributes of the registered SAP® default server that are assigned in SAP® Solution Manager. Attributes transferred earlier are now updated. Only text, single, and multi-value attributes are transferred.

          The Data type column shows data types maintained for customer attributes. Customer attributes with Undefined data type cannot be assigned to ARIS attributes. Attribute values can be specified only for customer attributes of the Value data type. If required, create new attributes to be used for the assignment.

        4. Click Customer attributes if a data type for a required attribute is undefined. The Manage Customer attributes dialog opens.

        5. Move to the row of the required attribute, click Down arrow, and select the data type.

        6. Click OK to return to the Edit attribute assignment dialog.

        7. Click (...) in the ARIS attributes column, and select the attribute to be used for the corresponding SAP® attribute.

          Ensure that the attributes are properly assigned. Assigning an SAP® attribute to different ARIS attributes is not allowed. If required, create new attributes with single values or multi-line text attributes to be used for the assignment. You can assign only ARIS attributes that are not used by SAP, such as SAP ID.

          The Valid for column lists the SAP item types the attribute is valid for. This information is required to correctly assign attributes. Only attributes that match the related ARIS object types are shown. This means that you only see attributes, for example, for Screen objects, if the SAP attribute is only available for executables. ARIS attributes for Function and Information carrier objects are listed if the SAP attribute is available for structural items and documents.

          For executables, interfaces, and documents, customer attributes can be transferred from the SAP system to ARIS and vice versa. Attributes for Screen and Information carrier object types can be assigned. This means you must use the same ARIS attributes for all objects if the objects share the same attribute in SAP Solution Manager. If an incorrect attribute assignment is made, for example, an ARIS attribute valid only for Screen objects is assigned to a SAP attribute that is only valid for structural elements, the attribute assignment is ignored by the SAP synchronization.

          Best practice is to define individual ARIS attributes and assign them to exactly the object types that match the attribute-carrying items in SAP Solution Manager. Customer attributes are not supported for diagrams and roles.

        8. If you have assigned Value attributes, click Customer attributes to assign customer attribute values. The Manage Customer attributes dialog opens.

        9. Click the related Browse button (...) in the Customer attribute value column. The Assign customer attribute values dialog opens.

        10. Click (...) in the Customer attribute values column. The Assign customer attribute values dialog opens.

        11. Click Add attribute value and enter a customer attribute value key and the related customer attribute value.

        12. Click OK. The added attribute is displayed.

        13. Click OK to return to the Edit attribute assignment dialog.

        14. Click OK. The attributes are assigned. These attributes are transferred during the SAP® synchronization.

    6. Activate the solution configuration.

      1. Select the Locked branch configuration locked configuration in the table.

      2. Click Activate Enable/Disable branch for synchronization.

      The configuration is enabled for synchronization. Active configurations are indicated by this symbol Enabled configuration. When Active, users can transfer contents between ARIS and SAP® Solution Manager.

    The solution is available to users for transferring data between ARIS and SAP® Solution Manager.

    You can customize the selected options at any time or lock the configuration.

    You can restore solution configurations that have been deleted.

    Prerequisites

    Procedure

    1. Open the solution configuration in ARIS Architect.

      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 Group SAP > Solution configurations (Solution Manager 7.2) folder. If you use ARIS Connector for SAP Solutions, open the Group SAP > ARIS Connectors for SAP Solutions folder. All registered SAP® Servers are displayed.

      4. Open the SAP® Server structure in which the solution is managed. The configurations on this SAP® Server are displayed.

    2. Click New New > SAP® system if the required SAP® Server is not listed.

    3. Select the SAP server icon SAP® Server or solution and click Resume Restore in the Start tab bar. The Restore configuration dialog opens.

    4. Select the database in which the branch is managed and select the configuration you wish to restore.

      You only need to select the database if you are logged into several databases for which configurations can be restored.

    5. Select the start object of the project or solution.

    6. Click OK. The SAP® logon dialog opens.

    7. If required, enter your login data, and click OK.

    The configuration has been restored.

    Activate the configuration.

    If you no longer want to mange your SAP Solutions using solution configurations in ARIS Architect, you can force the solutions to be handled by ARIS Connector for SAP Solutions. Make sure that only one configuration is available, either in the Group SAP >Solution configurations (Solution Manager 7.2) folder or in the Group SAP > ARIS Connectors for SAP Solutions folder.

    Prerequisite

    Procedure

    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 Group SAP > Solution configurations (Solution Manager 7.2) folder.

    4. Open the SAP server icon SAP® Server structure in which the solution is managed. The solution configurations for this SAP® Server are displayed.

    5. Delete the related SAP® Server. This removes all contained solution configurations.

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

    7. Select the SAP server icon SAP® Server or solution and click Resume Restore in the Start tab bar. The Restore configuration dialog opens.

    8. Select the database in which the branch is managed and select the configuration you wish to restore.

    9. Restore the configurations in turn.

      Do not use the Import functionality to restore configurations in ARIS Connector for SAP Solutions using solution configurations exported from the Solution configurations (Solution Manager 7.2) folder.

    The solutions are available to users for transferring data between ARIS and SAP® Solution Manager 7.2. SAP credentials are no longer required because authentication is handled by ARIS Connector for SAP Solutions.

    You can also migrate vice versa and use Solution configurations (Solution Manager 7.2) instead of ARIS Connector for SAP Solutions.

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

    You can use the command line interface to do the following:

    • Change the SAP password in the UpdateSAPConfiguration.json file.

    • Change the credentials in the UpdateARISConfiguration.json file.

    • Test the configuration.

    • Activate configurations (Update).

    Start the command line interface using the configureConnector.bat or configureConnector.sh script. The scripts are located in the <ARIS Connector for SAP Solutions installation>\bin\ directory.

    The UpdateSAPConfiguration.json and UpdateARISConfiguration.json files are located in the <ARIS Connector for SAP Solutions installation>\conf\ directory. The parameters are described in the corresponding .md files.

    Warning

    Do not edit the SAPConfiguration.json and ARISConfiguration.json files located in the <ARIS Connector for SAP Solutions installation>\conf\ directory. You can check and update these files only using the command line interface.

    The ConnectorConfiguration.json file contains start parameters for ARIS Connector for SAP Solutions. You can change settings manually, such as the port number. Changes made in this file require an ARIS Connector for SAP Solutions restart.

    Command line help

    -h,--help Print usage instructions and exit.

    -? Print usage instructions and exit.

    -v Print version number and exit.

    -pwd,--password <arg> Change password for SAP system alias and SAP system user.

    Password is needed twice (password and confirmation).

    -crd, --credentials <credentials> Change credentials.

    -chk,--check-configurations Check configurations.

    -upd,--update-configurations Update configurations.

    -sys,--system <arg> Specify SAP system alias.

    -usr,--user <arg> Specify SAP system user.

    User actions

    • Print help: configureConnector -h

    • Print version number: configureConnector -v

    • Change SAP system password: configureConnector -sys <sap_system> -usr <name> -pwd [<password> <password_conformation>]

    • Change ARIS credentials: configureConnector -crd <credentials copied from ARIS Architect>

    • Check current configurations: configureConnector -chk

    • Update current configuration(s), that is, reload current configuration file(s): configureConnector -upd

    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.

    Note that using ARIS Architect for accessing SAP systems in local or private cloud scenarios is not recommended and must not be used for synchronizing productive data. If the connection breaks down, this will result in inconsistent data. If your company has a strict network separation within the own environment, you can select the ARIS Architect option for test purposes or to synchronize a small number of data only. Only if you currently use a public cloud surrounding and you want to expand to ARIS Advanced, you can select the ARIS Architect option to test the SAP synchronization.

  9. Click OK.

Options are specified.