Skip to main content Skip to complementary content


The following section describes the prerequisites for working with the Qlik Replicate IBM DB2 for z/OS endpoint.

Install the R4Z product on z/OS

Before you can work with an IBM DB2 for z/OS source, you must first install and configure the R4Z product on z/OS.

For installation instructions, refer to the R4Z Installation and Configuration Guide, which is included in the ZIP file with the R4Z installer.

Warning noteThe Replicate and R4Z versions you install must be part of the same release, which can either be a GA release or a patch/service release. Basically, this means that if you upgrade Replicate, you must also upgrade your R4Z installation (to the version provided with the Replicate release you are installing), unless it has the same build number as your currently installed R4Z. Note that despite being part of the same release, the Replicate and R4Z build numbers will not be the same. For example, Replicate November 2021 PR03 includes the following files: (the Replicate installer) and (the R4Z installer).

Client requirements

The IBM Data Server Driver for ODBC is required in order to access the data. This section describes the client side and server side ODBC prerequisites.

Information note

The "enableWLB" driver option is not supported. To force the connection to automatically switch to another LPAR in a parallel sysplex (i.e. “failover”), set “enableACR” to “true” and “enableWLB” to “false” in the driver configuration.


Install "IBM Data Server Driver for ODBC and CLI" for DB2 11.5.6 for z/OS on the Qlik Replicate Server machine.


  1. Install v11.5.6_linuxx64_server_dec.tar.gz and choose the “CLIENT” option.
  2. If the Qlik Replicate machine does not have a DB2 instance, create a DB2 instance by running the following commands:

    adduser <db2_instance_name>

    /opt/ibm/db2/V11.5/instance/db2icrt <db2_instance_name>

  3. Add the DB2 driver location to the Linux library path.

    To do this, add the following line to the site_ file in <install_dir>/replicate/bin:

    export LD_LIBRARY_PATH=\$LD_LIBRARY_PATH:/path/lib64

    where path is the path to the driver.


    export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/ibm/db2/V11.1/lib64

  4. Add the following entry to the odbcinst.ini file under /etc:


    Driver =/opt/ibm/db2/V11.5/lib64/



  5. Restart the Qlik Replicate Server service.

Server side ODBC setup

Bind the plan to be used for ODBC, as specified in the PLANNAME= value in the ODBC initialization file. The default name is DSNACLI. The BIND job can be found in member DSNTIJCL, which is in the SDSNSAMP library of the source DB2 installation.

Use the DB2CLI bind command to bind the ODBC-supplied packages to your intended source z/OS DB2 subsystem. This action is described in Configuring your developer and runtime environment on the IBM website. For information about the DB2CLI utility, including an example for the bind utility, see db2cli - DB2 interactive CLI command on the IBM website.

Required permissions

To enable Qlik Replicate to extract data from the source tables (Full Load and Change Data Capture), the user specified in the IBM DB2 for z/OS endpoint settings must be granted the following permissions:

  • EXECUTE on the IFI reading the UDTF (only required for Change Data Capture)
  • SELECT on the source tables and on the DB2 catalog tables
  • MONITOR2 to be able to start IFI sessions (only required for Change Data Capture)

For additional details about these permissions, see Change Data Capture Requirements below.

Change data capture requirements

To capture changes from IBM DB2 for z/OS, Qlik Replicate uses a special program - invoked as an external routine - which is a user-defined table function (UDTF). This program (a load module) as well as the UDTF need to be installed and configured on the z/OS system before changes can be captured. The installation procedure, which should be performed by the DBA, is described in the Qlik R4Z Installation and Configuration Guide.

Additionally, the Data Capture Changes attribute must be set for every table whose changes you want to capture. You can either do this manually or allow Qlik Replicate to do this by leaving the Automatically enable Data Capture Changes (requires admin privileges) option enabled (the default) in the Advanced tab.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!