Performing a GUI-based installation

You can install the software by using the IBM Installation Manager. If you have not yet downloaded IBM® Installation Manager, the installation will check for this and automatically offer to download Installation Manager for you.

1. Close all open programs and any command prompt windows.
2. From the folder location of your downloaded product files, enter the following command:
   • For installation in English language: InstallerImage_<OS>/userinst.exe

     Example: InstallerImage_AIX/userinst.exe

     For installation in another, supported language: InstallerImage_<OS>/userinst.exe -nl <locale_code>
     Example: InstallerImage_AIX/userinst.exe -nl fr_CA

   • For installation in English language: InstallerImage_<OS>/userinst
     Example: ./InstallerImage_AIX/userinst

     For installation in another, supported language: ./InstallerImage_<OS>/userinst -nl <locale_code>
     Example: ./InstallerImage_AIX/userinst -nl fr_CA

3. Review the installation packages to be installed.
4. Review and accept the license agreement.
5. Accept the default location for the shared resources directory, or browse to a new location.
6. Accept the default location for Installation Manager directory, or enter a different location.
7. Review and accept the package group to be installed and the installation directory, or browse to a new location.
8. Select the languages for which you want to install the Sterling Order Management System Software language pack translations.
   Note: By default, the English language is selected.

   Important: To perform a traditional installation, continue with steps 9-19.

   To set up a runtime for generating Docker images, follow steps 20 - 27. Setup Runtime for Docker Image Build is supported only on UNIX.

9. Select the appropriate features to install.
   1. By default, the Product Files feature is selected.
   2. Select Enable Sharded Database Mode if you plan to use a sharded database mode.
      Note: Sharded Database Mode is supported in Sterling Order Management System Software version 10.0 Fix Pack 7, or later.
   3. Select Enable Upgrade if you are upgrading from a previous release or if you are doing a new installation, but want to apply DDL manually after installation.
   4. Select Install Reference Implementation if you are planning to install reference implementation.
      Note: If you choose to Install Reference Implementation, then you must perform the steps mentioned in Install all the Reference Implementation components on Windows
10. By default, the option to copy JDK to your installation directory is selected. If you do not want to copy JDK to your installation directory, clear the check box and enter the location and name of the JDK home directory. Copy the following jars to the <JAVA_HOME>/jre/lib/endorsed directory.
    • serializer.jar
    • xalan.jar
    • xercesImpl.jar
    • xml-apis.jar

    These jars are included in the Sterling Order Management System Software software installer image. If the endorsed directory is not present in <JAVA_HOME>/jre/lib, create a new directory and name it endorsed. Copy the jars to the endorsed directory, and proceed with your installation.
11. If you select Enable Sharded Database Mode in step 9, perform this step. Otherwise, skip this step and go to step 12.

    In the Sharded Database Properties screen, configure your schemas.

    1. To use more than one database vendor for your schemas, select the Enable mixed database vendor support checkbox. Otherwise, select the database vendor that you want to use for your schemas in the Database Vendor dropdown. You can select either Db2 or Oracle.
    2. For each database vendor, click Add Jars to browse to the JDBC driver file. If you are using mixed database vendors, you might need to add more than two drivers. Repeat to add the license file for Db2 (required).
    3. Configure connection data for the Metadata, Statistics, Configuration, Master, and Transaction shards by clicking the corresponding Configure buttons. The connection information window opens where you configure the following connection data for the shard:

       Select the Reuse existing database shard configuration button to reuse an existing configuration for the shard or the Create new database shard configuration button to configure new connection information for the shard. If you select the Reuse existing database shard configuration button, the corresponding dropdown displays existing database shard configurations that you can select for the shard's connection data. If you select Create new database shard configuration, you must configure the following database information for the selected schema:

       Note: The Transaction and Master database shard configuration must have the same connection data.

       • Database Vendor ( If you are using mixed database vendors, pick the database vendor type for each connection)
       • Database user name
       • Database password/Confirm database password
       • Database catalog name
       • Database host name (or IP address)
       • Database port number
       • Database schema name
         Note: The default schema names are always the same as the user name, except that the schema names are all uppercase.
       For each shard, you can test the connection to the database by clicking Validate Connection. If a message saying the connection failed is displayed, verify the information you entered in all fields and try validating again.

       Note: The Validate Connection option does not work when the ojdbc8.jar is used as an Oracle driver.
12. If you selected Enable Sharded Database Mode in step 9, skip this step. If you did not select Enable Sharded Database Mode in step 9, perform this step by entering the following information in the Database Information screen:
    • Database Vendor
    • Database user name
    • Database password/Confirm database password
    • Database catalog name
    • Database host name (or IP address)
    • Database port number
    • Database schema name
    • Database driver jars. For example, add the corresponding database driver jars based on the database vendor selected.
      Note: The default schema names are always the same as the user name, except that the schema names are all uppercase.
13. Based on the Database Vendor that you selected in the Database Information screen, perform one of the following steps in the Database Details screen and then click Next.
    • If you have chosen Db2 as your database vendor, select Enable database multibyte support if required.
    • If have chosen Oracle, there are no additional database properties to configure.
14. If you want to manage the properties in the database, select Enable database property management in the Additional configuration screen, and then click Next.
15. In the Memory Arguments screen, enter the ADDITIONAL_ANT_JAVA_TASK_ARGS and ADDITIONAL_ANT_COMPILER_TASK_ARGS memory parameter settings for your operating system.
16. Review the summary and then click Install to start the installation.
    A progress bar is displayed at the bottom of the screen.
17. When the installation is complete, a status screen is displayed. Click Finish.
    You can also view the installation log from this screen.

    Note: If the installed_data directory is not removed by the post installation cleanup process, you can delete it. It is only used for installation.
18. Exit Installation Manager.
19. Continue to post-installation tasks and configuration procedures that you must complete before running the Sterling Order Management System Software software. For more information, refer Post installation section.
20. Select Setup Runtime for Docker Build and then click Next.
21. By default, the option to copy JDK to your installation directory is selected. If you do not want to copy JDK to your installation directory, clear the check box and enter the location and name of the JDK home directory. Copy the following jars to the <JAVA_HOME>/jre/lib/endorsed directory.
    • serializer.jar
    • xalan.jar
    • xercesImpl.jar
    • xml-apis.jar

    These jars are included in the Sterling Order Management System Software software installer image. If the endorsed directory is not present in <JAVA_HOME>/jre/lib, create a new directory and name it endorsed. Copy the jars to the endorsed directory, and proceed with your installation.
22. In the Memory Arguments screen, enter the ADDITIONAL_ANT_JAVA_TASK_ARGS and ADDITIONAL_ANT_COMPILER_TASK_ARGS memory parameter settings for your operating system. For more information, refer Memory parameter settings.
23. Select the Database Vendor. Click Add Jars, select the Database driver jars, and then click Next.
24. Review the summary and then click Install to start the installation.
    A progress bar is displayed at the bottom of the screen.
25. When the installation is complete, a status screen is displayed. Click Finish.
    You can also view the installation log from this screen.

    Note: If the installed_data directory is not removed by the post installation cleanup process, you can delete it. It is only used for installation.
26. Exit Installation Manager.
27. Continue to post-installation tasks and configuration procedures that you must complete before running the Sterling Order Management System Software software. For more information, refer Post installation section.