Installing ARIS Server using an Oracle database

This procedure describes the installation on the active computer. To perform remote installations on Microsoft Windows machines, first run the ARIS Agent setup on the remote computers.

Prerequisites

Procedure

  1. Your database administrator must adjust the settings that are used by all database scripts. These scripts must be executed by the database administrator to setup the database as required.

    Edit the file envset.bat to specify the connection data of the Oracle instance. It's a good idea to write down values and credentials. They must be entered later during the ARIS Server setup process.

  2. Edit the envset.bat file and adjust the following lines replacing the highlighted parameters with the settings appropriate for your environment:

    REM The path to where sqlplus.exe can be found.

    SET CIP_ORA_BIN_PATH=<enter the path>

    REM hostname, port and service name

    SET TARGET_HOST=localhost

    SET TARGET_PORT=1521

    SET TARGET_SERVICE_NAME=ARIS

  3. Edit the following lines to change the highlighted credentials of the application user:

    REM credentials of the user that is used by the application.

    SET CIP_APP_USER=ARIS10

    SET CIP_APP_PWD=*ARIS!1dm9n#

    REM password of the tenant schemas.

    SET CIP_TENANT_SCHEMA_PWD=*ARIS!1dm9n#yy

  4. With the next two lines you specify the DBA user you intend to use to create the application user and this DBA user’s password:

    REM credentials of the Oracle user that will be used to create the application schema.

    REM Note that this user must be endowed with DBA privileges such as user SYSTEM.

    SET CIP_INSTALL_USER=system

    SET CIP_INSTALL_PWD=manager

  5. If your data tablespace name is different from ARISDATA respectively TEMP for temp tablespace, you will also need to modify these highlighted parameters accordingly:

    REM tablespace name of the tablespace in which the data of the application schema should be stored.

    SET CIP_TS_DATA=ARISDATA

    REM name of the temporary tablespace.

    SET CIP_TS_TEMP=TEMP

  6. Save the envset.bat file. So you can use it for future update setups again.

  7. Run the script cip_create_app_user.bat.

    This will create the application user. The application user (CIP_APP_USER) is the Oracle user connecting ARIS and the Oracle database. The default user name is ARIS10. But you may have changed that name in the envset.bat earlier.

  8. Create an empty schema for each tenant. Two schemes are mandatory. One for the master tenant and one for the default tenantdefault tenant. The names, for example, aris_master and aris_default can be modified. Write down the tenant names. These names must be entered later during the ARIS Server setup process. If you need additional tenants, you must create additional schemes.

    To create the schema objects, run these commands for each schema name aris_master, aris_default and additional tenants.

    Run the script cip_create_schema_for_tenant.bat and pass the schema name as parameter, for example:

    cip_create_schema_for_tenant.bat aris_master (mandatory)

    cip_create_schema_for_tenant.bat aris_default (mandatory)

    cip_create_schema_for_tenant.bat <oracle schema name for additional tenant> (optional)

    If you are going to create additional tenants for ARIS10.0 to migrate data from ARIS 9.8.7 or later, make sure to use identical names in both ARIS versions. If the schema already exists it will be dropped and recreated.

    If you use an external database management system and you have created empty schemes for additional tenants, you must assign additional tenants to these schemes after the ARIS Server setup is completed. The default tenant and the master tenant were assigned automatically.

  9. Run the ARIS Server setup.exe (see Windows setups\ARIS_Server) as an administrator.

  10. Install ARIS on the active computer and use the default agent user credentials. You will change them in one of the following steps. This is to prevent unauthorized access to the system.

  11. Select ARIS Server to be installed.

  12. Select ARIS Aware. This will activate the dashboarding runnable and provide dashboards. If you do not select this option, the runnable will be installed but not activated.

  13. Select ARIS Risk and Compliance if you want to install this program as well. The ARIS Risk and Compliance installation procedure is described in the ARIS Risk and Compliance Installation Guide. Documents are available in the Documents folder and can be downloaded from Empower or from the ARIS Download Center.

  14. Select the installation directory if required.

  15. Only if you need to specify an external proxy server IP address for incoming requests enter the proxy server computer name or IP.

  16. Change the ARIS Agent user credentials to prevent unauthorized access to your ARIS system. Make sure to store the credentials on a save place. If you forget the credentials, you can no longer update the system or modify the configuration.

  17. If you change the credentials, you will be further on prompted to enter that password you've chosen whenever you start/stop the ARIS Server or access your ARIS installation using ARIS Cloud Controller.

  18. If the ports 80 or 443 are already in use, specify the load balancer port numbers to be used. If you change the default port numbers, users must ad :<this port number> to the URL (see below).

  19. To force secure connections (HTTPS), uncheck HTTP port. If you do so, make sure to make a valid TLS server certificate available.

  20. Select the suitable system settings option. You need to take the RAM required and the number of users who will be accessing the ARIS Server into account. For a productive system it is recommended to select the Medium or Large option.

    The Demo scenario option is recommended for demonstration purposes (laptop) only.

    Warning

    If the hardware does not fit the system requirements, a warning is prompted. In this case do not proceed the setup. Otherwise, ARIS might not work reliably.

  21. To import the ARIS license file, enable Import now, click Select file..., and navigate to the license archive file. Otherwise, licenses must be imported after the installation.

    Make sure this file contains the required ARIS Server license. The functional range depends on the server license that you have purchased (see ARIS Functional Product Matrix contained in the downloaded ARIS installation package, ARIS Download Center, or Empower).

  22. Select Oracle.

  23. Select the required JDBC driver for the Oracle database management system.

  24. Enter the connection parameters used in the envset.bat file and exactly the values used by the Oracle server.

    The values shown are the default values used in the envset.bat file and the default parameters used when setting up the Oracle server.

    Enter exactly the values used by the Oracle server, for example, database name. Use the default schema's name and the master schema's name that have been created earlier.

    • Server: Fully qualified name or IP address of the Oracle server.

    • Port: Specify the port number addressing the Oracle server instance running over TCP. The corresponding line in the envset.bat file is SET TARGET_PORT=1521.

    • Database/Service name: Specify the Oracle SID or Oracle service name. The corresponding line in the envset.bat file is SET TARGET_SERVICE_NAME=ARIS.

    • Application user: Login user name that is used by the application. The corresponding line in the envset.bat file is SET CIP_APP_USER=ARIS10.

    • Password: The application user's password. The corresponding line in the envset.bat file is SET CIP_APP_PWD=*ARIS!1dm9n#. Enter the schema names exactly in the way as they have been created earlier.

    • Master schema: Schema name for the master tenant and user name for that schema's owner. Enter exactly the name used when you have created the schema, for example, aris_master (see step Create an empty schema for each tenant).

    • Default schema: Schema name for the default tenant and user name for that schema's owner. Enter exactly the name used when you have created the schema, for example, aris_default (see step Create an empty schema for each tenant).

      If you want to use an Oracle cluster you must change the connection URL as required: syntax: jdbc:oracle:thin:@<ORACLE_SERVER>:<ORACLE_PORT>:<ORACLE_SID>. If you need to adapt the connection URL later, you can update the external service.

  25. Enter the SMTP mail processing parameters of an existing account.

    Warning

    If you don't, ARIS will not send any notifications, due to the missing mailing functionality.

    But you can configure SMTP mail processing at any later point of time. Some parameters can also be managed using the ARIS Administration of this server. Please refer to the online help of ARIS Administration.

  26. Activate Use TLS/SSL encryption to prevent password sniffing.

  27. Only if your mail server requires SMTP authentication, select the option SMTP authentication and enter the user credentials.

    Warning

    If you enter these parameters but your mail server does not require SMTP authentication, the connection will be rejected.

  28. If you are about to use a proxy server, enter all proxy processing parameters. You can also enter them later, using the ARIS Administration of this server. Please refer to the online help of ARIS Administration.

    You can specify a URL to be used for validating the proxy server settings.

  29. Select the start option:

    Select Start automatically if you want to have the server started up with every restart of your operating system.

    Select Start manually if you want to start/stop the server on the active computer manually.

  30. Start the installation process. If you have changed the ARIS Agent's default user credentials during this procedure, you will be prompted for that password you have chosen.

    You might want to modify the shortcut (Start > All Programs > ARIS > Administration >...). However, that bears the risk of a stolen password.

The installation process takes some time. You can change settings entered during the setup process. Use the reconfigure ACC command to change settings, such as ports, such as ports. After the ARIS Server installation has completed, you must check the installation and configure the system.

To ensure optimum performance when you are using ARIS with an Oracle database, we recommend that you recalculate the database statistics regularly.