Configuring the Change Data Capture node

Configure the Change Data Capture node to capture all the changed data from your database into IBM® App Connect Enterprise.

1. In the IBM App Connect Enterprise Toolkit, create a flow that contains a Change Data Capture node.
2. Select the Change Data Capture node in the flow to show the node properties in the editor.
3. Optional: On the Description tab, enter a Short description, a Long description, or both. You can also rename the node on this tab.
4. On the Basic tab, specify a policy by completing one of the following steps:
   • Specify an existing policy by entering a value for Policy, or click Browse and select a property policy from your file system.
   • Create a new policy by clicking Browse and then clicking Create policy.
5. Update the policy that you specified in step 4. Right click the policy in the Application Development view of the IBM App Connect Enterprise Toolkit to open the menu and select Open with > Policy Editor > . Edit the policy properties by completing the following steps:
   1. Database Name: Set to the name of the database to connect to.
   2. Connector Class: Set the entry classname for the downloaded plug-in. Some examples are shown in the following list:
      • Db2: io.debezium.connector.db2.Db2Connector
      • PostgreSQL: io.debezium.connector.postgresql.PostgresConnector
      • SQL Server: io.debezium.connector.sqlserver.SqlServerConnector
      • Oracle: io.debezium.connector.oracle.OracleConnector
   3. Hostname: Hostname or IP address of database server.
   4. Port number: TCP port of database server.
   5. Security Identity: Credential to use for authentication to the server.
   6. Optional: Database Partition Name (PDB): Name of the PDB that is used for Oracle databases when you use containerized databases.
   7. Optional: Advanced Properties File: Path name for the properties file.
      If the target database requires custom Debezium properties, they can be added to a Java Properties file and placed in the file system of the integration server and in the path to the file that is specified in this property. Any properties in the properties file override any properties that were set in the policy.
6. On the Basic tab of the Change Data Capture node, click Add, Edit, or Delete to add, edit, or delete entries in the List of Database Tables.
   The tables that you add to the List of Database Tables are the only tables that the Change Data Capture node captures. Changes to any other tables are ignored.
7. Optional: If you need to capture data from Db2, obtain a license for IBM InfoSphere Data Replication (IIDR). For more information, see InfoSphere Data Replication.
8. Set up the database server by completing the following steps:
   1. Go to the Connectors page for Debezium.
   2. Select your database; for example, Db2.
   3. In the scrollable side menu, click the link for setting up your database server; for example, Setting up Db2.
   4. Follow the instructions in the link.
9. In IBM App Connect Enterprise versions before 12.0.12.12, the Change Data Capture node requires an integration server to run Java 11. In IBM App Connect Enterprise versions 12.0.12.12 or later, the Change Data Capture node requires an integration server to run Java 17. For more information about using a specified version of the Java Runtime Environment, see Configuring an integration server to use a specified Java Runtime Environment (JRE).
10. The Change Data Capture node requires extra JAR files specific to your database, which you can obtain by completing the following steps:
    1. Go to the Connectors page for Debezium.
    2. Select your database; for example, Db2.
    3. Follow the link to download the plug-in archive from Maven Central.
    4. Extract the file into /opt/mqsi/server/cdc (or an equivalent path if you installed elsewhere) so that you have a directory similar to /opt/mqsi/server/cdc/debezium-connector-db2 that contains several JAR files. (This example is for Db2).
    5. Optional: If your database is Db2, you must also complete the following steps:
       1. The following JDBC driver for Db2 is required: https://repo1.maven.org/maven2/com/ibm/db2/jcc/11.5.0.0/jcc-11.5.0.0.jar. Download this driver from Maven Central as described in step 3 of Debezium connector for Db2.
       2. Add the https://repo1.maven.org/maven2/com/ibm/db2/jcc/11.5.0.0/jcc-11.5.0.0.jar into the directory where you extracted the plug-in archive at step 10.d.
    6. Optional: If your database is Oracle, you must also complete the following steps:
       1. Download the JDBC driver for Oracle from Maven CentraL https://repo1.maven.org/maven2/com/oracle/database/jdbc/ojdbc8/21.6.0.0/ojdbc8-21.6.0.0.jar.
       2. Extract the downloaded driver into the directory where you extracted the Debezium Oracle connector JAR file at step 10.d.
11. On the Instances tab, select an option for Additional instances pool to determine the pool from which additional instances are obtained. The options are Use Pool Associated with Message Flow, and Use Pool Associated with node.
    Specify a value for Additional instances to determine the number of additional instances that the node can start if the Additional instances pool property is set to Use Pool Associated with node. The default value is 0.
12. On the Monitoring tab, use Add, Edit, and Delete to create, change, or delete monitoring events for the node. For more information, see Configuring monitoring event sources by using monitoring properties.