Omni-Gen™ Installer User's Guide > Installing Omni-Gen Server and Omni Governance Console on Windows Platforms > Installing the Omni-Gen Server and the Omni Governance Console

Installing the Omni-Gen Server and the Omni Governance Console

How to:

This section describes how to install the Omni-Gen Server and the Omni Governance Console (OGC).

Procedure: How to Install the Omni-Gen Server and the Omni Governance Console on Windows

This procedure assumes that a database server (for example, Microsoft SQL Server) and a repository server (for example, SVN) are already installed.

  1. Verify that the JAVA HOME environment variable (for Java Development Kit version 8) is defined properly and that %JAVA HOME%\bin is the first element in your PATH.
  2. Download the installer, TIB_og_mdm_3.16.0_win_x86_64.exe.

    Note: Omni-Gen Version 3.16 is packaged with iWay Data Quality Server (DQS) Version 12. When you download Omni-Gen from the edelivery.tibco.com site, you will receive a temporary key for the DQS software. If you need a permanent key, contact Customer Support.

  3. In the File Explorer, navigate to the downloaded TIB_og_mdm_3.16.0_win_x86_64.exe file, right-click this file, and select Run as administrator.

    The InstallAnywhere startup window appears.

    When the installation is ready to begin, the Introduction pane opens, as shown in the following image.

  4. Click Next.

    The Accept License Agreement pane opens, as shown in the following image.

  5. Read the License Agreement, select the I accept the terms of the License Agreement check box, and then click Next.

    The Choose Installation Folder pane opens, as shown in the following image.

  6. In the Where would you like to install field, specify a location (path) on your system where you want to install all of the required files for Omni-Gen.

    The installer will create a directory named OmniGen in the location you specified. For example, if you accept the default location as C:\, then the installer will install Omni-Gen to: 

    C:\OmniGen
  7. Click Next.

    The Choose Java Virtual Machine pane opens, as shown in the following image.

  8. Ensure that the Java version located is version 1.8 or higher, and then click Next.

    The Specify Base Port Number pane opens, as shown in the following image.

  9. Specifying a base port number automatically assigns a set of port numbers for use by Omni-Gen components, and is used when installing more than one instance of Omni-Gen on a single machine. If you are installing a second instance of Omni-Gen, or need to configure different ports to avoid conflicts with systems already deployed on your Omni-Gen host, then see your system administrator. Otherwise, click Next to continue.

    The Specify Hostname and Domain pane opens, as shown in the following image.

    The default host name is the machine on which you are currently installing.

  10. In the Domain field, type the host domain, and then click Next.

    The Configure Omni-Gen Repository Tomcat Ports pane opens, as shown in the following image.

  11. Verify the ports that are indicated by default and modify accordingly, if required.
  12. Click Next.

    The Specify Location of Omni-Gen Designer pane opens, which prompts for the parameters that define the location of Omni Designer, as shown in the following image.

  13. Accept the default parameters, and then click Next.

    The Specify Location of Source Control .jar Files pane opens, which prompts you to select a folder containing the Source Code Control System (SCCS) .jar files, as shown in the following image.

  14. Change the location of the SCCS .jar files, if necessary, and then click Next.

    If you have not created a folder for the SCCS .jar files, then the following message displays:

    If you receive this message, click Cancel and then create a new folder. Place the SCCS .jar files in that folder and click Choose in the Specify Location of Source Control .jar Files pane to navigate and select that new folder.

    The Select Source Code Control System and Location pane opens, as shown in the following image.

  15. Define the location and credentials for your source control repository by selecting either svn or git.
  16. Click Next.

    The Specify Location of JDBC .jar Files pane opens, as shown in the following image.

  17. Specify the location of your JDBC .jar files, and then click Next.

    The Configure Omni-Gen Server Databases pane opens, which provides an overview regarding Omni-Gen databases and configuration parameters, as shown in the following image.

  18. Review this information, and then click Next.

    The Select the DBMS type of the Remediation Database pane opens, as shown in the following image.

  19. Specify the database that you want to use for Omni-Gen Server (OGS) and the Remediation database.
  20. Click Next.

    The Enter OGS Database Parameters: Oracle, Postgres, Teradata pane opens, as shown in the following image.

  21. Specify the DBMS-specific parameters for the combined OGS and Remediation database, and then click Next.

    The Verify the Omni-Gen Master Database URL pane opens, as shown in the following image.

  22. Verify the database URL, ensure the Test Connection check box is selected, and then click Next.

    If you receive a message indicating that your connection test failed, verify that your database name exists in SQL (or the DBMS you are using).

    When your database exists and the user name, password, and host are correct, the following message appears, indicating that your connection test passed for the specified database.

  23. Click Next to continue.

    The Select the Data Quality DB's DBMS type pane opens, as shown in the following image.

  24. Select the DBMS type used for the Data Quality (DQ) database, and then click Next.

    The Enter DQ Database Parameters: Oracle, Postgres, Teradata pane opens, as shown in the following image.

  25. If you are using the same database for OGS, click Next, or type new parameters for the DQ database, and then click Next.

    The Verify the Data Quality Database URL pane opens, as shown in the following image.

  26. Verify the database URL, ensure the Test Connection check box is selected, and then click Next.

    If the test is successful, then the Data Quality Database Connection Test Passed pane opens, as shown in the following image.

    If the test is not successful, click Previous twice, correct the connection parameters, and retest the URL.

  27. Click Next.

    The Select the Omni-Gen Server Runtime Protocol pane opens, as shown in the following image.

  28. Select the HTTP or HTTPS protocol, and then click Next. The default value is HTTPS.

    The Verify the Omni-Gen Server Port Numbers pane opens for your selected runtime protocol, as shown in the following image.

  29. Accept the default values, but change them if the infrastructure manager informs you of a conflict and recommends changes to alternate available ports.
  30. Click Next.

    The Install the Controller as a Windows Service pane opens, as shown in the following image.

  31. Select whether you want to install the Omni-Gen Controller as a Windows service. The default value is No.

    Note: It is strongly encouraged that you select Yes for ease of administration. If you select Yes, you will be prompted for the service name. You may type the service name in the Controller Service name field, or accept the default value, OmniGen_omniController.

    The Verify the Omni-Gen Governance Console's Tomcat Parameters pane opens, as shown in the following image.

    The Hostname parameter defaults to the machine on which you are currently installing Omni-Gen.

  32. Accept the default values, and then click Next.

    The Configure OGC Email Server pane opens, as shown in the following image.

  33. Unless you are adding the email option, leave the parameter values blank, click Next, and proceed to the Preserve or Create New WSO2 Repository pane in the installer (skip to Step 35).
  34. To enable the email option, provide values for the following parameters as they apply to your SMTP, email server:
    • SMTP Host. Host name of your SMTP server (for example, smtp.ibi.com).
    • SMTP Port. SMTP port on that server (usually port 25).
    • Email Notification From. Email address from which the Assignment emails will originate (for example, OmniGen_Remediation@ibi.com).
    • SMTP Username. User name for accessing the email server.
    • SMTP Password. Password associated with the user name for accessing the email server.
    • SMTP SSL Enabled (true or false). Specify true if your email server supports or requires SSL authentication.

    In addition, each user who will receive email notifications must have a valid email address in their WSO2 user profile.

    • Each LDAP user with the Data Steward or Data Supervisor role, and who will receive Assignment emails, must have a valid email address in their Active Directory profile. When it makes the LDAP connection, WSO2 will bring back those email addresses to its Local User Store profile of the user.
    • Each hardcoded user in the WSO2 Primary domain must have an email in their WSO2 user profile.

    Following the Configure OGC Email Server pane, the Preserve or Create New WSO2 Repository pane opens, as shown in the following image.

  35. For new Omni-Gen installations, ensure that Yes is selected, and then click Next.

    The Verify the WSO2 parameters pane opens, as shown in the following image.

  36. Confirm the WSO2 parameters, and then click Next.

    The Enter WSO2 Certificate Parameters pane opens, as shown in the following image.

  37. Collect the parameters to generate the certificate for WSO2.

    The parameters are used to build a unique certificate to secure the Omni Governance Console to the WSO2 communication.

  38. Ensure that the address of your host is correct (not localhost), and then type values for the other parameters. For example:
  39. Click Next.

    The Verify or change JVM Memory Settings - MD pane opens, as shown in the following image.

  40. Change the values only if you are instructed by Customer Support, otherwise, click Next.

    The Pre-Installation Summary pane opens.

  41. Review all of the settings in the Pre-Installation Summary pane, and then click Next.

    The Ready To Install pane opens, indicating that the configuration for installation is complete.

  42. Click Install to proceed with installation.

    The Installing Omni-Gen pane opens, which displays the progress of the installation.

    The Executing Installation Script popup displays towards the end of the installation process, as shown in the following image.

    The Omni-Gen installation is complete when the Install Complete pane displays, as shown in the following image.

  43. Click Done to exit the Omni-Gen installer.
  44. Start the Omni-Gen Controller by typing the following command in a command prompt:
    cd \omnigen\omniserver
  45. Press Enter, then type the following command:
    omni start-controller
  46. Press Enter again.

    Note: When the installation completes, a BUILD Successful message appears, but the startup processing continues for a few minutes. You must wait for the processing to complete before proceeding to the next step.

  47. Using your browser (Google Chrome is recommended), open the Omni Console by typing the following address:
    https://yourhost.yourdomain.com:9500

    For example:

    https://tcmappsa.ibi.com:9500

    Note: You cannot use localhost in the URL.

  48. Log on using the following credentials:
    • Username: ibi
    • Password: ibi
  49. Deploy a bundle by clicking Deployment on the left side of the navigation bar.

    The Deployment Bundle Not found message displays, as shown in the following image.

    Note: The deployment bundle is created outside of the Omni Console. It is created using the Deployment Console based on a model created in Omni Designer. The following steps assume that a deployment bundle is already created and available in your environment.

  50. Click Install Bundle.

    The Open dialog box displays.

  51. Navigate to the location of your deployment bundle file.

    The deployment bundle was created using Omni Designer after rules and definitions were configured.

  52. Select your deployment bundle file and click Open.

    A blank Deployment Progress window displays.

    The window will start to show information and progress during the whole deployment process, as shown in the following image.

    When the process is complete, a successful installation message displays in a green banner, as shown in the following image.

  53. Close the green banner by clicking X in the top right corner.
  54. Start the Omni-Gen Server and the related services by clicking Services in the left navigation bar of the Omni Console and then clicking Start All.

    If the memory of your computer is insufficient, you can also start each individual service one at a time starting from the Utilities section and working upwards.

  55. Sign in to the Omni Governance Console (OGC) and load the metadata into your browser. For example:
    http://iwmdm2:9090/ogc
  56. Sign in to using the preauthorized WSO2 Local (Primary/) credentials, which can be used to perform other startup actions until site-specific credentials and permissions are added.

    For example:

    • Username: primary/super_a
    • Password: supera123

    If metadata has not yet been uploaded, the Omni Governance Console Setup page opens, as shown in the following image.

  57. Click Upload Meta Data.

    The Upload Metadata page opens, as shown in the following image.

  58. Click Choose File, navigate to the \omnigen\OmniGenData\mdata folder, and then select MData.xml.
  59. Ensure that the Validate after upload check box is selected, and then click Upload.

    The progress of the metadata upload process is shown on the Upload Metadata screen.

  60. When the metadata upload process is completed, click Administration, and then the Sources tab, as shown in the following image.
  61. Locate your uploaded metadata in the Source List table, and click the corresponding Sync hyperlink from the Action column.

    Performing this action ensures that when you initially open the 360 Viewer in the Omni Governance Console (OGC), a subject will be pre-loaded.

  62. Click 360 Viewer, as shown in the following image.

    OGC displays the 360 Viewer page, as shown in the following image.

    Omni-Gen Server and OGC are now installed and ready for use.

