Installation

Topics:

As of Omni-Gen version 3.2 and higher, a new wizard-based installer is provided, which simplifies the installation and configuration process. The user needs to download the installer applicable to their version and platform. The installation must be running with Administrative privileges to ensure that it has access to all required service configurations.

This install does not provide a pure upgrade functionality in terms of overlaying on top of the existing Omni-Gen 3.x release. The installation is meant to be a parallel process and then a migration of artifacts. It is important to note that if you install into the same directory, you may lose your configuration as configuration files will also be replaced in addition to the binaries. For more information, see the Omni-Gen™ Installer User's Guide.

Installation Considerations

Topics:

  • As of Omni-Gen version 3.2 and higher, a new wizard-based installer is provided with the product. There is no need to manually configure a properties file as in previous versions of Omni-Gen.
  • As of Omni-Gen version 3.2 and higher, there is no separate installer for Omni Governance Console (OGC). OGC is now installed as part of the Omni-Gen product within the same installation wizard.
  • During the installation process, it is important to provide a valid set of configuration properties so that the underlying system can be configured correctly. Although these settings can be updated using the Omni Console at a later time, additional steps might be required to relink any working components and re-initialize the back-end systems, such as databases, repositories, and so on.

UTF-8 Character Support

This section describes a configuration update you can make during the installation or after the installation (by modifying your database settings in the Omni Console) to enable the usage of UTF-8 characters in Omni-Gen version 3.2 and higher.

By default, the installation uses the following JDBC URL format when configuring SQL Server 2016:

jdbc:sqlserver://hostname:port;databasename=db_name;sendStringParametersAsUnicode=false

To enable UTF-8 character support in your Omni-Gen environment, modify the JDBC URL to either of the following:

jdbc:sqlserver://hostname:port;databasename=db_name;sendStringParametersAsUnicode=true

or

jdbc:sqlserver://hostname:port;databasename=db_name;useUnicode=true;characterEncoding=UTF-8

Operational Considerations

This section provides a summary of operational considerations for users. For more information, see the Omni-Gen™ Operation and Management Guide.

  • When doing large data loads (1M records and above), it is recommended to not have OGC up and running on the same machine due to resource constraints. You can either shut it down for the processing duration, or have it running on a separate instance.
  • To access the Omni-Gen Console, please use https://<host>.<domain>:<port> instead of a localhost URL (for example, https://mydesktop.ibi.com:9500).

  • All of the management of the relevant Omni-Gen Services is done from the Omni-Gen Console. There is no need to start any of the services from the command line. However, those options are still available. Please ensure that you have at least 32GB memory available if you plan to run all components at the same time.
  • All commands must be executed with Administrative privileges.
  • The copying of the model jar from the server to the OGC is done automatically by the deployment step.
  • Omni-Gen Master Data and Data Quality Editions require JDK version 8. The user is advised to consult with their JDK provider for the latest build and licensing.
  • Omni-Gen Master Data and Data Quality Editions have been certified with OpenJDK 8 build 232, as well as with Oracle JDK 8 build 231.
  • Omni-Gen Log files for its components are located under the <OmniGen_Home>/OmniGenData/log directory. You can find sub-directories for components such as OGC, server, OmniDesignerRepository, and so on.
  • Google Chrome is the recommended browser to be used with Omni-Gen version 3.2 and higher for all web-based user activity and interactions with the product.

Database Considerations

  • Microsoft SQL Server

    To use Microsoft SQL Server as a repository database, you must use sqljdbc42.jar drivers.

  • Oracle

    To use Oracle as a repository database, you must have select permission on SYS.DBA.RECYCLEBIN. Otherwise, the deployment of the bundle will not be successful.

  • Db2

    To use Db2 as a repository database, the following tuning steps are required. This is due to the nature of Db2 and its requirement for higher memory consumption during the deployment phase. If the memory is not increased, you might encounter an OutOfMemoryError exception when resetting the environment or the deployment phase.

    For new installations:

    1. The Db2 JDBC URL should include a traceLevel=0 option during the configuration.
    2. Prior to running config on the binary, set cfg.server.commandline.max-memory=2048M in the configuration file.
    3. After config completes, verify server.commandline.max-memory=2048M in the OmniGenconfiguration.properties file.

    For existing installations:

    1. The Db2 JDBC URL should include a traceLevel=0 option during the configuration.
    2. In the Omni Console, navigate to Configuration, Runtime, and click the Command Line tab. Set the JVM Process Max Memory parameter to 2048M.
    3. Stop all processes and then restart.

