Xtract Table CDC

This page shows how to use the Xtract TableCDC component.
The Xtract TableCDC component loads incremental data from SAP Tables. Unlike a full data load that transfers all records, CDC captures only data that has changed since the last load.

About Xtract TableCDC

Change Data Capture (CDC) is a method to keep track of data changes such as insert, update and delete in SAP tables. The Xtract TableCDC component creates a log table in SAP that records any changes made to a selected table. The content of the log table is cleared after every successful run of the extraction. Data that was not extracted is not cleared from the log table.

For a detailed overview of this process, refer to the Knowledge Base Article: Delta Mechanism of TableCDC.

General workflow for Xtract TableCDC extractions:

System Requirements

• The Xtract TableCDC component is compatible with SAP ECC 5.0 and higher
• Supported databases:
  • HANA
  • SQL Server
  • ASE (SAP Adaptive Server Enterprise, formerly Sybase)
  • Oracle
  • IBM Db2
  • IBM for i (Db4)
  • IBM for z/os (Db6)
  • MaxDB

Prerequisites

• The following custom function modules are installed in SAP:

  • /THEO/READ_TABLE
  • /THEO/CDC_ECC or /THEO/CDC_S4

  The SAP transport requests for the function modules are provided in the installation directory: C:\Program Files\XtracIS\ABAP\.

• A connection to an SAP system is available, see SAP Connection.

• The SAP user has sufficient user rights, see SAP Authority Objects.

Add an Xtract Table CDC Component

Follow the steps below to add an Xtract Table component to your SSIS package:

1. Drag&drop the Xtract Table CDC component from the SSIS toolbox into your data flow task.
   

2. Double-click the component. A connection manager is automatically assigned to the component and the main window of the component opens.

   Note

   If there are multiple connection managers, the window "Select Connection Manager" opens, see SAP Connection. Once a connection manager is selected, the main window of the component opens.

The majority of the functions of the component can be accessed in the main window.

Look Up a Table

1. In the main window of the component, click [ ]. The window “Table Lookup” opens.
   
2. In the field Table Name, enter the name of the table to track and extract . Use wildcards (*) if needed.
   
3. Click [ ] . Search results are displayed.
4. Select a table and click [OK].
   

All relevant metadata information of the table is retrieved from SAP. The application returns to the main window of the component.

Define the Xtract TableCDC Component

The Xtract TableCDC component offers the following options for tracking SAP tables:

1. Select the table columns you want to track and extract. By default all columns are selected. Deselect the columns you do not want to extract.
   
2. Activate Extract table on first run to extract the table when first running the extraction.

3. Optional: Use Log table row limit to set a maximum number of rows that the log table can contain. If the row limit is reached, the extraction fails with an exception. The maximum row limit of a log table is 500.000. The row limit is disabled by default (value 0).

   Note

   Once a log table is initialized, you cannot change the size limit anymore.

4. Optional: Define a WHERE Clause to filter table records. By default all data is extracted.

5. Click [Load live preview] to display a live preview of the first 1000 records.
   
   • The column TS_TIMESTAMP contains a timestamp of when the data was last changed.
   • The column TS_OPERATION indicates if a row was inserted (I), updated (U) or deleted (D).
     
6. Check the Settings before running the SSIS package.
7. Click [OK] to confirm your settings.

To initialize the tracking of the selected SAP table, run the SSIS package once.

Initialize the Log Table

Run the extraction for the first time to create a log table in SAP that records any changes made to a selected table or view.

• If the option [Extract table on first run] in the Xtract TableCDC component is active, the extracted table contains the original SAP table.
• If the option [Extract table on first run] in the Xtract TableCDC component is not active, the extracted table is empty.

The log table in SAP is now available for the Table CDC component. The extracted SAP table is now available in your destination.

Source Table Changes

After initializing the log table, you can make the following changes to the SAP source table:

• add new columns
• delete existing columns that are not part of the primary key (as of SAP Basis 7.76, S4H 1905)
• change columns that are not part of the primary key (as of SAP Basis 7.76, S4H 1905)

For more information, see SAP Note 2814740.

After changing a source table, open the corresponsing Xtract TableCDC extraction and click [Refresh Metadata] to update your Xtract TableCDC extraction.

Delete Log Table and Triggers

When a Table CDC extraction is no longer in use, simply deleting the extraction is not enough. To delete the log table and all associated triggers from your SAP system, open the Table CDC extraction and click [Delete CDC resources].

To delete the SAP resources of multiple extractions or extractions that are already deleted, see Active CDC Watches.