Install IBM i components - Precisely Data Integrity Suite

Data Integrity Suite

Product
Spatial_Analytics
Data_Integration
Data_Enrichment
Data_Governance
Precisely_Data_Integrity_Suite
geo_addressing_1
Data_Observability
Data_Quality
dis_core_foundation
Services
Spatial Analytics
Data Integration
Data Enrichment
Data Governance
Geo Addressing
Data Observability
Data Quality
Core Foundation
ft:title
Data Integrity Suite
ft:locale
en-US
PublicationType
pt_product_guide
copyrightfirst
2000
copyrightlast
2026

Install and configure all required components for IBM i platform support in replication engines, including environment preparation, DB2/400 configuration, and log reader installation.

  1. Prepare IBM i environment
    1. Prepare the following in your IBM i environment:
      • ftp is required when doing a remote GUI or remote batch installation.

      • IBM TCP/IP must be installed and running.

      • The installation directory must be created prior to the installation and must be created in the IBM i UNIX interface strqsh or iSeries Navigator under the integrated file system 'Root' structure.

      • The file system where Data Integrity Suite is installed must have at least 50 megabytes of disk space.

      • Java SE must be installed on both the installer and recipient hosts.
        Note: Although the user is required to obtain a JDBC driver for other platforms, the one exception is IBM i hosts where Data Integrity Suite installs the JDBC driver.
      • Ensure that the correct Greenwich Mean Time (GMT) or Coordinated Universal Time (UTC) offset is defined on all machines in your Data Integration system. To automatically adjust for time zone differences, Data Integration relies on a time zone setting that the operating system on each host machine keeps. This setting specifies the difference between the machine's local time and the current time in Greenwich, England.

        You must also reset the offset if you have seasonal changes in local time (for example, when Standard Time changes to Daylight Saving Time in the USA).

        For an IBM i machine, the timezone offset is kept in the system value, QUTCOFFSET. You can use the DSPSYSVAL and CHGSYSVAL commands to display and change the value. For example:

        DSPSYSVAL QUTCOFFSET
        CHGSYSVAL QUTCOFFSET offset

        where offset is in the form +hhmm or -hhmm, that is, hours (maximum 24) and minutes ahead of or behind UTC, respectively. A sample offset for New York, for example, is -0500. Locations east of Greenwich are preceded by a positive sign (+).

        For more information about GMT in general, you can search on UT (universal time) on the Astronomical Applications Department of the U.S. Naval Observatory website: http://aa.usno.navy.mil

    2. Edit the SystemDefault.properties file to add the timezone property

      Java applications using timestamps require this timezone property since Java uses QTIME, QUTCOFFSET, and the user.timezone property together.

      1. Open the file with the Windows-provided Notepad (or equivalent) editor
      2. Add the timezone statement, using the setting appropriate for your locale (for example, user.timezone=EST).
        Note: Do not insert a blank on either side of the = character.
      3. Save the file and exit the editor.
      When this is set, and when Data Integrity Suite has been installed and the Data Integrity Suite Listener is started, you will see timestamps in the kernel and Data Integrity Suite Listener logs set to local time.
      Note: This property needs to be changed manually for Daylight Saving time.
    3. Set up journaling for replication
      One or more database tables can be journaled to each environment, and multiple journal environments can exist at the same time on an individual IBM i machines.
      Note: Data Integrity Suite supports remote journals, however some changes are required on the i5 server where the remote journal resides, as well as to the Data Integrity Suite director. Additionally, the Data Integrity Suite change selector cannot open or read journal records from a journal with more than 2045 receivers. If this limit is exceeded, the Change Selector terminates with MSS CPF7053.

      You must create or specify existing journals for:

      • All replication source tables: Source tables are journaled to provide the records of the data changes that Data Integrity Suite captures for distribution to the target.
      • All replication and copy target tables: Target tables are journaled to provide transaction control for committing or rolling back a series of changes.

      The tables must be journaled with before-images as well as after-images. In addition to providing control for committing or rolling back, before-images are required to detect distribution key changes and 10 Data Integrity Suite IBM i Install Guide for data enhancement as well as for collision reporting in protected replication.

      To create a journal, you must first define or have available one or more journal receivers and a journal message queue. The table below describes first the IBM i commands to create a receiver and a message queue, followed by the command to create a journal definition and to assign a table to the journal. The descriptions include usage comments and related commands.

      DB2/400 databases support logging of database transactions within a journal environment. The environment includes a journal definition (*JRN object), one or more journal receivers (*JRNRCV object), and a journal message queue (*MSGQ object).
      Note: When creating a journal, the MINENTDTA parameter must be set to *NONE.
      Table 1.
      Command Comment

      CRTJRNRCV

      Creates a journal receiver (*JRNRCV object), the first of a series (chain) of physical storage containers for the journal. You must create a receiver before you create the journal definition object. The receiver and journal may belong to different libraries.

      Related commands:

      • DLTJRNRCV–Deletes a journal receiver.
      • DSPJRNRCVA–Displays journal receiver attributes

      CRTMSGQ

      Creates a journal message queue (*MSGQ object), a persistent queue attached to the journal for receiving messages about the state of receivers. You must create a message queue before you create the journal definition object. It is not recommended to use the system message queue QSYSOPR for Data Integrity Suite distribution. Its typical heavy usage makes it subject to operator maintenance that risks loss of data.

      Related command:

      DLTMSGQ–Deletes a journal message queue.

      CRTJRN Creates a journal definition (*JRN object), which contains management information for the journal environment and associates the receiver(s) and message queue with the journal.

      It is recommended that you set the command option Manage receivers (MNGRCV) to *SYSTEM and set Delete receivers (DLTRCV) to *NO.

      If this journal is for tables on a target-only DB2/400 server, journals are necessary for commitment control only, and Data Integrity Suite change management is not available. You may want to specify *SYSTEM for Manage receivers and *YES for Delete receivers.

      Changes to user data are recorded as entries in the journal receiver, each of which is identified by a sequence number. You can display the entries in the journal receiver by issuing the DSPJRN command.

      Related commands:

      • DLTJRN–Deletes a journal definition object.
      • CHGJRN–Changes a journal definition object. For example,attaches a new receiver if receivers are user-managed and not system-managed.
      • WRKJRNA–Works with journal attributes, including the files that are journaled by the journal.
      • DSPJRN–Displays journal entries in detail.
      • DSPOBJAUT–Displays authorities.
      • GRTOBJAUT–Grants authorities to an object.
      STRJRNPF Starts journaling for a table (physical file) that is not currently being journaled.
      • Specify *BOTH for the Journal images option: This journals both before-images and after-images of the changed data. *BOTH is not the default.
      • Do not assign a table to the QAUDJRN journal (the system audit journal) in the QSYS library or to the Data Integrity Suite metabase journal, if it exists.

      Related command:

      ENDJRNPF–Ends journaling on a physical file.

    4. Set up a journal on the source server and the target server
      1. Prepare a journal on the source server

        For all DB2/400 tables from which you replicate data, you must create or have available one or more journals and accompanying receivers. A single journal is often sufficient for all the tables, but you can use multiple journals. A unique Data Integrity Suite process (DB2/400 Change Selector) reads each journal. A table cannot be assigned to more than one journal. You can create new journal objects or use existing ones. To create a new journal object and assign tables to it, see the journal management commands above, which briefly describes the basic IBM i commands to do so. The journal you use for your tables must be distinct from the journal that Data Integrity Suite creates for its metabase tables.

        If you use an existing journal:

        • Do not use QSYS/QAUDJRN, the system audit journal.
        • You may use a QSQJRN journal, a library's default SQL journal, but be aware that it can grow very large: all tables created within that library using the SQL CREATE TABLE statement are automatically assigned to QSQJRN (as long as the table creator has sufficient authority to write to the journal).
          Note: Do not setup journaling for user tables in the product or install library regardless of whether or not you opt to use the QSQJRN.
        • Make sure the journal's authorization is *ALL for those users who may start or end journaling for tables that you want journaled.

        • Special examples of this requirement are the user profiles that sign on to IBM i machines on sending and receiving server connections from Data Integrity Suite Director. To use the Data Integrity Suite Director to journal tables for you, the journals' authorizations must permit access to these users. You can use the IBM i DSPOBJAUT command to display a journal's authorities, and the GRTOBJAUT command to grant authorities to a journal.

        • Review the journal definition's settings for change management and delete management of journal receivers.

          These receivers are the buffers that contain the data-change records that Data Integrity Suite captures and replicates. It must not be deleted until after all their entries are captured and committed. To help ensure this, assign the task of changing receivers to IBM (using the journal definition), and assign the task of deleting receivers to Data Integrity Suite (using Data Integrity Suite Director). Even if your site has an existing change management method in place, assign delete management to Data Integrity Suite to safeguard the data to be replicated.

          To display or change your journal's definition, issue the CHGJRN command. If the system is to do change management, set Manage receivers to *SYSTEM (set it to *USER if Data Integrity Suite does change management). If Data Integrity Suite is to do delete management, set Delete receivers to *NO.

        • Assign the tables.

          For tables that are not currently being journaled, issue the STRJRNPF command to start journaling.

          For tables that are currently being journaled, check the table attributes (Display file description, DSPFD) to make sure Journal images is set to *BOTH (changes to the table are journaled with before-images as well as after-images).

          If Journal images is not set to *BOTH, issue the ENDJRNPF command to end journaling and restart journaling (STRJRNPF) with Journal images set to *BOTH.

      2. Prepare a journal on the target server

        1. You must create or specify existing journals and accompanying receivers that include before-images for all receiving files (tables) at an IBM i target server. You can follow the same procedure you used based on the information in the source server section above.
          Note: The journals are necessary for commitment control only, and Data Integrity Suite has no journal management facilities for target-only IBM i host machines. (Journal definition settings are described above.) You may want to define system-managed changing and deleting of receivers, and arrange for regular checking of the message queues assigned to your journals to make sure journaling is not interrupted.

          If your receiving table is an IBM i logical file, you must journal only the underlying physical file(s) referenced by the logical file.

  2. Prepare DB2/400 environment
    1. Understand eligible table types for distribution

      Data Integration is designed for distributing SQL tabular data or user changes to that data. If the data can be accessed through an SQL entity that is represented in the SQL system catalog, it should be distributable. The table below lists the table types are eligible for distribution as DB2/400 source or target tables.

      DB2/400 object

      Data Integration Director category

      Copy or Replication source

      Copy or Replication target

      Table (SQL)

      Table

      Both

      Both

      Physical file

      Table

      Both

      Both

      View

      View

      Copy

      Both (only if updateable)

      Logical file

      View

      Copy

      Both (only if updateable)

      Alias for table

      Alias

      Both

      Both

      Alias for multi-member file member

      Alias

      Both

      Both

      a The check box label you select in Director when you retrieve that object's data from the DB2 system catalog into your Data Integration model.

    2. Install Data Integration on IBM i

      Installing and using Data Integration on an IBM i system differs from installing and using Data Integration on another type of system because you must install a log reader.

      Note: This process is for IBM i only.
      1. Download and extract IBMi series files.

        https://prd-cloud-platform-dis-downloads.s3.amazonaws.com/iseries-latest.zip

      2. Install DB2 log reader on the IBM i platform whose database server is a source of data movement.
      3. Install the agent if it has not been installed already.
      4. Install journal receiver exit program on each IBM i source host that has an installation library.
    3. Create user IDs and authorities

      Create user IDs and authorities required to install, test, and run Data Integrity Suite. Although multiple IDs are described, you can combine their responsibilities under fewer IDs. For example, a single user with the QSECOFR profile along with one other user ID for testing could install, test, and run the product.

      • Data Integrity Suite installation creates the OMNIENT user profile to own the objects initially installed in the product library.
        Note: You must not modify the OMNIENT user profile or specify it for any of the users described below or elsewhere in the product.
        The OMNIENT user ID is installed with these settings:
         USER CLASS . . . . . . . . : *SECOFR
         SPECIAL AUTHORITY . . . . : *ALLOBJ
         *JOBCTL
         *SPLCTL
      • After installation is complete, change the password with WRKUSRPRF to a site-specific password. The OMNIENT user id has all the required privileges on the source. It is used for both replication (rep user) and the metabase owner. For a target-only IBM i, a user id with the same privileges should be created for the rep user and metabase owner.

        This user profile owns all the metabase objects, including the journal and journal receivers created for the metabase. The user ID is used on connections to the metabase from the Data Integrity Suite processes and Data Integrity Suite Director.

        This user profile also owns objects created using these connections (such as lookup and shadow tables used by Data Integrity Suite Director). You specify this user in the Data Integrity Suite Director on the Server Properties tab by checking Rep user after entering the user ID.

        The Rep user requires the following authorities:

        • Authority to create a collection and create tables in the Data Integrity Suite product library.
        • Authority to read the system catalog to retrieve column information from sending and receiving tables.
        • *ALLOBJ authorization privileges.
        • This is not required for Copy, since journaling of Copy sending tables is not required.
      • Create or make available an IBM i user profile for the system installer.

      • Make certain you have established a user profile with *SECOFR, *SECADM and *AUDIT permissions with:

        • Privileges to restore objects.

        • Privileges to start/stop subsystems.

        • All object authority.
          Note: Precisely advises against using the QSECOFR user.
      • Create a user profile for the metabase owner.

      • Make certain you have established a user profile with DB2 update (insert, update, delete) authority on the target tables.

        The target table updater is a user profile, other than the metabase owner, that can sign on to the receiving server, select table and column names from the system catalog, start or end journaling for the receiving table (*ALL authority to the journal), and update the receiving table. This is the replication userid for bi-directional replication.
        Note: When adding, updating, or deleting rows on the source table, be sure you are not using the replication user ID (rep user) to make these changes. Change capture ignores changes made by the replication user.
      • Define a LOCALHOST IP connection. This is especially important if you are using remote hosting use CFGTCP.

        Work with TCP/IP Host Table Entries 
         System: <machine name
        Type options, press Enter. 
        1=Add 2=Change 4=Remove 5=Display 7=Rename 
         
         Internet Host 
         Opt Address Name 
         127.0.0.1 INTRA 
         LOOPBACK 
         LOCALHOST

        The standard for localhost is 127.0.0.1.

      • Similarly, define an INTRA connection.
        Note: LOCALHOST, INTRA, and LOOPBACK are all required for Data Integrity Suite.
  3. Install log reader
    1. Understand the log reader purpose
      Note: If it does not exist, the installation creates the OMNIENT user profile, which owns all product executables. You must not use or modify the OMNIENT profile.

      The log reader is a process used for replication on DB2 servers, which captures SQL row operation changes, specifically INSERT, UPDATE, and DELETE in the context of an SQL transaction.

      Install a log reader on all IBM i machines where you will replicate data. You may need the cooperation of a systems programmer, security administrator, DB2 administrator, and a network administrator. The installation process includes unpacking the compressed installation library. Trace information about the entire installation job is stored in a spool file (QPJOBLOG) in your user output queue.

    2. Sign on and assign privileges
      1. Sign on
      2. Assign QSECOFR Privileges or Security Officer Authority

        Ensure the user profile has QSECOFR privileges or security officer authority at the product level (ADM). This can be done by either assigning the profile to the QSECOFR group or granting security officer authority using the appropriate commands. This ensures the user has the necessary permissions to perform the installation. For more information, see Installing when License Manager is not yet installed.

        The end of the installation process automatically generates a job log. By signing on just before starting the installation, you limit the job log to only the installation process.

      3. Copy the STM file to this location.
        /connectcdc/<version number>.SYSTEMI.CONNECTCDC.STM
      4. Install INSPRD, if not already installed. For more information, see INSPRD_Readme.pdf located in the zip file.

        Precisely provides the Install (INSPRD) tool in version 8: License and Availability Manager for users that are installing from a streamfile (STMF). The INSPRD tool simplifies the install process.

        If either of the following conditions apply, you must obtain the tool manually during the installation.

        • You are using the STMF format for a new install, where License and Availability Manager is not installed.
        • You are using the STMF format to upgrade to version 8 for the first time and License and Availability Manager is not at version 7.
      5. Issue the following command on the IBM i:

        LAKEVIEW/INSPRD STMF('/connectcdc/<version number>.SYSTEMI.CONNECTCDC.STM') INSTLIB(*SELECT)
      6. Install License Manager, if not already installed. For more information, refer Installing when License Manager is not yet installed.

        If you do not have a License Manager installed, you are prompted to install it when you attempt to install the log reader. License Manager must be installed before you install the log reader.

        Note: The License Manager can only be automatically upgraded from the prior version, version 7. The License Manager must be installed at version 8.0.15.00 or higher prior to installing the log reader.
      7. From the Lakeview Technology Common Install screen, select 1 Install/Upgrade in the Opt column next to Data Integrity Suite.
      8. Press Enter. The Install Lakeview Product (INSLKVPRD) display appears.
      9. Accept or select new installation Library name.

        In the Installation Library field, you see either a default library name (OMNIENT), the name of your existing product library (if you are reinstalling) or the value *NEW. You can accept the library name or change it to a new name.

      10. If the value *NEW appears, the default library already exists on the system and you must provide the name of a library that does not already contain a copy of the files you are installing.
      11. Press Enter to start the installation process. Messages at the bottom of the page describe the active installation task. When the installation of all the products completes, the Lakeview Technology Common Lakeview Technology Install display appears. A completion message appears at the bottom of the display.
      12. If you are installing multiple products, repeat step 1 and step 2 for each product.
      13. Press F12 to return to the command line.
      14. Provide a password for the OMNIENT user profile to secure access and comply with security policies. This is a mandatory step.
    3. Optional: Configure advanced settings
      Tip:
      • Add DRE (Dynamic Resource Expansion) settings if required, as these optional configurations can enhance system resource management.
      • Use a different user profile than the default to improve security and ensure proper permissions are assigned for the installation or task.
      • Update the JOBD (Job Description) to run the task in a separate subsystem for better resource management and to avoid interference with other system operations (detailed instructions on this are covered elsewhere).
      • Configure the iSeries for High Availability (HA) by setting up replication, failover, and fault tolerance features, with additional steps provided in a separate section of the documentation.
IBM i components are now installed and configured for replication engine support. Your IBM i environment is ready for data replication operations.