Additional Considerations for Current Users

This section provides a short overview for the migration needed from prior 3.1.x versions to the version 3.2 and higher platform. For more information, see Appendix A in the Omni-Gen™ Installer User's Guide. Please contact iWay Customer Support for additional information and best practices.

  • Install Omni-Gen version 3.2 or higher into a separate location, which is outside of Omni-Gen version 3.x from a prior release.
  • During installation, you may reuse the connection information for external resources as outlined below:
    • You can reuse the Source Management connection.
    • You can reuse the database connection (ensure to select options to not recreate tables).
    • You can reuse ports that you have used previously. However, stop the existing 3.1.x version of Omni-Gen and OGC before upgrading. This will ensure that there are no port conflicts. If you changed the default port values or used custom port values in version 3.1.x, then carefully review and change the default port numbers that are being suggested by the 3.2 and higher version of the upgrade facility to prevent conflicts.
    • Ensure that file path directories point to proper artifacts.
  • If you have an existing model, use Omni Designer version 3.2 and higher to check out your project from the repository.
    • The links to DQ plans will be lost and will need to be re-created.
    • In a future release, there will be an option available to fully export and then re-import the model with all of the associated artifacts, such as DQ plans. This will eliminate the need to re-establish DQ links and mappings of attributes.
  • If you want to preserve existing data, use the Deployment Command Line facility (without the clean option to preserve the database) to redeploy the release bundle.

    Note: If you navigate to the Omni Deployment Web Console, you will not see any bundle deployed due to the new directory structure. If you install or deploy the new bundle using a web console, it will recreate your database and all prior data will be lost.

  • In OGC, you should reuse the MData file, which you have been using in Omni-Gen version 3.x. For more information, see Appendix A in the Omni-Gen™ Installer User's Guide.
  • The EMF data store has moved to the OmniGenData location.

If you want to start with a clean environment, then ensure to complete the following:

  • Delete prior used: C:\Users\<<userid>>\id2*
  • Delete prior used: C:\Users\<<userid>>\.emfstore
  • Drop the existing Omni-Gen databases used in prior installations and recreate them.

The following database changes need to be considered when comparing Omni-Gen version 3.0.x with version 3.1.2 and higher. These are generic database change examples and may or may not apply to the specific deployment.

Area

Omni-Gen Version 3.0.1

Omni-Gen Version 3.1.2 and Higher

Note

Action

Ramp

source_instance_id_name

SUBJECT_SIN

Every Ramp table.

 

Source/Instance/Master

ORIGINATION

CLEARANCE_CODE

ORIGINATION_CODE

CLEARANCE_CODE_CODE

Every instance of code fields in the model.

Reprocess Ramp batch to sync data or move data manually to new columns.

Source/Instance

PERSON_ID

PERSON_PERSON_ID

Every instance of link fields in the model.

Reprocess Ramp batch to sync data or move data manually to new columns.

Data Quality Updates

As of Omni-Gen version 3.2 and higher, if you have existing Omni-Gen 3.0.x Data Quality plans, they must be updated as follows to meet the new structural requirements:

  • For Cleansing components, the exp_meta_cleanse attribute must be renamed to tag_subject.
  • For Matching components, all tag attributes for each subject must be renamed from exp_<your_subject>_meta_cleanse to tag_<your_subject>.
  • For Remediation components, all tag attributes must be renamed from exp_<your_subject>_meta_cleanse to tag_<your_subject>.