Procedure: How to Install Omni-Gen Using Silent Mode

As a prerequisite, the Omni-Gen installer must be run at least once prior to installing Omni-Gen using silent mode. The Omni-Gen installer creates the OmniGenInstall.properties file, which is used by the silent mode installer. The Omni-Gen installer can then be run again in silent mode and it will use the existing properties file as input.

The silent mode installer requires the installation folder as input to locate the properties file. The installation folder is the same folder as specified in the Choose Installation Folder pane of the Omni-Gen installer. However, the folder must already exist and contain the OmniGenInstall.properties file. The folder structure can exist from a previous installation, or it may be newly created. No other folders are required.

Use the following command to run in silent mode:

TIB_og_mdm_3.16.0_win_x86_64.exe -i silent 
-DUSER_INSTALL_DIR=<installation_folder>

For example, if the OmniGenInstall.properties file is located in the c:\omnigen\install folder, then you would execute the following command: 

TIB_og_mdm_3.16.0_win_x86_64.exe -i silent -DUSER_INSTALL_DIR=c:\

To install Omni-Gen using silent mode:

  1. Save the OmniGenInstall.properties file from a previous installation.
  2. Create a folder called omnigen on your c:\ drive. For example:
    c:\omnigen
  3. Create a subfolder called install. For example:
    c:\omnigen\install
  4. Copy the OmniGenInstall.properties file to the c:\omnigen\install folder.
  5. Open a command prompt window and execute the following command:
    TIB_og_mdm_3.16.0_win_x86_64.exe -i silent -DUSER_INSTALL_DIR=c:\