You are on page 1of 632

IBM InfoSphere Change Data Capture

Version 6.3

IBM InfoSphere Change Data Capture Management Console, Version 6.3 Administration Guide

IBM InfoSphere Change Data Capture


Version 6.3

IBM InfoSphere Change Data Capture Management Console, Version 6.3 Administration Guide

Note Before using this information and the product it supports, read the information in Notices on page 609.

First edition This edition applies to version 6, release 3 of IBM InfoSphere CDC (product number 5724-U70) and version 6, release 2 of IBM InfoSphere CDC for z/OS (product number 5755-U96), and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright International Business Machines Corporation 2008. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Contents
InfoSphere CDC architectural overview 1 Introducing the InfoSphere CDC Management Console interface . . . . . 3
About InfoSphere CDC Management Console . . Terminology changes . . . . . . . . . . Command changes . . . . . . . . . . . Functionality changes . . . . . . . . . . Connecting to datastores and working with subscriptions . . . . . . . . . . . . . Datastores view . . . . . . . . . . . Source Tables area . . . . . . . . . . Subscriptions view . . . . . . . . . . Mapping source and target tables . . . . . . Map Tables wizard . . . . . . . . . . Table Mappings view . . . . . . . . . Setting mapping details on a subscription . . . Edit Mapping Details view . . . . . . . Column Mappings tab . . . . . . . . . Filtering tab . . . . . . . . . . . . Translation tab . . . . . . . . . . . . Conflicts tab . . . . . . . . . . . . Operation tab . . . . . . . . . . . . User Exits tab . . . . . . . . . . . . Promoting subscriptions . . . . . . . . . Monitoring the performance of a subscription . . Subscriptions view (Monitoring perspective) . Table Mappings view (Monitoring perspective) Statistics view . . . . . . . . . . . Event Log view . . . . . . . . . . . Replication Diagram view . . . . . . . . . . . 3 3 4 4 Table Mappings view . . . . . . . . Mapping Details view . . . . . . . . Subscriptions view (Monitoring perspective) Replication Diagram view . . . . . . Setting Preferences . . . . . . . . . . . . . . . . . . . . . . . . 18 19 19 20 20

Before you start InfoSphere CDC Management Console . . . . . . . . 21


Logging in to Management Console (Connecting Access Server) . . . . . . . . . . . To log in to Management Console . . . . To change your login password. . . . . to . . 21 . . 21 . . 22

. 4 . 4 . 5 . 5 . 5 . 6 . 6 . 6 . 7 . 7 . 7 . 7 . 8 . 8 . 8 . 9 . 10 . 10 10 . 11 . 11 . 11

Setting up datastores and user accounts in Access Manager . . . . . 23


Managing datastores . . . . . . . . . . To add a new datastore . . . . . . . . To edit a datastore . . . . . . . . . . To delete a datastore . . . . . . . . . To copy a datastore . . . . . . . . . . To view the history of a datastore . . . . . To set connection parameters on a datastore . Managing user accounts . . . . . . . . . To add a new user . . . . . . . . . . To edit a user . . . . . . . . . . . . To delete a user . . . . . . . . . . . To copy a user . . . . . . . . . . . To change the existing role on a user account . To enable a System Administrator user account and datastore administration privileges . . . To view the history of a user account . . . . Assigning users to datastores . . . . . . . To assign a datastore to users . . . . . . To assign users to a datastore . . . . . . Managing datastore connections . . . . . . To delete a connection . . . . . . . . . To override default connection parameters on a datastore . . . . . . . . . . . . . Managing security on user accounts . . . . . To disable a user account . . . . . . . . To enable a user to change password at next login . . . . . . . . . . . . . . To override password expiration policy set in Management Console . . . . . . . . . To unlock a user account . . . . . . . . Setting password and account security policies on user accounts . . . . . . . . . . . . . To set complex passwords on user accounts . To enforce password history . . . . . . . To enforce password expiry . . . . . . . To enforce password locking on failed login attempts . . . . . . . . . . . . . To enforce new account expiry . . . . . . To display previous failed login attempts . . To display the last successful login . . . . . . . . . . . . . . . . . . . . . . . . 23 24 24 25 25 25 25 26 27 27 28 29 29 30 30 30 30 31 32 33

Introducing InfoSphere CDC Management Console with InfoSphere CDC Event Server . . . . . . . . . . 13
About InfoSphere CDC Event Server . . . . . . InfoSphere CDC Event Server as a target-only datastore . . . . . . . . . . . . . . . Mapping source tables on a subscription that targets a JMS message destination . . . . . . . . . Setting mapping details on a subscription that targets a JMS Message destination . . . . . . . XML Message tab . . . . . . . . . . . XML Settings tab . . . . . . . . . . . Column Mapping tab . . . . . . . . . . Filtering tab . . . . . . . . . . . . . Translation tab . . . . . . . . . . . . Operation tab . . . . . . . . . . . . . User Exits tab . . . . . . . . . . . . 13 13 14 14 15 15 15 16 16 16 16

. 33 . 34 . 34 . 34 . 34 . 35 . . . . . . . . 35 36 36 36 36 36 37 37

Using the InfoSphere CDC Management Console user interface . . 17


Datastores view . . . . . . . . . . . Subscriptions view (Configuration perspective)
Copyright IBM Corp. 2008

. .

. 17 . 18

iii

Auditing user accounts, datastores, security policies, and general events . . . . . . . . . . . . To enable auditing . . . . . . . . . . . To generate an audit trail log . . . . . . . To generate a security log report . . . . . . To clear the log . . . . . . . . . . . . Creating list reports . . . . . . . . . . . To create a user list report . . . . . . . . To create a datastore list report . . . . . . . Commands for Access Server . . . . . . . . dmaddconnectionAdding a datastore connection to a user . . . . . . . . . . dmchangeconnectionChanging the connection parameters to a datastore . . . . . . . . . dmchangepasswordChanging the password on a user account . . . . . . . . . . . . dmcreatedatastoreAdding a datastore . . . . dmcreateuserAdding a user . . . . . . . dmdeleteconnectionDeleting a datastore connection . . . . . . . . . . . . . . dmdeletedatastoreDeleting a datastore . . . dmdeleteuserDeleting a user . . . . . . . dmdisableuserDisabling a user account . . . dmenableuserEnabling a user . . . . . . dmlistdatastoreusersGenerating a report list of users assigned to a datastore . . . . . . . dmlistuserdatastoresGenerating a report list of datastores assigned to a user . . . . . . . dmlistusersListing user accounts . . . . . dmresetuserResetting a user account . . . . dmunlockuserUnlocking a user account . . .

37 38 39 39 39 39 40 40 40 41 42 43 43 44 45 45 46 46 46 47 47 48 49 49

To delete a character encoding . To import the CSV template . . To export the CSV template . .

. . .

. . .

. . .

. . .

. . .

. 57 . 57 . 57

Setting up datastores for replication . . 59


Connecting to a datastore . . . . . . . . . To connect to a datastore . . . . . . . . Shutting down a datastore (InfoSphere CDC for Oracle) . . . . . . . . . . . . . . . To shut down a datastore . . . . . . . . Updating access parameters for a subscription . . To update access parameters for a subscription Setting system parameters on source and target datastores . . . . . . . . . . . . . . To add a system parameter . . . . . . . To modify a system parameter . . . . . . To delete a system parameter . . . . . . Creating aliases for a target datastore on a private network connection . . . . . . . . . . . To add an alias . . . . . . . . . . . To modify an alias . . . . . . . . . . To delete an alias . . . . . . . . . . . 59 . 59 . 60 . 60 . 60 60 . . . . . . . . 60 61 61 61 61 62 62 62

Upgrading subscriptions . . . . . . . 63
Upgrading Transformation Server subscriptions from version 5.3.4 to 6.2 . . . . . . . . To upgrade a subscription to Transformation Server for Microsoft SQL Server version 6.2 To transfer a bookmark to a new subscription To clear the log position for a subscription . . . . . . 63 . 63 . 64 . 64

Setting preferences in Management Console . . . . . . . . . . . . . . 51


Setting connection preferences . . . . . . . To specify a default port number . . . . . To specify outbound ports . . . . . . . To connect to databases automatically . . . Setting advanced preferences . . . . . . . To set timeout values . . . . . . . . . To allocate memory for Management Console . To verify that an automatic prompt for filtering tables is enabled . . . . . . . . . . . To disable an automatic prompt for filtering tables . . . . . . . . . . . . . . Setting prompt preferences . . . . . . . . To set prompt preferences . . . . . . . Setting statistics preferences . . . . . . . . To set the length of time for data retention . . To set the sample rate for data collection . . Setting the behavior of progress windows . . . To automatically close progress windows . . Showing usability hints . . . . . . . . . To show usability hints . . . . . . . . Setting view preferences . . . . . . . . . To set how subscriptions are grouped . . . To save project layouts automatically . . . . To set the number of events . . . . . . . Setting character encodings . . . . . . . . To add a character encoding . . . . . . . To modify a character encoding . . . . . . . . . . . . 51 51 52 52 52 52 53

Managing tables available for replication . . . . . . . . . . . . . 67


Updating, removing, and viewing tables for replication . . . . . . . . . . . . . To update the definition of a table . . . . To remove a table from Management Console To view the properties of a table . . . . . . . . . . . . 67 67 67 68

Setting notifications . . . . . . . . . 69
Selecting a notification handler . . . . . . . . Choosing a notification category and a message type Setting notifications for a datastore . . . . . . To set an email (MAPI) notification . . . . . To set an email (SMTP) notification . . . . . To set an email notification . . . . . . . . To set an email notification . . . . . . . . To set a notification for the TSDPRINT spool file To set a notification for an operator system log To set a notification for a UNIX system log . . . To set a notification using a user exit program . . To set a notification using a user exit program . . To set a notification using a user exit program . . To set a notification for a message queue . . . To filter a notification message . . . . . . . To copy notification settings . . . . . . . . Setting notifications for a subscription . . . . . To set notifications for a subscription . . . . . To view the datastore default notifications for a subscription . . . . . . . . . . . . . 70 71 72 72 73 73 74 74 74 75 75 75 76 76 77 77 77 77 78

. 53 . . . . . . . . . . . . . . . . . 53 53 54 54 54 54 55 55 55 55 55 55 56 56 56 56 57

iv

InfoSphere Change Data Capture Management Console: Administration Guide

Copying notifications for a subscription . . To copy notification settings . . . . . Setting latency thresholds and notifications . To set a latency threshold and notification

. . . .

. . . .

. . . .

78 78 78 79

Setting up and managing subscriptions 81


Using projects to organize your subscriptions . . . To add a new project . . . . . . . . . . To rename a project . . . . . . . . . . . To delete a project . . . . . . . . . . . Exporting and importing projects . . . . . . . To export projects . . . . . . . . . . . To import projects . . . . . . . . . . . Setting up subscriptions . . . . . . . . . . To add a subscription . . . . . . . . . . To modify a subscription . . . . . . . . . To delete a subscription . . . . . . . . . Specifying advanced settings for a subscription . . To specify a TCP host for a subscription . . . . To specify a firewall port for a subscription . . . To set propagation control on a subscription . . Searching for tables used in replication . . . . . To search for subscriptions that use a table in replication . . . . . . . . . . . . . . Setting up subscriptions for datastores outside of your organization . . . . . . . . . . . . To add a subscription for an external target datastore . . . . . . . . . . . . . . To modify a subscription for an external target datastore . . . . . . . . . . . . . . Copying subscriptions . . . . . . . . . . . To a copy subscription . . . . . . . . . . To copy a subscription for an external target datastore . . . . . . . . . . . . . . Setting properties for a subscription that targets IBM WebSphere DataStage . . . . . . . . . . . To specify batch size thresholds for a WebSphere DataStage subscription . . . . . . . . . To specify large object truncation size for a WebSphere DataStage subscription . . . . . Generating a WebSphere DataStage definition file for a subscription . . . . . . . . . . . . To generate a WebSphere DataStage definition file . . . . . . . . . . . . . . . . 81 82 82 82 82 82 83 83 83 84 84 84 85 85 85 86 86 86 87 87 88 88 88 89 89 90 90 90

To map a multi-member table using LiveAudit for AS/400 . . . . . . . . . . . . . To map multiple source tables to existing tables using LiveAudit . . . . . . . . . . . To map multiple source tables to new tables using LiveAudit . . . . . . . . . . . Mapping using WebSphere DataStage . . . . . To map a single source table to WebSphere DataStage using flat files . . . . . . . . To map a single source table to WebSphere DataStage using Direct Connect . . . . . . To map multiple source tables to WebSphere DataStage using flat files . . . . . . . . To map multiple source tables to WebSphere DataStage using Direct Connect . . . . . . Mapping using Adaptive Apply . . . . . . . To map a source table using Adaptive Apply To map multi-member source tables using Adaptive Apply on AS/400 . . . . . . . . Mapping to summarize data . . . . . . . . To map a source table to summarize data . . . To map multi-member source tables using Summarization on AS/400 . . . . . . . . Mapping to consolidate data (one-to-one) . . . . To map a source table to consolidate data (one-to-one) . . . . . . . . . . . . . To map multi-member source tables using Consolidation One-to-One on AS/400 . . . . Mapping to consolidate data (one-to-many) . . . To map a source table to consolidate data (one-to-many) . . . . . . . . . . . . To map multi-member source tables using Consolidation one-to-many on AS/400 . . . . Mapping to a datastore outside of your organization . . . . . . . . . . . . . . To map tables for a subscription on an external datastore . . . . . . . . . . . . . . Mapping to a JMS message destination using InfoSphere CDC Event Server . . . . . . . . To map multiple source tables to a JMS message destination . . . . . . . . . . . . . To map a single source table to a JMS message destination . . . . . . . . . . . . . To stage a source table . . . . . . . . .

102 104 105 106 106 107 108 109 110 110 112 113 114 115 117 117 119 121 122 124 126 126 127 127 129 131

Mapping tables . . . . . . . . . . . 91
Mapping using standard replication . . . . . . 91 To map similar source tables to similar target tables (One-to-One) . . . . . . . . . . . 92 To map a custom source table to a custom target table (standard) . . . . . . . . . . . . 93 To map multi-member source tables on AS/400 (standard) . . . . . . . . . . . . . . 95 To map multi-member source tables to existing target tables on AS/400 (one-to-one) . . . . . 97 To map multi-member source tables to new tables on AS/400 (one-to-one) . . . . . . . 99 Mapping using LiveAudit . . . . . . . . . 100 To map a single source table using LiveAudit 101

Managing table mappings . . . . . . 133


Remapping a source table . . . . . . . . . To remap a source table . . . . . . . . . To remap a source table (InfoSphere CDC Event Server) . . . . . . . . . . . . . . Changing the message destination . . . . . . To change the message destination of a table mapping . . . . . . . . . . . . . . Flagging a source table for a refresh . . . . . . To flag a source table for a refresh before mirroring . . . . . . . . . . . . . . Marking a table capture point on a source table To mark a table capture point on a source table before mirroring . . . . . . . . . . . Parking a table mapping from replication . . . . To park a table mapping from replication . . .
Contents

133 133 133 134 134 135 135 135 136 136 136

Changing the refresh order on a table mapping . . To change the refresh order on a table mapping Changing the replication method of a table mapping . . . . . . . . . . . . . . . To change the replication method of a table mapping . . . . . . . . . . . . . . Selecting a new journal table . . . . . . . . To select a new journal table . . . . . . . Setting members for replication . . . . . . . To select a member for replication . . . . . Deleting table mappings . . . . . . . . . . To delete a table mapping . . . . . . . . To delete a table mapping (InfoSphere CDC Event Server) . . . . . . . . . . . . Updating the definition of mapped source and target table in a subscription . . . . . . . . To update the definition of a source table . . . To update the definition of a target table . . .

137 137 137 138 139 139 140 140 140 140 141 141 142 142

To accumulate or deduct numeric data on a target column . . . . . . . . . . . Mapping source and target columns automatically To map columns automatically . . . . . Mapping initial values to target columns . . . To define an initial value for a target column Adding and mapping derived columns to target columns . . . . . . . . . . . . . . To add a derived column . . . . . . . To map a derived column to a target column To modify a derived column . . . . . . To delete a derived column . . . . . . .

. 159 160 . 160 . 161 161 . 162 . 163 164 . 164 . 165

Filtering rows and columns . . . . . 167


Filtering rows . . . . . . . . . To filter rows . . . . . . . . Selecting critical columns to filter rows . To select critical columns . . . . Filtering columns . . . . . . . . To filter columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 167 168 168 168 169

Customizing JMS message destination mappings . . . . . . . . 143


Creating an XML message . . . . . . . . To create an XML message . . . . . . . Importing and exporting XML files, schemas, and mapping projects . . . . . . . . . . . To import an XML, schema, or mapping definition file . . . . . . . . . . . To export an XML schema or mapping definition file . . . . . . . . . . . Building an XPath expression . . . . . . . To build an XPath expression . . . . . . Querying columns from other tables . . . . . To query columns from other tables . . . . . 143 . 143 . 144 . 145 . . . . . 145 146 146 147 147

Setting data translations on column mappings . . . . . . . . . . . . . 171


Setting data translations . . . . . . . To add a data translation . . . . . To modify a data translation . . . . To delete a data translation . . . . . Importing and exporting data translations . To import a data translation . . . . To export a data translation . . . . . . . . . . . . . . . . . . . . . . . . . 171 172 172 173 173 173 174

Setting multibyte and Unicode character set conversions . . . . . . 175


Setting multibyte conversionscommon scenarios Converting multibyte character sets . . . . . . To convert multibyte character sets . . . . . Handling Unicode character encodings . . . . . To set handling for Unicode character encodings 175 175 176 176 177

Setting JMS message header properties . . . . . . . . . . . . . 151


Defining the JMS message header . . . . . . To add a JMS message header property . . . To add a custom JMS message header property To delete a custom JMS message header property . . . . . . . . . . . . . . Setting general runtime options . . . . . . . To enable InfoSphere CDC Event Server to trim text . . . . . . . . . . . . . . . . To disable InfoSphere CDC Event Server from differentiating between an empty string from a NULL value . . . . . . . . . . . . . To disable streamed transformation mode . . . Selecting a character encoding . . . . . . . . To select a character encoding . . . . . . . 151 151 152 152 153 153

Controlling row operations . . . . . 179


Suppressing the apply of row operations . . . . To suppress an insert, update, or delete . . . Preventing the audit of row operations . . . . . To prevent row operations from being audited To audit only the after image . . . . . . . Detecting conflicts on row operations . . . . . To detect conflicts on row operations . . . . Enabling the apply of soft deletes (InfoSphere CDC for Oracle) . . . . . . . . . . . . . . To enable InfoSphere CDC for Oracle to apply a soft delete . . . . . . . . . . . . . 179 179 180 180 180 181 181 182 182

154 154 154 155

Mapping columns . . . . . . . . . 157


Mapping source columns to target columns . . To map a source column to a target column . Mapping journal control fields to target columns To map a journal control field to a target column . . . . . . . . . . . . . Mapping expressions to target columns . . . To map an expression to a target column . . . 157 . 157 158 . 158 . 158 . 159

Controlling table operations . . . . . 183


Controlling the apply of refresh operations To keep all rows on a refresh . . . . To delete all rows on a refresh . . . . To audit rows on a refresh . . . . . Specifying SQL to control refresh operations To specify additional SQL after a refresh . . . . . . . . . . . . . . . . . . 183 183 184 184 184 185

vi

InfoSphere Change Data Capture Management Console: Administration Guide

To delete selected rows on a refresh .

. 186

Setting member identifiers . . . . . . 187


Setting member identifiers for multi-member source tables . . . . . . . . . . . To add a member identifier . . . . . . To modify a member identifier . . . . To delete a member identifier . . . . . . . . . . . . . 187 187 188 188

Setting conflict detection and resolution . . . . . . . . . . . . . 189


Resolving conflicts for source or target wins . To resolve conflicts for source row wins . To resolve conflicts for target row wins . . Resolving conflicts for largest or smallest value wins . . . . . . . . . . . . . . To resolve conflicts for largest value wins . To resolve conflicts for smallest value wins Resolving conflicts with user exits . . . . To resolve conflicts with user exit programs . . . . . . . . . 189 . 190 . 191 . . . . . 191 193 193 194 195

To configure a user exit for a Java class . . . . Configuring user exits for InfoSphere CDC for Oracle or InfoSphere CDC for Sybase . . . . . To configure a C shared library . . . . . . To configure a stored procedure (Oracle and Sybase) . . . . . . . . . . . . . . To configure a derived column or an expression that calls %STPROC (Oracle and Sybase) . . . Configuring user exits for InfoSphere CDC for AS/400 (version 6.2 and below) or InfoSphere CDC for z/OS . . . . . . . . . . . . . . . To configure a standard function . . . . . . Creating a custom data format for IBM WebSphere DataStage . . . . . . . . . . . . . . To create a custom data format for WebSphere DataStage . . . . . . . . . . . . .

214 216 216 217 218

219 219 220 220

Configuring user exits for InfoSphere CDC Event Server . . . . . . . . . 221


Overriding JMS message header properties . . To override JMS message header properties . Sending the XML message to a different JMS message destination . . . . . . . . . . To send the XML message to another JMS message destination . . . . . . . . . Creating XML output and applying XSLT to an XML message . . . . . . . . . . . . To create an XML message and apply XSLT . Sending XML messages to multiple JMS message destinations . . . . . . . . . . . . . To send an XML message to a different JMS message destination . . . . . . . . . Querying a Web service to access content . . . To query a Web service to access content . . Content based routing . . . . . . . . . To route the content of an XML message to another JMS message destination . . . . . . 221 . 222 . 223 . 223 . 224 . 225 . 226 . . . . 226 227 227 228

Starting and ending replication on subscriptions . . . . . . . . . . . 197


Starting mirroring on a subscription . . . . To start continuous mirroring . . . . . To start net-change mirroring . . . . . Starting a refresh on a subscription . . . . To start a refresh . . . . . . . . . Ending replication on a subscription. . . . To end replication . . . . . . . . . Sending XML messages to a JMS message destination . . . . . . . . . . . . To send an XML message to a JMS message destination or a staging target database. . . . . . . . . . . . . . . . . . 197 197 197 198 198 198 199

. 199 . 199

Promoting changes to subscriptions


Before you promote a subscription . . . . . Promoting subscriptions . . . . . . . . . To promote a subscription to a new environment . . . . . . . . . . . . To promote changes to an existing subscription Exporting and importing subscriptions . . . . To import a subscription from an XML file . To export a subscription into an XML file . .

201
. 201 . 202 . 202 204 . 205 . 205 . 205

. 229

Monitoring your subscriptions . . . . 231


About the state and status of your subscriptions Subscription state . . . . . . . . . . . Subscription status . . . . . . . . . . Displaying event messages during replication . . To show the event log for a subscription . . . To view event details . . . . . . . . . . To copy events . . . . . . . . . . . . To clear events . . . . . . . . . . . . To export events . . . . . . . . . . . Profiling the latency and throughput performance of your subscription . . . . . . . . . . . To start profiling the performance of a subscription . . . . . . . . . . . . . To stop profiling the performance of a subscription . . . . . . . . . . . . . To view and save plotted performance statistics of a subscription . . . . . . . . . . . Displaying a graphical view of your subscription 231 232 232 232 233 233 234 234 235 235 236 237 237 238

Configuring user exits . . . . . . . 207


Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB . . . . . . . . . . . . . . . . To configure for IDispatch COM DLL . . . . To configure for C or C++ . . . . . . . . To configure a stored procedure (Microsoft SQL Server version 5.3) . . . . . . . . . . . To configure a stored procedure (Microsoft SQL Server (version 6.0 and higher) and DB2 UDB (version 6.1 and higher)) . . . . . . . . To configure a derived column or an expression that calls %STPROC (Microsoft SQL Server 6.0 and above and DB2 UBD 6.1 and above) . . . 207 209 210 211

213

214

Using InfoSphere CDC with IBM WebSphere DataStage . . . . . . . 241


Contents

vii

Before configuring InfoSphere CDC for WebSphere DataStage . . . . . . . . . . . . . . Configuring InfoSphere CDC to send data to WebSphere DataStage . . . . . . . . . . Adding a subscription for WebSphere DataStage Mapping tables to WebSphere DataStage . . . Customizing your WebSphere DataStage table mappings . . . . . . . . . . . . . Generating a WebSphere DataStage Definition File . . . . . . . . . . . . . . . . Creating a custom data format for WebSphere DataStage . . . . . . . . . . . . . Starting replication in Management Console . . .

241 241 241 242 242 242 242 243

Using journal control fields for auditing replication activities . . . . 245


About journal control fields . . . . . . Commit Cycle ID (&CCID) . . . . . . Source RRN (&CNTRRN) . . . . . . Entry Type Code (&CODE) . . . . . . Entry Type (&ENTTYP) . . . . . . . Source Job Name (&JOB) . . . . . . Source Job Number (&JOBNO) . . . . Source Job User (&JOBUSER) . . . . . Journal Name (&JOURNAL) . . . . . Source Table Library (&LIBRARY) . . . Source Table Member Name (&MEMBER) . Source Table Name (&OBJECT) . . . . Source Program Name (&PROGRAM) . . Journal Sequence Number (&SEQNO) . . Source Server Name (&SYSTEM) . . . . Record Modification Time (&TIMESTAMP) Record Modification User (&USER) . . . About journal codes . . . . . . . . . Table Clear . . . . . . . . . . . Delete . . . . . . . . . . . . . Insert . . . . . . . . . . . . . Update Before . . . . . . . . . . Update After . . . . . . . . . . Translating journal codes into meaningful information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 246 246 247 247 248 249 250 250 251 252 252 253 254 254 255 256 257 257 258 258 258 259

. 259

Column functions . . . . . . . . . 261


Conventions in using column functions String functions . . . . . . . . Concatenation%CONCAT . . . Lowercase%LOWER . . . . . Left trim%LTRIM . . . . . . Capitalization%PROPER . . . . Character substitution%REPLACE . Right trim%RTRIM . . . . . . Substring%SUBSTRING . . . . Uppercase%UPPER . . . . . Date and time functions . . . . . . Century%CENTURY . . . . . Current date%CURDATE. . . . Current time%CURTIME . . . . Current timestamp%CURTMSTP . Conversion functions . . . . . . . Character conversion%TOCHAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 262 262 263 263 264 265 266 267 268 269 269 270 271 273 274 274

Date conversion%TODATE . . . . . . . Date and time conversion%TODATETIME Number conversion%TONUMBER . . . . Time conversion%TOTIME . . . . . . . Conditional and variable functions . . . . . . Conditional%IF . . . . . . . . . . . Variable%VAR . . . . . . . . . . . Data functions . . . . . . . . . . . . . Before value%BEFORE . . . . . . . . Current value%CURR . . . . . . . . . Retrieve column%GETCOL (DB2 UDB for iSeries) . . . . . . . . . . . . . . Retrieve column%GETCOL (Dynamic SQL) Retrieve column%SELECT . . . . . . . User exit functions . . . . . . . . . . . Stored procedure%STPROC . . . . . . . User exit%USER . . . . . . . . . . User exit%USER (InfoSphere CDC for Microsoft SQL 5.x) . . . . . . . . . . . User Exit%USERFUNC . . . . . . . . %GETCOL column function scenarios (DB2 UDB for iSeries) . . . . . . . . . . . . . . Retrieving a column from another table using the %GETCOL function (DB2 UDB for iSeries) . Performing an outer join using the %GETCOL function (DB2 UDB for iSeries) . . . . . . Nesting columns to join data using the %GETCOL function (DB2 UDB for iSeries) . . Combining columns using the %GETCOL function (DB2 UDB for iSeries) . . . . . . %GETCOL column function scenarios (Dynamic SQL) . . . . . . . . . . . . . . . . Retrieving a column using the %GETCOL function (Dynamic SQL) . . . . . . . . . Retrieving a column using the %GETCOL function without reading the same row from the table . . . . . . . . . . . . . . . Retrieving a column using nested %GETCOL functions (Dynamic SQL) . . . . . . . . Filtering rows using the %GETCOL function (Dynamic SQL) . . . . . . . . . . . . Publishing multiple derived columns using the %GETCOL function (Dynamic SQL) . . . . . .

275 277 279 280 282 282 283 284 284 284 285 288 293 297 297 298 302 303 305 305 306 306 306 307 307

308 308 309 309

System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) . . . . . . . 313
General product system parameters AuthCode . . . . . . . DBMS . . . . . . . . . dbUser . . . . . . . . dllname . . . . . . . . DSN . . . . . . . . . NetServiceName . . . . . pwdencrypt . . . . . . . Startup Timeout . . . . . TSSrcCP . . . . . . . . TSTgtCP . . . . . . . . TCP_KEEPALIVE_SECS . . . WindowsAuthentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313 314 314 314 314 314 315 315 315 315 316 316 316

viii

InfoSphere Change Data Capture Management Console: Administration Guide

Replication system parameters . . . . AutoRestart . . . . . . . . . . convertNotNullableColumns . . . . MirrorError . . . . . . . . . . RefreshError . . . . . . . . . . RefreshMode . . . . . . . . . Database translation log system parameters Cleanup Interval . . . . . . . . Cleanup Log Events . . . . . . . Cleanup Record Count . . . . . . LogCleanupMethod . . . . . . . Report Position Interval . . . . . . Synchronization Interval . . . . . . Commitment control system parameters . CommitmentControl . . . . . . . Commitment Group Size . . . . . RefreshBlock . . . . . . . . . SeparateCommits . . . . . . . . Event log system parameters . . . . . AllowEventLogClear . . . . . . . Multibyte character set system parameters. Unicode Handling . . . . . . . . Latency system parameters . . . . . . Deadband Percentage . . . . . . Monitor Sample Interval . . . . . . Notification system parameters . . . . convertNotNullableMsg . . . . . . DM_STATUS_INTERVAL . . . . . Heartbeat Timeout. . . . . . . . InvalidNumericMsg . . . . . . . Tracing system parameters . . . . . . CommTrace . . . . . . . . . . ProgramTrace . . . . . . . . . traceActive . . . . . . . . . . TraceLevel . . . . . . . . . . trcCleanup . . . . . . . . . . trcCOMM . . . . . . . . . . trcFiles . . . . . . . . . . . trcFncCalls . . . . . . . . . . trcJrlSync . . . . . . . . . . . trcReplStatus . . . . . . . . . trcScan . . . . . . . . . . . trcSQL. . . . . . . . . . . . trcThread . . . . . . . . . . . Data type system parameters . . . . . TrimVarchar . . . . . . . . . . Lock detection system parameters . . . DeadlockRetrys . . . . . . . . . DM_LOCK_DETECTION . . . . . DM_LOCK_TIMEOUT . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

317 317 317 318 318 319 319 319 320 320 321 322 322 323 323 324 324 325 325 325 325 325 326 326 329 329 329 330 331 331 332 332 332 333 333 333 333 334 334 334 334 334 334 335 335 335 335 335 335 336

mirror_commit_after_max_operations . . . . 339 mirror_commit_on_transaction_boundary . . . 340 refresh_commit_after_max_operations . . . . 340 Encoding system parameters . . . . . . . . 341 global_unicode_as_char . . . . . . . . . 341 Supplemental logging system parameters . . . . 342 mirror_logging_by_empty_triggers . . . . . 342 Disk resource system parameters . . . . . . . 343 mirror_memory_txqueue_total_mb . . . . . 343 mirror_memory_txqueue_each_mb . . . . . 343 global_memory_lob_cache_mb. . . . . . . 343 mirror_queue_for_buffers_between_cdc_threads_operations 344 Apply process system parameters . . . . . . 344 mirror_end_on_error . . . . . . . . . . 344 refresh_end_on_error . . . . . . . . . . 344 Authentication system parameters . . . . . . 345 global_ts_user_authentication_method . . . . 345

System parameters for InfoSphere CDC for Oracle (version 6.2 and below) . . . . . . . . . . . . . . 347
General product system parameters . . . . . . 347 CODE_PAGE . . . . . . . . . . . . 348 DEFAULT_ORACLE_HOME . . . . . . . 348 DEFAULT_ORACLE_SID . . . . . . . . 348 DEFAULT_ORACLE_USER . . . . . . . . 349 DM_COMMS_HOME . . . . . . . . . 349 D_MIRROR_HOME . . . . . . . . . . 349 D_MIRROR_LOG . . . . . . . . . . . 349 DM_DYNAMIC_PARAMETER_CHECK_INT 350 DM_MAX_MONITOR_ENTRIES . . . . . . 350 DM_TS_MAX_POOL_SIZE_MB . . . . . . 350 DM_TS_POOL_BLOCK_SIZE_MB . . . . . 351 <subscription>_MAX_POOL_SIZE_MB . . . . 351 <subscription>_POOL_BLOCK_SIZE_MB . . . 352 LD_LIBRARY_PATH . . . . . . . . . . 353 LIBPATH . . . . . . . . . . . . . . 353 ORACLE_HOME . . . . . . . . . . . 353 ORACLE_SID . . . . . . . . . . . . 353 PASSWORD . . . . . . . . . . . . . 354 PUBLISH_METADATA . . . . . . . . . 354 RLD_SYSTEM_TXQSIZE . . . . . . . . 354 <subscription>_TXQSIZE . . . . . . . . 355 SHLIB_PATH . . . . . . . . . . . . 355 STARTUP_TIMEOUT . . . . . . . . . . 355 TCP_KEEPALIVE_SECS . . . . . . . . . 356 USER . . . . . . . . . . . . . . . 356 Apply process system parameters . . . . . . 357 convertNotNullableColumns . . . . . . . 357 D_MIRROR_MIRROR_ERROR_LIST. . . . . 358 D_MIRROR_MIRROR_ERROR_STOP . . . . 358 D_MIRROR_REFRESH_ERROR_LIST . . . . 359 D_MIRROR_REFRESH_ERROR_STOP . . . . 359 DM_ADAPTIVE_APPLY_SOFT_DELETES . . . 359 DM_ADAPTIVE_APPLY_<SCHEMA>.<TABLENAME> 360 DM_ADAPTIVE_APPLY_MIMIC_SOURCE_OPERATION 360 DM_ARRAY_BIND_MAX . . . . . . . . 361 FILTER_NOCHANGE_UPDATES_FOR_AUDIT 361 NLS_LANG . . . . . . . . . . . . . 362 NLS_NCHAR . . . . . . . . . . . . 362
Contents

System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) . . . . . . . 337
Notification system parameters . . . . . . . 337 global_shutdown_after_no_heartbeat_response_minutes 337 global_conversion_not_possible_warning . . . 338 Maximize throughput system parameters . . . . 338 mirror_commit_after_max_transactions . . . . 339 mirror_commit_after_max_seconds . . . . . 339

ix

NOT_NULL_DATE_DEFAULT . . . . . . 362 TRIM_CHAR_TO_VARCHAR . . . . . . . 362 TRIM_VARCHAR_TO_VARCHAR . . . . . 363 TRIM_TO_NULL . . . . . . . . . . . 363 UNICODE_HANDLING. . . . . . . . . 364 Cascading replication system parameters . . . . 365 CASCADE_OMIT_TARGETS . . . . . . . 365 PREVENT_RECURSION. . . . . . . . . 365 Database journal (trigger) system parameters . . . 366 REPORT_POSITION_INTERVAL . . . . . . 366 MONITOR_PURGE_INTERVAL . . . . . . 367 MONITOR_REFRESH_PERIOD . . . . . . 367 Maximize throughput system parameters . . . . 367 COMMIT_GROUP_SIZE. . . . . . . . . 368 COMMIT_LEVEL . . . . . . . . . . . 368 COMMIT_INTERVAL . . . . . . . . . 369 MAINTAIN_TRANSACTION_CONSISTENCY 370 SYNCHRONIZATION_COMMIT_ GROUP_SIZE . . . . . . . . . . . . 370 SYNCHRONIZATION_INTERVAL . . . . . 371 TRANSACTION_GROUP_SIZE . . . . . . 371 TRANSACTION_INTERVAL . . . . . . . 372 TRANSACTION_RECORDS_THRESHOLD . . 372 Tracing system parameters . . . . . . . . . 372 D_MIRROR_SP_TRACE . . . . . . . . . 373 D_MIRROR_TRACE . . . . . . . . . . 373 D_MIRROR_TRACE_FILE_SIZE . . . . . . 373 D_MIRROR_TRACE_ON_ERROR . . . . . 374 DM_PRINT_DIAGNOSTICS . . . . . . . 374 D_MIRROR_ALARM_TRACE . . . . . . . 375 Refresh loader system parameters . . . . . . 375 DIRPATH_BUF_ROWS . . . . . . . . . 375 DIRPATH_BUF_SIZE . . . . . . . . . . 376 DIRPATH_CACHE_DATE_SIZE . . . . . . 377 DIRPATH_LOAD . . . . . . . . . . . 377 DIRPATH_LOGGING . . . . . . . . . 378 DIRPATH_DO_RECOVERY. . . . . . . . 378 User exit system parameters . . . . . . . . 379 D_MIRROR_SP_CONNECTION . . . . . . 379 DM_FROM_CODEPAGE_V4USEREXIT. . . . 379 DM_TO_CODEPAGE_V4USEREXIT . . . . . 380 Table mapping system parameters . . . . . . 380 TS_DELETE_ASSIGNED_OBJECTS_DURING_DESCRIBE 380 Notification system parameters . . . . . . . 381 convertNotNullableMsg . . . . . . . . . 381 DEADBAND_PERCENTAGE . . . . . . . 381 DM_STATUS_INTERVAL . . . . . . . . 384 HEARTBEAT_TIMEOUT . . . . . . . . 384 LOG_EMAIL_USERNAME . . . . . . . . 385 MONITOR_SAMPLE_INTERVAL . . . . . . 385 STATISTICS_INTERVAL . . . . . . . . . 386 Disk resource system parameters . . . . . . . 386 LOG_MAX_SIZE . . . . . . . . . . . 386

Notification system parameters . . . . . . . 388 events_max_retain . . . . . . . . . . . 388 global_shutdown_after_no_heartbeat_response_minutes 388 global_conversion_not_possible_warning . . . 389 Maximize throughput system parameters . . . . 389 mirror_commit_on_transaction_boundary . . . 389 mirror_sess_hist_age_threshold . . . . . . 390 mirror_src_ora_version . . . . . . . . . 390 refresh_commit_after_max_operations . . . . 390 userexit_max_lob_size_queue . . . . . . . 391 Database journal (trigger) system parameters . . . 391 mirror_journal_schema . . . . . . . . . 391 Encoding system parameters . . . . . . . . 391 global_unicode_as_char . . . . . . . . . 392 Disk resource system parameters . . . . . . . 392 mirror_queue_for_buffers_between_cdc_threads_operations 392 mirror_global_disk_quota_mb . . . . . . . 393 Apply process system parameters . . . . . . 393 convert_not_nullable_column . . . . . . . 393 global_max_batch_size . . . . . . . . . 394 mirror_end_on_error . . . . . . . . . . 394 refresh_end_on_error . . . . . . . . . . 394 refresh_allow_fast_loader . . . . . . . . 395 refresh_allow_jdbc_batch . . . . . . . . 395 mirror_expected_errors_list . . . . . . . . 395 refresh_in_unicode . . . . . . . . . . 396 trim_char_to_varchar . . . . . . . . . . 396 trim_varchar_to_varchar . . . . . . . . . 396 User exit system parameters . . . . . . . . 397 userexit_max_lob_size_kb . . . . . . . . 397

System parameters for InfoSphere CDC for Sybase (version 6.0 and below) . . . . . . . . . . . . . . 399
General product system parameters . . . . . CODE_PAGE . . . . . . . . . . . D_MIRROR_HOME . . . . . . . . . D_MIRROR_LOG . . . . . . . . . . DM_DYNAMIC_PARAMETER_CHECK_INT DM_MAX_MONITOR_ENTRIES . . . . . DSQUERY . . . . . . . . . . . . LD_LIBRARY_PATH . . . . . . . . . LIBPATH . . . . . . . . . . . . . PUBLISH_METADATA . . . . . . . . SYBASE . . . . . . . . . . . . . SYBASE_OCS . . . . . . . . . . . SHLIB_PATH . . . . . . . . . . . STARTUP_TIMEOUT . . . . . . . . . USER . . . . . . . . . . . . . . Apply process system parameters . . . . . convertNotNullableColumns . . . . . . D_MIRROR_MIRROR_ERROR_STOP . . . D_MIRROR_REFRESH_ERROR_STOP . . . FILTER_NOCHANGE_UPDATES_FOR_AUDIT NLS_LANG . . . . . . . . . . . . TRANSACTION_GROUP_SIZE . . . . . TRANSACTION_INTERVAL . . . . . . TRANSACTION_RECORDS_THRESHOLD . TRIM_CHAR_TO_VARCHAR . . . . . . TRIM_VARCHAR_TO_VARCHAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399 400 400 400 400 401 401 401 402 402 402 402 403 403 403 404 404 405 405 405 406 406 407 407 407 408

System parameters for InfoSphere CDC for Oracle (version 6.3 and above) . . . . . . . . . . . . . . 387
General product system parameters . . . mirror_set_table_data_capture_timeout . mirror_asm_oracle_path . . . . . . . . . . . . . 387 . 387 . 388

InfoSphere Change Data Capture Management Console: Administration Guide

TRIM_TO_NULL . . . . . . . . . Cascading replication system parameters . . PREVENT_RECURSION. . . . . . . Database journal (trigger) system parameters . REPORT_POSITION_INTERVAL . . . . Maximize throughput system parameters . . COMMIT_GROUP_SIZE . . . . . . . COMMIT_INTERVAL . . . . . . . SYNCHRONIZATION_COMMIT_ GROUP_SIZE . . . . . . . . . . SYNCHRONIZATION_INTERVAL . . . Tracing system parameters . . . . . . . D_MIRROR_TRACE . . . . . . . . D_MIRROR_TRACE_FILE_SIZE . . . . D_MIRROR_TRACE_ON_ERROR . . . Notification system parameters . . . . . convertNotNullableMsg . . . . . . . DEADBAND_PERCENTAGE . . . . . DM_STATUS_INTERVAL . . . . . . HEARTBEAT_TIMEOUT . . . . . . LOG_EMAIL_USERNAME . . . . . . MONITOR_SAMPLE_INTERVAL . . . . STATISTICS_INTERVAL . . . . . . . Disk resource system parameters . . . . . LOG_MAX_SIZE . . . . . . . . . Refresh loader system parameters . . . . D_HOME_BCP . . . . . . . . . . D_MIRROR_BCP . . . . . . . . . D_MIRROR_BCP_ROWS . . . . . . D_MIRROR_FASTBCP . . . . . . . DM_BCP_PACKET_SIZE . . . . . .

General product system parameters . . . . . . 435 Authorization Code . . . . . . . . . . 436 . . 412 Enable *MAXOPT3 Option . . . . . . . . 436 . . 413 Record Format Check . . . . . . . . . 436 . . 413 Startup Timeout . . . . . . . . . . . 436 . . 414 TCP_KEEPALIVE_SECS . . . . . . . . . 437 . . 414 Replication system parameters . . . . . . . 437 . . 414 Allow Refresh While Active . . . . . . . 438 . . 415 End on Error During Mirroring . . . . . . 438 . . 415 End on Error During Refresh . . . . . . . 438 . . 416 Refresh After Restore . . . . . . . . . . 439 . . 418 Cascading replication system parameters . . . . 439 . . 418 Enable Cascading Replicates . . . . . . . 439 . . 419 Database journal (trigger) system parameters . . . 440 . . 419 Default Journal Library . . . . . . . . . 440 . . 420 Default Journal Name . . . . . . . . . 440 . . 420 Report Position Interval . . . . . . . . . 441 . . 420 Synchronization Interval . . . . . . . . . 441 . . 421 Remote journal system parameters . . . . . . 442 . . 421 Data Origin TCP/IP Name . . . . . . . . 442 . . 421 Data Origin Port . . . . . . . . . . . 442 . . 421 Relational Database Directory Entry . . . . . 443 . . 422 Commitment control system parameters . . . . 443 . . 422 Commitment Control . . . . . . . . . . 443 Multibyte character set system parameters. . . . 444 System parameters for InfoSphere Unicode Handling . . . . . . . . . . . 444 CDC for Sybase (version 6.3 and Latency system parameters . . . . . . . . . 445 above) . . . . . . . . . . . . . . 425 Deadband Percentage . . . . . . . . . 445 Notification system parameters . . . . . . . 425 Monitor Sample Interval . . . . . . . . . 447 events_max_retain . . . . . . . . . . . 425 Notification system parameters . . . . . . . 447 global_shutdown_after_no_heartbeat_response_minutes 426 Heartbeat Timeout. . . . . . . . . . . 448 global_conversion_not_possible_warning . . . 426 Messages on Column Not Null Capable . . . 448 Maximize throughput system parameters . . . . 426 Messages on Invalid Numerics . . . . . . 449 global_max_batch_size . . . . . . . . . 427 Progress Status Interval . . . . . . . . . 449 mirror_commit_on_transaction_boundary . . . 427 Data type system parameters . . . . . . . . 450 refresh_commit_after_max_operations . . . . 428 Numeric Column Validation . . . . . . . 450 Encoding system parameters . . . . . . . . 428 Date and time column function system parameters 450 global_unicode_as_char . . . . . . . . . 428 Default Date On Error . . . . . . . . . 450 Disk resource system parameters . . . . . . . 429 Row and column filtering system parameters . . . 451 global_memory_lob_cache_mb. . . . . . . 429 Audit Filtered Transactions . . . . . . . . 451 mirror_global_disk_quota_mb . . . . . . . 429 Critical Column Filtering . . . . . . . . 452 mirror_memory_txqueue_each_mb . . . . . 430 Event log system parameters . . . . . . . . 452 mirror_memory_txqueue_total_mb . . . . . 430 Notify Message Queue . . . . . . . . . 452 mirror_queue_for_buffers_between_cdc_threads_operations Notify Message Queue Library . . . . . . 453 430 Apply process system parameters . . . . . . 431 Notify Message Threshold . . . . . . . . 453 convert_not_nullable_column . . . . . . . 431 Lock detection system parameters . . . . . . 453 mirror_end_on_error . . . . . . . . . . 431 Lock Timeout Value . . . . . . . . . . 453 refresh_end_on_error . . . . . . . . . . 431 userexit_max_lob_size_kb . . . . . . . . 432 System parameters for InfoSphere mirror_expected_errors_list . . . . . . . . 432 CDC for DB2 UDB, PointBase, and refresh_expected_errors_list . . . . . . . 432 Teradata (version 6.0 and below) . . . 455 trim_char_to_varchar . . . . . . . . . . 433 General product system parameters . . . . . . 455 trim_varchar_to_varchar . . . . . . . . . 433 audit_auth_ code . . . . . . . . . . . 456
Contents

. . . . . . . .

. . . . . . . .

408 409 409 410 410 410 411 412

Supplemental logging system parameters . auto_configure_supplemental_logging . mirror_logging_by_empty_triggers . .

. . .

. . .

. 433 . 433 . 434

System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) . . . . . . . . . . . . . . 435

xi

auth_ code . . . . . . . . . . db_password . . . . . . . . . db_user . . . . . . . . . . . debug . . . . . . . . . . . . engine_ port . . . . . . . . . . log_file_quota . . . . . . . . . log_total_quota . . . . . . . . . md_db_url . . . . . . . . . . md_schema . . . . . . . . . . scrape_timeout . . . . . . . . . startup_timeout . . . . . . . . target_assert . . . . . . . . . . target_debug . . . . . . . . . target_initial_codepage . . . . . . ts_password . . . . . . . . . . ts_product . . . . . . . . . . use_uni_listener . . . . . . . . Access Server system parameters . . . . accessserver_udp_ listenport . . . . agent_assert . . . . . . . . . . agent_debug. . . . . . . . . . agent_jdbcdb2_driver . . . . . . . agent_jdbcdb2_driver_net . . . . . agent_jdbcpb_driver . . . . . . . agent_jdbcpb_driver_net. . . . . . agent_max_connections_num . . . . agent_message_version . . . . . . agent_msg_resources_file . . . . . agent_src_engine_address . . . . . agent_src_engine_port . . . . . . agent_src_engine_socket_tmout . . . agent_trace_in_message . . . . . . agent_trace_out_message . . . . . agent_udp_ listenport . . . . . . Cascading replication system parameters . cascade_replication . . . . . . . Commitment control system parameters . commit_group_size . . . . . . . commit_ interval . . . . . . . . refresh_commit_ block_size . . . . . scraper_trans_ num_limit . . . . . target_default_commit_level . . . . Database translation log system parameters report_position_interval . . . . . . Fastload system parameters . . . . . del_fastload_file . . . . . . . . dofastload . . . . . . . . . . fastload_backup_path . . . . . . fastload_in_whole . . . . . . . . fastload_path . . . . . . . . . make_fastload_log_file . . . . . . max_fastload_ file_size . . . . . . Latency system parameters . . . . . . monitor_sample_interval . . . . . Lock detection system parameters . . . dm_lock_detection. . . . . . . . dm_lock_timeout . . . . . . . . Multibyte character set system parameters. unicode_handling . . . . . . . . Notification system parameters . . . . dm_status_interval . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

456 456 456 457 457 457 457 457 457 457 457 458 458 458 458 458 458 458 459 459 459 459 459 459 459 460 460 460 460 460 460 460 460 460 461 461 461 461 462 463 463 464 464 464 465 465 466 466 467 467 467 468 468 468 469 469 469 470 470 471 471

heartbeat_timeout . . . . . . . . . . Replication system parameters . . . . . . dobatch . . . . . . . . . . . . . source_default_active_refresh . . . . . . source_default_replication_type . . . . . target_mirror_number_of_errors_before_abort target_print_refresh_details . . . . . . . target_refresh_number_of_errors_before_abort Tracing system parameters . . . . . . . . message_handler_trace_level . . . . . . message_trace_level . . . . . . . . . target_trace_logical_messages . . . . . . target_trace_physical_messages . . . . . trace_level . . . . . . . . . . . . trace_on . . . . . . . . . . . . . Teradata TPump system parameters . . . . . tpump_arc_data_files . . . . . . . . . tpump_files_root_folder . . . . . . . . tpump_logging . . . . . . . . . . . tpump_max_file_size . . . . . . . . . tpump_script_params_file . . . . . . . tpump_script_val_file. . . . . . . . . tpump_ timeout . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . .

472 472 472 473 473 473 473 474 474 474 474 474 474 474 474 475 475 475 476 477 477 477 478

System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) . . . . . . . . . . . . . . 479
Notification system parameters . . . . . . . 479 global_shutdown_after_no_heartbeat_response_minutes 479 global_conversion_not_possible_warning . . . 480 Maximize throughput system parameters . . . . 480 mirror_commit_after_max_transactions . . . . 481 mirror_commit_after_max_seconds . . . . . 481 mirror_commit_after_max_operations . . . . 481 mirror_commit_on_transaction_boundary . . . 482 refresh_commit_after_max_operations . . . . 482 Encoding system parameters . . . . . . . . 483 global_unicode_as_char . . . . . . . . . 483 Disk resource system parameters . . . . . . . 484 mirror_memory_txqueue_total_mb . . . . . 484 mirror_memory_txqueue_each_mb . . . . . 484 global_memory_lob_cache_mb. . . . . . . 484 mirror_queue_for_buffers_between_cdc_threads_operations 485 Apply process system parameters . . . . . . 485 mirror_end_on_error . . . . . . . . . . 485 refresh_end_on_error . . . . . . . . . . 485

System parameters for InfoSphere CDC for Teradata (version 6.2 and above) . . . . . . . . . . . . . . 487
Notification system parameters . . . . . . . 487 global_shutdown_after_no_heartbeat_response_minutes 487 global_conversion_not_possible_warning . . . 488 Apply process system parameters . . . . . . 488 mirror_end_on_error . . . . . . . . . . 488 refresh_end_on_error . . . . . . . . . . 488 Teradata TPump system parameters . . . . . . 489 mirror_tpump_files_root_folder_path . . . . 489 mirror_tpump_max_file_size_mb . . . . . . 490 mirror_tpump_script_val_file_name . . . . . 490

xii

InfoSphere Change Data Capture Management Console: Administration Guide

mirror_tpump_timeout_seconds . . Fastload system parameters . . . . refresh_max_fastload_file_size_mb .

. . .

. . .

. . .

. 491 . 492 . 492

System parameters for InfoSphere CDC Event Server . . . . . . . . . 493


Notification system parameters . . . . global_conversion_not_possible_warning Apply process system parameters . . . mirror_end_on_error . . . . . . . refresh_end_on_error . . . . . . . userexit_max_lob_size_kb . . . . . . . . . . . . . . . . . . . . . . . 493 493 494 494 494 494

System parameters for InfoSphere CDC for WebSphere DataStage . . . . 497


Notification system parameters . . . . . . . 497 global_shutdown_after_no_heartbeat_response_minutes 497 global_conversion_not_possible_warning . . . 498 Apply process system parameters . . . . . . 498 mirror_end_on_error . . . . . . . . . . 498 refresh_end_on_error . . . . . . . . . . 498 WebSphere DataStage system parameters . . . . 499 userexit_max_lob_size_kb . . . . . . . . 499

Functions . . . . . . . . . . . . . 501
XPath functions . . . ceiling . . . . . . concat . . . . . . contains . . . . . floor . . . . . . false . . . . . . formatNumber . . . normalizeSpace . . . not . . . . . . . number . . . . . position . . . . . round . . . . . . startsWith . . . . string . . . . . . stringLength . . . . substring . . . . . substringAfter . . . substringBefore . . . sum . . . . . . translate . . . . . true . . . . . . Transform extensions . . sxt:add . . . . . sxt:db-lookup . . . sxt:divide . . . . . sxt:filter . . . . . sxt:formatDate . . . sxt:getSequentialNum sxt:getSubField . . . sxt:getSysDate . . . sxt:getSysTime . . . sxt:groupConcat . . sxt:ifExist . . . . . sxt:ifReturn . . . . sxt:isEqual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501 501 502 502 502 502 503 503 503 503 504 504 504 504 505 505 505 505 506 506 506 506 507 507 508 508 509 509 509 510 510 510 510 511 511

sxt:multiply . . . . . sxt:nodeConcat . . . . sxt:padLeft . . . . . sxt:padRight . . . . . sxt:proper . . . . . sxt:setDefault . . . . sxt:subtract . . . . . sxt:toLowerCase . . . sxt:toUpperCase . . . sxt:trim . . . . . . Database functions . . . sxtdb:getPKSeq . . . . sxtdb:lookup . . . . sxtdb:procCall . . . . Using external Java objects in Simple string objects (type SQL data types (type II) . XML objects (type III) . XPath expression operators . + Operator . . . . . - Operator . . . . . * Operator . . . . . div Operator . . . . mod Operator . . . . = Operator . . . . . != Operator . . . . . < Operator . . . . . <= Operator . . . . . > Operator . . . . . >= Operator . . . . . or Operator . . . . . and Operator . . . . () parentheses Operator . [ ] Operator . . . . . / Operator . . . . . // Operator . . . . . @ Operator . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . data I) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . transformations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

511 511 512 512 512 513 513 513 513 514 514 514 514 515 515 516 516 516 516 517 517 517 517 517 517 517 518 518 518 518 518 518 518 519 519 519 519

Dialog boxes

. . . . . . . . . . . 521
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521 521 522 523 523 523 524 524 525 525 526 527 527 527 528 529 529 530 530 531 531 531

Datastore Management . . . . . New Datastore dialog box . . . Connection Parameters dialog box Copy Datastore dialog box . . . Select User dialog box . . . . Datastore List Report dialog box . Edit Datastore dialog box . . . Datastore tab . . . . . . . History tab . . . . . . . . User Management . . . . . . . New User dialog box . . . . . Copy User dialog box . . . . Select Datastore dialog box . . . Change Role dialog box . . . . User List Report dialog box . . User Properties dialog box . . . User tab . . . . . . . . . History tab . . . . . . . . Connection Management . . . . Connection Parameters dialog box Access Server Options . . . . . Access Server Options dialog box

Contents

xiii

Preferences . . . . . . . . . . . . . Save Changes dialog box . . . . . . . Column Encodings dialog box . . . . . . Add Encoding dialog box . . . . . . . Modify Encoding dialog box . . . . . . Datastores . . . . . . . . . . . . . Datastore Properties dialog box . . . . . Update Access Parameters dialog box . . . Add or Modify System Parameter dialog box General tab . . . . . . . . . . . . System Parameters tab . . . . . . . . Aliases tab . . . . . . . . . . . . Retry Datastore Connection dialog box . . . Specify Owner and Name page . . . . . Define Columns page . . . . . . . . Review New Table page . . . . . . . . Add Column dialog box . . . . . . . . Modify Column dialog box . . . . . . . Notifications. . . . . . . . . . . . . Notification dialog box . . . . . . . . Filter Messages dialog box . . . . . . . Copy Notification Settings dialog box . . . Latency Threshold dialog box . . . . . . Source tables . . . . . . . . . . . . Replication Tables dialog box . . . . . . Table Properties dialog box . . . . . . . Structure tab . . . . . . . . . . . Subscriptions tab . . . . . . . . . . Update Source Table Definition dialog box . Unique Indexes dialog box . . . . . . . Target tables . . . . . . . . . . . . . Update Target Table Definition dialog box . . Subscriptions . . . . . . . . . . . . New Subscription dialog box . . . . . . Subscription Properties dialog box . . . . Advanced Subscription Settings dialog box . Specify External Target Datastore dialog box Notification dialog box . . . . . . . . Upgrade Subscriptions dialog box . . . . Naming Options dialog box . . . . . . Transfer Bookmark dialog box . . . . . . Clear Log Position dialog box . . . . . . WebSphere DataStage Properties dialog box . Table mappings . . . . . . . . . . . Filter Columns dialog box . . . . . . . Change Example Table dialog box . . . . Select Target Table dialog box . . . . . . Select Target Owner or Library dialog box . . Add or Modify Audit Column dialog box . . Message Destinations dialog box . . . . . Message Destination dialog box . . . . . Change Message Destination dialog box . . Delete Table Mappings dialog box . . . . Filter Tables dialog box . . . . . . . . Column mappings . . . . . . . . . . . Map Columns Automatically dialog box . . Set Initial Value dialog box . . . . . . . Define Derived Column dialog box . . . . Copy Column Properties dialog box . . . . Summarize Column dialog box . . . . . Specify Key dialog box . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

534 534 535 535 536 536 537 537 537 537 538 538 539 539 539 539 540 540 541 541 542 542 543 543 543 544 544 544 545 545 546 546 546 546 547 547 548 548 549 549 550 550 550 551 551 551 551 552 552 553 553 553 554 554 555 555 555 556 557 557 557

Define Expression dialog box . . . . . . Replace Expressions Variables dialog box . . Select Column dialog box . . . . . . . Import Options dialog box . . . . . . . XML message mappings . . . . . . . . . Expression Builder dialog box . . . . . . Data translation . . . . . . . . . . . Define Translation dialog box . . . . . . Table operations . . . . . . . . . . . Additional SQL dialog box . . . . . . . Add Member Identifier Dialog Box . . . . Modify Member Identifier dialog box . . . Delete Selected WHERE Clause dialog box . Promoting changes . . . . . . . . . . Compare XML dialog box . . . . . . . Advanced Target Settings dialog box . . . Monitoring . . . . . . . . . . . . . Start Refresh dialog box . . . . . . . . Change Refresh Order dialog box . . . . Flag for Refresh dialog box . . . . . . . Mark Table Capture Point for Mirroring dialog box . . . . . . . . . . . . . . . Park (Do not replicate) dialog box . . . . Replication Method dialog box . . . . . Set Member Replication dialog box . . . .

. . . . . . . . . . . . . . . . . . . . . . . .

558 558 558 558 559 559 560 560 560 560 561 561 561 561 562 562 562 563 563 563 563 564 564 565

Wizards . . . . . . . . . . . . . . 567
Create Table wizard . . . . . . . . . . . Specify Owner and Name page . . . . . . Define Columns page . . . . . . . . . Define Primary Key Name and Order page . . Review New Table page . . . . . . . . . Promote Subscription wizard . . . . . . . . Promote to a New or Existing Subscription page Specify New Source page (Promote Subscription wizard) . . . . . . . . . . . . . . Specify External Target page (Promote Subscription wizard) . . . . . . . . . . Specify New Target page (Promote Subscription wizard) . . . . . . . . . . . . . . Review Promotion Settings page . . . . . . Import Subscription wizard . . . . . . . . Import to a New or Existing Subscription page Specify New Source page (Import Subscription wizard) . . . . . . . . . . . . . . Specify External Target page (Import Subscription wizard) . . . . . . . . . . Specify New Target page (Import Subscription wizard) . . . . . . . . . . . . . . Review Settings page (Import Subscription wizard) . . . . . . . . . . . . . . Copy Subscription wizard . . . . . . . . . Define New Subscription page . . . . . . Specify New Source page (Copy Subscription wizard) . . . . . . . . . . . . . . Specify External Target Page (Copy Subscription wizard) . . . . . . . . . . . . . . Specify New Target page (Copy Subscription wizard) . . . . . . . . . . . . . . Review Settings page (Copy Subscription wizard) . . . . . . . . . . . . . . 567 567 567 568 568 568 568 569 569 570 570 570 571 571 571 572 572 572 572 573 573 573 574

xiv

InfoSphere Change Data Capture Management Console: Administration Guide

Map Tables wizard . . . . . . . . . . . One-to-One mapping type . . . . . . . . Select Mapping Type page (One-to-One) . . . Select Source Tables page (One-to-One) . . . . Select Existing or Create New Target Tables page (One-to-One) . . . . . . . . . . . Map Source Tables to Existing Target Tables page (One-to-One) . . . . . . . . . . . Select Owner for New Target Tables page (One-to-One) . . . . . . . . . . . . Name Target Tables page (One-to-One) . . . . Set Replication Method page (One-to-One) . . Review Mappings page (One-to-One) . . . . Complete Mappings page (One-to-One) . . . Mapping to an external target datastore mapping type . . . . . . . . . . . . Select Mapping Type page (Mapping to an external target datastore) . . . . . . . . Select Source Tables page (Mapping to an external target datastore) . . . . . . . . LiveAudit mapping type (Automatic) . . . . Select Mapping Type page (LiveAudit Automatic) . . . . . . . . . . . . . Define Audit Columns page (LiveAudit Automatic) . . . . . . . . . . . . . Select Source Tables page (LiveAudit Automatic) Select Existing or Create New Target Tables page (LiveAudit Automatic) . . . . . . . Map Source Tables to Existing Target Tables page (LiveAudit Automatic) . . . . . . . Select Owner for New Target Tables page (LiveAudit Automatic) . . . . . . . . . Name Target Tables page (LiveAudit Automatic) Review Mappings page (LiveAudit Automatic) Complete Mappings page (LiveAudit Automatic) . . . . . . . . . . . . . WebSphere DataStage mapping type (Automatic) . . . . . . . . . . . . . Select Mapping Type page (WebSphere DataStage Automatic) . . . . . . . . . Select WebSphere DataStage Connection Method page (WebSphere DataStage Automatic) . . . Select Source Tables page (WebSphere DataStage Automatic) . . . . . . . . . . . . . WebSphere DataStage Flat File page (WebSphere DataStage Automatic) . . . . . . . . . WebSphere DataStage Direct Connect page (WebSphere DataStage Automatic) . . . . . Review Mappings page (WebSphere DataStage Automatic) . . . . . . . . . . . . . Standard mapping type . . . . . . . . . Select Mapping Type page (Standard) . . . . Select Source Table page (Standard) . . . . . Select Target Table page (Standard) . . . . . Specify Key page (Standard) . . . . . . . Set Replication Method page (Standard) . . . Review Mappings page (Standard) . . . . . LiveAudit mapping type (Custom) . . . . . Select Mapping Type page (LiveAudit Custom) Define Audit Columns page (LiveAudit Custom) . . . . . . . . . . . . . .

574 576 576 577 577 577 577 578 578 579 579 579 579 579 580 580 580 581 581 581 581 582 582 582 582 582 582 583 583 584 584 584 585 585 585 586 586 587 587 587 587

Select Source Tables page (LiveAudit Custom) Select Target Table page (LiveAudit Custom) Review Mappings page (LiveAudit Custom) . . Adaptive Apply mapping type . . . . . . Select Mapping Type page (Adaptive Apply) Select Source Tables page (Adaptive Apply) . . Select Target Table page (Adaptive Apply) . . . Specify Key page (Adaptive Apply) . . . . . Set Replication Method page (Adaptive Apply) Review Mappings page (Adaptive Apply) . . . Summarization mapping type . . . . . . . Select Mapping Type page (Summarization) . . Select Source Tables page (Summarization) . . Select Target Table page (Summarization) . . . Specify Key page (Summarization) . . . . . Select Summarization type page . . . . . . Set Replication Method page (Summarization) Review Mappings page (Summarization) . . . Consolidation one-to-one mapping type . . . Select Mapping Type page (Consolidation one-to-one) . . . . . . . . . . . . . Select Source Tables page (Consolidation one-to-one) . . . . . . . . . . . . . Select Target Table page (Consolidation one-to-one) . . . . . . . . . . . . . Specify Key page (Consolidation one-to-one) Set Replication Method page (Consolidation one-to-one) . . . . . . . . . . . . . Review Mappings page (Consolidation one-to-one) . . . . . . . . . . . . . Consolidation one-to-many mapping type . . . Select Mapping Type page (Consolidation one-to-many) . . . . . . . . . . . . Select Source Tables page (Consolidation one-to-many) . . . . . . . . . . . . Select Target Table page (Consolidation one-to-many) . . . . . . . . . . . . Specify Key page (Consolidation one-to-many) Set Replication Method page (Consolidation one-to-many) . . . . . . . . . . . . Review Mappings page (Consolidation one-to-many) . . . . . . . . . . . . WebSphere DataStage mapping type (Custom) Select Mapping Type page (WebSphere DataStage Custom) . . . . . . . . . . Select WebSphere DataStage Connection Method page (WebSphere DataStage Custom) . . . . Select Source Tables page (WebSphere DataStage Custom) . . . . . . . . . . . . . . WebSphere DataStage Flat File page (WebSphere DataStage Custom) . . . . . . . . . . WebSphere DataStage Direct Connect page (WebSphere DataStage Custom) . . . . . . Review Mappings page (WebSphere DataStage Custom) . . . . . . . . . . . . . . Message Destination mapping type (Automatic) Select Mapping Type page (Message Destination) . . . . . . . . . . . . . Select Source Tables page . . . . . . . . Message Content page . . . . . . . . . Message Destination page . . . . . . . .
Contents

588 588 588 589 589 589 589 589 590 591 591 591 591 591 592 592 592 593 593 593 594 594 594 594 595 596 596 596 596 596 597 598 598 598 598 598 599 599 600 600 600 600 600 601

xv

Review Mappings page . . . . . . . . Message Destination mapping type (Custom) Select Mapping Type page (Message Destination) . . . . . . . . . . . . Select Source Tables page . . . . . . . Message Content page . . . . . . . . Message Destination page . . . . . . . Review Mappings page . . . . . . . . Other Tables wizard . . . . . . . . . . Define Table Location page . . . . . . .

. 602 602 . . . . . . . 602 602 602 603 604 604 604

Select Table page . . . SELECT Clause page . . WHERE Clause page . . GROUP BY Clause page . ORDER BY Clause page .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

605 605 605 606 606

Notices . . . . . . . . . . . . . . 609
Trademarks . . . . . . . . . . . . . . 611

xvi

InfoSphere Change Data Capture Management Console: Administration Guide

InfoSphere CDC architectural overview


The following diagram illustrates the key components of IBM InfoSphere Change Data Capture, or more simply, InfoSphere CDC.

The key components of the InfoSphere CDC architecture are described below: Datastore Replication Enginean InfoSphere CDC process that sends or receives replicated data. Datastore replication engine processes on source and target servers are created when you install InfoSphere CDC. DBMS the source or target database. You can work only with those databases that InfoSphere CDC supports as a source or target of replicated data. Datastorean InfoSphere CDC process on a source or target server that accepts requests from an instance of Access Server and communicates with the datastore replication engine to initiate and manage replication activity. Datastore processes on source and target servers are created when you install InfoSphere CDC. These processes are also defined in Access Manager perspective so that you can connect to the same datastores in InfoSphere CDC Management Console. InfoSphere CDC Management Console Userthe name specified in an InfoSphere CDC Management Console log in process on a client workstation (for example, gsmith). As a InfoSphere CDC administrator, you can define InfoSphere CDC users in Access Manager and assign one of four roles to each InfoSphere CDC user. Each role determines the InfoSphere CDC Management Console operations that can be applied by a InfoSphere CDC user to a replication configuration. Access Servera client workstation where a set of background processes direct requests received from InfoSphere CDC Management Console on other client
Copyright IBM Corp. 2008

workstations to the appropriate datastores. These processes also return information back to the applications. Processes running on Access Server accept requests only from known InfoSphere CDC users, and communicate only with known datastores. You can create datastores and other InfoSphere CDC users in the Access Manager perspective in Management Console and these are associated with Access Server. Auto-discovery provides a way for Access Manager to recognize, upon startup, all available datastores on the local subnetwork. The processes running on Access Server are created during InfoSphere CDC Management Console installation. You can have multiple instances of Access Server in your working environment. In this case, you may be able to connect to one of several Access Servers from InfoSphere CDC Management Console. To establish a connection, you must know the name of the workstations where Access Server processes are running and provide appropriate security information. InfoSphere CDC Management Consolean interactive application that you can use to configure and monitor replication. It allows you to manage replication on various servers, specify replication parameters, and initiate refresh and mirroring operations from a client workstation. Use Management Console after creating datastores in the Access Manager perspective . After you have setup replication, Management Console can be closed on the client workstation without affecting active data replication activities between source and target servers. Management Console also includes an event log and a monitor. The event log allows you to examine generated InfoSphere CDC event messages. The monitor provides the necessary support to continuously monitor replication operations and latency. Diagrams depicting components of your replication configuration are constructed through direct manipulation of graphical objects. The monitor in Management Console is intended for time-critical working environments that require continuous analysis of data movement.

InfoSphere Change Data Capture Management Console: Administration Guide

Introducing the InfoSphere CDC Management Console interface


This section is intended for users of Enterprise Administrator that want to upgrade to InfoSphere CDC Management Console. In this section, you will learn: About InfoSphere CDC Management Console Terminology changes Command changes on page 4 Functionality changes on page 4 Connecting to datastores and working with subscriptions on page 4 Mapping source and target tables on page 5 Setting mapping details on a subscription on page 6 Promoting subscriptions on page 9 Monitoring the performance of a subscription on page 10

About InfoSphere CDC Management Console


InfoSphere CDC Management Console is an intuitive graphical user interface (GUI) that lets you create subscriptions and manage your replication environment. Management Console includes the same features as Enterprise Administrator, but provides an integrated view of your source and target data sources. You can specify tables for replication, set up data transformations, include custom business logic, and monitor replication processes. Monitoring and replication configuration are consolidated in a single GUI.

Terminology changes
InfoSphere CDC now uses the term v datastore in place of replication agent v source and target in place of publisher and subscriber v notifications in place of alerts and alarms v source tables and target tables in place of publication tables and subscription tables v table mappings in place of table assignments v mapping types in place of assignment types v row filtering expression in place of row selection expression v expression in place of derived expression v translation in place of value translation However, you may still encounter the old terms in some InfoSphere CDC products and documentation.

Copyright IBM Corp. 2008

Command changes
Management Console uses the command v Add or Remove Tables in place of Manage Publications v Update Source Table Definition in place of the Re-Add Table, Describe, and Re-assign process for updating metadata of source tables v Update Target Table Definition in place of Re-assign to update the metadata of target tables v Map Tables in place of Assign

Functionality changes
To eliminate the publisher-subscriber model in the user interface and align the product to a subscription-centric experience, Management Console automatically. v adds tables to a subscription when you map tables v performs a describe from the source datastore to the target datastore when you have mapped source and target tables, update the definition of a source table, or change the properties of a subscription

Connecting to datastores and working with subscriptions


In Enterprise Administrator, after connecting to a replication agent, you had to configure publisher-side properties and subscriber-side properties. For example, on the publisher-side, you had to add tables to a catalog, create a new subscription, manually add tables to a subscription, and then perform a describe to send this information to the subscriber-side. Management Console provides a unified view of the datastores you have access to. Therefore, after connecting to a datastore and making your source tables available for replication, you can create a new subscription and (instead of manually adding tables to a subscription and then performing a describe) associate a source datastore and a target datastore to the subscription. See also: Datastores view Source Tables area on page 5 Subscriptions view on page 5

Datastores view
Use the Datastores view to identify the datastores you can connect to and make source tables available for replication.

About connection to datastores


By default, Management Console connects to your datastores automatically. You can also connect to a datastore manually by disabling the Connect to Datastores Automatically check box. This option is available on the Connection page of the Edit Preferences menu.

InfoSphere Change Data Capture Management Console: Administration Guide

Source Tables area


Depending on the datastore selected, the Source Tables area lists the source tables you have made available for replication. You must be connected to the datastore to view the tables. You can add or remove source tables from replication, update the definition of a source table (after changing the structure of a source table), and view table properties in this area. Related concepts Connecting to a datastore on page 59 Setting connection preferences on page 51 Updating, removing, and viewing tables for replication on page 67

Subscriptions view
Use the Subscriptions view to create new subscriptions or view existing subscriptions. You must be connected to both a source and target datastore to view existing table mappings in a subscription, map tables between them, and edit mapping details.

Organize subscriptions into projects


You can organize subscriptions into different projects.

Unknown datastores
Management Console displays Unknown source datastores when you do not have permissions to them or you are disconnected from it. Access parameters for datastores are set in Access Manager. Management Console also displays Unknown target datastores when you do not have permissions to them in Access Manager, or because the target datastore resides outside of your organization or department. Management Console displays the hostname and IP address of unknown target datastores. Management Console also displays any disconnected target datastores. Related concepts Using projects to organize your subscriptions on page 81 Setting up subscriptions on page 83 Setting up subscriptions for datastores outside of your organization on page 86

Mapping source and target tables


In Enterprise Administrator, the processing of mapping source tables to target tables was referred to as an Assign. Management Console refers to this command as Map. Management Console provides a Map Tables wizard that automates the mapping process. See also: Map Tables wizard on page 6 Table Mappings view on page 6

Introducing the InfoSphere CDC Management Console interface

Map Tables wizard


Use the Map Tables wizard to map multiple source tables to multiple target tables or map tables one at a time using a custom mapping type. The wizard organizes mapping types into two areas v Automaticlets you perform a bulk assignment of multiple source tables to multiple target tables that have the same table structure, similar table names, and columns with the same or compatible data types. One-to-Onelets you map multiple source tables to multiple target tables (available in Enterprise Administrator as Standard Replication) LiveAuditlets you map multiple source tables to multiple target tables when you want to track source table operations v Customlets you map a source table to a target table that is customized in some way. For example, when you choose Standard mapping type, you can map a source table to a target table that does not share the same structure or similar table names as the source table.

Set Replication Method


You must now choose a replication method before you finish mapping source and target tables. In Enterprise Administrator, you did this after adding a table to the subscription on the publisher-side. Related concepts Mapping using standard replication on page 91 Mapping using LiveAudit on page 100

Table Mappings view


Use the Table Mappings view to see a list of mapped source and target tables within a subscription. You can also view the mapping type, replication method, and status of each table mapping. You can also access this view from the Monitoring perspective. See Monitoring the performance of a subscription on page 10.

Show Incomplete Table Mappings


By default, Management Console displays only assigned table mappings. If you did not assign a source table to a target table in Enterprise Administrator, Management Console lists this as an incomplete table mapping. To view incomplete table mappings, in the Table Mappings view, right-click and select the Show Incomplete Mappings option.

Setting mapping details on a subscription


In Enterprise Administrator, you were able to set properties for an assigned subscription table on the Subscribers tab, or properties for a subscribed publication table on the Publishers tab. These properties are now consolidated in the Edit Mapping Details view of Management Console. See also: Edit Mapping Details view on page 7 Column Mappings tab on page 7 Filtering tab on page 7

InfoSphere Change Data Capture Management Console: Administration Guide

Translation tab Conflicts tab on page 8 Operation tab on page 8 User Exits tab on page 8

Edit Mapping Details view


Use the Edit Mapping Details view to configure details for a mapped source table, a target table, or both.

Column Mappings tab


Use the Column Mappings tab to v map source columns to target columns v create a derived column on the source table v v v v build custom expressions and map to target columns map accumulation and deduction expressions for summarization mapping types map journal control fields map source and target columns automatically Related concepts Mapping source columns to target columns on page 157 Mapping journal control fields to target columns on page 158 Mapping expressions to target columns on page 158 Mapping source and target columns automatically on page 160 Mapping initial values to target columns on page 161 Adding and mapping derived columns to target columns on page 162

Filtering tab
Use the Filtering tab to v define a row-filtering expression to include or exclude rows from replication (row selection expression in Enterprise Administrator) v filter columns v enable critical column selection Related concepts Filtering rows on page 167 Selecting critical columns to filter rows on page 168 Filtering columns on page 168

Translation tab
Use the Translation tab to v set translations (value translations in Enterprise Administrator) v set encoding conversions (character handling in Enterprise Administrator) v set multibyte character encoding conversions (this is a new feature and only available in specific platforms and versions of InfoSphere CDC) Related concepts Setting data translations on page 171 Converting multibyte character sets on page 175 Handling Unicode character encodings on page 176
Introducing the InfoSphere CDC Management Console interface

Conflicts tab
Use the Conflicts tab when you want InfoSphere CDC to detect conflicts on target columns and resolve them. v source row wins v target row wins v largest value wins v smallest value wins v user exits If you do not want InfoSphere CDC to detect conflicts on target columns, then you can select None. Related concepts Resolving conflicts for source or target wins on page 189 Resolving conflicts for largest or smallest value wins on page 191 Resolving conflicts with user exits on page 194

Operation tab
Use the Operation tab to specify the row-level or table-level operations you want InfoSphere CDC to apply on a target table when there is a corresponding row-level or table-level operation on the source table. In Enterprise Administrator, you had to specify row-level or table-level options on separate tabs of the Subscription Table Properties dialog boxthe Table tab and the Row tab. These options are now consolidated in the Operation tab of Management Console. If you do not want InfoSphere CDC to detect conflicts on target columns, then you can select None. Related concepts Suppressing the apply of row operations on page 179 Preventing the audit of row operations on page 180 Detecting conflicts on row operations on page 181 Controlling the apply of refresh operations on page 183 Specifying SQL to control refresh operations on page 184

User Exits tab


Use the User Exit when you want InfoSphere CDC to detect conflicts on target columns and resolve them for v identify the name and type of user exit you want InfoSphere CDC to call v specify at which event or action you want InfoSphere CDC to call the user exit (either before or after a row-level or table-level operation) In Enterprise Administrator, if you wanted InfoSphere CDC to call the user exit before or after a specific event (either before or after a row-level or table-level operation), then you had to specify the name of the user exit (User Exit Before or User Exit After) in either the Table tab or Row tab of the Subscription Table Properties dialog box. These options are now consolidated in the Event and Actions area in the User Exits tab of Management Console. Related concepts

InfoSphere Change Data Capture Management Console: Administration Guide

Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207 Configuring user exits for InfoSphere CDC for Oracle or InfoSphere CDC for Sybase on page 216 Configuring user exits for InfoSphere CDC for AS/400 (version 6.2 and below) or InfoSphere CDC for z/OS on page 219

Promoting subscriptions
The manual subscription promotion process available in Enterprise Administrator has been replaced with a Promote Subscription wizard in Management Console. In Enterprise Administrator, you had to promote the publisher-side and subscriber-side of the subscription. This wizard provides an integrated view of your subscription and automates the process of promoting subscription changes from development to test to production. The promotion wizard can also create copies and backups of InfoSphere CDC replication configurations. Also, if you have configured items on your source tables or target tables then you can promote these to datastores in the new environment. As an alternative to promoting subscriptions, you can also use export and import subscriptions. Use the Import Subscription wizard when you have exported the subscription as an XML file on your local computer and made changes to this file. When you are ready to import the XML file into Management Console, the wizard lets you either import the changes into a new subscription or overwrite an existing one. Both the commands Export Subscription and Import Subscription are available on the Subscription menu. You can also make copies of a subscription to a new subscription using Copy Subscription wizard.

Promote Subscription wizard


The Promote Subscription wizard lets you promote subscription changes from development to test to production. You can promote a subscription using the Promote Subscriptions command available in the Subscription menu. Use the Promote Subscription wizard to v promote to a new subscriptionthe wizard creates a copy of the subscription with changed configuration details. The wizard saves your changes and you can reapply these when you need to promote to an existing subscription. v promote changes to an existing subscriptionthe wizard creates a copy of the subscription with the same configuration details as a previously promoted subscription.

About comparing XML


You can compare the XML of the new subscription with the original. If you need to send the XML to another department or organization, you can export the XML to your local computer. You can also export the subscription directly to an XML file from the Promote Subscription wizard Related concepts Promoting subscriptions on page 202
Introducing the InfoSphere CDC Management Console interface

Exporting and importing subscriptions on page 205

Monitoring the performance of a subscription


In Enterprise Administrator, you were able to monitor the performance of a subscription using the Enterprise Administrator Monitor. The functionality of this application is integrated into the Management Console interface. You can view the performance of a subscription in the Monitoring perspective. See also: Subscriptions view (Monitoring perspective) Table Mappings view (Monitoring perspective) Statistics view on page 11 Event Log view on page 11 Replication Diagram view on page 11

Subscriptions view (Monitoring perspective)


The Monitoring perspective lists the replication state and status, latency, and source and target datastores for each subscription. Use the Subscriptions view in the Monitoring perspective to v start continuous or net-change mirroring on a subscription v start a refresh of the target table v end replication v show the Table Mappings view to control replication v show the Event Log view to monitor the state and status of a subscription v show the Statistics view to monitor the latency and throughput of a subscription Related concepts Starting mirroring on a subscription on page 197 Starting a refresh on a subscription on page 198 Ending replication on a subscription on page 198

Table Mappings view (Monitoring perspective)


You can open the table mappings view in the Monitoring perspective so you can manage and control the replication of table mappings. Use the table mappings view in the Monitoring perspective to reset a log position (update the bookmark) flag tables for a refresh park tables from replication change the refresh order change the replication method update table definitions delete table mappings view the properties of source and target tables v reset a log position (update the bookmark) v flag tables for a refresh v park tables from replication v change the refresh order v change the replication method v update table definitions v delete table mappings v view the properties of source and target tables Related concepts

10

InfoSphere Change Data Capture Management Console: Administration Guide

Flagging a source table for a refresh on page 135 Marking a table capture point on a source table on page 135 Parking a table mapping from replication on page 136 Changing the refresh order on a table mapping on page 137 Changing the replication method of a table mapping on page 137 Setting members for replication on page 140 Deleting table mappings on page 140

Statistics view
The Statistics view monitor latency and throughput on a subscription. You can monitor the following statistics v latency, the amount of a time a subscription takes to replicate data to the target table. v throughput, the number of operations applied to the target table (measured in bytes and number of operations) Related concepts Profiling the latency and throughput performance of your subscription on page 235

Event Log view


In Enterprise Administrator, you were able to monitor events using the Enterprise Administrator Event Log Viewer. The functionality of this application is integrated into the Management Console interface. Use the Event Log view to monitor source and target replication and activities on your source and target datastores. You can also double-click on each event to read details about each event in a separate window. Related concepts Displaying event messages during replication on page 232

Replication Diagram view


In Enterprise Administrator, you were able to create a diagram using the Enterprise Administrator Monitor. The functionality of this application is integrated into the Management Console interface. Management Console automatically creates a replication diagram for each project in your replication configuration. Use the Replication Diagram view to see a topological view of your replication configuration. Related concepts Displaying a graphical view of your subscription on page 238

Introducing the InfoSphere CDC Management Console interface

11

12

InfoSphere Change Data Capture Management Console: Administration Guide

Introducing InfoSphere CDC Management Console with InfoSphere CDC Event Server
This section is intended for users of Management Console that want to transform data to XML and send data to a JMS message destination with InfoSphere CDC Event Server In this section, you will learn: About InfoSphere CDC Event Server InfoSphere CDC Event Server as a target-only datastore Mapping source tables on a subscription that targets a JMS message destination on page 14 Setting mapping details on a subscription that targets a JMS Message destination on page 14

About InfoSphere CDC Event Server


InfoSphere CDC Event Server receives replicated row-level operations (inserts, updates, deletes) from your source database and transforms these rows into XML. Using InfoSphere CDC Management Console, you can map source columns to XML elements and attributes. When you start mirroring and if there is a row-level operation on your source table, InfoSphere CDC Event Server receives and applies the row-level operation to the XML document which is sent to a JMS message destination (queue or topic). Before you can use InfoSphere CDC Event Server to transform table data in XML, you must install and setup a InfoSphere CDC source product that can scrape row-level operations (inserts, updates, and deletes) from your source database. When InfoSphere CDC Event Server detects a row-level operation (insert, update, or a delete), it sends the XML message to the JMS message destination. The following are some examples of the kinds of business events that you can define: v A new customer sale has been entered into the source databaseYou may want InfoSphere CDC Event Server to send an XML message to a JMS application which will generate an event to different departments. v Credit card balance changes significantly in a short period of timeYou may want to track this and notify the fraud department with real time information about the credit card changes. v Inventory levels are running low on a particular productDetect a low inventory and generate an XML message which some other application could interpret and automatically place a new order.

InfoSphere CDC Event Server as a target-only datastore


InfoSphere CDC Event Server is a target-only product. This means that InfoSphere CDC Event Server can only receive row-level and table-level operations already replicated from another supported InfoSphere CDC product that you have installed. You must install another InfoSphere CDC product and connect to this datastore so that you can select the source tables you want to make available for replication. You can then continue to add a subscription that uses InfoSphere CDC Event Server as the target datastore.
Copyright IBM Corp. 2008

13

Related concepts Connecting to a datastore on page 59 Updating, removing, and viewing tables for replication on page 67 Setting up subscriptions on page 83

Mapping source tables on a subscription that targets a JMS message destination


In addition to the existing mapping types available with other InfoSphere CDC products you install, Management Console provides another mapping type that is only available when you create a subscription that targets a JMS message destination using InfoSphere CDC Event Server. The Message Destination Mappings mapping type option is available in the Map Tables wizard. When you map a source table to a message destination, InfoSphere CDC Event Server receives the row-level operation and transforms this row into XML. This XML message is sent to a JMS application supported by InfoSphere CDC Event Server. You can also map your source table to a target staging table. When you enable the One table mapping of any type option in the Map Tables wizard and choose Standard, the wizard lets you map your source table to a target table available in an embedded staging database provided with InfoSphere CDC Event Server. InfoSphere CDC Event Server provides an embedded staging database as a temporary repository for your source table before it is transformed to XML. You may want to map your source table to a target staging table in order to customize the source table outside of your production database in some way before InfoSphere CDC Event Server converts the replicated rows into XML. Also, by mapping the source table to a staging database, you can reduce performance overhead on your production database. InfoSphere CDC Event Server depends on the staging database (instead of your production database) to receive and transform replicated rows into XML. Related tasks To map multiple source tables to a JMS message destination on page 127 To stage a source table on page 131

Setting mapping details on a subscription that targets a JMS Message destination


Management Console lets you create an XML message for subscriptions that target JMS message destinations. In addition to the existing mapping details that you can configure with other InfoSphere CDC products you install, Management Console provides additional configuration details available only with subscriptions created with InfoSphere CDC Event Server: v XML message tab v XML settings tab As with other InfoSphere CDC products, the Filtering tab, the Translation tab, and the User Exits tab are available for configuration with InfoSphere CDC Event Server. Note: The Column mappings tab and the Operations tab are only available if you have mapped your source table to a target staging table. See also:

14

InfoSphere Change Data Capture Management Console: Administration Guide

XML Message tab XML Settings tab Column Mapping tab Filtering tab on page 16 Translation tab on page 16 Operation tab on page 16 User Exits tab on page 16

XML Message tab


Use this tab to create your XML message, import and export mapping projects, import and export XML schemas, build XPath expressions, and query columns from other tables if required. Related concepts Creating an XML message on page 143 Importing and exporting XML files, schemas, and mapping projects on page 144 Building an XPath expression on page 146 Querying columns from other tables on page 147

XML Settings tab


Use this tab to set JMS message header properties and set general runtime options. Related concepts Defining the JMS message header on page 151 Setting general runtime options on page 153

Column Mapping tab


Use this tab to map source columns to columns in a target staging table. InfoSphere CDC Event Server provides an embedded staging database as a temporary repository for your source table before it is converted into XML. This tab is only available if you have you have mapped your source table to a target staging table using the Standard mapping type in the Map Tables wizard. You may want to map your source table to a target staging table when: v You want to customize the source table outside of your production database. Before mapping your source table to a JMS message destination, you can map your source table to a target staging table in order to send a copy of the source table to the staging database. Using the Column Mappings tab, you can decide on the source columns you want to map (or unmap) from columns in the target staging table. This lets you control which columns you want to include or exclude for replication and therefore the kind of data you want to include or exclude for InfoSphere CDC Event Server to XML. v You want to reduce performance overhead on your production database. Because you have mapped your source table to a target staging table, when you start replication, a copy of your source table is sent to the staging database. In this scenario, InfoSphere CDC Event Server receives replicated rows from the staging database (instead of your production database) and transforms these rows into XML. This setup reduces performance overhead on your production environment. Related concepts Creating an XML message on page 143
Introducing InfoSphere CDC Management Console with InfoSphere CDC Event Server

15

Mapping columns on page 157 Related tasks To stage a source table on page 131

Filtering tab
Use this tab to include or exclude rows or columns for replication. Related concepts Filtering rows and columns on page 167

Translation tab
Depending on how you have mapped your source table, you can use this tab to add a data translation between your source and target staging columns and/or set encoding conversions. You can only set a data translation on a subscription for source columns that are mapped to target staging columns. If you have only mapped your source table to a JMS message destination, then you can only set encoding conversions for any multibyte character sets in your source table. When you add a data translation and start replication, the supported InfoSphere CDC source product translates values from the source column into the new value you specified for the mapped target column. InfoSphere CDC Event Server then inserts the translated value into an XML document. Related concepts Setting data translations on column mappings on page 171 Setting multibyte and Unicode character set conversions on page 175

Operation tab
Use this tab to control how InfoSphere CDC Event Server applies row-level operations (insert, update, and deletes) and table-level operations (truncate/clear) to the target staging table. This tab is only available if you have you have mapped your source table to a target staging table using the Standard mapping type in the Map Tables wizard. Related concepts Creating an XML message on page 143 Controlling row operations on page 179 Controlling table operations on page 183

User Exits tab


Use this tab configure a user exit for InfoSphere CDC Event Server. User exits define a set of actions that you want InfoSphere CDC Event Server to run either before or after applying a row-level operation. Depending on how you have mapped your source table, InfoSphere CDC Event Server can run the user exit before or after applying a row-level operation to the target staging table, and/or run the user exit before or after applying a row-level operation to the JMS message destination. Row-level operations include an insert, update, or a delete. Related concepts Configuring user exits on page 207

16

InfoSphere Change Data Capture Management Console: Administration Guide

Using the InfoSphere CDC Management Console user interface


InfoSphere CDC Management Console is composed of a number of windows or tabs that are referred to as perspectives and views. After logging in to Management Console you will see two perspectives, Configuration and Monitoring, from which you can access a number of different views. In the Configuration perspective, you can use the different views to configure your replication environment by connecting to your datastores, creating subscriptions, mapping your tables, and transforming your data. In the Monitoring perspective, different views allow you to initiate replication and monitor your replication activity. Preferences allow you to control the behavior of InfoSphere CDC Management Console. For example, you can choose whether you want to connect to datastores automatically after logging in to InfoSphere CDC Management Console. In this section, you will learn: Datastores view Subscriptions view (Configuration perspective) on page 18 Table Mappings view on page 18 Mapping Details view on page 19 Subscriptions view (Monitoring perspective) on page 19 Replication Diagram view on page 20 Setting Preferences on page 20

Datastores view
Datastores are logical entities that represent the data files and processes required to accomplish data replication. Each datastore represents the database to which you want to connect and acts as a container for your tables. Tables made available for replication are contained in a datastore. To access this view, log in toInfoSphere CDC Management Console and click Configuration > Datastores. In this view, you can do the following: v Connect to datastores. v Configure properties on your datastores such as system parameters. v Configure notifications on your source or target datastores. Related concepts Logging in to Management Console (Connecting to Access Server) on page 21 Setting up datastores for replication on page 59

Copyright IBM Corp. 2008

17

Subscriptions view (Configuration perspective)


A subscription is a connection that is required to replicate data between a source datastore and a target datastore. It contains details of the data that is being replicated and how the source data is applied to the target. Subscriptions use datastores as the source or target of replicated data. To access this view, log in toInfoSphere CDC Management Console and click Configuration > Subscriptions. In this view, you can do the following: v Add and configure subscriptions v Create, export, and import projects for your subscriptions v Promote subscriptions Related concepts Logging in to Management Console (Connecting to Access Server) on page 21 Setting up and managing subscriptions on page 81 Promoting changes to subscriptions on page 201

Table Mappings view


You cannot display the Table Mappings view until you create a subscription and map your tables. After you have done this, select the subscription with the table mappings to display this view. After defining a subscription in InfoSphere CDC Management Console, you can use the Map Tables wizard to map source and target tables. Subscriptions can contain as many table mappings as necessary, and the number of table mappings you create depends on how many source tables you want InfoSphere CDC to replicate to the target system. The table mappings that you create with the wizard are displayed in this view. Use the Table Mappings view to see a list of mapped source and target tables within a subscription. You can also view the mapping type, replication method, and status of each table mapping. You can also access this view from the Monitoring perspective. In this view, you can do the following: v View a list of mapped source and target tables within a subscription v View the mapping type, replication method, and status of each table mapping v v v v v Flag a source table for refresh before mirroring Set a log position on a source table Park a table mapping from replication Change the refresh order on a table mapping Change the replication method of a table mapping Related concepts Setting up and managing subscriptions on page 81 Mapping tables on page 91 Managing table mappings on page 133

18

InfoSphere Change Data Capture Management Console: Administration Guide

Mapping Details view


You cannot display the Mapping Details view until you create a subscription and map your tables. After you have done this, right-click a subscription and select Edit Mapping Details to display this view. In this view, you can do the following: v Customize the kind of information you want to map to target columns in a subscription. v Include or exclude rows or columns for replication. v Add, modify, and delete a data translation. v Specify how InfoSphere CDC converts character sets on source columns during replication. v Set how a target table responds to changes made on the source table. v Control the truncation of the target table in response to a table-level clear or refresh operation so that all or some of the rows are preserved. v Set member identifiers for multi-member source tables. v Configure conflict detection and resolution. v Configure user exits. Related concepts Setting up and managing subscriptions on page 81 Mapping tables on page 91 Mapping columns on page 157 Filtering rows and columns on page 167 Setting data translations on column mappings on page 171 Setting multibyte and Unicode character set conversions on page 175 Controlling row operations on page 179 Controlling table operations on page 183 Setting member identifiers on page 187 Setting conflict detection and resolution on page 189 Configuring user exits on page 207

Subscriptions view (Monitoring perspective)


This view alllows you to monitor and analyze replication activities for each subscription so that you can diagnose potential problems. In addition, this view contains operational features for subscriptions that allow you to connect to datastores, start or end replication, display subscription properties, and display table mappings for subscriptions. To access this view, log in toInfoSphere CDC Management Console and click Monitoring > Subscriptions. In this view, you can do the following: v Monitor the state and status of your subscription v Display the event messages in the Event Log view v Profile the latency and throughtput performance of your subscription in the Statistics view v Start or end replication on a subscription
Using the InfoSphere CDC Management Console user interface

19

v v v v

Refresh a Subscription Connect to a datastore Show table mappings for a subscription Display subscription properties Related concepts Monitoring your subscriptions on page 231 Starting and ending replication on subscriptions on page 197 Connecting to a datastore on page 59

Replication Diagram view


This view uses schematic diagrams to visually represent the relationship between subscriptions and datastores in your replication configuration. The graphical nature of this view is what differentiates it from the Subscriptions view in the Monitoring perspective which uses a table format to display information about your replication environment. The operational tasks that you can perform in this view are identical to the Subscriptions view (Monitoring perspective). To access this view, log in toInfoSphere CDC Management Console and click Monitoring > Replication Diagram.

Setting Preferences
Preferences allow you to control certain aspects of the behavior ofInfoSphere CDC Management Console. Preferences allow you to do the following: v Specify port preferences for Access Server and connection preferences for datastores. v Set timeout values, allocate memory, and set prompts for filtering large numbers of tables. v Set prompt preferences. v Control the behavior of progress windows. v Control how statistics are collected for your replication environment. v Control the behavior or views. To access Preferences, click Edit, Preferences. Related concepts Setting preferences in Management Console on page 51

20

InfoSphere Change Data Capture Management Console: Administration Guide

Before you start InfoSphere CDC Management Console


Before you can start and log in to Management Console, make sure that you have installed Access Server. For more information, see your Access Server and Management Console Installation Guide. In the Access Manager perspective in Management Console, you need to do the following: Add datastoresdatastores are required to access the tables in your database. After creating a datastore, Management Console users can connect to it. For more information, see or contact your InfoSphere CDC system administrator. Add usersas an InfoSphere CDC system administrator, you need to add users and provide them with permissions for your datastores. The level of permissions depends on the role you want to assign to a user. In this section, you will learn: Logging in to Management Console (Connecting to Access Server) Related concepts Setting up datastores and user accounts in Access Manager on page 23

Logging in to Management Console (Connecting to Access Server)


When you log in to Management Console, you are connecting to Access Server. Access Server is the server application that controls access to your replication environment. Using the Access Manager perspective in Management Console, you can add users and datastores. You can have multiple instances of Access Server in your working environment, but you can only connect to one server at a time. For more information on installing Access Server, see Access Server and Management Console Installation Guide. See also: To log in to Management Console To change your login password on page 22

To log in to Management Console


1. Ensure that your InfoSphere CDC system administrator has added you as a user to an existing datastore in Management Console. Your system administrator can set your user name and password in the Access Manager perspective. 2. Navigate to the programs menu and start Management Console. 3. Type your user name in the User Name box. 4. Type your password in the Password box. The password is case-sensitive. 5. In the Server Name list, type or select the host name (system name) or full IP address of the workstation running Access Server. 6. Type the TCP/IP port number in the Port Number box. Note: If you want to log in using the default port number, click Default. The default port number was specified in the Edit Preferences menu.
Copyright IBM Corp. 2008

21

Related tasks To add a new user on page 27

To change your login password


1. Click File > Access Server> Change Password. 2. Type the current password in the Current password box. 3. Type and confirm the new password in the New password and Confirm password boxes.

22

InfoSphere Change Data Capture Management Console: Administration Guide

Setting up datastores and user accounts in Access Manager


InfoSphere CDC Access Manager is an integrated component of Management Console that provides a central point of administration for system administrators to manage datastores and user accounts. You must be a System Administrator that can manage datastores and user accounts to create datastores and users in the Access Manager perspective. You can then assign these users to datastores and set database connection parameters in order to provide users with access to an installation of InfoSphere CDC and the database available for replication. Users can be assigned to different roles that are distinguished by different levels of access into Management Console. The Access Manager perspective also provides security options that you can set on user accounts. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. In this section, you will learn: Managing datastores Managing user accounts on page 26 Assigning users to datastores on page 30 Managing datastore connections on page 32 Managing security on user accounts on page 34 Setting password and account security policies on user accounts on page 35 Auditing user accounts, datastores, security policies, and general events on page 37 Creating list reports on page 39 Commands for Access Server on page 40

Managing datastores
A datastore represents the InfoSphere CDC installation and the database made available for replication. As a System Administrator, you can add, modify, and delete datastores in the Access Manager perspective of Management Console. Use the Datastore Management view to: v Add, modify, copy, and delete datastoresadding a datastore in Management Console means that you are in the process of making an installation of InfoSphere CDC and the database you want users to replicate to or from available for connection by other users. When adding a new datastore, you must specify information about the database and provide database connection parameters so that users can connect to the datastore. Only users you have assigned to a datastore can connect to the datastore. v Assign users to a datastoreassigning users to a datastore gives them access to an installation of InfoSphere CDC and the ability to connect to the database that you have made available for replication on the server.

Copyright IBM Corp. 2008

23

v Propagate connection parameterspropagating new connection parameters for users that use the existing connection parameters eases system administration in that you only have to specify connection parameters once. v Generate reports on the activities related to a set of datastoresgenerating a report on a specific datastore can help you keep track of which users you have assigned datastore access to and what databases users can access, the date of creation, and the last time it was modified. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: To add a new datastore To edit a datastore To delete a datastore on page 25 To copy a datastore on page 25 To view the history of a datastore on page 25 To set connection parameters on a datastore on page 25 Related concepts Setting up datastores for replication on page 59 Related tasks To assign users to a datastore on page 31

To add a new datastore


1. Click Access Manager > Datastore Management. 2. Click File > Access Server > New Datastore. 3. Type the name of the datastore in the Name box. 4. Type a description in the Description box. 5. Type the host name or the full IP address of the server where you have installed InfoSphere CDC in the Server box. 6. Type the port number of the server in the Port box. 7. Ping the server. If successful, this returns the datastore properties including the type of server where you have installed InfoSphere CDC and the version number of the product. Note: You can only add a datastore if you are a System Administrator and have the privilege to manage datastores and user accounts. Related concepts Setting up datastores for replication on page 59

To edit a datastore
1. Click Access Manager > Datastore Management. 2. Select an existing datastore. 3. Click File > Access Server > Properties. 4. If you want to change the Name of the datastore, type it in the Name box. 5. If you want to change the description, type it in the Description box. 6. If the name of the server or IP address where InfoSphere CDC is installed has changed, type it in the Server box.

24

InfoSphere Change Data Capture Management Console: Administration Guide

7. If the port number of the server has changed, type it in the Port box. Note: You can only edit a datastore if you are a System Administrator and have the privilege to manage datastores and user accounts. Related concepts Setting up datastores for replication on page 59

To delete a datastore
1. Click Access Manager > Datastore Management. 2. Select an existing datastore or hold CTRL and select multiple datastores. 3. Click File > Access Server > Delete. Note: You can only delete a datastore if you are a System Administrator and have the privilege to manage datastores and user accounts. Related concepts Setting up datastores for replication on page 59

To copy a datastore
1. Click Access Manager > Datastore Management. 2. Select an existing datastore. 3. Click File > Access Server > Copy. 4. Type the name of the new datastore in the New Name box. Note: You can only copy a datastore if you are a System Administrator and have the privilege to manage datastores and user accounts. Related concepts Setting up datastores for replication on page 59

To view the history of a datastore


1. 2. 3. 4. Click Access Manager > Datastore Management. Select an existing datastore. Click File > Access Server > Properties. Click History. Related concepts Setting up datastores for replication on page 59

To set connection parameters on a datastore


1. Click Access Manager > Datastore Management. Select an existing datastore. Click File > Access Server > Properties. Click Connection Parameters. Type the name of the database or the Universal Resource Locator (URL) of the database server in the Database/URL box. 6. Type the database user name in the DB Login box. If you want users to connect to a database for replication with WebSphere DataStage, then you must specify the user you created when installing InfoSphere CDC. 7. Type and confirm the password to connect to this database in the Password and Confirm boxes. 2. 3. 4. 5.
Setting up datastores and user accounts in Access Manager

25

8. If you want users assigned to this datastore that use the existing connection parameters to connect to the datastore using the new connection parameters you have set for this datastore, then enable the Propagate changes to users checkbox. Note: You can only set connection parameters on a datastore if you are a System Administrator that can manage datastores and user accounts. Related concepts Setting up datastores for replication on page 59

Managing user accounts


You can create user accounts and assign these users to a datastore in the Access Manager perspective of Management Console. v Add, modify, delete, or copy user accountsadding a user account is necessary to provide users with the ability to connect to Access Server and log into Management Console. When adding a user account, you must specify a unique user name. When setting a password for the user, it must meet any complex password requirements you may have set in Management Console. v Assign a datastore to a userassigning a datastore provides the user access to an installation of InfoSphere CDC and the ability to connect to the database that you have made available for replication on the server. v Change the security role of a userchanging the security role on a user account determines the level of access a user has in Management Console. Users can work in either a System Administrator account, Administrator account, Monitor account, or an Operator account. v Generate a report on selected user accountsgenerating a report on a specific user account can help you keep track of which datastores the user has access to, the role of the user, the date of user account creation, and the last time it was modified. You can also track account status settings such as if the account is locked, disabled, if the user is required to change their password at next login, or if the account has a password expiry policy set on it. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: To add a new user on page 27 To edit a user on page 27 To delete a user on page 28 To copy a user on page 29 To change the existing role on a user account on page 29 To enable a System Administrator user account and datastore administration privileges on page 30 To view the history of a user account on page 30 Related tasks To assign a datastore to users on page 30

26

InfoSphere Change Data Capture Management Console: Administration Guide

To add a new user


1. Click Access Manager > User Management. 2. Click File > Access Server > New User. 3. Type the name of the user in the Name box. This is the name the user will need to supply when connecting to Access Server and logging into Management Console. 4. If you want to keep a profile of the user for system administrator purposes, type their full name and a description in the Full Name and Description boxes. 5. If you want the user to specify a password, type and confirm it in the Password and Confirm boxes. If you have enabled complex passwords, then you must specify a password that meets the requirements. 6. If you want to assign the user to a role, choose one of the following: Role v System Administratorspecifies that users assigned to this role can perform all available operations in Management Console. Only users that require full operational access to the Monitoring and Configuration perspectives should be assigned to this role. System administrators can also modify system parameters to calibrate their replication environment. v Administratorspecifies that users assigned to this role can perform all available operations in Management Console, but cannot modify system parameters. Users assigned to this role can access both the Monitoring and Configuration perspectives. v Operatorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. v Monitorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. Enable user account and datastore administrationenables a user assigned the System Administrator role access to the Access Manager perspective. If you enable this option for a user, then they can create new users, new datastores, and define Access Server password settings. Note: You can only add a new user if you are a System Administrator and have the privilege to manage datastores and user accounts. Notes: v Users assigned to the Operator role can start, stop, and monitor replication activities. They can also view the tables selected for refresh and start a refresh on a subscription. Operators also have access to the Replication Diagram view, and can view notifications sent by subscriptions or datastores. However, users assigned to this role cannot configure replication and select or remove tables from a refresh. v Users assigned to the Monitor role can view the event log, view statistics, and view table mappings. Users can view the replication state and status of a subscription and can view latency threshold information. Monitors also have access to the Replication Diagram view. However, users assigned to this role cannot start or stop replication, configure replication, refresh tables, or view notifications sent by subscriptions and datastores.

To edit a user
1. Click Access Manager > User Management. 2. Select an existing user.
Setting up datastores and user accounts in Access Manager

27

3. Click File > Access Server > Properties. 4. If you want to change the full name or description of the user, type this information in the Full Name and Description boxes. 5. If you want the user to specify a new password, type and confirm it in the Password and Confirm boxes. As the system administrator, if you have enabled complex passwords, then you must specify a password that meets the requirements. 6. If you want to change the role assigned to the user, choose one of the following: Role v System Administratorspecifies that users assigned to this role can perform all available operations in Management Console. Only users that require full operational access to the Monitoring and Configuration perspectives should be assigned to this role. System administrators can also modify system parameters to calibrate their replication environment. v Administratorspecifies that users assigned to this role can perform all available operations in Management Console, but cannot modify system parameters. Users assigned to this role can access both the Monitoring and Configuration perspectives. v Operatorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. v Monitorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. Enable user account and datastore administrationenables a user assigned the System Administrator role access to the Access Manager perspective. If you enable this option for a user, then they can create new users, new datastores, and define Access Server password settings. Note: You can only edit a user if you are a System Administrator and have the privilege to manage datastores and user accounts. Notes: v Users assigned to the Operator role can start, stop, and monitor replication activities. They can also view the tables selected for refresh and start a refresh on a subscription. Operators also have access to the Replication Diagram view, and can view notifications sent by subscriptions or datastores. However, users assigned to this role cannot configure replication and select or remove tables from a refresh. v Users assigned to the Monitor role can view the event log, view statistics, and view table mappings. Users can view the replication state and status of a subscription and can view latency threshold information. Monitors also have access to the Replication Diagram view. However, users assigned to this role cannot start or stop replication, configure replication, refresh tables, or view notifications sent by subscriptions and datastores.

To delete a user
1. Click Access Manager > User Management. 2. Select an existing user or hold the CTRL key to select multiple users. 3. Click File > Access Server > Delete. Note: You can only delete a user if you are a System Administrator that can manage datastores and user accounts.

28

InfoSphere Change Data Capture Management Console: Administration Guide

To copy a user
1. 2. 3. 4. Click Access Manager > User Management. Select an existing user. Click File > Access Server > Copy. Type the name of the user in the Enter the name of the user box. Note: You can only copy a user if you are a System Administrator that can manage datastores and user accounts.

To change the existing role on a user account


1. 2. 3. 4. Click Access Manager > User Management. Select an existing user or hold the CTRL key to select multiple users. Click File > Access Server > Change Role. Choose from one of the following: Role v System Administratorspecifies that users assigned to this role can perform all available operations in Management Console. Only users that require full operational access to the Monitoring and Configuration perspectives should be assigned to this role. System administrators can also modify system parameters to calibrate their replication environment. v Administratorspecifies that users assigned to this role can perform all available operations in Management Console, but cannot modify system parameters. Users assigned to this role can access both the Monitoring and Configuration perspectives. v Operatorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. v Monitorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. Enable user account and datastore administrationenables a user assigned the System Administrator role access to the Access Manager perspective. If you enable this option for a user, then they can create new users, new datastores, and define Access Server password settings. Note: You can only change the role of users if you are a System Administrator and have the privilege to manage datastores and user accounts. Notes: v Users assigned to the Operator role can start, stop, and monitor replication activities. They can also view the tables selected for refresh and start a refresh on a subscription. Operators also have access to the Replication Diagram view, and can view notifications sent by subscriptions or datastores. However, users assigned to this role cannot configure replication and select or remove tables from a refresh. v Users assigned to the Monitor role can view the event log, view statistics, and view table mappings. Users can view the replication state and status of a subscription and can view latency threshold information. Monitors also have access to the Replication Diagram view. However, users assigned to this role cannot start or stop replication, configure replication, refresh tables, or view notifications sent by subscriptions and datastores.

Setting up datastores and user accounts in Access Manager

29

To enable a System Administrator user account and datastore administration privileges


1. 2. 3. 4. 5. Click Access Manager > User Management. Select an existing user. Click File > Access Server > Properties. Ensure the user is assigned to the System Administrator role. Enable the Enable user account and datastore administration checkbox. Note: You can only enable a System Administrator to manage datastores and user accounts if you are a System Administrator that can manage datastores and user accounts.

To view the history of a user account


1. 2. 3. 4. Click Access Manager > User Management. Select an existing user. Click File > Access Server > Properties. Click History. Note: You can only view the history of an account if you are a System Administrator that can manage datastores and user accounts.

Assigning users to datastores


You can either assign a datastore to a user or assign a user to a datastore in the Access Manager perspective of Management Console. Both methods create the required relationship between a datastore and a user. Users need this relationship so that they can connect to a datastore. A datastore represents the InfoSphere CDC installation and the database made available for replication. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: To assign a datastore to users To assign users to a datastore on page 31

To assign a datastore to users


Ensure you have added a user. Click Access Manager > User Management. Select an existing user or hold the CTRL key to select multiple users. Click File > Access Server > Assign > Datastore. Select a datastore. Review the connection parameters. You can click OK to accept the default connection parameters on the datastore or you can choose to override the default parameters for the selected user. 7. If you choose to override the defaults, specify the following: 1. 2. 3. 4. 5. 6.

30

InfoSphere Change Data Capture Management Console: Administration Guide

v Database/URLspecifies the name of the database or the Universal Resource Locator (URL) of the database server you want to connect to. v DB Loginspecifies the database user name to connect to the database. If you want users to connect to the database for replication with WebSphere DataStage, then you must specify the user you created when installingInfoSphere CDC. v DB Passwordspecifies the password to connect to the database. v Confirm Passwordspecifies the confirmed password. 8. If you want to set specific options on how these connection parameters are displayed to the user when connecting to the datastore in the Connect to datastore dialog box, then enable one or more of the following options: v Always show connection dialogenables the user to specify the password each time they want to connect to the datastore. v Show parameter valuess (except password)displays the connection parameters to the user (except password) each time the user tries to connect to the datastore. v Write-protect parameters (except password)displays the connection parameters to the user (except password) in read-only format each time the user tries to connect to the datastore. v Allow connection parameters savingenables the user to save the connection parameters when connecting to a datastore. Note: You can only assign a datastore to users if you are a System Administrator and have the privilege to manage datastores and user accounts.

To assign users to a datastore


1. 2. 3. 4. 5. 6. Ensure you have added a datastore. Click Access Manager > Datastore Management. Select an existing datastore. Click File > Access Server > Assign > User. Select a user or hold the CTRL key to select multiple users. Review the connection parameters. You can click OK to accept the default connection parameters on the datastore or you can choose to override the default parameters for the selected user(s).

7. If you choose to override the defaults, specify the following: v Database/URLspecifies the name of the database or the Universal Resource Locator (URL) of the database server you want to connect to. v DB Loginspecifies the database user name to connect to the database. If you want users to connect to the database for replication with WebSphere DataStage, then you must specify the user you created when installingInfoSphere CDC. v DB Passwordspecifies the password to connect to the database. v Confirm Passwordspecifies the confirmed password. 8. If you want to set specific options on how these connection parameters are displayed to the user when connecting to the datastore in the Connect to datastore dialog box, then enable one or more of the following options: v Always show connection dialogenables the user to specify the password each time they want to connect to the datastore.

Setting up datastores and user accounts in Access Manager

31

v Show parameter valuess (except password)displays the connection parameters to the user (except password) each time the user tries to connect to the datastore. v Write-protect parameters (except password)displays the connection parameters to the user (except password) in read-only format each time the user tries to connect to the datastore. v Allow connection parameters savingenables the user to save the connection parameters when connecting to a datastore. Note: You can only assign users to a datastore if you are a System Administrator and have the privilege to manage datastores and user accounts.

Managing datastore connections


A datastore represents the InfoSphere CDC installation and the database made available for replication. As a System Administrator, you can manage datastore connections. Use the Connection Management view to: v Assign a user to a datastoreassigning a user to a datastore creates a datastore centric relationship between a datastore and a user. This means when you select a datastore in the Datastores Management view, you should be able to see all the users you have assigned to that specific datastore in the Connection Management view. When assigning a user, you must specify the correct connection parameters. The user will require these parameters in order to connect to the datastore. You can assign the same user to more than one datastore. v Assign a datastore to a userassigning a datastore to a user creates a user centric relationship between a user and a datastore. This means when you select a user in the User Management view, you should be able to see all the datastores you have assigned to that specific user in the Connection Management view. When assigning a datastore, you must specify the correct connection parameters. The user will require these parameters in order to connect to the datastore. You can assign the same datastore to more than one user. v Set connection parameterssetting connection parameters on a datastore provides users with the ability to connect to the datastore. If you have already specified connection parameters for a datastore when you had added it to Management Console, then these parameters will display when you assign a user to a datastore. You can choose to apply these same connection parameters, or choose to override these and specify another set of connection parameters. v Modify and delete connection parametersdeleting an existing connection may be necessary when a user no longer requires access to a specific datastore. You can also modify connection parameters. Users will need to be made aware of the new parameters so that they can connect. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: To delete a connection on page 33 To override default connection parameters on a datastore on page 33

32

InfoSphere Change Data Capture Management Console: Administration Guide

Related tasks To assign users to a datastore on page 31

To delete a connection
1. Ensure you have assigned a datastore and a user. 2. Click Access Manager. 3. Delete an existing connection using one of the following methods: v Click Datastores Management and select an existing datastore that has a user assigned to it. Click Connection Management and right-click on the user assigned to the datastore. Click Delete Connection. v Click User Management and select an existing user that has a datastore assigned to it. Click Connection Management and right-click on the datastore assigned to the user. Click Delete Connection. Note: You can only delete a datastore if you are a System Administrator that can manage datastores and user accounts.

To override default connection parameters on a datastore


1. 2. 3. 4. 5. 6. Ensure you have assigned a user to the datastore. Click Access Manager > Datastore Management. Select the datastore. Select the user assigned to this datastore in the Connection Management view. Click File > Access Server > Properties. Type the name of the database or the Universal Resource Locator (URL) of the database server in the Database/URL box.

7. Type the database user name in the DB Login box. If you want users to connect to a database for replication with WebSphere DataStage, then you must specify the user you created when installing InfoSphere CDC. 8. Type and confirm the password to connect to this database in the DB Password and Confirm boxes. 9. If you want to set specific options on how these connection parameters are displayed to the user when connecting to the datastore in the Connect to datastore dialog box, then enable one or more of the following options: v Always show connection dialogenables the user to specify the password each time they want to connect to the datastore. v Show parameter valuess (except password)displays the connection parameters to the user (except password) each time the user tries to connect to the datastore. v Write-protect parameters (except password)displays the connection parameters to the user (except password) in read-only format each time the user tries to connect to the datastore. v Allow connection parameters savingenables the user to save the connection parameters when connecting to a datastore. Note: You can only override connection parameters on a datastore if you are a System Administrator and have the privilege to manage datastores and user accounts.

Setting up datastores and user accounts in Access Manager

33

Managing security on user accounts


You can set specific security options on an existing user account in the Access Manager perspective of Management Console. Use the User Properties dialog box to: v disable a user account. v enable users to change their passwords at next login. v override any password expiration policy you may have set in Management Console. v unlock locked user accounts. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: To disable a user account To enable a user to change password at next login To override password expiration policy set in Management Console To unlock a user account on page 35

To disable a user account


1. 2. 3. 4. Click Access Manager > User Management. Select an existing user. Click File > Access Server > Properties. Enable the Account is disabled checkbox.

To enable a user to change password at next login


1. 2. 3. 4. Click Access Manager > User Management. Select an existing user. Click File > Access Server > Properties. Enable the User must change password at next login checkbox. Note: You can only enable a user to change the password at next login if you are a System Administrator that can manage datastores and user accounts.

To override password expiration policy set in Management Console


1. Click Access Manager > User Management. 2. Select an existing user. 3. Click File > Access Server > Properties. 4. Enable the Password never expires checkbox. Note: You can only override an existing password expiration policy if you are a System Administrator that can manage datastores and user accounts.

34

InfoSphere Change Data Capture Management Console: Administration Guide

To unlock a user account


1. 2. 3. 4. Click Access Manager > User Management. Select an existing user. Click File > Access Server > Properties. Disable the Account is locked checkbox. This checkbox is enabled automatically after the number of failed login attempts exceeds the locking policy you may have set in the Access Server Options dialog box in Management Console. Note: You can only unlock an account if you are a System Administrator that can manage datastores and user accounts.

Setting password and account security policies on user accounts


You can enhance password and account security on all user accounts in the Access Manager perspective of Management Console. Use the Access Server Options dialog box to: v Set a complex password requirementenhances password security by enabling users to specify a complex password when logging into Management Console. v Enforce password historyenables system administrators to enhance security by ensuring that old passwords are not continually reused. For this policy to be effective, do not let users change their password immediately after setting a new one. You can control this by setting the minimum age of the password. v Enforce a password expiry policyenables system administrators to enhance security by ensuring that new passwords are created and associated with user accounts. v Lock accounts after a number of failed login attemptsenables a three strikes login policy which is used to prevent computer password attacks. The policy creates a condition where a user will be locked out of their account after a number of attempts. By default, this setting is set to 3 login attempts. v Enforce an account expiry after new account creationenhances account security by forcing users to change their passwords when a new account is created for them. v Display the number of failed login attemptsenables users to track the number of failed login attempts before they get locked out of the account. v Display the last successful loginenables users to track their last successful login. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: To set complex passwords on user accounts on page 36 To enforce password history on page 36 To enforce password expiry on page 36 To enforce password locking on failed login attempts on page 36 To enforce new account expiry on page 36 To display previous failed login attempts on page 37 To display the last successful login on page 37

Setting up datastores and user accounts in Access Manager

35

To set complex passwords on user accounts


Click File > Access Server > Access Server Options. Click Passwords. Enable the Require complex password checkbox. Type the minimum password length in the Minimum password length box. The number must be between 0 and 30. 5. Type the minimum number of alphabetic characters in the Minimum alphabetic characters box. The number must be between 0 and 30. 6. Type the minimum number of non-alphabetic characters in the Minimum non-alphabetic characters box. The number must be between 0 and 30. 1. 2. 3. 4. Note: You can only set complex passwords on user accounts if you are a System Administrator that can manage datastores and user accounts.

To enforce password history


1. 2. 3. 4. Click File > Access Server > Access Server Options. Click Passwords. Ensure the Enforce Password history checkbox is enabled. Type the number of passwords remembered in the Passwords remembered box. The number must be between 1 and 12. The default number is 5. Note: You can only enforce password history if you are a System Administrator and have the privilege to manage datastores and user accounts.

To enforce password expiry


1. 2. 3. 4. Click File > Access Server > Access Server Options. Click Passwords. Ensure the Enforce password expiry checkbox is enabled. Type the maximum number of days before a password expires in the Maximum password (age) box. The number must be between 1 and 999. The default number is 3. Note: You can only enforce password expiry if you are a System Administrator and have the privilege to manage datastores and user accounts.

To enforce password locking on failed login attempts


1. 2. 3. 4. Click File > Access Server > Access Server Options. Click Accounts. Ensure the Lock accounts on failed login attempts checkbox is enabled. Type the maximum number of attempts before an accounts is locked in the Consecutive failures before lock box. The number must be between 1 and 100. The default number is 3. Note: You can only enforce new password locking if you are a System Administrator and have the privilege to manage datastores and user accounts.

To enforce new account expiry


1. Click File > Access Server > Access Server Options. 2. Click Accounts.

36

InfoSphere Change Data Capture Management Console: Administration Guide

3. Ensure the Enforce new account expiry checkbox is enabled. 4. Type the maximum number of days before a new account expires in the Maximum new account age (days) box. The number must be between 1 and 999. The default number is 15. Note: You can only enforce new account expiry if you are a System Administrator and have the privilege to manage datastores and user accounts.

To display previous failed login attempts


1. Click File > Access Server > Access Server Options. 2. Click Accounts. 3. Ensure the Display previous failed login attempts checkbox is enabled. Note: You can only display previous failed login attempts if you are a System Administrator and have the privilege to manage datastores and user accounts.

To display the last successful login


1. Click File > Access Server > Access Server Options. 2. Click Accounts. 3. Ensure the Display last successful login checkbox is enabled. Note: You can only display the last successful login if you are a System Administrator and have the privilege to manage datastores and user accounts.

Auditing user accounts, datastores, security policies, and general events


You can audit user accounts, datastores, security policies, and general events in the Access Manager perspective of Management Console. Collecting data generated by user activities is very important for analyzing the security of information, verifying system integrity, and detecting signs of suspicious behavior. By generating reports that contain this type of information, you can systematically examine user activities and identify any attempts to breach the security of your replication configuration. When audit logging is enabled, Access Server keeps track of significant activities and records them into an audit log file. You can archive audit log files and generate audit trail reports for a specified period of time from the current audit log, or from an archived log file. Two types of reports can be generated from an audit log: audit trail and security log. You can save audit trail reports as HTML files, and display or print them through a web browser. Use the Audit tab in the Access Server Options dialog box to: v Enable audit loggingenabling audit logging lets you audit the activity of user accounts, datastores, security policies set on user accounts, and other general events. Use the Audit Trail Report dialog box to generate an audit trail report. You can generate audit trail reports after enabling audit logging. The following activities are recorded in the report: v Added, modified, or deleted user accounts v Added, modified, deleted, or renamed datastores v New or lost user and datastore assignments v Enabled, disabled, or modified ability to generate an audit log
Setting up datastores and user accounts in Access Manager

37

v Modified security settings on user accounts Use the Security Log dialog box to generate a security log report. You can generate security log reports after enabling audit logging. The following activities are recorded the report: v v v v v v v Modified user passwords Disabled or enabled user accounts Locked or unlocked user accounts Successful or failed log in attempts by a user Which users are logged or logged out of Management Console Which datastores users are connected to or disconnected from Started or stopped Access Servers

v Generated report lists Each of the activities contained in either an audit trail or security log report has the following categories and items of information: v Eventspecifies the description of the activity being audited. v Timestampthe date and time of activity. v Identificationdepending on the activities being audited, the report will specify the name on the user account, datastore name, and the process responsible for generating the activity. v Commentprovides more information if applicable. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: To To To To enable auditing generate an audit trail log on page 39 generate a security log report on page 39 clear the log on page 39

To enable auditing
1. 2. 3. 4. Click File > Access Server > Access Server Options. Click Audit. Enable the Audit log checkbox. Enable one or more of the following: v Audit account managementenable if you want to audit user account management activities such as the creation, modification, and deletion of users. v Audit datastore managementenable if you want to audit datastore management activities such as the creation, modification, and deletion of datastores. v Audit security policy managementenable if you want to audit security policy settings related to passwords and user accounts. v Audit general eventsenable if you want to audit general events generated by Access Server.

38

InfoSphere Change Data Capture Management Console: Administration Guide

Note: You can only enable auditing if you are a System Administrator and have the privilege to manage datastores and user accounts.

To generate an audit trail log


1. 2. 3. 4. Ensure you have enabled audit logging. Click File > Access Server > Audit log > Audit Trail. Select the start date of the events you want to audit in the From box. Select the end date of the events you want to audit in the To box. Note: You can only generate an audit trail log if you are a System Administrator and have the privilege to manage datastores and user accounts. Note: If you have cleared your log, then the report will be empty until new events are generated.

To generate a security log report


1. 2. 3. 4. Ensure you have enabled audit logging. Click File > Access Server > Audit log > Security Log. Select the start date of the events you want to audit in the From box. Select the end date of the events you want to audit in the To box. Note: You can only generate a security log report if you are a System Administrator and have the privilege to manage datastores and user accounts. Note: If you have cleared your log, then the report will be empty until new events are generated.

To clear the log


1. Ensure you have enabled audit logging and generated a report. This ensures that there is nothing important in the report that you want to save first before clearing the log. 2. Click File > Access Server > Audit log > Clear Log. 3. Click Yes to clear the log. Note: You can only clear the log if you are a System Administrator and have the privilege to manage datastores and user accounts.

Creating list reports


You can generate a list report in the Access Manager perspective of Management Console. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: To create a user list report on page 40 To create a datastore list report on page 40

Setting up datastores and user accounts in Access Manager

39

To create a user list report


1. 2. 3. 4. Click Access Manager > User Management. Select an existing user or hold the CTRL key to select multiple users. Click File > Access Server > Reports>User Report. Enable one or more of the following: v Full Nameincludes the full name you specified when you created the user. v Roleincludes the role you had assigned to the user. v Descriptionincludes the description you specified when you created the user. v Account Statusincludes information about the account such as password expiry or if the account has been disabled or locked. v Date Createdincludes the date you had created the user account. v Date Last Modifiedincludes the date the user was last modified. v Datastores Accessincludes the datastores you have assigned to the user. Note: You can only create a list report if you are a System Administrator and have the privilege to manage datastores and user accounts.

To create a datastore list report


Click Access Manager > Datastore Management. Select an existing datastore or hold the CTRL key to select multiple datastores. Click File > Access Server > Reports>Datastore Report. Enable one or more of the following: v Descriptionincludes a description you specified when you added the datastore. v Datastore Platformincludes the type of database platform on which this datastore resides. v Date Createdincludes the date you had created the datastore. v Date Last Modifiedincludes the date the datastore was last modified. v User Accessincludes the users you have assigned to this datastore. 5. Click OK and Save. 1. 2. 3. 4. Note: You can only create a list report if you are a System Administrator and have the privilege to manage datastores and user accounts.

Commands for Access Server


Access Server provides a set of commands that let you manage datastores and user accounts from a Windows, UNIX, or Linux command prompt. In this section, you will learn: dmaddconnectionAdding a datastore connection to a user on page 41 dmchangeconnectionChanging the connection parameters to a datastore on page 42 dmchangepasswordChanging the password on a user account on page 43 dmcreatedatastoreAdding a datastore on page 43 dmcreateuserAdding a user on page 44 dmdeleteconnectionDeleting a datastore connection on page 45

40

InfoSphere Change Data Capture Management Console: Administration Guide

dmdeletedatastoreDeleting a datastore on page 45 dmdeleteuserDeleting a user on page 46 dmdisableuserDisabling a user account on page 46 dmenableuserEnabling a user on page 46 dmlistdatastoreusersGenerating a report list of users assigned to a datastore on page 47 dmlistuserdatastoresGenerating a report list of datastores assigned to a user on page 47 dmlistusersListing user accounts on page 48 dmresetuserResetting a user account on page 49 dmunlockuserUnlocking a user account on page 49

dmaddconnectionAdding a datastore connection to a user


Use this command to set connection parameters to a datastore for a user. When adding a connection for a user, you must identify the name and password of the database you want users to use for replication. This database resides on the same server as your InfoSphere CDC installation. When the user establishes a connection to the datastore, they are in fact connecting to this database. To set connection parameters on a user account, you must be a System Administrator and have the privilege to manage datastores and user accounts.

Syntax Parameters
userName Specifies the name of the user for which you want to create a connection. datastoreName Specifies the name of the datastore you want the user to connect to. database Specifies the name of the database that you want users to replicate to or from. Not all datastore connections are to a database. Use if not required. databaseOwner Specifies the user name of the database. Not all datastore connections are to a database. Use if not required. databasePassword Specifies the password to log into the database. Not all datastore connections are to a database. Use if not required. alwaysPrompt Specifies that you want the user to always be prompted for a connection each time the user tries to connect to the datastore. If you want the user to be prompted for a connection, then specify a value of TRUE. Otherwise, specify a value of FALSE. showParams Specifies that you want all the connection parameters displayed to the user (except for the password) each time the user tries to connect to the datastore. If you want the parameters displayed, then specify a value of TRUE. Otherwise, specify a value of FALSE.

DMADDCONNECTION userName datastoreName database databaseOwner databasePassword alwaysPrompt showPa

Setting up datastores and user accounts in Access Manager

41

writeProtected Specifies that you want all the connection parameters displayed to the user in read-only format each time the user tries to connect to the datastore. If you want the parameters displayed in read-only format, specify a value of TRUE. Otherwise, specify a value of FALSE. saveParams Specifies that you want the user to be able to save connection parameters when connecting to the datastore. If you want to enable parameter saving, then specify a value of TRUE. Otherwise, specify a value of FALSE. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.

dmchangeconnectionChanging the connection parameters to a datastore


Use this command to change connection parameters to a datastore for a user account. When changing a connection for a user, you must identify the name and password of the database you want users to use for replication. This database resides on the same server as your InfoSphere CDC installation. When the user establishes a connection to the datastore, they are in fact connecting to this database. To change connection parameters on a user account, you must be a System Administrator and have the privilege to manage datastores and user accounts.

Syntax Parameters
userName Specifies the name of the user for which you want to create a connection. datastoreName Specifies the name of the datastore you want the user to connect to. database Specifies the name of the database that you want users to replicate to or from. Not all datastore connections are to a database. Use if not required. databaseOwner Specifies the user name of the database. Not all datastore connections are to a database. Use if not required. databasePassword Specifies the password to log into the database. Not all datastore connections are to a database. Use if not required. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.

DMCHANGECONNECTION userName datastoreName database databaseOwner databasePassword [-accessserver host

42

InfoSphere Change Data Capture Management Console: Administration Guide

dmchangepasswordChanging the password on a user account


Use this command to change the password on a user account that you had created. This user will require the password in order to log into Management Console. To change passwords, you must be a System Administrator and have the privilege to manage datastores and user accounts.

Syntax
DMCHANGEPASSWORD username password [-accessserver hostname port adminuser adminpassword]

Parameters
userName Specifies the name of the user that you are changing the password for. password Specifies the password you want the user to supply when logging into Management Console. If you have enabled complex passwords, then you must specify a password that meets the requirements. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.

dmcreatedatastoreAdding a datastore
Use this command to add a new datastore. Adding a datastore in Management Console means that you are in the process of making an installation of InfoSphere CDC and the database you want users to replicate to or from available for connection by other users. When adding a datastore, you must specify information about where your installation of InfoSphere CDC resides. To add a datastore, you must be a System Administrator and have the privilege to manage datastores and user accounts.

Syntax Parameters
datastoreName Specifies the name of the datastore you want to add. description Specifies a brief description about this datastore. hostname Specifies the hostname of the server where you have installed InfoSphere CDC. port Specifies the port number of the server where you have installed InfoSphere CDC. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.
Setting up datastores and user accounts in Access Manager

DMCREATEDATASTORE datastoreName description hostname port [-accessserver hostname port adminuser a

43

dmcreateuserAdding a user
Use this command to add a new user. Adding a user account is necessary to provide users with the ability to log into Management Console. To add a user, you must be a System Administrator and have the privilege to manage datastores and user accounts.

Syntax Parameters
username Specifies the unique name for the user you want to create an account for. fullname Specifies the full name of the user. description Specifies a description about the user. password Specifies the password you want the user to supply when logging into Management Console. If you have enabled complex passwords, then you must specify a password that meets the requirements. role Specifies the role you want to assign to the user. Enable one of the following values: v SYSADMINspecifies that a user assigned to this role is a System Administrator and can perform all available operations in Management Console. Only users that require full operational access to the Monitoring and Configuration perspectives should be assigned to this role. System administrators can also modify system parameters to calibrate their replication environment. v ADMINspecifies that a user assigned to this role is an Administrator and can perform all available operations in Management Console, but cannot modify system parameters. Users assigned to this role can access both the Monitoring and Configuration perspectives. v OPERATORspecifies a that user assigned to this role is an Operator and only has access to the Monitoring perspective in Management Console. v MONITORspecifies that a user assigned to this role is a Monitor and only has access to the Monitoring perspective in Management Console. manager Specifies that a user assigned the role of SYSADMIN also has privileges to manage datastores and user accounts in the Access Manager perspective of Management Console. If you want to enable this privilege for a System Administrator, then specify a value of TRUE. Otherwise, specify a value FALSE. changePassword Specifies you want the user to change their password when logging into Management Console for the first time. If you want the user to change the password, specify a value of TRUE. Otherwise, if you want the user to login using the same password you have assigned to them, then specify a value of FALSE.

DMCREATEUSER username fullname description password role manager changePassword passwordExpires [-acc

44

InfoSphere Change Data Capture Management Console: Administration Guide

passwordExpires Specifies that you want to override any existing password expiry policies set in Management Console so that the password never expires. If you want to override an existing password expiry policy, specify a value of TRUE. Otherwise, if you want the password to expire, then specify a value of FALSE. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required. Notes: v Users assigned to the Operator role can start, stop, and monitor replication activities. They can also view the tables selected for refresh and start a refresh on a subscription. Operators also have access to the Replication Diagram view, and can view notifications sent by subscriptions or datastores. However, users assigned to this role cannot configure replication and select or remove tables from a refresh. v Users assigned to the Monitor role can view the event log, view statistics, and view table mappings. Users can view the replication state and status of a subscription and can view latency threshold information. Monitors also have access to the Replication Diagram view. However, users assigned to this role cannot start or stop replication, configure replication, refresh tables, or view notifications sent by subscriptions and datastores.

dmdeleteconnectionDeleting a datastore connection


Use this command to delete an existing connection between a datastore and a user. To delete a connection, you must be a System Administrator and have the privilege to manage datastores and user accounts.

Syntax
DMDELETECONNECTION userName datastoreName [-accessserver hostname port adminuser adminpassword]

Parameters
username Specifies the unique name of the user you want to delete the connection for. datastoreName Specifies the name of the datastore you want to delete the connection for. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.

dmdeletedatastoreDeleting a datastore
Use this command to delete a datastore. To delete a datastore, you must be a System Administrator and have the privilege to manage datastores and user accounts.

Syntax
DMDELETEDATASTORE datastoreName [-accessserver hostname port adminuser adminpassword]

Setting up datastores and user accounts in Access Manager

45

Parameters
datastoreName Specifies the name of the datastore you want to delete. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.

dmdeleteuserDeleting a user
Use this command to delete a user. To delete a user, you must be a System Administrator and have the privilege to manage datastores and user accounts.

Syntax
DMDELETEUSER username [-accessserver hostname port adminuser adminpassword]

Parameters
username Specifies the name of the user you want to delete. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.

dmdisableuserDisabling a user account


Use this command to disable a user account. This prevents the user from logging into Management Console. To disable a user, you must be a System Administrator and have the privilege to manage datastores and user accounts.

Syntax
DMDISABLEUSER username [-accessserver hostname port adminuser adminpassword]

Parameters
username Specifies the name of the user you want to disable. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.

dmenableuserEnabling a user
Use this command to enable a user account. This lets the user log into Management Console. To enable a user, you must be a System Administrator and have the privilege to manage datastores and user accounts.

Syntax
DMENABLEUSER username [-accessserver hostname port adminuser adminpassword]

46

InfoSphere Change Data Capture Management Console: Administration Guide

Parameters
username Specifies the name of the user you want to enable. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.

dmlistdatastoreusersGenerating a report list of users assigned to a datastore


Use this command to generate a list of users assigned to a specific datastore. To generate a report list, you must be a System Administrator and have the privilege to manage datastores and user accounts.

Syntax
DMLISTDATASTOREUSERS adminUser adminPassword datastoreName

Parameters
adminUser Specifies the name of the System Administrator. adminPassword Specifies the password of the System Administrator. datastoreName Specifies the name of the datastore you want to generate a list for. This list specifies the names of the users assigned to this datastore.

dmlistuserdatastoresGenerating a report list of datastores assigned to a user


Use this command to generate a list of datastores assigned to a specific user. To generate a report list, you must be a System Administrator and have the privilege to manage datastores and user accounts.

Syntax
DMLISTUSERDATASTORES username [-accessserver hostname port adminuser adminpassword]

Parameters
username Specifies the name of the user you want to generate a list for. This list specifies the datastores assigned to this user. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.

Setting up datastores and user accounts in Access Manager

47

dmlistusersListing user accounts


Use this command to generate a list of users and properties on the account. To list users, you must be a System Administrator and have the privilege to manage datastores and user accounts.

Syntax
DMLISTUSERS [-accessserver hostname port adminuser adminpassword]

Parameters
accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.

Output
User Specifies the name of the user. Role Specifies the role assigned to the user. v SYSADMINspecifies that a user assigned to this role is working in a System Administrator account and can perform all available operations in Management Console. Only users that require full operational access to the Monitoring and Configuration perspectives should be assigned to this role. System administrators can also modify system parameters to calibrate their replication environment. v ADMINspecifies that a user assigned to this role is working in an Administrator account and can perform all available operations in Management Console, but cannot modify system parameters. Users assigned to this role can access both the Monitoring and Configuration perspectives. v OPERATORspecifies a that user assigned to this role is working in an Operator account and only has access to the Monitoring perspective in Management Console. v MONITORspecifies that a user assigned to this role is working in a Monitoring account and only has access to the Monitoring perspective in Management Console. Manager Specifies if the user assigned to the role of System Administrator has also been assigned privileges to manage datastores and user accounts. TRUE indicates that the System Administrator has been given these privileges. FALSE indicates that the System Administrator has not been given these privileges. Disabled Specifies if the account has been disabled. TRUE indicates that the account is disabled. FALSE indicates the account is enabled. Locked Specifies if the account has been locked. This is automatically set to TRUE if the number of failed login attempts exceeds the locking policy you may have set. PwdChange Specifies if the user is required to change their password the next time the user

48

InfoSphere Change Data Capture Management Console: Administration Guide

logs into Management Console. TRUE indicates the user is required to change the password. FALSE indicates the user can use the same password assigned to them. Expires Specifies if the user account overrides any existing password expiry policy set in Management Console. TRUE indicates the password supplied will not expire and overrides any expiry policy. FALSE indicates the password does expire based on an expiry policy. Notes: v Users assigned to the Operator role can start, stop, and monitor replication activities. They can also view the tables selected for refresh and start a refresh on a subscription. Operators also have access to the Replication Diagram view, and can view notifications sent by subscriptions or datastores. However, users assigned to this role cannot configure replication and select or remove tables from a refresh. v Users assigned to the Monitor role can view the event log, view statistics, and view table mappings. Users can view the replication state and status of a subscription and can view latency threshold information. Monitors also have access to the Replication Diagram view. However, users assigned to this role cannot start or stop replication, configure replication, refresh tables, or view notifications sent by subscriptions and datastores.

dmresetuserResetting a user account


Use this command to reset a user account. To reset a user account, you must be a System Administrator and have the privilege to manage datastores and user accounts. When you reset a user account, the following properties are returned to their defaults: v the password is set to an empty string v the account is enabled v the account is unlocked v the user must change their password at next login v the password is set to follow the password expiry policy

Syntax
DMRESETUSER username [-accessserver hostname port adminuser adminpassword]

Parameters
username Specifies the name of the user account that needs to be reset. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.

dmunlockuserUnlocking a user account


Use this command to unlock a user account. A user account is automatically locked after the number of failed login attempts exceeds the locking policy you may have

Setting up datastores and user accounts in Access Manager

49

set in the Access Server Options dialog box in Management Console. To unlock a user, you must be a System Administrator and have the privilege to manage datastores and user accounts.

Syntax
DMUNLOCKUSER username [-accessserver hostname port adminuser adminpassword]

Parameters
username Specifies the name of the user you want to unlock. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.

50

InfoSphere Change Data Capture Management Console: Administration Guide

Setting preferences in Management Console


Preferences allow you to control certain aspects of the behavior of Management Console. In this section, you will learn: Setting connection preferences Setting advanced preferences on page 52 Setting prompt preferences on page 53 Setting statistics preferences on page 54 Setting the behavior of progress windows on page 55 Showing usability hints on page 55 Setting view preferences on page 55 Setting character encodings on page 56

Setting connection preferences


You can set the default port, specify outbound ports for Access Server, and choose whether you want to connect to datastores automatically after logging in to Management Console. Default Portthe default port is a unique TCP/IP number that is used to connect to Access Server. You specify this port number when you install Access Manager and when you log in to Management Console. Specify Outbound Portssets the starting port number and number of ports you require to go through a firewall to Access Server. The following ports are required: one for connection to Access Server; and one for each datastore that connects to Access Server. Connect to Datastores Automaticallywhen checked, automatically connects to datastores after logging into Management Console. When unchecked, you are required to manually connect to each datastore after logging in. See also: To specify a default port number To specify outbound ports on page 52 To connect to databases automatically on page 52

To specify a default port number


1. 2. 3. 4. Click Edit Preferences. Click Connection. Type the unique TCP/IP port number in the Default Port text box. Click Apply.

Note: You can click Restore Defaults at any time to use the default preferences. Related concepts Setting connection preferences
Copyright IBM Corp. 2008

51

To specify outbound ports


1. 2. 3. 4. 5. 6. Click Edit Preferences. Click Connection. Enable the Specify Outbound Ports check box. Type the starting port in the Starting Port box. Type the number of ports in the Number of Ports box. Click Apply. Related concepts Setting connection preferences on page 51

To connect to databases automatically


1. Click Edit Preferences. 2. Click Connection. 3. Enable the Connect to Datastores check box. 4. Click Apply. Note: You can click Restore Defaults at any time to use the default preferences. Related concepts Setting connection preferences on page 51

Setting advanced preferences


You can set the following advanced preferences: v Set timeout values. The describe and general timeout values indicate how long Management Console waits for a response from the datastore. v Allocate memory for Management Console. You can increase the timeout interval if necessary and adjust the amount of memory available for Management Console. v By default, Management Console automatically prompts you to set a filter when retrieving a large number of tables from your database. If you do not require an automatic prompt when mapping tables, you can disable this option. See also: To set timeout values To allocate memory for Management Console on page 53 To verify that an automatic prompt for filtering tables is enabled on page 53 To disable an automatic prompt for filtering tables on page 53

To set timeout values


1. Click Edit Preferences. 2. Click Advanced. 3. In the Integration Server Timeouts area, type values in the following boxes: v Describe Timeout (in minutes) v General Timeout (in minutes) 4. Click Apply. Note: You can click Restore Defaults at any time to use the default preferences.

52

InfoSphere Change Data Capture Management Console: Administration Guide

To allocate memory for Management Console


1. Click Edit Preferences. 2. Click Advanced. 3. Type the maximum amount of memory (in megabytes) you want to allocate for Management Console in the Maximum Memory box. 4. Click Apply.

To verify that an automatic prompt for filtering tables is enabled


1. Click Edit Preferences. 2. Click Advanced. 3. Ensure the Automatically prompt for filter when expanding nodes check box is enabled. 4. Ensure that there is a value greater than 0 in the Minimum number of tables box. 5. Click Apply.

To disable an automatic prompt for filtering tables


1. Click Edit Preferences. 2. Click Advanced. 3. Clear the Automatically prompt for filter when expanding nodes check box. 4. Click Apply.

Setting prompt preferences


The preferences for prompts allow you to control when Management Console prompts you for confirmation before performing certain tasks. You can enable the following prompt preferences: Requesting Configuration Details from Monitoringenables Management Console to prompt you before switching from the Monitoring perspective to the Configuration perspective when you want to edit a table mapping. Switching to Monitoring with Outstanding Changesenables Management Console to prompt you if there are outstanding changes in the Mapping Details view. Deleting Objectsenables Management Console to prompt you for confirmation before deleting objects, such as users, subscriptions, table mappings, etc. Starting or Ending Replicationenables Management Console to prompt you for confirmation before starting or ending replication. Marking a Table Capture Pointenables Management Console to prompt you with a confirmation message before setting a capture point for a table. The message warns you that setting a capture point will update the bookmark for the table. Updating Access Parametersenables Management Console to prompt you with a confirmation message before opening the Update Access Parameters dialog box.

Setting preferences in Management Console

53

Shutting Down Datastoreenables Management Console to prompt you with a confirmation message before shutting down a InfoSphere CDC for Oracle datastore. Note: You can click Restore Defaults at any time to use the default preferences. See also: To set prompt preferences

To set prompt preferences


1. 2. 3. 4. Click Edit Preferences. Click Prompts. Specify the prompt options you want by enabling the appropriate check boxes. Click Apply.

Note: You can click Restore Defaults at any time to use the default preferences.

Setting statistics preferences


The preferences for statistics let you control how Management Console collects statistics for your replication environment. You can set the following preferences: Statistics History Retained (minutes)the length of time that Management Console retains data for the statistics view. Statistics Sample Rate (seconds)the frequency at which Management Console collects data for the statistics view. A lower number will increase the frequency of data collection. See also: To set the length of time for data retention To set the sample rate for data collection

To set the length of time for data retention


1. 2. 3. 4. Click Edit Preferences. Click Statistics. Type the number of minutes in the Statistics History Retained (minutes) box. Click Apply.

To set the sample rate for data collection


1. 2. 3. 4. Click Edit Preferences. Click Statistics. Type the number of minutes in the Statistics Sample Rate (seconds) box. Click Apply.

54

InfoSphere Change Data Capture Management Console: Administration Guide

Setting the behavior of progress windows


You can choose to have Management Console automatically close progress windows after applying changes. See also: To automatically close progress windows

To automatically close progress windows


1. 2. 3. 4. Click Edit Preferences. Click Prompts. Enable the Close Progress Windows Automatically check box. Click Apply.

Showing usability hints


You can choose to have Management Console display a usability hint for source objects below the source columns on the Column Mappings tab in the Mapping Details view. See also: To show usability hints

To show usability hints


1. 2. 3. 4. Click Edit Preferences. Click Prompts. Enable the Show Hint for Mapping to Target Columns box. Click Apply.

Setting view preferences


Set preferences for view to control: v How Management Console groups subscriptions in the Subscriptions view. v If Management Console saves changes to the project layout in the Replication Diagram view. v The number of events Management Console displays in the Event Log view. See also: To set how subscriptions are grouped To save project layouts automatically on page 56 To set the number of events on page 56

To set how subscriptions are grouped


1. Click Edit Preferences. 2. Click Views. 3. Enable one of the following options: v Project v Source Datastore v Target Datastore
Setting preferences in Management Console

55

4. Click Apply.

To save project layouts automatically


1. 2. 3. 4. Click Edit Preferences. Click Views. Enable the Save Project Layouts Automatically check box. Click Apply.

To set the number of events


1. Click Edit Preferences. 2. Click Views. 3. Specify the number of events you want Management Console to fetch in the Number of Events to fetch box. 4. Specify the number of events you want Management Console to display on a page in the Number of Events on a page box. 5. Click Apply.

Setting character encodings


Management Console provides standard character sets and default encodings. You can add character sets and encodings to Management Console that are different from the default encodings. These become available for encoding conversion on the Translations tab in Management Consoles. You can also import and export character sets and encodings if you need share these settings. See also: To add a character encoding To modify a character encoding on page 57 To delete a character encoding on page 57 To import the CSV template on page 57 To export the CSV template on page 57

To add a character encoding


1. Click Edit Encodings. 2. Click Add. 3. In the Character Set box, type a name for the character set or select an existing set. 4. Type the encoding name in the Encoding Name box. 5. Type the supported encoding name in the IBM CCSID box. A Coded Character Set Identifier (CCSID) is a unique 16-bit number identifying a set of encoding scheme identifiers, character set identifiers, code page identifiers, and additional coding-related required information. 6. Type the supported encoding name in the ISO/IANA Name box. This is dependent on database platform. Refer to the Java Supported Encodings Document for a list of supported ISO/IANA encoding names. 7. Choose one of the following from the Character Length box. v Single-byte

56

InfoSphere Change Data Capture Management Console: Administration Guide

v Double-byte v Multi-byte Related concepts Setting character encodings on page 56

To modify a character encoding


1. Click Edit Encodings. 2. Click Modify. 3. In the Character Set box, type a name for the character set or select an existing set. 4. Type the encoding name in the Encoding Name box. 5. Type the supported encoding name in the IBM CCSID box. A Coded Character Set Identifier (CCSID) is a unique 16-bit number identifying a set of encoding scheme identifiers, character set identifiers, code page identifiers, and additional coding-related required information. 6. Type the supported encoding name in the ISO/IANA Name box. This is dependent on database platform. Refer to the Java Supported Encodings Document for a list of supported ISO/IANA encoding names. 7. Choose one of the following from the Character Length box. v Single-byte v Double-byte v Multi-byte Related concepts Setting character encodings on page 56

To delete a character encoding


1. Click Edit Encodings. 2. Select the character set. 3. Click Delete. Related concepts Setting character encodings on page 56

To import the CSV template


1. Click Edit Encodings. 2. Click Import. 3. Type a name for the template in the File Name box. Related concepts Setting character encodings on page 56

To export the CSV template


1. Click Import. 2. Type a name for the template in the File Name box. Related concepts Setting character encodings on page 56

Setting preferences in Management Console

57

58

InfoSphere Change Data Capture Management Console: Administration Guide

Setting up datastores for replication


Datastores are logical entities that represent the data files and processes required to accomplish data replication. Each datastore represents the database to which you want to connect and acts as a container for your tables. Tables made available for replication are contained in a datastore. Depending on the database platform on which you have installed InfoSphere CDC, you can connect to datastores on several different platforms, including Microsoft SQL Server, Oracle, DB2 UDB for iSeries, and JDBC. In this section, you will learn: Connecting to a datastore Shutting down a datastore (InfoSphere CDC for Oracle) on page 60 Updating access parameters for a subscription on page 60 Setting system parameters on source and target datastores on page 60 Creating aliases for a target datastore on a private network connection on page 61

Connecting to a datastore
Before you can connect to a datastore, you must have user access to a datastore. If you do not see a datastore listed, request your system administrator to set access parameters for you in the Access Manager perspective in Management Console. See also: To connect to a datastore

To connect to a datastore
1. Click File Connect to Datastores. 2. Select the datastore. 3. Click Connect. You can set preferences to connect to a datastore automatically, each time you log into Access Server. Notes: v Before you can connect to a datastore in Management Console, your system administrator must have given you user access to that datastore. For more information, see Assigning users to datastores on page 30. v If Management Console cannot establish a connection with a particular datastore, then this datastore is listed with the following icon: . You can view general information about the datastore and possible reasons as to why a connection could not be established in the Datastore Properties dialog box. To view general information, make sure you are in the Datastores view, select the datastore and right-click Properties.

Copyright IBM Corp. 2008

59

Shutting down a datastore (InfoSphere CDC for Oracle)


When you want to end all InfoSphere CDC Access Manager replication processes to perform database or operating system maintenance activities, you must shut down the associated datastore in Management Console. This ends replication on all active subscriptions. See also: To shut down a datastore

To shut down a datastore


1. 2. 3. 4. Click Configuration Datastores. Right-click on a datastore and select Shut down datastore . Click File Access Server. Select Disconnect.

Updating access parameters for a subscription


When configuring a datastore in Access Manager, you must specify the access parameters that InfoSphere CDC uses to connect to the database. Access parameters include information such as a user ID, database name, and password. If at some point you decide to change access parameters for a datastore, then you need to update each subscription that uses this datastore as a target in Management Console. See also: To update access parameters for a subscription

To update access parameters for a subscription


Click Configuration Datastores. Right-click on a datastore and select Properties. Click General. Click Update Related Subscriptions. If there are any active subscriptions, click End Replication on each active subscription. 6. Click Update. 1. 2. 3. 4. 5. Note: After changing the access parameters for a datastore in Access Manager, you must restart Management Console.

Setting system parameters on source and target datastores


You can add, modify, or delete system parameters for datastores. System parameters let you customize the behavior of InfoSphere CDC in your replication environment. You can specify system parameters in Management Console or modify system parameters on the replication servers by performing server-dependent operations. When you change the value of a system parameter for a particular source or target datastore, all users that have access to that datastore can see the change as well.

60

InfoSphere Change Data Capture Management Console: Administration Guide

The default values for most system parameters should be adequate. However, depending on your requirements, you can modify the a system parameter to specify a behavior for InfoSphere CDC that is different than the default. See also: To add a system parameter To modify a system parameter To delete a system parameter

To add a system parameter


1. Click Configuration Datastores. 2. Right-click on a datastore and select Properties. 3. On the System Parameters tab, click Add. 4. Select either Source Parameter or Target Parameter. 5. Type the name of the parameter in the Parameter Name box. 6. Type the value in the Value box. In this section, you will learn: Related concepts Setting system parameters on source and target datastores on page 60

To modify a system parameter


1. Click Configuration Datastores. 2. Right-click on a datastore and select Properties. 3. On the System Parameters tab, select a system parameter. 4. Click Modify. 5. Type a value in the Value box. Related concepts Setting system parameters on source and target datastores on page 60

To delete a system parameter


1. 2. 3. 4. Click Configuration Datastores. Right-click on a datastore and select Properties. On the Source Parameter tab, select a system parameter. Click Delete. Related concepts Setting system parameters on source and target datastores on page 60

Creating aliases for a target datastore on a private network connection


The Access Manager perspective uses the hostname or the IP address you specified to connect to your target datastore. If you want to create a subscription that replicates data to a target datastore on a private network connection, then you need to identify the name your source datastore uses to recognize that target datastore. Depending on your environment, this could be a hostname, IP address, Data Source Name (DSN), etc. You can identify this name by creating an alias in Management Console. The Access Manager perspective uses the alias to connect to the target datastore. For more information on how to set up connection parameters to connect to a datastore, see To set connection parameters on a datastore on page 25.
Setting up datastores for replication

61

See also: To add an alias To modify an alias To delete an alias

To add an alias
1. 2. 3. 4. Click Configuration Datastores. Right-click on a datastore and select Properties. On the Alias tab, click Add. Type a name in the Alias box. Related concepts Creating aliases for a target datastore on a private network connection on page 61

To modify an alias
1. Click Configuration Datastores. 2. Right-click on a datastore and select Properties. 3. On the Alias tab, select an alias. 4. Click Modify. 5. Type a name in the Alias box. Related concepts Creating aliases for a target datastore on a private network connection on page 61

To delete an alias
1. 2. 3. 4. Click Configuration Datastores. Right-click on a datastore and select Properties. On the Alias tab, select an alias. Click Delete. Related concepts Creating aliases for a target datastore on a private network connection on page 61

62

InfoSphere Change Data Capture Management Console: Administration Guide

Upgrading subscriptions
InfoSphere CDC allows you to upgrade your subscriptions from InfoSphere CDC for Microsoft SQL Server version 5.3.4 to version 6.2 by following the upgrade process outlined in this section. Note: Contact IBM support before you begin the upgrade process. The upgrade process may not be automatic if your subscriptions depend on notifications or output from expressions. In this section, you will learn: Upgrading Transformation Server subscriptions from version 5.3.4 to 6.2

Upgrading Transformation Server subscriptions from version 5.3.4 to 6.2


To upgrade subscriptions, you must complete the following tasks: v Upgrade subscriptions by selecting new names, new source IDs, and source and target datastores. Note: Transformation Server for Microsoft SQL Server version 5.3.4 supports multiple databases whereas Transformation Server for Microsoft SQL Server version 6.2 supports a single database. If you are upgrading a subscription that uses two databases, such as database1.user.source_table -> database2.user.target_table, you will have to install Transformation Server for Microsoft SQL Server version 6.2 on database1 and database2 to upgrade the subscription. v Transfer the bookmark from your old subscriptions to the new upgraded subscriptions. Your datastore must support bookmark transfer. After transferring the bookmark, you can also move the bookmark back to the original subscription. v Clear the log position for old subscriptions. This task is optional and will prevent you from resuming replication with these subscriptions. If you want to resume mirroring with the version 5.3.4 subscription after clearing the log position, you must refresh the tables in the subscription. See also: To upgrade a subscription to Transformation Server for Microsoft SQL Server version 6.2 To transfer a bookmark to a new subscription on page 64 To clear the log position for a subscription on page 64

To upgrade a subscription to Transformation Server for Microsoft SQL Server version 6.2
1. Ensure that you have installed Transformation Server for Microsoft SQL Server version 6.2 and created a datastore. The Transformation Server instances and datastores should be associated with the database containing the tables being replicated by Transformation Server for Microsoft SQL Server version 5.3.4. 2. Log into Management Console.
Copyright IBM Corp. 2008

63

3. Connect to the Transformation Server for Microsoft SQL version 5.3.4 datastore. 4. Connect to the Transformation Server for Microsoft SQL Server version 6.2 datastore. 5. Click Configuration Subscriptions. 6. Select one or more subscriptions that use Transformation Server for Microsoft SQL version 5.3.4 as a source or target datastore and click Subscription Upgrade Upgrade Subscription. 7. Click Continue if you want to upgrade your subscriptions without assistance from Product Support. 8. Type a new name for each subscription in the New Name box. 9. Type a new source ID for each subscription in the New Source ID box. 10. Select a new source datastore for each subscription in the Source Datastore box. 11. Select a new target datastore for each subscription in the Target Datastore box. 12. Click OK to upgrade your subscription. After upgrading your subscription, Management Console displays an upgrade report that outlines any issues encountered during the upgrade process to version 6.2 of Transformation Server. To install Transformation Server for Microsoft SQL Server version 6.2, see the Transformation Server for Microsoft SQL Server version 6.2 documentation. Related tasks To log in to Management Console on page 21 To connect to a datastore on page 59

To transfer a bookmark to a new subscription


1. Click Configuration Subscriptions. 2. Click Subscription Upgrade Transfer Bookmark.Management Console displays all subscriptions for which you can transfer the bookmark. 3. Enable the Transfer to New Subscription check box for subscriptions for which you want to transfer the bookmark. 4. To view the upgrade report for the subscription, click View Upgrade Report... . 5. Enable the After transferring bookmark... check box if you want to start mirroring after transferring the bookmark. 6. Click Transfer Bookmark to transfer the bookmark to the specified subscriptions. You can resume mirroring with these subscriptions. After transferring the bookmark, Management Console displays a report that outlines any issues encountered during the bookmark transfer process. Related tasks To upgrade a subscription to Transformation Server for Microsoft SQL Server version 6.2 on page 63 To clear the log position for a subscription

To clear the log position for a subscription


1. Click Configuration Subscriptions. 2. Click Subscriptions Upgrade Clear Log Position.Management Console displays all subscriptions for which you can clear the log position.

64

InfoSphere Change Data Capture Management Console: Administration Guide

3. Enable the Clear Log check box for subscriptions for which you want to clear the log position. 4. Click Clear Log Position to set the replication method for the specified subscriptions to Refresh. You will not be able to resume replication with this subscription. Related tasks To upgrade a subscription to Transformation Server for Microsoft SQL Server version 6.2 on page 63 To transfer a bookmark to a new subscription on page 64

Upgrading subscriptions

65

66

InfoSphere Change Data Capture Management Console: Administration Guide

Managing tables available for replication


You can view the tables that are available for replication, update the definition of the table if you have changed the structure in your database, and remove any tables from Management Console. In this section, you will learn: Updating, removing, and viewing tables for replication

Updating, removing, and viewing tables for replication


Use the Replication Tables dialog box to update the definition of a table that has changed in your database, to view the properties of tables, and to remove tables no longer in use by subscriptions for replication. You make tables available fro replication by selecting tables for a table mapping in the Map Tables wizard. Note: If you have deleted tables from your RDBMS (relational database management system), then you also need to remove the table from the Replication Tables dialog box. See also: To update the definition of a table To remove a table from Management Console To view the properties of a table on page 68

To update the definition of a table


1. 2. 3. 4. Click Configuration Datastores. Select a datastore. Right-click Replication Tables. Expand the database user or schema until you display its tables. Tables are only available if you have created a table mapping in the Map Tables wizard.

5. Select the table that has changed in your relational database management system and click Update. Related concepts Updating, removing, and viewing tables for replication

To remove a table from Management Console


Ensure there are no subscriptions using the tables in replication. Click Configuration Datastores. Select a datastore. Right-click Replication Tables. Expand the database user or schema until you display its tables. Tables are only available if you have created a table mapping in the Map Tables wizard. 6. Select the table and click Remove. 1. 2. 3. 4. 5.

Copyright IBM Corp. 2008

67

Notes: v Before removing the table, you must first search for tables used in the replication by subscriptions, and then delete the table mapping if necessary. v Remove a table only if you have first deleted it from your relational database management system and it is still available for replication in Management Console. Related concepts Searching for tables used in replication on page 86 Updating, removing, and viewing tables for replication on page 67 Related tasks To delete a table mapping on page 140

To view the properties of a table


Click Configuration Datastores. Select a datastore. Right-click Replication Tables. Expand the database user or schema until you display its tables. Tables are only available if you have created a table mapping in the Map Tables wizard. 5. Select the table and click Properties. Related concepts Updating, removing, and viewing tables for replication on page 67 1. 2. 3. 4.

68

InfoSphere Change Data Capture Management Console: Administration Guide

Setting notifications
You can use notifications when you want to be alerted of any problems in your replication environment. Notifications are most useful when performing diagnostic analysis of replication activities in the Management Console and you want to detect events that are happening in your source and target datastores and/or subscriptions.

Setting notifications for datastores and subscriptions


You can set notifications so that they are sent from either a source or target datastore, or set notifications so that they are sent from a subscription. When you set a notification on the datastore, the InfoSphere CDC loads these as default notification settings across all subscriptions that use that datastore. This means that each subscription that uses the datastore for replication inherits the notification settings by default. Setting notifications at the datastore level is useful when you want to set the same notifications for all your datastores regardless of which subscriptions use them. However, if you have a subscription that uses the same datastore in some special way, then you can set the notification at the subscription level. Set notifications from the datastore before setting notifications from each subscription. This is to help you during diagnose and track the location of your notifications.

Filtering notifications
You can filter notifications. When an event occurs in your replication environment, InfoSphere CDC generates messages in the Event Log view. Each message is identified with an event ID. Using the event ID, you can specify the messages for which you want to be notified or those which should be suppressed. For example, if you want to be notified when mirroring fails on a subscription, you can specify the event ID for that message in the Filter Messages dialog box.

Copying notifications
You can copy notification settings to notification categories in the same datastore or subscription. Email notification settings include information such as the name of the person to which you send a notification or the subject line of an email. You can copy this information to other notification categories in the same datastore. For example, you may have already set an email notification that gets sent to jane@datamirror.com when the datastore DM0001@50000 on the source-side detects a fatal communications error on the network. You may have set other notifications that get sent in different events, but want all those notifications sent to the same account. Instead of having to manually specify that jane@datamirror.com receive all notifications detected from DM0001@50000 in each notification, you can copy this setting to other notification categories. Before you setup an email notification for MAPI, you should read the considerations outlined for these protocols in your InfoSphere CDC for Microsoft SQL Server documentation.

Copyright IBM Corp. 2008

69

Setting latency thresholds and notifications


You can also set latency notifications that alert you when InfoSphere CDC has passed your warning or problem thresholds. You must specify a threshold before you can set up a notification. In this section, you will learn: Selecting a notification handler Choosing a notification category and a message type on page 71 Setting notifications for a datastore on page 72 Setting notifications for a subscription on page 77 Copying notifications for a subscription on page 78 Setting latency thresholds and notifications on page 78

Selecting a notification handler


Before setting up a notification, you need to decide on the kind of notification handler you want to use to receive notifications. Notification handlers specify how you want a certain notification to be handled. You can set a notification so that it is handled through email, message queues, or user exits. For example, you may want to send messages to an email address, relay a message to a message queue, or you may prefer to set up a user exit that triggers certain operations upon specific InfoSphere CDC events. Depending on the InfoSphere CDC product you have installed, you can select certain notification handlers in the Notifications dialog box: v Message QueueYou can indicate that you want to relay a message to a specified message queue when a certain type of message is generated. You have the option of relaying that message to up to ten different message queues. To specify a message queue, you need to specify both the name of the message queue and the library where it resides. v User Exit/User HandlerYou can indicate that you want to launch a user exit program when a certain type of message is generated. Note that you are responsible for creating the user exit program and ensuring that it works properly. For more information about creating user exit programs for alerts and alarms, see the appropriate InfoSphere CDC End-User Documentation. v EmailYou can indicate that you want to send the generated message to an email address. Depending on the type of datastore, SMTP (Simple Mail Transfer Protocol) and MAPI (Messaging Application Program Interface) can be used for sending email messages. Unless explicitly stated, each setting described below applies to both SMTP and MAPI. v SNMP (Simple Network Management Protocol)You can indicate that you want to send a trap containing the generated message to an SNMP management system. v Event LogYou can indicate that you want to send the generated message to the Windows application log. v TSDPRINTYou can indicate that you want to send the generated message to the TSDPRINT spool file provided with InfoSphere CDC for z/OS.

70

InfoSphere Change Data Capture Management Console: Administration Guide

SYSLOG
v DB2 UDB for z/OSYou can indicate that you want to send the generated message to the operator system log maintained on zSeries servers. For more information about the operator system log, see the InfoSphere CDC for z/OS End-User Documentation. v Oracle (on UNIX servers only)You can indicate that you want to send a generated message to the UNIX syslogd program that logs messages from external applications like InfoSphere CDC Related concepts Setting notifications for a datastore on page 72 Setting notifications for a subscription on page 77

Choosing a notification category and a message type


When setting up a notification, you must select a notification category and a notification message type.

Notification categories
Notification categories represent the events that InfoSphere CDC detects in your source and/or target datastores. v Scrape/Refresh Events (Source)categorizes notifications that are generated for events that occur when InfoSphere CDC scrapes or refreshes data from your source datastore. v Apply Events (Target)InfoSphere CDC generates notifications related to events that occur during the target apply process. For example, InfoSphere CDC can generate a message when there is failure to apply on the target table. v Communications Eventscategorizes notifications that are generated for communication events that can occur between source and the target datastores. For example, InfoSphere CDC can generate a message when there is a failure to create TCP/IP socket. v Environment Eventscategorizes notifications that are generated when requirements for a basic replication environment are not met. For example, InfoSphere CDC can generate a message when it cannot connect to a database, or when permissions have not been set. v Journal/Log Maintenance Eventscategorizes notifications that are generated when InfoSphere CDC reads the journal or during log maintenance.

Notification message type


v Fatal Messagesenables you to setup a notification for fatal messages. For example, InfoSphere CDC v Error Messagesenables you to setup a notification for error messages. InfoSphere CDC sends a notification when it encounters an error. For example, InfoSphere CDC can generate an error message in the Event Log view when it inserts a row and creates a duplicate key, or when it encounters a runtime verification error on a derived expression. v Informational Messagesenables you to setup a notification for informational messages. InfoSphere CDC sends a notification when it encounters an event that you need to know about. For example, InfoSphere CDC can generate informational messages in the Event Log view when it is ready to mirror tables, or when it encounters instances that require code page conversions.

Setting notifications

71

v Status Messagesenables you to setup a notification for status messages. InfoSphere CDC sends a notification when it encounters a specific event during replication. For example, InfoSphere CDC can generate status messages in the Event Log view when it is going to refresh a table, when it cannot journal changes on a table, or when it has parked a table for replication. v Operational Messagesenables you to setup a notification for operational messages. InfoSphere CDC sends a notification when it has completed an operation during replication. For example, InfoSphere CDC can generate operational messages in the Event Log view after applying an operation to the target table, or when it has completed a refresh on a table. Related concepts Setting notifications for a datastore Setting notifications for a subscription on page 77

Setting notifications for a datastore


Use the Source tab or the Target tab in the Notifications dialog box to set up a notification. InfoSphere CDC can generate messages for events that occur on either your source or target datastore. See also: To set To set To set To set To To To To To To To To

an an an an

email email email email

(MAPI) notification (SMTP) notification on page 73 notification on page 73 notification on page 74

set a notification for the TSDPRINT spool file on page 74 set a notification for an operator system log on page 74 set a notification for a UNIX system log on page 75 set a notification using a user exit program on page 75 set a notification using a user exit program on page 75 set a notification using a user exit program on page 76 set a notification for a message queue on page 76 filter a notification message on page 77

To copy notification settings on page 77

To set an email (MAPI) notification


Note: This information is applicable to InfoSphere CDC for Microsoft SQL Server version 5.3. 1. Click Configuration Datastores. 2. Right-click on a datastore and select Notification. 3. Depending on whether you want InfoSphere CDC to detect events on the source datastore or on the target datastore, click the Source tab or the Target tab. 4. Select a category from Notification Categories. 5. Select Email (MAPI). 6. Type the email address in the Alert Account box. Use a semi-colon to separate multiple email addresses or specify a distribution list from your email application. 7. Type the subject in theSubject box.

72

InfoSphere Change Data Capture Management Console: Administration Guide

8. Type the name of the mail profile you created to identify the mailbox of the specific domain user in theProfile box. The subject and profile name cannot exceed 254 characters. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70

To set an email (SMTP) notification


Note: This information is applicable to InfoSphere CDC for Microsoft SQL Server version 5.3. 1. Click Configuration Datastores. 2. Right-click on a datastore and select Notification. 3. Depending on whether you want InfoSphere CDC to detect events on the source datastore or on the target datastore, click the Source tab or the Target tab. 4. Select a category from Notification Categories. 5. Select Email (SMTP). 6. Type the email address that will receive the email in the Alert Account box. Use a semi-colon to separate multiple email addresses or specify a distribution list from your email application. 7. Type the host name of your outgoing mail server in the SMTP Mail Host box. 8. Type the email address that will send the generated messaged in the Sender Account box. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70

To set an email notification


Note: This information is applicable to InfoSphere CDC for Oracle. 1. Click Configuration Datastores. 2. Right-click on a datastore and select Notification. 3. Depending on whether you want InfoSphere CDC to detect events on the source datastore or on the target datastore, click the Source tab or the Target tab. 4. Select a category from Notification Categories. 5. Select the Email box. 6. Type the email address in the Address box. Use a semi-colon to separate multiple email addresses or specify a distribution list from your email application. 7. Type the subject in the Subject box. The subject cannot exceed 254 characters. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70

Setting notifications

73

To set an email notification


Note: This information is applicable to InfoSphere CDC for DB2 UDB, InfoSphere CDC for Microsoft SQL Server version 6.0, InfoSphere CDC for PointBase, and InfoSphere CDC for Teradata. 1. Click Configuration Datastores. 2. Right-click on a datastore and select Notification. 3. Depending on whether you want InfoSphere CDC to detect events on the source datastore or on the target datastore, click the Source tab or the Target tab. 4. Select a category from Notification Categories. 5. Select the Internet Mail box. 6. Type the host name of your outgoing mail server in the SMTP Mail Host box. 7. Type the email address in the Alert Account box. Use a semi-colon to separate multiple email addresses or specify a distribution list from your email application. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70

To set a notification for the TSDPRINT spool file


Note: This information is applicable to InfoSphere CDC for z/OS. 1. Click Configuration Datastores. 2. Right-click on a datastore and select Notification. 3. Depending on whether you want InfoSphere CDC to detect events on the source datastore or on the target datastore, click the Source tab or the Target tab. 4. Select a category from Notification Categories. 5. Select the TSDPRINT box. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70

To set a notification for an operator system log


Note: This information is applicable to InfoSphere CDC for z/OS. 1. Click Configuration Datastores. 2. Right-click on a datastore and select Notification. 3. Depending on whether you want InfoSphere CDC to detect events on the source datastore or on the target datastore, click the Source tab or the Target tab. 4. Select a category from Notification Categories. 5. Select the SYSLOG box. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70

74

InfoSphere Change Data Capture Management Console: Administration Guide

To set a notification for a UNIX system log


Note: This information is applicable to InfoSphere CDC for Oracle. 1. Click Configuration Datastores. 2. Right-click on a datastore and select Notification. 3. Depending on whether you want InfoSphere CDC to detect events on the source datastore or on the target datastore, click the Source tab or the Target tab. 4. Select a category from Notification Categories. 5. Select the Syslog box. 6. Type the number of the log channel in the Facilities box. Routes messages to the location specified in the configuration file (/etc/syslog.conf). The number must be between 0 and 7 and it corresponds to the number specified in the configuration file. 7. Type a string in the ID box. Appends to all messages routed through the log channel. You can attach an identifier for each message. Note: This program supports up to eight log channels and identifies different locations where you can place messages. You can configure log channels using a predefined configuration file (/etc/syslog.conf). You should contact your UNIX system administrator to find out how many log channels are configured in your environment. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70

To set a notification using a user exit program


Note: This information is applicable to InfoSphere CDC for z/OS. 1. Click Configuration Datastores. 2. Right-click on a datastore and select Notification. 3. Depending on whether you want InfoSphere CDC to detect events on the source datastore or on the target datastore, click the Source tab or the Target tab. 4. Select a category from Notification Categories. 5. Select the User Exit box. 6. Type the name of the module in the box. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70

To set a notification using a user exit program


Note: This information is applicable to InfoSphere CDC for AS/400. 1. Click Configuration Datastores. 2. Right-click on a datastore and select Notification.

Setting notifications

75

3. Depending on whether you want InfoSphere CDC to detect events on the source datastore or on the target datastore, click the Source tab or the Target tab. 4. Select a category from Notification Categories. 5. Select the User Exit box. 6. Type the name of the user exit program in the Program box. 7. Type the name of the library in the Library box. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70

To set a notification using a user exit program


Note: This information is applicable to InfoSphere CDC for DB2 UDB, InfoSphere CDC for Microsoft SQL Server version 6.0, InfoSphere CDC for PointBase, and InfoSphere CDC for Teradata. 1. Click Configuration Datastores. 2. Right-click on a datastore and select Notification. 3. Depending on whether you want InfoSphere CDC to detect events on the source datastore or on the target datastore, click the Source tab or the Target tab. 4. Select a category from Notification Categories. 5. Select the User Handler box. 6. Type the fully qualified Java class name of the user exit program in the Java Class Name box. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70

To set a notification for a message queue


Note: This information is applicable to InfoSphere CDC for AS/400. 1. Click Configuration Datastores. 2. Right-click on a datastore and select Notification. 3. Depending on whether you want InfoSphere CDC to detect events on the source datastore or on the target datastore, click the Source tab or the Target tab. 4. 5. 6. 7. Select a category from Notification Categories. Select the Message Queue box. Type the name of the message queue in the Queue box. Type the name of the library in the Library box.

Note: You can relay the same message up to 10 message queues. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70

76

InfoSphere Change Data Capture Management Console: Administration Guide

To filter a notification message


1. 2. 3. 4. 5. Click Configuration Datastores. Right-click on a datastore and select Notification. Click Filter Messages. Type the event ID in the box. Select one of the following: v Do not send these messagesDoes not send the specified messages. v Send these messages onlySends the specified messages. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70

To copy notification settings


1. 2. 3. 4. 5. 6. Click Configuration Datastores. Right-click on a datastore and select Notification. ClickSource or Target. Select the notification setting. ClickCopy Settings. Clear the boxes for the notifications that you do not want to copy. If you want to copy all notification settings, click OK. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70

Setting notifications for a subscription


If you want to send a notification only when a datastore is used by a subscription, then you can set notifications at the subscription level. Before setting a notification for a subscription, you should do the following: v View any default notifications that were set at the datastore level for the subscription. v Decide what kind of events you want to be notified about in your replication environment. When setting notifications you must first identify the category of the message you want to set, and then decide on a severity level. See also: To set notifications for a subscription To view the datastore default notifications for a subscription on page 78

To set notifications for a subscription


1. 2. 3. 4. 5. 6. Click Configuration Subscriptions. Right-click on a datastore and select Notification. Click the Source tab or the Target tab. Select a category from Notification Categories. Clear any default notifications settings to enable the Notification Settings area. Specify how you want to send this notification in the Notification Settings area.
Setting notifications

77

Depending on the InfoSphere CDC product you have installed, you can send this notification through email message queues, or a user exit program. Related concepts Setting notifications for a subscription on page 77

To view the datastore default notifications for a subscription


1. Click Configuration Subscriptions. 2. Right-click on a datastore and select Notification. 3. Depending on whether you want InfoSphere CDC to detect events on the source datastore or on the target datastore, click the Source tab or the Target tab. 4. ClickDatastore Defaults. The Notifications dialog box opens and displays the default notifications that were set for the datastore. Related concepts Setting notifications for a subscription on page 77

Copying notifications for a subscription


You can copy notification settings from one category to another in the same subscription. For example, email notification settings include information such as the name of the person to which you send a notification, or you can copy the subject line of an email between different notification categories on a subscription. See also: To copy notification settings on page 77

To copy notification settings


1. 2. 3. 4. 5. 6. Click Configuration Datastores. Right-click on a datastore and select Notification. ClickSource or Target. Select the notification setting. ClickCopy Settings. Clear the boxes for the notifications that you do not want to copy. If you want to copy all notification settings, click OK. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70

Setting latency thresholds and notifications


You can set a notification that specifies the latency (in minutes) of a subscription. This notification specifies how long it takesInfoSphere CDC to apply data to the target datastore. You must set latency thresholds before you can set a notification. When you set a notification,InfoSphere CDC sends you a notification after the following events: v Normallatency for the journal or log is below the warning threshold. This means that latency is acceptable and within your normal range. Latency is normal according to the latency thresholds you have set for the subscription.

78

InfoSphere Change Data Capture Management Console: Administration Guide

v Warninglatency for the journal or log is above the warning threshold but below the problem threshold. Latency is starting to become a problem according to the latency thresholds you have set for the subscription. v Problemlatency for the journal or log is above the problem threshold. Latency is now a problem according to the latency thresholds you have set for the subscription. See also: To set a latency threshold and notification

To set a latency threshold and notification


1. 2. 3. 4. Click Configuration Subscriptions. Right-click on a subscription and select Latency Thresholds. Enable the Notify when latency crosses these thresholds check box. Specify a warning threshold (in minutes).

5. Specify a problem threshold (in minutes). The problem threshold must be greater than the warning threshold. 6. ClickSet Notification. 7. As a best practice, ensure that Target Apply Informational is enabled. You must configure at least one notification setting in the Informational category so that you can receive notification messages and this must be set on the Target tab. These changes will take effect the next time you start replication on this subscription. 8. Specify how you want to send this notification in the Notification Settings area. Depending on the InfoSphere CDC product you have installed, you can send this notification through email message queues, or a user exit program. In this section, you will learn: Related concepts Setting latency thresholds and notifications on page 78 Profiling the latency and throughput performance of your subscription on page 235

Setting notifications

79

80

InfoSphere Change Data Capture Management Console: Administration Guide

Setting up and managing subscriptions


A subscription is a connection that is required to replicate data between a source datastore and a target datastore. It contains details of the data that is being replicated and how the source data is applied to the target. Subscriptions use datastores as the source or target of replicated data. You can view the datastores that your subscriptions are using in the Source and Target columns of the Subscriptions view. In this section, you will learn: Using projects to organize your subscriptions Exporting and importing projects on page 82 Setting up subscriptions on page 83 Specifying advanced settings for a subscription on page 84 Searching for tables used in replication on page 86 Setting up subscriptions for datastores outside of your organization on page 86 Copying subscriptions on page 88 Setting properties for a subscription that targets IBM WebSphere DataStage on page 89 Generating a WebSphere DataStage definition file for a subscription on page 90

Using projects to organize your subscriptions


Projects let you group your subscriptions into categories to reflect your organizational or operational needs. Organizational Approach for ProjectsThe organizational approach is useful if you want to group your subscriptions according to their current state of development. In many working environments, organizations prefer to test a InfoSphere CDC replication configuration before promoting the configuration to a production environment. If you have subscriptions that are still in development, others that are being tested, and some that have been promoted to production, you may want to group your subscriptions in projects according to their current development state. For example, you can use Test, Development, and Production for project names. As you finish development or testing of a subscription, you can then move the subscription to the appropriate project. Operational Approach for ProjectsThe operational approach is useful if you are creating subscriptions that relate to particular departments or operations within your organization. For example, you may have subscriptions that relate to human resources, finance, or sales. In this case, you may want to organize your subscriptions into projects that reflect these particular operations or departments. See also: To add a new project on page 82 To rename a project on page 82
Copyright IBM Corp. 2008

81

To delete a project

To add a new project


1. Click Configuration Subscriptions. 2. Right-click in the Subscriptions view and select Project Add New Project. 3. Enter a unique name for your project. Related concepts Using projects to organize your subscriptions on page 81 Related tasks To rename a project To delete a project

To rename a project
1. Click Configuration Subscriptions. 2. Right-click on a project and select Project Rename Project. 3. Enter a new name for your project. Related concepts Using projects to organize your subscriptions on page 81 Related tasks To add a new project To delete a project

To delete a project
1. Click Configuration Subscriptions. 2. Right-click on a project and select Project Delete Project. Management Console will delete the project and move all subscriptions to your Default project. Related concepts Using projects to organize your subscriptions on page 81 Related tasks To rename a project To add a new project

Exporting and importing projects


Every user of Management Console will have a different approach to organizing their projects and subscriptions. To share your project organization with other users, you can export your projects to a CSV template on your local computer. Other users can then import the CSV template into Management Console. See also: To export projects To import projects on page 83

To export projects
1. Click Configuration Subscriptions. 2. Right-click on a project and select Project Export Projects.

82

InfoSphere Change Data Capture Management Console: Administration Guide

3. Type a name for the template in the File Name box. 4. Click Save. Related concepts Exporting and importing projects on page 82 Related tasks To import projects

To import projects
1. Click Configuration Subscriptions. 2. Right-click on a project and select Project Import Projects. Existing projects will be deleted during project import. 3. Select the CSV template that you want to import into Management Console and click Open. You will have to restart Management Console or reconnect to Access Server to see the changes. Related concepts Exporting and importing projects on page 82 Related tasks To export projects on page 82

Setting up subscriptions
Before you can start replicating data, you need to add a subscription. When adding a new subscription, you can organize your subscription into a project, select the datastores you want to use as the source and target of data during replication activities, and specify optional communication settings. How you decide to set up the datastores in your subscriptions depends on your replication requirements. See also: To add a subscription To modify a subscription on page 84 To delete a subscription on page 84

To add a subscription
1. 2. 3. 4. 5. Click Configuration Subscriptions. Right-click on a project and select New Subscription. Type the name of the subscription in the Name box. Type the description of the subscription in the Description box. From the Project list, select an existing project or click New Project to create a new project.

6. Select the source datastore from the Source list. 7. Select the target datastore from the Target list. Notes: v If you want to replicate data to a target datastore using a host name that differs from the one used in Management Console, then click Details and select the alias you created for the host name. v If you want this subscription to send data to an external target, then select External and click Details to configure an external target datastore.
Setting up and managing subscriptions

83

v By default, each new subscription you create is assigned a unique source ID in Management Console. If the subscription is sending data to an external target, you can specify a source ID that makes the subscription identifiable for the receiving organization. Click Advanced Settings. Related concepts Setting up subscriptions on page 83 Setting up subscriptions for datastores outside of your organization on page 86 Creating aliases for a target datastore on a private network connection on page 61

To modify a subscription
1. Click Configuration Subscriptions. 2. Right-click on a subscription and select Properties. 3. You can modify the following: v DescriptionType the description of the subscription. v ProjectSelect a project or click New Project to create a new project. Note: If you want to replicate data to a target datastore using a host name that differs from the one used in Management Console, then click Details and select the alias you created for the host name. Related concepts Setting up subscriptions on page 83 Setting up subscriptions for datastores outside of your organization on page 86 Creating aliases for a target datastore on a private network connection on page 61

To delete a subscription
1. Click Configuration Subscriptions. 2. Right-click on a subscription and select Delete subscription. You cannot delete a subscription when: v Your subscription is active. Before deleting a subscription, you must end replication. v You are using InfoSphere CDC Version 5.2 and have a subscription with an external target datastore. You must remove the table mappings for the subscription before you can delete the subscription. v Your subscription is not connected to the target datastore. You must connect to the target datastore before you can delete the subscription. Related tasks To end replication on page 199 To delete a table mapping on page 140 To connect to a datastore on page 59

Specifying advanced settings for a subscription


You can set communication settings for your subscription.

84

InfoSphere Change Data Capture Management Console: Administration Guide

v Firewall Portif the source and target datastores have a limited number of ports for communication through a firewall, you may need to specify a firewall port for your subscription. v TCP Hostspecifies the TCP host that your source datastore will use to recognize the target datastore when the computer where InfoSphere CDC is installed has multiple network cards. This is useful if you want to specify a host that is different from the host that you specified in InfoSphere CDC Access Manager. v Propagation Controlyou can use propagation control to prevent the replication of data from a particular source. This is useful if you are using a hub-and-spoke replication configuration and prevents subscriptions from unnecessarily repeating operations like inserting data. See also: To specify a TCP host for a subscription To specify a firewall port for a subscription To set propagation control on a subscription

To specify a TCP host for a subscription


1. 2. 3. 4. Click Configuration Subscriptions. Right-click on a subscription and select Properties. Click Advanced Settings. Type the TCP host name for the subscription in the TCP Host box. Your source datastore will use this name to recognize the target database when the computer where InfoSphere CDC is installed has multiple network cards. This is useful if you want to specify a host that you specified in the Access Manager perspective. The default option is Auto-select which will automatically select the network card that can communicate with the target datastore. The host that you specified in the Access Manager perspective also appears by default as well as any aliases that you configured in the Datastore Properties dialog box. Related concepts Specifying advanced settings for a subscription on page 84 Creating aliases for a target datastore on a private network connection on page 61

To specify a firewall port for a subscription


1. 2. 3. 4. Click Configuration Subscriptions. Right-click on a subscription and select Properties. Click Advanced Settings. Type a port number in the Firewall Port box. InfoSphere CDC requires that the source datastore can connect to the target datastore using the firewall port and the next three ports. For example, if you enter port 2000 in this field, then ports 2000, 2001, 2002, and 2003 must all be accessible through the firewall. Related concepts Specifying advanced settings for a subscription on page 84

To set propagation control on a subscription


1. Click Configuration Subscriptions. 2. Right-click on a subscription and select Properties.
Setting up and managing subscriptions

85

3. Click Advanced Settings. 4. From the Propagation Control area, click Add to select the source ID of the subscription from which you want to prevent data from being replicated to the target. 5. Select the Do not replicate data received from any subscriptions box if you want to prevent data from being replicated to the target for all subscriptions. Related concepts Specifying advanced settings for a subscription on page 84

Searching for tables used in replication


In order to make tables available for replication, you must create a subscription and associate a source and target datastore. These datastores contain the tables you want to use in replication. You may have more than one subscription using the same table in replication. When you want to make the table unavailable from replication, it becomes important to search for the table and identify which subscriptions are using it replication activities. See also: To search for subscriptions that use a table in replication

To search for subscriptions that use a table in replication


1. Click Configuration Datastores. 2. Select a datastore. 3. Expand the source tables tree until you display the tables in the Source Tables area. 4. Right-click on a table and select Table Properties. 5. Click Search on the Subscriptions tab. 6. Identify the subscription from the following: v SubscriptionThe name of the subscription that uses the selected table. v Used AsIdentifies whether the table is used as source or target. v Replication MethodThe replication method for the selected table. v Table StatusIdentifies if the selected table has been refreshed, mirrored, or parked.

Setting up subscriptions for datastores outside of your organization


You can add subscriptions that send data to a target datastore that is external to your organization. In order to set up a subscription that sends data to an external target datastore, the receiving organization must have installed InfoSphere CDC Management Console and you need to find out the necessary authentication and database details to connect to their target datastore. External target datastores are not available in your Access Manager because they reside outside of your organization or department, or your system administrator has not given you the permission to access it. If you have received authorization from the company or organization to which you are replicating data, then you can modify the properties of an external target datastore, including the port number, owner, and password. System and database information about external target datastores is provided by the organization or department that owns that datastore.

86

InfoSphere Change Data Capture Management Console: Administration Guide

You can also copy subscriptions that send data to an external target. This is a time-saving mechanism. If your organization is at the receiving end of replication activities co-ordinated with another organization that is outside of your database security policy, then you should seeUnknown source datastores in your subscription list. This is because you are receiving replicated data from a source datastore that is outside of your security policy (and, therefore, to which you do not have access to) and the name of the source datastore is not known to you. See also: To add a subscription for an external target datastore To modify a subscription for an external target datastore

To add a subscription for an external target datastore


1. Click Configuration Subscriptions. 2. Right-click on a subscription and select New Subscription. 3. 4. 5. 6. 7. Select <External> from the Target list and click Details. Select the operating system from the Platform list. Type the host name or IP address of the external target in the Host Name box. Type the port number for the external target in the Target Port box. Select the type of database for your external target that holds the InfoSphere CDC metadata from the Database Type list.

InfoSphere CDC creates the metadata tables when you install InfoSphere CDC. For more information, see the appropriate InfoSphere CDC End-User Documentation. 8. Type the name of the metadata database in the Database Name box. 9. Type the name of the database user that owns the external target metadata in the Owner box. 10. Type the password for the database user in the Password box. Note: This information is provided by the organization or department that owns the external target datastore. Related concepts Setting up subscriptions for datastores outside of your organization on page 86 Related tasks To modify a subscription for an external target datastore

To modify a subscription for an external target datastore


1. Click Configuration Subscriptions. 2. Right-click on a subscription with an external target datastore and selectProperties. 3. Click Details and make the necessary changes. Note: This information is provided by the organization or department that owns the external target datastore. Related concepts Setting up subscriptions for datastores outside of your organization on page 86
Setting up and managing subscriptions

87

Related tasks To add a subscription for an external target datastore on page 87

Copying subscriptions
Copying a subscription is a time-saving mechanism. If you have a subscription that contains table mappings that you do not want to recreate, then you can copy the subscription under a new name. You can also recreate an existing subscription with the same table mappings if you want to setup a replication scenario within in another environment. See also: To a copy subscription To copy a subscription for an external target datastore

To a copy subscription
Click Configuration Subscriptions. Right-click on a subscription and select Copy Subscription. Type a name for the subscription in the Name box. Type a description for the subscription in the Description box. Select an existing project for the subscription from the Project list or click New Project to organize the subscription into a new project. 6. If you want to specify advanced settings, click Advanced Settings. 1. 2. 3. 4. 5. 7. Click Next. 8. Select the source datastore for the new subscription from the New Source Datastore list. 9. Select the databases and/or owners for the new source datastore under New Name and click Next. 10. Select the target datastore for the new subscription from theNew Target Datastore list. 11. Select the databases and owners for the new target datastore underNew Name and click Next. 12. If the existing subscription contains user exits, then specify their location for the new subscription under New Location and click Next. 13. If you built a derived column, an expression, or a row-filtering expression that uses the %SELECT column function, then confirm the list of displayed expressions and click Next. After copying the subscription, you may have to change these expressions manually. 14. Review the list of changes and click Finish. Related concepts Copying subscriptions Related reference Retrieve column%SELECT on page 293

To copy a subscription for an external target datastore


1. Click Configuration Subscriptions. 2. Right-click on a subscription and select Copy Subscription. 3. Type the name of the new subscription in the Name box.

88

InfoSphere Change Data Capture Management Console: Administration Guide

4. Type the description of the new subscription in the Description box. 5. Select a project for the new subscription from the Project list or click New Project to create a new project. 6. If you want to specify advanced settings, click Advanced Settings. 7. Click Next. 8. Select the new source datastore for the subscription from the New Source Datastore list. 9. Select the databases and owners for your new source datastore under New Name. 10. Click Next. 11. If you want to change the properties of the external target datastore, then make the necessary changes and click Next. Note: This information is provided by the organization or department that owns the external target datastore. 12. Review the list of changes and click Finish. Related concepts Copying subscriptions on page 88

Setting properties for a subscription that targets IBM WebSphere DataStage


After creating a subscription that uses InfoSphere CDC for WebSphere DataStage as a target datastore, you can modify the following subscription properties: v Batch size thresholds that control how often subscription data is sent to WebSphere DataStage. v Large object truncation size for character and binary data. See also: To specify batch size thresholds for a WebSphere DataStage subscription To specify large object truncation size for a WebSphere DataStage subscription on page 90 Related concepts WebSphere DataStage system parameters on page 499 Using InfoSphere CDC with IBM WebSphere DataStage on page 241

To specify batch size thresholds for a WebSphere DataStage subscription


1. Click Configuration Subscriptions. 2. Right-click on a subscription and select WebSphere DataStage Properties. 3. In the Number of rows box, type the number of rows that can be changed before subscription data is sent to WebSphere DataStage. The default value is 100000. 4. In the Time (seconds) box, type the amount of time that will elapse before subscription data is sent to WebSphere DataStage. The default value is 600. The values that you specify are used by InfoSphere CDC to determine when a flat file is complete and is made available to WebSphere DataStage for processing. 5. Click OK.
Setting up and managing subscriptions

89

To specify large object truncation size for a WebSphere DataStage subscription


1. Click Configuration Subscriptions. 2. Right-click on a subscription and select WebSphere DataStage Properties. 3. In the Character data (# characters) box, type the truncation point for large character data. The default value is 8000. 4. In the Binary data (# bytes) box, type the truncation point for large binary data. The default value is 8000. 5. Click OK.

Generating a WebSphere DataStage definition file for a subscription


After mapping your tables to WebSphere DataStage, you can generate a definition file (*.dsx) that creates a job sequence and two utility routines in WebSphere DataStage. You can import this file into IBM WebSphere DataStage Designer and then customize it to meet your business requirements. See also: To generate a WebSphere DataStage definition file Related concepts Using InfoSphere CDC with IBM WebSphere DataStage on page 241 Setting properties for a subscription that targets IBM WebSphere DataStage on page 89

To generate a WebSphere DataStage definition file


1. Click Configuration Subscriptions. 2. Right-click on a subscription and select Generate WebSphere DataStage Definition . 3. Select the location for your DSX file (*.dsx) and click Save. After generating the DSX file you can import it into WebSphere DataStage Designer. For more information on how to do this, see your IBM WebSphere DataStage documentation.

90

InfoSphere Change Data Capture Management Console: Administration Guide

Mapping tables
After defining a subscription in Management Console, use the Map Tables wizard to map source and target tables. Subscriptions can contain as many table mappings as necessary. The number of table mappings you create depends on how many source tables you want InfoSphere CDC to replicate to the target system. In this section, you will learn: Mapping using standard replication Mapping using LiveAudit on page 100 Mapping using WebSphere DataStage on page 106 Mapping using Adaptive Apply on page 110 Mapping to summarize data on page 113 Mapping to consolidate data (one-to-one) on page 117 Mapping to consolidate data (one-to-many) on page 121 Mapping to a datastore outside of your organization on page 126 Mapping to a JMS message destination using InfoSphere CDC Event Server on page 127

Mapping using standard replication


If you want your target table to keep an updated image of the data contained in the source table, then map your source and target tables using standard replication. Your source and target tables can be of different types and you can transform the data that you replicate between the source and the target. Under standard replication, InfoSphere CDC applies the same operation that occurred on the source table to the target table. A row insert operation on the source table determines a row insert operation on the target table, and so on. You can map tables one at a time using standard replication. Management Console provides two mechanisms for mapping using standard replication. v One-to-onemap tables using one-to-one replication when you want to map multiple source tables to multiple target tables at a time and these tables share the same table structure and similar table names. The Map Tables wizard automatically maps tables based on an example mapping you set up. v Standardmap tables using standard replication when you want to map only one source table to one target table at a time. These are tables that do not share the same table structure or similar table names. See also: To map similar source tables to similar target tables (One-to-One) on page 92 To map a custom source table to a custom target table (standard) on page 93 To map multi-member source tables on AS/400 (standard) on page 95 To map multi-member source tables to existing target tables on AS/400 (one-to-one) on page 97 To map multi-member source tables to new tables on AS/400 (one-to-one) on page 99
Copyright IBM Corp. 2008

91

To map similar source tables to similar target tables (One-to-One)


Click Configuration Subscriptions. Select a subscription, right-click and select Map Tables. Enable One-to-One mapping and click Next. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 5. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 1. 2. 3. 4. 6. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 7. If you want to modify this filter, select a database user or schema and click Specify Filter. 8. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 9. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 10. Click Next. 11. Enable Map to existing target tables and click Next. If you want to map to a new target table, click Create new target tables. 12. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 13. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. The wizard uses the relationship between this target table and the selected source table to map the remaining source and target tables. You can click Change Example Table if you want the Map Tables wizard to base the mapping on a different source table. This option is only available if you have selected more than one source table. 14. Select a table from the Target Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 15. Click Next.

92

InfoSphere Change Data Capture Management Console: Administration Guide

16. Verify the mappings in the Complete Mappings page. The Map Tables wizard may leave some source tables unmapped if it did not find a target table that shared the same table structure or similar column names. You must map these manually. 17. Click Next. 18. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. 19. If you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then enable one of the following: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC Event Server creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table. 20. If you are using InfoSphere CDC for Microsoft SQL Server 5.3 to replicate source database changes and have configured bidirectional replication, then enable the Prevent Recursion check box. This prevents InfoSphere CDC Event Server from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM technical support to implement bidirectional replication in your environment. 21. Click Next. 22. Review the mapping summary and click Finish. Related tasks To map a custom source table to a custom target table (standard) To map multi-member source tables on AS/400 (standard) on page 95 To map multi-member source tables to existing target tables on AS/400 (one-to-one) on page 97 To map multi-member source tables to new tables on AS/400 (one-to-one) on page 99

To map a custom source table to a custom target table (standard)


1. Click Configuration Subscriptions. 2. Select a subscription, right-click and select Map Tables. 3. Enable One table mapping of any type.
Mapping tables

93

4. Select Standard from the Mapping type list and clickNext. 5. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 6. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 7. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 8. If you want to modify this filter, select a database user or schema and click Specify Filter. 9. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 10. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 11. Click Next. 12. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 13. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 14. Select a table from the Target Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to map to a new target table, click Create Table. 15. Choose one of the following and click Next: v Use an Indexselect the index name from the Index box. Use if your target table has an index that uniquely identifies a row. v Specify the keyselect the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. v Use all searchable columnssearches all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Availability of the above options is dependent on the platform and version of InfoSphere CDC Event Server that you have installed. 16. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and

94

InfoSphere Change Data Capture Management Console: Administration Guide

replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. 17. If you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then enable one of the following: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC Event Server creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table. 18. If you are using InfoSphere CDC for Microsoft SQL Server 5.3 to replicate source database changes and have configured bidirectional replication, then enable the Prevent Recursion check box. This prevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM technical support to implement bidirectional replication in your environment. 19. Click Next. 20. Review the mapping summary. 21. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping using standard replication on page 91 Setting member identifiers for multi-member source tables on page 187

To map multi-member source tables on AS/400 (standard)


Click Configuration Subscriptions. Select a subscription, right-click and select Map Tables. Enable One table mapping of any type. Select Standard from the Mapping type list and clickNext. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 6. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 1. 2. 3. 4. 5.
Mapping tables

95

7. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 8. If you want to modify this filter, select a database user or schema and click Specify Filter. 9. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 10. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 11. Click Next. 12. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 13. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 14. Select a table from the Target Tables list. If you do not see your table listed, select the database user or schema and click Refresh. Choose one of the following options and click Next: v Source and Target Files are Single Membermerges all members from the source table to a single-member target table. v Use Source member Structure on Targetmaintains the same multi-member structure on the target table as the one on the source table. Each source member is mapped to the corresponding target member. v Merge Source Members into One Target Membermerges all members from the source table to a single member in a multi-member. 15. Choose one of the following and click Next: v Use an Indexselect the index name from the Index box. Use if your target table has an index that uniquely identifies a row. v Specify the keyselect the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. v Use all searchable columnssearches all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Availability of the above options is dependent on the platform and version of InfoSphere CDC Event Server that you have installed. 16. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box.

96

InfoSphere Change Data Capture Management Console: Administration Guide

v Refresh (Snapshot)replicates a snapshot of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. 17. Click Next. 18. Review the mapping summary. 19. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Attention: AS/400 must be installed on both source and target. Related concepts Mapping using standard replication on page 91 Setting member identifiers for multi-member source tables on page 187

To map multi-member source tables to existing target tables on AS/400 (one-to-one)


Click Configuration Subscriptions. Select a subscription, right-click and select Map Tables. Enable One-to-one Mappings and click Next. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 5. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 6. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. 1. 2. 3. 4.
Mapping tables

97

7. 8. 9.

10.

v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next.

11. Enable Map to existing target tables and clickNext. 12. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 13. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. The wizard uses the relationship between this target table and the selected source table to map the remaining source and target tables. You can click Change Example Table if you want the Map Tables wizard to base the mapping on a different source table. This option is only available if you have selected more than one source table. 14. Select the target table from the Target Table list and clickNext. If any of the mappings are incorrect, you can click the assigned target table and pick another target table from the displayed list. If you have not chosen similar tables, you can select target tables individually by clicking on the target list beside the source table you want to map. 15. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make

98

InfoSphere Change Data Capture Management Console: Administration Guide

use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. 16. Click Next. 17. Review the mapping summary. 18. Review the mapping summary and click Finish. Related concepts Mapping using standard replication on page 91 Setting member identifiers for multi-member source tables on page 187

To map multi-member source tables to new tables on AS/400 (one-to-one)


1. 2. 3. 4. Click Configuration Subscriptions. Select a subscription, right-click and select Map Tables. Enable One-to-one Mappings and click Next. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping.

5. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 6. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 7. If you want to modify this filter, select a database user or schema and click Specify Filter. 8. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 9. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 10. Click Next. 11. Enable Create New Target Tables and click Next. 12. Click Click to select a target owner under Target Library and select a target owner. 13. Choose from the following options and click Next: v Identical to the source table namesNames the new target tables the same name as the source tables.

Mapping tables

99

v Source table names with prefixes and/or suffixesAdds the suffix and/or prefix to the source table name. Enable the Use Prefix/Suffix for index name to use the prefix/suffix as the index name. 14. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. 15. Review the mapping summary and click Finish. Related concepts Mapping using standard replication on page 91 Setting member identifiers for multi-member source tables on page 187

Mapping using LiveAudit


If you want your target table to keep an audit trail of operations applied to the source table, then use the Map Tables wizard to map your source and target tables using LiveAudit. When you replicate data using LiveAudit, your target tables contain rows that track insert, update, delete, and clear (truncate) operations applied to the mapped source table. LiveAudit is most useful if your environment must satisfy data auditing and change-tracking requirements. With LiveAudit, you can audit changes to sensitive information, and you can monitor and report on risk in a timely manner. To replicate data using LiveAudit, you must have a LiveAudit-enabled authorization code. The following table summarizes how row-level operations are replicated to the target datastore when you map your tables for LiveAudit.
Source operations INSERT Target Operations INSERTs the new row that was added.

100

InfoSphere Change Data Capture Management Console: Administration Guide

Source operations UPDATE (Key not changed)

Target Operations Either: v INSERT the row that contains the after image. v INSERT row containing before image values, and INSERT another row containing after image values.

UPDATE (Key changed)

Either: v INSERT the row that contains the after image. v INSERT row containing before image values, and INSERT another row containing after image values.

DELETE

INSERTs the row that was deleted.

See also: To map To map To map To map

a single source table using LiveAudit a multi-member table using LiveAudit for AS/400 on page 102 multiple source tables to existing tables using LiveAudit on page 104 multiple source tables to new tables using LiveAudit on page 105

To map a single source table using LiveAudit


1. Click Configuration Subscriptions. 2. Select a subscription, right-click and select Map Tables. 3. Enable One table mapping of any type and select LiveAudit from the Mapping Type list box. Click Next. 4. Review the following audit columns. You can choose to add, modify, or delete audit columns to the target table. Click Next: v AudTimestores the &TIMSTAMP journal control field which indicates date and time changes are made to the source. v AudTypestores the &ENTTYP journal control field which indicates the type of change made to the source. v AudUserstores the &USER journal control field which indicates the ID of the user who made the change to the source. 5. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 6. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 7. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified.

Mapping tables

101

8. 9. 10.

11. 12.

13.

14.

You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. Select a table from the Target Tables list. If you do not see your table listed, select the database user or schema and click Refresh.

15. Click Next. 16. Review the mapping summary. 17. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping using LiveAudit on page 100

To map a multi-member table using LiveAudit for AS/400


1. Click Configuration Subscriptions. 2. Select a subscription, right-click and select Map Tables. 3. Enable One table mapping of any type. 4. Select LiveAudit from the Mapping Type list box and clickNext. 5. Review the following audit columns. You can choose to add, modify, or delete audit columns to the target table. Click Next: v AudTimestores the &TIMSTAMP journal control field which indicates date and time changes are made to the source. v AudTypestores the &ENTTYP journal control field which indicates the type of change made to the source. v AudUserstores the &USER journal control field which indicates the ID of the user who made the change to the source. 6. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 7. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically

102

InfoSphere Change Data Capture Management Console: Administration Guide

8.

9. 10. 11.

12. 13.

14.

15.

16. 17.

displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. Select a target table from the Target Tables list and choose one of the following options. v Source and Target Files are Single MemberMerges all members from the source table to a single-member target table. v Use Source member Structure on TargetMaintains the same multi-member structure on the target table as the one on the source table. Each source member is mapped to the corresponding target member. v Merge Source Members into One Target MemberMerges all members from the source table to a single member in a multi-member. Review the mapping settings. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view.

Attention: AS/400 must be installed on both source and target. Related concepts Mapping using standard replication on page 91 Setting member identifiers for multi-member source tables on page 187

Mapping tables

103

To map multiple source tables to existing tables using LiveAudit


1. 2. 3. 4. Click Configuration Subscriptions. Select a subscription, right-click and select Map Tables. Enable LiveAudit Mappings and clickNext. Review the following audit columns. You can choose to add, modify, or delete audit columns to the target table. Click Next: v AudTimestores the &TIMSTAMP journal control field which indicates date and time changes are made to the source. v AudTypestores the &ENTTYP journal control field which indicates the type of change made to the source. v AudUserstores the &USER journal control field which indicates the ID of the user who made the change to the source. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next. Enable Map to existing target tables and click Next. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. Select a table from the Target Tables list and click Next. If you do not see your table listed, select the database user or schema and click Refresh. Verify that the correct target table is mapped to the source tables and click Next.

5.

6.

7.

8. 9. 10.

11. 12. 13.

14.

15. 16.

104

InfoSphere Change Data Capture Management Console: Administration Guide

If any of the mappings are incorrect, you can click the assigned target table and pick another target table from the displayed list. If you have not chosen similar tables, you can select target tables individually by clicking on the target list beside the source table you want to map. 17. Review the mapping summary and click Finish. InfoSphere CDC inserts a row into the target table for every row-level operation (insert, update, or delete) applied to a row in the source table. The target table can become extremely large. Ensure that you allow sufficient disk space and perform regular maintenance for target tables that audit data. Related concepts Mapping using LiveAudit on page 100

To map multiple source tables to new tables using LiveAudit


1. Click Configuration Subscriptions. 2. Select a subscription, right-click and select Map Tables. 3. Select LiveAudit and clickNext. 4. Review the following audit columns. You can choose to add, modify, or delete audit columns to the target table. Click Next: v AudTimestores the &TIMSTAMP journal control field which indicates date and time changes are made to the source. v AudTypestores the &ENTTYP journal control field which indicates the type of change made to the source. v AudUserstores the &USER journal control field which indicates the ID of the user who made the change to the source. 5. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 6. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 7. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next. Enable Create New Target Tables and click Next.

8. 9. 10.

11. 12.

Mapping tables

105

13. Click Click to select a target owner under Target Library and select a target owner. 14. Choose from the following options and click Next: v Identical to the source table namesNames the new target tables the same name as the source tables. v Source table names with prefixes and/or suffixesAdds the suffix and/or prefix to the source table name. Enable the Use Prefix/Suffix for index name to use the prefix/suffix as the index name. 15. Review the mapping summary and click Finish. Related concepts Mapping using LiveAudit on page 100

Mapping using WebSphere DataStage


After adding a subscription that uses InfoSphere CDC for WebSphere DataStage as a target datastore, you must map one or more source tables to the target system, IBM WebSphere DataStage. You can create as many table mappings as you feel necessary, and this may depend on the number of tables that you want to replicate to the target system. See also: To map a single source table to WebSphere DataStage using flat files To map a single source table to WebSphere DataStage using Direct Connect on page 107 To map multiple source tables to WebSphere DataStage using flat files on page 108 To map multiple source tables to WebSphere DataStage using Direct Connect on page 109

To map a single source table to WebSphere DataStage using flat files


1. Click Configuration Subscriptions. 2. Select a subscription, right-click and select Map Tables. 3. Enable One table mapping and select WebSphere DataStage from the Mapping Type box. Click Next. 4. Enable Flat File and click Next. 5. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 6. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 7. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified.

106

InfoSphere Change Data Capture Management Console: Administration Guide

8. 9. 10.

11. 12.

13.

14. 15.

You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next. In the Directory box, type the output directory for the WebSphere DataStage flat files that are generated by InfoSphere CDC and utilized by WebSphere DataStage. Enable one of the following options for the record format of the flat files and click Next: v Single Recordan update operation is sent as a single row. v Multiple Recordan update operation is sent as two rows. Review the mapping settings. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view.

To map a single source table to WebSphere DataStage using Direct Connect


1. Click Configuration Subscriptions. 2. Select a subscription, right-click and select Map Tables. 3. Enable One table mapping and select WebSphere DataStage from the Mapping Type box. Click Next. 4. Enable Direct Connect and click Next. 5. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 6. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 7. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 8. If you want to modify this filter, select a database user or schema and click Specify Filter.

Mapping tables

107

9. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 10. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 11. Click Next. 12. In the Host box, type the host name of your WebSphere DataStage installation. 13. In the Port box, type port number for the WebSphere DataStage host. 14. Enable one of the following options for the output records used by WebSphere DataStage and click Next: v Single Recordan update operation is sent as a single row. v Multiple Recordan update operation is sent as two rows. 15. Review the mapping settings. 16. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view.

To map multiple source tables to WebSphere DataStage using flat files


1. 2. 3. 4. Click Configuration Subscriptions. Select a subscription, right-click and select Map Tables. Under Automatic, enable WebSphere DataStage. Click Next. Enable Flat File and click Next.

5. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 6. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 7. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next.

8. 9. 10.

11.

108

InfoSphere Change Data Capture Management Console: Administration Guide

12. In the Directory box, type the output directory for the WebSphere DataStage flat files that are generated by InfoSphere CDC Event Server and utilized by WebSphere DataStage. 13. Enable one of the following options for the flat file output records and click Next: v Single Recordan update operation is sent as a single row. v Multiple Recordan update operation is sent as two rows. 14. Review the mapping settings and click Finish.

To map multiple source tables to WebSphere DataStage using Direct Connect


1. Click Configuration Subscriptions. 2. Select a subscription, right-click and select Map Tables. 3. EnableOne table mapping and select WebSphere DataStage from theMapping Type box. Click Next. 4. EnableDirect Connect and click Next. 5. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 6. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 7. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 8. If you want to modify this filter, select a database user or schema and click Specify Filter. 9. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 10. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 11. Click Next. 12. In theHost box, type the host name of your WebSphere DataStage installation. 13. In thePort box, specify the starting port if you have selected more than one source table. 14. Enable one of the following options for the output records used by WebSphere DataStage and click Next: v Single Recordan update operation is sent as a single row. v Multiple Recordan update operation is sent as two rows. 15. Review the mapping settings and click Finish.

Mapping tables

109

Mapping using Adaptive Apply


If you know that your source and target tables are not synchronized, but you want to replicate data from the source to the target without error, then map your source table to your target table using the Adaptive Apply mapping type. For example, if there is an insert on the source table, but that row already exists in your target table, InfoSphere CDC switches the insert to an update operation. Also, if there is an update on your source table, and this row does not exist on your target table, then InfoSphere CDC switches the update into an insert. Adaptive Apply ensures that replicated rows in the source and target tables are the same. You can also use adaptive apply to restore the contents of a target table from recorded journal or log entries. To do this, you set the journal or log position to a specific entry or point in time, and then use adaptive apply to populate an empty target table with the latest data. See also: To map a source table using Adaptive Apply To map multi-member source tables using Adaptive Apply on AS/400 on page 112

To map a source table using Adaptive Apply


1. 2. 3. 4. 5. Click Configuration Subscriptions. Select a subscription, right-click and select Map Tables. Enable One table mapping of any type. Select Adaptive Apply from the Mapping type list and click Next. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK.

6.

7.

8. 9. 10.

11. Click Next.

110

InfoSphere Change Data Capture Management Console: Administration Guide

12. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 13. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 14. Select a table from the Target Tables list and click Next. If you do not see your table listed, select the database user or schema and click Refresh. Click Next. If you want to create a new table to map to, click Create Table. 15. Choose one of the following and click Next: v Use an Indexselect the index name from the Index box. Use if your target table has an index that uniquely identifies a row. Specify the keyselect the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. v Use all searchable columnssearches all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. v Availability of the above options is dependent on the platform and version of InfoSphere CDC Event Server that you have installed. 16. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. 17. If you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then enable one of the following: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC Event Server creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table. 18. If you are using InfoSphere CDC for Microsoft SQL Server 5.3 to replicate source database changes and have configured bidirectional replication, then enable the Prevent Recursion check box. This prevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM Technical Support to implement bidirectional replication in your environment.
Mapping tables

111

19. Click Next. 20. Review the mapping summary. 21. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping using Adaptive Apply on page 110

To map multi-member source tables using Adaptive Apply on AS/400


1. Click Configuration Subscriptions. 2. Select a subscription, right-click and select Map Tables. 3. Select Adaptive Apply from the Mapping type list and click Next. 4. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 5. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 6. If you want to modify this filter, select a database user or schema and click Specify Filter. 7. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 8. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 9. Click Next. 10. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 11. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 12. Select a table from the Target Tables list and click Next. If you do not see your table listed, select the database user or schema and click Refresh. Click Next. If you want to create a new table to map to, click Create Table. 13. Choose one of the following and click Next: v Use an Indexselect the index name from the Index box. Use if your target table has an index that uniquely identifies a row.

112

InfoSphere Change Data Capture Management Console: Administration Guide

Specify the keyselect the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. v Use all searchable columnssearches all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Availability of the above options is dependent on the platform and version of InfoSphere CDC Event Server that you have installed. v 14. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. 15. Review the mapping settings. 16. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping using Adaptive Apply on page 110

Mapping to summarize data


If you want to accumulate or deduct numerical values on the target, then map your source and target tables using the Summarization mapping type. There are two types of summarization: Accumulation and Deduction. Accumulation ensures that numeric changes applied to the target column are directly proportional to changes applied to the corresponding source columns. Deduction ensures that numeric changes applied to the target columns are inversely proportional to changes applied to mapped source columns.

Mapping tables

113

See also: To map a source table to summarize data To map multi-member source tables using Summarization on AS/400 on page 115

To map a source table to summarize data


1. 2. 3. 4. Click Configuration Subscriptions. Select a subscription, right-click and select Map Tables. Select Summarization from the Mapping type list. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next.

5.

6.

7. 8. 9.

10.

11. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 12. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 13. Select a table from the Target Tables list and click Next. If you do not see your table listed, select the database user or schema and click Refresh. Click Next. If you want to create a new table to map to, click Create Table. 14. Select the target columns from the Key Columns list and click Next. 15. Choose one of the following from the Summarization Type list: v AccumulationNumeric changes applied to target columns are directly proportional to changes applied to source columns. v DeductionNumeric changes applied to target columns are inversely proportional to changes applied to source columns.

114

InfoSphere Change Data Capture Management Console: Administration Guide

16. Select the source column from the Summarized Column list and click Next. 17. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. 18. If you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then enable one of the following: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC Event Server creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table. 19. If you are using InfoSphere CDC for Microsoft SQL Server 5.3 to replicate source database changes and have configured bidirectional replication, then enable the Prevent Recursion check box. This prevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM Technical Support to implement bidirectional replication in your environment. 20. Click Next. 21. Review the mapping settings. 22. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping to summarize data on page 113

To map multi-member source tables using Summarization on AS/400


1. Click Configuration Subscriptions. 2. Select a subscription, right-click and select Map Tables. 3. Select Summarization from the Mapping type list. 4. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 5. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically
Mapping tables

115

6.

7. 8. 9.

10. 11.

12.

13.

14.

15.

16. 17.

displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. Select a table from the Target Tables list and click Next. If you do not see your table listed, select the database user or schema and click Refresh. Click Next. If you want to create a new table to map to, click Create Table. Select the target columns from the Key Columns list and click Next. InfoSphere CDC for AS/400 requires that the selected key columns match an existing index. Choose one of the following from the Summarization Type list: v AccumulationNumeric changes applied to target columns are directly proportional to changes applied to source columns. v DeductionNumeric changes applied to target columns are inversely proportional to changes applied to source columns. Select the source column from the Summarized Column list and click Next. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on

116

InfoSphere Change Data Capture Management Console: Administration Guide

the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. 18. Review the mapping settings. 19. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping to summarize data on page 113

Mapping to consolidate data (one-to-one)


If your business environment contains information that is scattered across different source tables, you may want to consolidate it to facilitate report generation, data management, or data security. To merge different information about a common entity into a single row, such as a person, a customer, or a product part, map your source table to your target table using the Consolidation one-to-one mapping type. See also: To map a source table to consolidate data (one-to-one) To map multi-member source tables using Consolidation One-to-One on AS/400 on page 119 Related concepts Mapping using standard replication on page 91 Adding and mapping derived columns to target columns on page 162 Related tasks To map a source table to consolidate data (one-to-many) on page 122 To map multi-member source tables using Consolidation one-to-many on AS/400 on page 124 Related reference Retrieve column%GETCOL (Dynamic SQL) on page 288

To map a source table to consolidate data (one-to-one)


1. Click Configuration Subscriptions. 2. Select a subscription, right-click and select Map Tables. 3. Select Consolidation One-to-one from the Mapping type list.

Mapping tables

117

4. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 5. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 6. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 7. If you want to modify this filter, select a database user or schema and click Specify Filter. 8. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 9. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 10. Click Next. 11. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 12. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 13. Select a table from the Target Tables list and click Next. If you do not see your table listed, select the database user or schema and click Refresh. Click Next. If you want to create a new table to map to, click Create Table. 14. Check the key for the target columns and click Next. 15. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. 16. If you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then enable one of the following: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target.

118

InfoSphere Change Data Capture Management Console: Administration Guide

v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC Event Server creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table. 17. If you are using InfoSphere CDC for Microsoft SQL Server 5.3 to replicate source database changes and have configured bidirectional replication, then enable the Prevent Recursion check box. This prevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM Technical Support to implement bidirectional replication in your environment. 18. Click Next. 19. Review the mapping settings. 20. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping to consolidate data (one-to-one) on page 117

To map multi-member source tables using Consolidation One-to-One on AS/400


1. Click Configuration Subscriptions. 2. Select a subscription, right-click and select Map Tables. 3. Select Consolidation One-to-one from the Mapping type list. 4. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 5. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 6. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 7. If you want to modify this filter, select a database user or schema and click Specify Filter. 8. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh.

Mapping tables

119

9. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 10. Click Next. 11. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 12. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 13. Select a table from the Target Tables list and click Next. If you do not see your table listed, select the database user or schema and click Refresh. Click Next. If you want to create a new table to map to, click Create Table. 14. Check the key for the target columns and click Next. 15. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. 16. Review the mapping settings. 17. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping to consolidate data (one-to-one) on page 117

120

InfoSphere Change Data Capture Management Console: Administration Guide

Mapping to consolidate data (one-to-many)


If you are using a lookup table to make updates to a target table, then you can map your lookup table using one-to-many row consolidation. When you map a lookup table using one-to-many consolidation, InfoSphere CDC only applies updates to the rows in the target table. v If you insert a row into your lookup table, InfoSphere CDC: Does not apply an operation to the target table (leaves the target table unchanged); or Updates the row that has the same consolidation key value. v If you delete a row from your lookup table, InfoSphere CDC does not apply an operation to target table. v If you update a row in your lookup table, InfoSphere CDC updates all rows that have the same consolidation key value. The following example illustrates how InfoSphere CDC can update regional tax code information in a target table that was mapped to a source table using One to Many Consolidation. When there are updates made to the lookup table TAXCODES, InfoSphere CDC updates these columns in the target table.

Before you map your lookup table for one-to-many consolidation, make sure you have completed the following tasks:
v Created a lookup table For InfoSphere CDC to accomplish one-to-many row consolidation, you need to create a lookup table that contains the columns you want InfoSphere CDC to update in your target table. For example, if you want InfoSphere CDC to update tax codes for a specific state, then make sure these columns exist in your lookup table and that you set a primary key. For example, the primary key in the TAXCODES table would be STATE. You can then map your lookup table to the target table using one-to-many consolidation. v Mapped your source table to the target table using Standard mapping type InfoSphere CDC requires that at least one source table is mapped to the target table using a mapping type other than one-to-many consolidation, such as Standard. When you map a source table using one-to-many mapping, InfoSphere
Mapping tables

121

CDC only updates the target table and does not insert or delete rows in the target table. Therefore, another mapping type such as Standard ensures that InfoSphere CDC populates the target table with source data. You need to identify the primary key on the source table. For example, to populate the target table STOREDATA with data from the source table STORELOC, you would map the source columns STORE, CITY, STATE, and TAX to the target columns STORE_CON, CITY_CON, STATE_CON, and TAX_CON. You can map these columns using Standard mapping type. v Created a derived column on the source table using %GETCOL to retrieve data from your lookup table After mapping your source table to the target table using Standard mapping type, InfoSphere CDC requires you create a derived column on the source table to retrieve data from the lookup table when replicating data from the source to the target table. For example, if you want your source table to retrieve tax codes and state information from the TAXCODES table, your %GETCOL expression would be: %GETCOL(TAX, TAXCODES, <default value>, STATE, STATE). The default value of the tax you want InfoSphere CDC to retrieve is up to you. In this example, a typical default value would be 0. See also: To map a source table to consolidate data (one-to-many) To map multi-member source tables using Consolidation one-to-many on AS/400 on page 124

To map a source table to consolidate data (one-to-many)


1. 2. 3. 4. Click Configuration Subscriptions. Select a subscription, right-click and select Map Tables. Select Consolidation One-to-one from the Mapping type list. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK.

5.

6.

7. 8. 9.

122

InfoSphere Change Data Capture Management Console: Administration Guide

10. Click Next. 11. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 12. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 13. Select a table from the Target Tables list and click Next. If you do not see your table listed, select the database user or schema and click Refresh. Click Next. If you want to create a new table to map to, click Create Table. 14. Check the consolidation key for the target columns and click Next. InfoSphere CDC uses the consolidation key to determine the rows that will be updated in the target table in response to an update in the look-up table. The consolidation key must identify the same column you identified as the primary key in the lookup table. 15. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. 16. If you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then enable one of the following: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC Event Server creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table. 17. If you are using InfoSphere CDC for Microsoft SQL Server 5.3 to replicate source database changes and have configured bidirectional replication, then enable the Prevent Recursion check box. This prevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM Technical Support to implement bidirectional replication in your environment. 18. Click Next. 19. Review the mapping settings. 20. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping
Mapping tables

123

v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. After you map your lookup table for one-to-many consolidation, make sure you have set the following on the table mapping: 1. In the Table Mappings view, select the table mapping you just created and right-click Edit Mapping Details. 2. On the Column Mappings tab, verify your column mappings to the target table. Make sure that the appropriate columns from the lookup table are mapped to the target table. 3. On the Operations tab, selectUpdate all if exists from theOn Insert list. This ensures that InfoSphere CDC updates all rows where the consolidation key is the same when there is an insert on the lookup table. 4. Click Apply.

To map multi-member source tables using Consolidation one-to-many on AS/400


Click Configuration Subscriptions. Select a subscription, right-click and select Map Tables. Select Consolidation One-to-one from the Mapping type list. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 5. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 6. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 7. If you want to modify this filter, select a database user or schema and click Specify Filter. 1. 2. 3. 4. 8. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 9. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 10. Click Next. 11. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 12. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not

124

InfoSphere Change Data Capture Management Console: Administration Guide

13.

14. 15. 16.

enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. Select a table from the Target Tables list. If you do not see your table listed, select the database user or schema and click Refresh. Choose one of the following options and click Next: v Source and Target Files are Single Membermerges all members from the source table to a single-member target table. v Use Source member Structure on Targetmaintains the same multi-member structure on the target table as the one on the source table. Each source member is mapped to the corresponding target member. v Merge Source Members into One Target Membermerges all members from the source table to a single member in a multi-member. If you want to create a new table to map to, click Create Table. Check the key for the target columns and click Next. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target.

Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. 17. Review the mapping settings. 18. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. After you map your lookup table for one-to-many consolidation, make sure you have set the following on the table mapping: 1. In the Table Mappings view, select the table mapping you just created and right-click Edit Mapping Details.

Mapping tables

125

2. On the Column Mappings tab, verify your column mappings to the target table. Make sure that the appropriate columns from the lookup table are mapped to the target table. 3. On the Operations tab, selectUpdate all if exists from theOn Insert list. This ensures that InfoSphere CDC updates all rows where the consolidation key is the same when there is an insert on the lookup table. 4. Click Apply.

Mapping to a datastore outside of your organization


If you are mapping tables for a subscription with an external target datastore, the organization that owns the external target datastore must first add tables to the subscription before you can map the tables. After adding tables to the subscription, you can map tables using one of the available mapping types. See also: To map tables for a subscription on an external datastore

To map tables for a subscription on an external datastore


1. Click Configuration Subscriptions. 2. Select a subscription, right-click and select Map Tables. 3. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 4. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 5. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 6. If you want to modify this filter, select a database user or schema and click Specify Filter. 7. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 8. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 9. Click Next. 10. Review the mapping settings and click Finish. Related concepts Mapping to a datastore outside of your organization

126

InfoSphere Change Data Capture Management Console: Administration Guide

Mapping to a JMS message destination using InfoSphere CDC Event Server


If you have created a subscription that uses InfoSphere CDC Event Server as a target datastore, then you can map a source table to a JMS message destination. InfoSphere CDC Event Server receives the row-level operation (insert, update, or delete) and transforms it into a row that is inserted into an XML message. Also, using the standard mapping type, you can stage your source table in an embedded staging database provided with InfoSphere CDC Event Server. This may be necessary when you want InfoSphere CDC Event Server to receive replicated rows from the staging database instead of your source database so that you can reduce overhead on your production environment. If you have mapped the source table to a staging table and to a JMS message destination, InfoSphere CDC Event Server receives the row-level operation from the staging database and transforms it into XML. The standard mapping type creates an exact copy of your source table in the staging database. If you want to setup this type of replication, you must map your source table to a table in the staging database using the Standard mapping type. See also: To map multiple source tables to a JMS message destination To map a single source table to a JMS message destination on page 129 To stage a source table on page 131

To map multiple source tables to a JMS message destination


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select a subscription, right-click and select Map Tables. Ensure you have ended replication on the subscription. 4. Enable Message DestinationMappings. 5. Click Next. 6. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 7. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 8. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified.

Mapping tables

127

9. 10. 11.

12. 13.

14. 15.

16. 17. 18. 19.

You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next. Enable one of the following options: v Use the source table structure for the XML message: Include before-image valuesenable this option when you want the XML message to include the before image of a row-level operation. The before-image represents the data in the source column before an insert, update, or delete operation on the row. Include after-image valuesenable this option when you want the XML message to include the after image of a row-level operation. The after-image represents the data in the source column after an insert, update, or delete operation on the row. Include journal control valuesenable this option when you want the XML message to include journal control fields. These provide information about the source table, the source database, or the row-level operations taking place in the database log or journal of the source database. For example, the _ENNTYPE journal control field indicates the type of row-level operation (insert, update, or delete) that took place on the source table. v Value Formatchoose how you want to format source column data in the XML message. You can choose from one of the following: Use attributes for data valuesformats data values of the before image, the after image, or journal control fields in your XML message as XML attributes. Use elements for data valuesformats data values of the before image, the after image, or journal control fields in your XML message as XML elements. v Do not specify the message format at this timeenable this option when you want to manually decide whether you want to include the before or after image values for source columns, or journal control fields in your XML document. Click Next. Select the JMS connection you had configured in the InfoSphere CDC Event Server Configuration Tool and click Add Destination to add a queue or a topic. Type the name of queue or topic in theName box. Type a brief description about the queue or topic in the Description box. Type the JNDI name of the JMS queue or topic to which you want to send the XML message in the Request Destination box. Enable one of the following options: v Use persistent deliveryenable to ensure the message is not lost in transit due to a JMS provider failure.

128

InfoSphere Change Data Capture Management Console: Administration Guide

v Use transacted sessionsenables InfoSphere CDC Event Server to open a transacted session and commit every message to the JMS queue or topic. 20. Click Test and OK. 21. Click Next and Finish. Related concepts Mapping to a JMS message destination using InfoSphere CDC Event Server on page 127 Related tasks To map a single source table to a JMS message destination To stage a source table on page 131

To map a single source table to a JMS message destination


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select a subscription, right-click and select Map Tables. Ensure you have ended replication on the subscription. 4. Enable Message DestinationMappings. 5. Click Next. 6. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 7. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 8. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 9. If you want to modify this filter, select a database user or schema and click Specify Filter. 10. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 11. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 12. Click Next. 13. Enable one of the following options: v Use the source table structure for the XML message: Include before-image valuesenable this option when you want the XML message to include the before image of a row-level operation. The
Mapping tables

129

before-image represents the data in the source column before an insert, update, or delete operation on the row. Include after-image valuesenable this option when you want the XML message to include the after image of a row-level operation. The after-image represents the data in the source column after an insert, update, or delete operation on the row. Include journal control valuesenable this option when you want the XML message to include journal control fields. These provide information about the source table, the source database, or the row-level operations taking place in the database log or journal of the source database. For example, the _ENNTYPE journal control field indicates the type of row-level operation (insert, update, or delete) that took place on the source table. v Value Formatchoose how you want to format source column data in the XML message. You can choose from one of the following: Use attributes for data valuesformats data values of the before image, the after image, or journal control fields in your XML message as XML attributes. Use elements for data valuesformats data values of the before image, the after image, or journal control fields in your XML message as XML elements. v Do not specify the message format at this timeenable this option when you want to manually decide whether you want to include the before or after image values for source columns, or journal control fields in your XML document. 14. If you have decided to format the XML message based on an imported schema, mapping project, or XML file, then browse for the file and enable one or both of the following options: v Import repeated elements with the same parentby default, InfoSphere CDC Event Server imports only one repeated element in a group node with the same parent. Enable this option to import all repeated elements. v Import attribute valuesby default, InfoSphere CDC Event Server imports only the structure of your XML. Enable this option to import the attribute values. This may be necessary if attribute values represent the structure of your XML document. 15. Click Next. 16. Select the JMS connection you had configured in the InfoSphere CDC Event Server Configuration Tool and click Add Destination to add a queue or a topic. 17. Type the name of queue or topic in the Name box. 18. Type a brief description about the queue or topic in the Description box. 19. Type the JNDI name of the JMS queue or topic to which you want to send the XML message in the Request Destination box. 20. Enable one of the following options: v Use persistent deliveryenable to ensure the message is not lost in transit due to a JMS provider failure. v Use transacted sessionsenables InfoSphere CDC Event Server to open a transacted session and commit every message to the JMS queue or topic. 21. Click Test and OK. 22. Click Next and Finish. Related concepts

130

InfoSphere Change Data Capture Management Console: Administration Guide

Mapping to a JMS message destination using InfoSphere CDC Event Server on page 127 Related tasks To map multiple source tables to a JMS message destination on page 127 To stage a source table

To stage a source table


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select a subscription, right-click and select Map Tables. Ensure you have ended replication on the subscription. 4. Enable One mapping of any type. 5. Select Standard as the mapping type. 6. Click Next. 7. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 8. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 9. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 10. If you want to modify this filter, select a database user or schema and click Specify Filter. 11. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 12. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 13. Click Next. 14. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 15. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK.
Mapping tables

131

16. Choose one of the following and click Next: v Use an Indexselect the index name from the Index box. Use if your target table has an index that uniquely identifies a row. v Specify the keyselect the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. v Use all searchable columnssearches all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Availability of the above options is dependent on the platform and version of InfoSphere CDC Event Server that you have installed. 17. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. 18. Review the mapping summary. 19. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping to a JMS message destination using InfoSphere CDC Event Server on page 127

132

InfoSphere Change Data Capture Management Console: Administration Guide

Managing table mappings


You can manage table mappings. In this section, you will learn: Remapping a source table Changing the message destination on page 134 Flagging a source table for a refresh on page 135 Marking a table capture point on a source table on page 135 Parking a table mapping from replication on page 136 Changing the refresh order on a table mapping on page 137 Changing the replication method of a table mapping on page 137 Selecting a new journal table on page 139 Setting members for replication on page 140 Deleting table mappings on page 140 Updating the definition of mapped source and target table in a subscription on page 141

Remapping a source table


You can remap an existing source table so that it is mapped to the correct target table. If you want to remap a source table on a subscription that uses InfoSphere CDC Event Server as the target datastore, then you can do the following: v Remap a source table already mapped to a JMS message destination to a staging target table. v Remap a source table already mapped to a staging target table to a JMS message destination. See also: To remap a source table To remap a source table (InfoSphere CDC Event Server)

To remap a source table


1. Ensure the subscription has at least one table mapping. You set this when mapping tables in the Map Tables wizard. 2. Ensure you have ended any active replication on the subscription. 3. Click Configuration Subscriptions. 4. Select the subscription that contains the mapped source and target tables. 5. Select the mapped source and target tables in the Table Mappings view. 6. Right-click and click Remap Source Table . Related concepts Remapping a source table

To remap a source table (InfoSphere CDC Event Server)


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore.
Copyright IBM Corp. 2008

133

2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select the subscription that contains the mapped source and target tables. Ensure you have ended replication on the subscription. 4. Select the table mapping in the Table Mappings view. 5. Right-click Remap Source Table. This option is only available if you have already mapped your source table to a message destination or to a staging target table. 6. Enable one of the following: v Message Destination Mappingsenable this option if you want to map this source table to a message destination. v One mapping of any typeenable this option if you want to map this source table to a staging target table. Select Standard as the mapping type. 7. Click Next and map the source table to a message destination or to a staging target table. Related concepts Remapping a source table on page 133 Related tasks To map multiple source tables to a JMS message destination on page 127 To stage a source table on page 131

Changing the message destination


This option is only available for subscriptions that use InfoSphere CDC Event Server as the target datastore. You can change the JMS message destination of a table mapping. See also: To change the message destination of a table mapping

To change the message destination of a table mapping


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. 4. 5. 6. Select a subscription that contains the table mapping to a message destination. Select the table mapping in the Table Mappings view. Right-click Change Message Destination. Select the new message destination and click OK. Related concepts Changing the message destination

134

InfoSphere Change Data Capture Management Console: Administration Guide

Flagging a source table for a refresh


If you have a subscription that contains a target table that is not synchronized with the source table, then you can flag the source table for a refresh before you start mirroring. When you flag a source table for a refresh, InfoSphere CDC will synchronize this source table with your target table when you start mirroring. Synchronizing your source and target table can become necessary when you have parked a subscription from replication for some time to make changes (such as updating the definition of a source table) and the journal no longer logs changes that are taking place on the source. This may cause the target table to become inconsistent with the source table. By default, when you start refresh on a table, InfoSphere CDC deletes all the rows in your target table. You can control this behavior so that InfoSphere CDC only deletes certain rows (using SQL statements) or deletes no rows in response to a refresh operation. See also: To flag a source table for a refresh before mirroring

To flag a source table for a refresh before mirroring


1. Ensure the subscription has at least one table mapping with replication method set to Mirror. You set this when mapping tables in the Map Tables wizard. 2. Ensure you have ended any active replication on the subscription. 3. Click Configuration Subscriptions. 4. Select the subscription that contains the mapped source and target tables. 5. Select the mapped source and target tables in the Table Mappings view. 6. Right-click and click Flag for Refresh. When you are ready to start mirroring, InfoSphere CDC will send all changes from the source table to the target table so that both tables are synchronized. InfoSphere CDC will then mirror subsequent changes to the target. Related concepts Starting and ending replication on subscriptions on page 197 Mapping tables on page 91 Flagging a source table for a refresh Controlling the apply of refresh operations on page 183 Ending replication on a subscription on page 198

Marking a table capture point on a source table


Attention: Only use this procedure when you want to override an existing position in the stream of changed data. This is possible when you have already synchronized (refreshed) your source and target tables using an application other than InfoSphere CDC Management Console (for example, using the import or export capabilities of your database platform) and you know the point in time your source and target are synchronized with each other. InfoSphere CDC mirrors changes to the target table from the current position in the stream of changed data. This position is set by InfoSphere CDC when you select Mirror (Change Data Capture) after mapping your tables in the Map Tables wizard. If you want to override the position set by InfoSphere CDC, then you can
Managing table mappings

135

manually mark a table capture point in Management Console. When you decide to start mirroring on the subscription, InfoSphere CDC identifies the position you have set as the point in time from which to capture and replicate database changes to the target. See also: To mark a table capture point on a source table before mirroring

To mark a table capture point on a source table before mirroring


1. Ensure your database platform is in idle mode to avoid losing synchronization between your source and target tables. 2. Ensure you have ended any active replication on the subscription that contains the source table. 3. Click Configuration Subscriptions. 4. Select the subscription that contains the mapped source and target tables. 5. Select the mapped source table in the Table Mappings view. 6. Right-click and click Mark Table Capture Point For Mirroring. Tip: You can mark a table capture point on more than one mapped source table at a time. Related concepts Marking a table capture point on a source table on page 135 Ending replication on a subscription on page 198

Parking a table mapping from replication


If your subscription contains more than one table mapping, then you can park one or more before starting mirroring or a refresh on your subscription. When you park a table mapping from replication, InfoSphere CDC does not replicate changes to the target. See also: To park a table mapping from replication

To park a table mapping from replication


1. 2. 3. 4. 5. Ensure you have ended any active replication on the subscription. Click Configuration Subscriptions. Select the subscription that contains the mapped source and target tables. Select the mapped source and target table in the Table Mappings view. Right-click and click Park (Do not replicate).

Tip: You can park more than one table-mapping at a time. Related concepts Parking a table mapping from replication Ending replication on a subscription on page 198

136

InfoSphere Change Data Capture Management Console: Administration Guide

Changing the refresh order on a table mapping


If you have set referential integrity constraints on your tables, then you can set a refresh order to preserve these constraints during a refresh. For example, you may want InfoSphere CDC to refresh your DEPARTMENT tables before refreshing your EMPLOYEE tables, based on the fact that each employee belongs to a specific department. You can change the order in which InfoSphere CDC refreshes your table mappings by moving tables into groups. Each table you decide to move into a group is assigned a sequence number that InfoSphere CDC uses to refresh each table mapping in numerical order. For example, if you want InfoSphere CDC to refresh your DEPARTMENT table before refreshing the EMPLOYEE table, then you can add a group for each of these table mappings and move the DEPARTMENT table in group 1 and the EMPLOYEE table in group 2. See also: To change the refresh order on a table mapping

To change the refresh order on a table mapping


1. Ensure you have ended any active replication on the subscription. 2. When setting up tables that have referential integrity constraints, ensure that the target tables are empty before starting replication. 3. Click Configuration Subscriptions. 4. Select the subscription that contains the mapped source and target tables. 5. Select the table mapping you want InfoSphere CDC to refresh first in the Table Mappings view. 6. Right-click and click Change Refresh Order. 7. Click Add New Group to add the first group-Group 1. Repeat this step for as many groups you want to add. Note: Any remaining table mappings that you did not add to a group are refreshed by InfoSphere CDC last. Related concepts Changing the refresh order on a table mapping Selecting a new journal table on page 139 Ending replication on a subscription on page 198

Changing the replication method of a table mapping


Your subscription can contain table mappings that have a combination of replication methods: Mirror or Refresh. You can change the replication method of one or more of your table mappings within a subscription. Before you can change the replication method, if you are mirroring the source table to the target, then you need to end replication on the subscription. See also: To change the replication method of a table mapping on page 138 Related concepts Table Mappings view (Monitoring perspective) on page 10 Starting mirroring on a subscription on page 197 Ending replication on a subscription on page 198

Managing table mappings

137

To change the replication method of a table mapping


1. 2. 3. 4. 5. 6. Ensure you have ended any active replication on the subscription. Click Configuration Subscriptions. Select the subscription that contains the mapped source and target tables. Select the table mapping in the Table Mappings view. Right-click and click Change Replication Method. Enable one of the following: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. Note: If you are replicating your source table using InfoSphere CDC for Oracle Trigger-based edition and decide to change the replication method from Mirror to Refresh, then InfoSphere CDC disassociates the journal table from the source table. This was the journal table you had selected in the Map Tables wizard. After InfoSphere CDC completes the refresh operation on the subscription, if you want InfoSphere CDC to continue mirroring changes from this source table using the same journal table, then you must change the replication method back to Mirror and select the same journal table you were using before. v Prevent Recursionprevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM Technical Support to implement bidirectional replication in your environment. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC Event Server will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source.

138

InfoSphere Change Data Capture Management Console: Administration Guide

Selecting a new journal table


InfoSphere CDC for Oracle Trigger based edition uses journal tables to detect and replicate database changes to the target table. If you have mapped your source and target tables and have enabled Mirror (Change Data Capture) in the Map Tables wizard, then you have already selected a journal table. InfoSphere CDC creates this table and uses it to track the database operations that occur on your source system. Each time there is a new row-level operation on your source table, a trigger executes in response to the database operation and InfoSphere CDC reads the journal table to identify the database operation that occurred. InfoSphere CDC then scrapes the database operation from the journal table and replicates it to the target. If you want to change the journal table you had selected in the Map Tables wizard, then you must change the replication method to Refresh so that InfoSphere CDC can disassociate the journal from the source table. You can then change the replication method back to Mirror and select a new journal table that you want InfoSphere CDC to use. See also: To select a new journal table

To select a new journal table


1. 2. 3. 4. 5. Ensure you have ended replication on the subscription. Click Monitoring Subscriptions. Select the subscription that contains the mapped source and target tables. Right-click, click Show Table Mappings. Select a table mapping.

6. Right-click, click Change Replication Method. 7. Enable Refresh. This disassociates the journal table from the source table. If you are using this same source table in other subscriptions, then you must set the replication method to Refresh for these subscriptions as well. InfoSphere CDC disassociates the journal table from the source table in each subscription. 8. Click OK. The table mapping should have a replication method and status of Refresh/Refresh. 9. Select the same table mapping and click Change Replication Method. 10. Enable Mirror. This lets you select a new journal table. 11. Choose one of the following options and click OK. v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC Event Server creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table.
Managing table mappings

139

Namelists the name of the journal table. Related concepts Ending replication on a subscription on page 198 Selecting a new journal table on page 139 Mapping tables on page 91

Setting members for replication


iSeries environments supports a table concept known as multi-member files, in which one table can possess several different members. Each member is part of the same table and shares the same schema, but the members are uniquely named and have unique data. If you have installed InfoSphere CDC for AS/400 and have multi-member source tables, then you can select the members you want InfoSphere CDC to replicate. See also: To select a member for replication

To select a member for replication


1. 2. 3. 4. Ensure you have ended replication on the subscription. Click Configuration Subscriptions. Select the subscription that contains the mapped source and target tables. Right-click, click Show Table Mappings.

5. Select a table mapping. 6. Right-click, click Set Member Replication. 7. You can choose from one of the following: v All current and future membersEnables InfoSphere CDC to replicate all members, including members you may add a future point in time. v Selected members onlyEnables InfoSphere CDC to only replicate the members you selected. Related concepts Setting members for replication

Deleting table mappings


You can delete table mappings that belong to a particular subscription. Before deleting a table mapping, you need to end replication on the subscription that contains the table mapping you want to delete. If the subscription uses InfoSphere CDC Event Server as the target datastore and you have mapped your source table to both a JMS message destination and a staging target table, then you are provided with the option to delete either mapping. See also: To delete a table mapping To delete a table mapping (InfoSphere CDC Event Server) on page 141

To delete a table mapping


1. Ensure you have ended replication on the subscription. 2. Click Configuration Subscriptions. 3. Select the subscription that contains the mapped source and target tables.

140

InfoSphere Change Data Capture Management Console: Administration Guide

4. Select the table mapping in the Table Mappings view. 5. Right-click and click Delete Table Mappings. Related concepts Ending replication on a subscription on page 198

To delete a table mapping (InfoSphere CDC Event Server)


1. Click Configuration Subscriptions. 2. Select a subscription that contains the table mapping to a message destination, to a staging target table, or both. Ensure you have ended replication on the subscription. 3. Select the table mapping in the Table Mappings view. 4. Right-click and click Delete Table Mappings. 5. If you have mapped your source table to both a message destination and a target staging table, you will be presented with the following options: v Delete message destination mappingenable this option if you want to unmap your source table from a JMS message destination. v Delete staging target mappingenable this option if you want to unmap your source table from a staging target table. 6. If you have mapped your source table to either one of a message destination or a staging target table, then click Yes to the confirmation message. Related concepts Ending replication on a subscription on page 198

Updating the definition of mapped source and target table in a subscription


Once you change the structure of a source or mapped target table, you must update the definition of the table so that subscriptions are aware of the new structure. v Updating the definition of a source tableif you change the definition of a source table (add a new column, set column constraints, or new foreign key dependencies), then you have to update the definition of the table in Management Console. Management Console requires you to update the source table so that the new structure is available for configuration when editing your table mapping details. For example, if you have added a new column on the source table, then you may want to map this new column to a target column. v Updating the definition of a target tableif you change the definition of a target table (add a new column, set column constraints, or new foreign key dependencies), then you need to update the definition of the target table in Management Console. Management Console requires you to update the target table so that the new structure is available for configuration when editing your table mapping details. For example, if you have added a new column on the target table, then you may want to map a source column to the target column. See also: To update the definition of a source table on page 142 To update the definition of a target table on page 142

Managing table mappings

141

To update the definition of a source table


1. 2. 3. 4. 5. 6. 7. Click Configuration Subscriptions. Select the subscription that contains the mapped source and target tables. In the Table Mappings area, select and right-click on the table mapping. Select Update Table Definition Source Table. Click End Replication on each active subscription. Click Update. If you want to restart mirroring on the subscription, you need to synchronize your source and target tables so that InfoSphere CDC can set a log position.

Note: As a best practice, you should verify your mapping details. If you have added a new column and you want InfoSphere CDC to replicate data from this column, then you need to map that column to the target. Related concepts Flagging a source table for a refresh on page 135 Updating the definition of mapped source and target table in a subscription on page 141 Mapping source columns to target columns on page 157

To update the definition of a target table


1. Click Configuration Subscriptions. 2. Select a subscription. 3. In the Table Mappings area, select and right-click on the table mapping. 4. Select Update Table Definition Target Table. 5. Click End Replication on each active subscription. 6. Click Update. Note: As a best practice, you should verify your table mapping details. If you have added a new column to your target table and you want InfoSphere CDC to replicate data to the column, then you need to map a source column to the new target column. Related concepts Mapping source columns to target columns on page 157 Updating the definition of mapped source and target table in a subscription on page 141

142

InfoSphere Change Data Capture Management Console: Administration Guide

Customizing JMS message destination mappings


After mapping your tables using the Map Tables wizard, you can use the XML Message tab to customize which columns you want to map to XML elements and attributes. You can build your XML message and XPath expressions, import and export mapping projects, import/export XML schemas, and query columns from other tables if required. This tab is only available for subscriptions targeting a JMS message destination. In this section, you will learn: Creating an XML message Importing and exporting XML files, schemas, and mapping projects on page 144 Building an XPath expression on page 146 Querying columns from other tables on page 147

Creating an XML message


You can create an XML message by mapping source columns to XML elements and attributes. See also: To create an XML message

To create an XML message


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select the subscription that contains the table mapping to a message destination. Ensure you have ended any active replication on the subscription. 4. Click the Table Mappings view and select the table mapping. 5. Right-click Edit Mapping Details. 6. Click the XML Message tab. 7. Expand the Source tree and build the structure of the XML message in one of the following ways: v If you want the XML message to have the same structure as your source table, then you can drag and drop the entire source table to the root (/) node of the XML Document Structure area. This method retains mappings between source columns and XML elements and attributes. v If you have an existing XML structure, then you can import the structure into the XML Document Structure area. v You can manually build the XML structure using the options provided in the XML Document Structure area: Add an XML element
Copyright IBM Corp. 2008

143

Add an XML attribute Rename an element or attribute Move an XML element or attribute up and down the result tree Change the node type to either XML element or attribute 8. For each XML element or attribute you have mapped to a source column, verify the following options from the Output area: v Alwaysindicates that if the value of an XML element or attribute is empty, then InfoSphere CDC Event Server includes the XML element or attribute in the XML message and sets the value to an empty string. This occurs when you have mapped an XML element or attribute to a source column that is blank, or when you have mapped the XML element or attribute to a source column that contains a derived expression that results to an empty string. v Output when empty or NULLindicates that if the value of an XML element or attribute is mapped to a source column that is empty or NULL, then the XML element or attribute is not included in the XML message. v Optional when NULLindicates that if the value of an XML element or attribute is mapped to a source column that is NULL, then the XML element or attribute is not included in the XML message. However, if the XML element or attribute is mapped to a source column that contains an empty string, then InfoSphere CDC Event Server includes the XML element or attribute in the XML message. 9. Verify the XPath expression for each mapping in the Value area. When you map a source column to an XML element or attribute, you are mapping the value of the source column to an XML element or attribute. This value is represented as an XPath expression in the Value area. If necessary, you can edit the expression using the Expression editor. 10. Click Apply. Related concepts Importing and exporting XML files, schemas, and mapping projects Related tasks To build an XPath expression on page 146 To end replication on page 199

Importing and exporting XML files, schemas, and mapping projects


You can import XML files into Management Console. You can also import and export XSD files and XTRANS files created in Management Console. v Importing XML filesyou may have already created an XML file using an editor outside of Management Console. You can import this XML file and continue mapping source columns to elements and attributes in Management Console. When importing XML files, you can choose to import repeated elements and/or choose to import attribute values into . v Importing and exporting XSD filesyou may want to import the schema of an XML message into Management Console when it is necessary to generate an XML document using a specific structure. When importing the schema, the structure of the XML document is displayed the XML Document Structure area in Management Console. You can then continue to map source columns to XML elements or attributes to create values and build XPath expressions if required. The XPath expression identifies the XML element or attribute that contains the value of a source column. You can also export the schema. This may be necessary when another department or organization requires the schema.

144

InfoSphere Change Data Capture Management Console: Administration Guide

Importing and exporting XTRANS filesyou can export the mapping definition of your XML document with values to your local computer. You can later reuse the mapping definition for other XML documents by importing it back into Management Console. It is important to note that any preexisting mappings between source columns to XML elements and attributes in Management Console are replaced with the imported mapping definition.

See also: To import an XML, schema, or mapping definition file To export an XML schema or mapping definition file

To import an XML, schema, or mapping definition file


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select the subscription that contains the table mapping to a message destination. 4. Click the Table Mappings view and select the table mapping. 5. Right-click Edit Mapping Details. 6. Click the XML Message tab. 7. Click and from the Files of Type list, select one of the following: v Schema fileimports the structure of the XML document. v Mapping definitionimports an XML document with mapped source column to XML element and attribute values. The values in the mapping definition replace any preexisting mappings of your XML document in Management Console. v XML fileimports an XML document. If you are importing an XML file, then the XML Import Options dialog box opens and you can enable one or both of the following options: Import repeated elements with the same parentBy default, Management Console imports only one repeated element in a group node with the same parent. Enable this option to import all repeated elements. Import attribute valuesBy default, Management Console imports only the structure of your XML. Enable this option to import the attribute values. This may be necessary if attribute values represent the structure of your XML document. 8. Click Apply. Related concepts Importing and exporting XML files, schemas, and mapping projects on page 144

To export an XML schema or mapping definition file


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database.
Customizing JMS message destination mappings

145

3. Select the subscription that contains the table mapping to a message destination. 4. Click the Table Mappings view and select the table mapping. 5. Right-click Edit Mapping Details. 6. Click the XML Message tab. Ensure you have created the structure of an XML message that you can export. 7. Click and from the Save as Type list, select one of the following: v Schema file (XSD)exports only the structure of the XML document. This includes the name of the element, attribute, and the tree structure. Any pre-existing mapping definitions are not exported. v Mapping definition (XTRANS)exports the structure of the XML document and the mapping definition you created in Management Console. 8. Click Save. Related concepts Importing and exporting XML files, schemas, and mapping projects on page 144

Building an XPath expression


When you launch the Expression Builder, you can build an XPath expression to reference a source column (the before or after image), a journal control field, a function, a literal value in single quotes, or a combination of these. For more information about XPath expressions, see http://www.w3.org/TR/xpath. See also: To build an XPath expression

To build an XPath expression


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select the subscription that contains the table mapping to a message destination. 4. Click the Table Mappings view and select the table mapping. 5. Right-click Edit Mapping Details. 6. Click the XML Message tab. Ensure you have an existing XML structure you can build an expression for in the XML Document Structure area. 7. Select an XML element or attribute for which you want to build an XPath expression and double-click the Value area to open the Expression Builder. 8. You can build an expression using a combination of one or more of the following items: FunctionsYou can specify functions and a location path for your XPath expression. v OperatorsYou can use operators to build your expression. For more information about a specific function or operator, press F1. v

146

InfoSphere Change Data Capture Management Console: Administration Guide

DatabaseRepresents the source database and lists all the nodes (such as source columns and journal control fields) in your source table. Select the node you want to search for, double-click it to add to the Expression box. You can repeat this process for all the nodes you want to add to the expression. v Target XML DocumentRepresents the XML document that you want to send to the JMS queue or topic. v Saved expressionsLists any saved expressions you have built. Your XPath expression can reference these. 9. Click Validate to verify the expression and click OK. v The XPath expression should now reference the before or after image of the column, a function, a literal or a combination of each of these. Related concepts Building an XPath expression on page 146

Querying columns from other tables


The XML message want to send may depend on columns from other tables. You can query these columns from other databases for which you have configured a JDBC connection or from tables in the InfoSphere CDC Event Server staging database. See also: To query columns from other tables

To query columns from other tables


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select the subscription that contains the table mapping to a message destination. 4. Click the Table Mappings view and select the table mapping. 5. Right-click Edit Mapping Details. 6. Click the XML Message tab. 7. Expand the Other Tables tree. 8. Click Add Tables. 9. Choose one of the following: v Add table as top level nodeenable when you want the other table to reside at the node level. v Add table as a child of another tableenable when you want the table to reside as the child of another table. You must add a parent table before you can add a child table. 10. Click Next. 11. Select the table you want to add. This can be from a database you have configured a JDBC connection for or from the InfoSphere CDC Event Server staging database. 12. Choose one of the following:
Customizing JMS message destination mappings

147

v Click Next to continue with the wizardenable when you want the wizard to create the SQL statement for you based on the columns in the other table. You can modify the SQL statement in the SQL Expression editor. v Click Finish to add the table and open the SQL editorenable when you want to create your own SQL statement in the SQL Expression editor. 13. If you had enabled the Click Finish to add the table and open the SQL editor option, click Finish. The SQL Expression Editor opens and you are required to build a valid SQL expression. When you have completed building the SQL statement, you must map this expression to an XML element or attribute in your XML document. When you start replication, InfoSphere CDC Event Server will retrieve data values from the table based on your query. Otherwise, click Next to continue build your SQL statement with the help of the wizard. 14. On the Select Clause page, review the columns in your select statement. If you want to add more columns, click Add. Specify a name for the column and the column or expression you want InfoSphere CDC Event Server to retrieve. Note: You can modify the name to an alias name. With SQL, aliases can be used for column names and table names. If you specify an alias for the column name, the SELECT statement will retrieve the column and return the result with the alias name you specified. 15. Click OK and click Next. 16. On the WHERE Clause page, you can choose to add filters to restrict which rows are returned by the query. The where clause is optional. Omitting the WHERE clause from your SQL statement specifies that all rows are returned by the query. If you want to create a WHERE clause, click Add to enable the fields required to build your WHERE clause statement. Your WHERE clause can return one of the following values: v Static valuesto build your WHERE clause so that it returns a static value, select Value from the Type list and specify the value in the Value box. v The before image or the after image of a rowto build your WHERE clause so that it returns the before image or the after image of the column, select Trigger from the Type list and then select either the before image or the after image of the column from the Value list. Also, if you want InfoSphere CDC Event Server to detect any missing before images or after images, then enable the If before/after image does not exist, then use other image check box. For example, if you map the before image of a column to an XML element or attribute and the operation on the source database was an insert, then because there is no before image of that column, InfoSphere CDC Event Server inserts the after image of the column instead when you enable this check box. Also, if you map the after image of a column to XML element or attribute and the operation on the source database was a delete, then because there is no after image of a delete operation, InfoSphere CDC Event Server inserts the before image of that column instead. v The column of a parent tableto build your WHERE clause so that it returns the column of the parent table, select Parent Table Column from the Type list and then select the column name from the Value list. This option is only available if the table is added a child of a parent table. 17. Click Next.

148

InfoSphere Change Data Capture Management Console: Administration Guide

18. On the GROUP BY clause page, group the results by one or more columns. The GROUP BY clause is optional. When specified, it can be used in a SELECT statement to collect data across multiple rows. 19. Click Next. 20. On the ORDERED BY clause page, sort the records in your result set. The ORDER BY clause is optional. You can order the result set in either ascending or descending order. 21. Click Finish. Related concepts Querying columns from other tables on page 147

Customizing JMS message destination mappings

149

150

InfoSphere Change Data Capture Management Console: Administration Guide

Setting JMS message header properties


Only available for subscriptions targeting a JMS message destination, you can use the XML Settings tab to set JMS message header properties for the XML message. These properties are saved on the source table to XML mapping and are valid each time you send the XML message to a queue or topic. You can edit these values using the expression editor at any time. In addition to the JMS header properties provided with InfoSphere CDC Event Server, you may also need to associate extra information in the header of an XML message. InfoSphere CDC Event Server lets you specify custom JMS header properties in an XML message. You can use this information in a JMS selector to filter messages. In this section, you will learn: Defining the JMS message header Setting general runtime options on page 153 Selecting a character encoding on page 154

Defining the JMS message header


You can add and delete JMS message header properties. You can also add or delete custom properties that you create. See also: To add a JMS message header property To add a custom JMS message header property on page 152 To delete a custom JMS message header property on page 152

To add a JMS message header property


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select the subscription that contains the table mapping to a message destination. 4. Click the Table Mappings view and select the table mapping. 5. Right-click Edit Mapping Details. 6. Click the XML Settings tab. 7. Select one of the following in the Standard Settings area. v JMS Correlation IDprovides a way to correlate related messages. This is normally used for a request or response scenario. This can either be a vendor-specific ID, an application-specific string, or a provider-native byte value. v JMS Priorityindicates the priority at which the JMS server will handle the message. By default, InfoSphere CDC Event Server assigns a priority of

Copyright IBM Corp. 2008

151

4. JMS uses a priority scale from 0 to 9, where 0 indicates the lowest priority and 9 indicates the highest priority. v JMS Reply Tocontains a destination supplied by a client when a message is sent. If you want to receive a response from the JMS queue or topic when either of these destinations receive a message, then specify the destination. v JMS Time to Livespecifies the number of milliseconds that you want the XML message to remain in the queue or topic. This value is used by your JMS provider to delete XML messages automatically once the amount of time specified in the box expires. The default value is 0, which indicates that the XML message will never be deleted automatically from the queue or topic. v JMS Typespecifies the type of message you are sending. This could be the name of the queue or topic. Your JMS provider can use a message repository that contains the definition of messages sent by third party applications. You should enter a symbolic value that can be configured to the values defined in the current providers message repository. 8. Click to open the expression editor and set a value for the JMS property. 9. Specify a value (enclose the value in quotation marks) or an expression for the JMS property and click Verify . 10. Click OK and Apply. Related concepts Setting JMS message header properties on page 151

To add a custom JMS message header property


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select the subscription that contains the table mapping to a message destination. 4. Click the Table Mappings view and select the table mapping. 5. 6. 7. 8. Right-click Edit Mapping Details. Click the XML Settings tab. Click Add. Type the name of the JMS property and click OK.

9. Click to set a value in the Expression editor. 10. Click OK. 11. Click Apply. Related concepts Setting JMS message header properties on page 151

To delete a custom JMS message header property


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions.

152

InfoSphere Change Data Capture Management Console: Administration Guide

3. 4. 5. 6. 7.

Ensure you have created a subscription that uses the Event Server datastore as the target database. Select the subscription that contains the table mapping to a message destination. Click the Table Mappings view and select the table mapping. Right-click Edit Mapping Details. Click the XML Settings tab. Select the JMS property you want to delete in the Custom Settings area.

8. Click Delete. 9. Click Apply. Related concepts Setting JMS message header properties on page 151

Setting general runtime options


You can set the following runtime options: v Trim textby default, InfoSphere CDC Event Server does not trim white spaces before and after character strings. You can enable this so that InfoSphere CDC Event Server trims the text. v Nullable XPath expressionby default, InfoSphere CDC Event Server differentiates between empty strings and a null value. Most XML parsers return an empty string if a referenced node does not exist in the source table. This results in no distinction between an empty string and a null value. However, InfoSphere CDC Event Server can differentiate a real empty string (the node does exist, but contains an empty value) from a null value (the referenced node does not exist at all). Disable this option if you do not want InfoSphere CDC Event Server to distinguish between empty strings and a null value. v Streamed transformation modeby default, InfoSphere CDC Event Server uses IBMs Streamed XML Transformation (XST). Disable this check box if you want InfoSphere CDC Event Server to use the Document Object Model (DOM) instead. The XST technology will dynamically switch parsing mode between (Simple API for XML) SAX and DOM depending on your transformation requirements. This may affect the performance but may be necessary in some cases. See also: To enable InfoSphere CDC Event Server to trim text To disable InfoSphere CDC Event Server from differentiating between an empty string from a NULL value on page 154 To disable streamed transformation mode on page 154

To enable InfoSphere CDC Event Server to trim text


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select the subscription that contains the table mapping to a message destination. 4. Click the Table Mappings view and select the table mapping.
Setting JMS message header properties

153

5. 6. 7. 8.

Right-click Edit Mapping Details. Click the XML Settings tab. Enable the Trim Text check box. Click Apply. Related concepts Setting general runtime options on page 153

To disable InfoSphere CDC Event Server from differentiating between an empty string from a NULL value
1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select the subscription that contains the table mapping to a message destination. 4. Click the Table Mappings view and select the table mapping. 5. Right-click Edit Mapping Details. 6. Click the XML Settings tab. 7. Disable the Nullable XPath expression check box. 8. Click Apply. Related concepts Setting general runtime options on page 153

To disable streamed transformation mode


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select the subscription that contains the table mapping to a message destination. 4. Click the Table Mappings view and select the table mapping. 5. Right-click Edit Mapping Details. 6. Click the XML Settings tab. 7. Disable the Enable streamed transformation mode check box. 8. Click Apply. Related concepts Setting general runtime options on page 153

Selecting a character encoding


Select the encoding scheme you want InfoSphere CDC Event Server to use when saving a mapping. You can select encodings based on character set requirements. By default, InfoSphere CDC Event Server uses 8-bit UCS/Unicode Transformation Format (UTF-8). You can also add your own character set to the list. See also:

154

InfoSphere Change Data Capture Management Console: Administration Guide

To select a character encoding

To select a character encoding


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select the subscription that contains the table mapping to a message destination. 4. Click the Table Mappings view and select the table mapping. 5. Right-click Edit Mapping Details. 6. Click the XML Settings tab. 7. Choose a character encoding from the Project File Encoding list. 8. Click Apply. If you want to add your own character encoding, type the name of the encoding in the box Related concepts Selecting a character encoding on page 154

Setting JMS message header properties

155

156

InfoSphere Change Data Capture Management Console: Administration Guide

Mapping columns
After mapping your tables using the Map Tables wizard, you can use the Column Mappings tab to customize what items you want to map to target columns in a subscription. If you have mapped your tables using any mapping type, then most or all of your target columns are already mapped to source columns that have identical names and attributes. However, using the Columns Mappings tab, you can customize the kind of information you want to map to a target column and populate it with. In this section, you will learn: Mapping source columns to target columns Mapping journal control fields to target columns on page 158 Mapping expressions to target columns on page 158 Mapping source and target columns automatically on page 160 Mapping initial values to target columns on page 161 Adding and mapping derived columns to target columns on page 162

Mapping source columns to target columns


Manually map any remaining target columns left by the Map Table wizard so that they are populated with data during replication activities. For example, the Map Tables wizard may have left certain target columns unmapped if the column names between the source and target tables did not match, or if the data types between columns are not compatible. See also: To map a source column to a target column

To map a source column to a target column


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. 4. Right-click and select Edit Mapping Details. You may see target columns that are not mapped to any source columns. These target columns are mapped with an initial default value such as BLANK, CURRENT DATE, NULL, and so on. 5. Click the Column Mappings tab. 6. Expand the Source Columns list and select a source column. 7. Drag and drop the source column to the Source area to map it to a target column. 8. Click Apply. When you start replication on the subscription, InfoSphere CDC populates the target column with data from the source column. Note: You can map source columns to target columns only if the data types between both are compatible. To view the data types of each column in a table, enable the Show Column Data Types check box.
Copyright IBM Corp. 2008

157

Related concepts Mapping source columns to target columns on page 157 Starting and ending replication on subscriptions on page 197

Mapping journal control fields to target columns


Journal control fields let you populate a target column with system information about the inserts, updates, or deletes taking place on your source tables. If you decide to map a journal control field to a target column, then each time there is a change in your source table, InfoSphere CDC translates the journal control field into system information and populates this information into the mapped target column during replication. For example, you may want to audit the name of the user that inserts a row in a source table. To capture this information in a target column, map the &USER journal control field to the appropriate target column. Journal control fields are especially useful when you want to audit the changes that are taking place in your source environment. These are available to you when you select LiveAudit as your mapping type. See also: To map a journal control field to a target column Related concepts About journal control fields on page 245 Mapping using LiveAudit on page 100

To map a journal control field to a target column


1. Click Configuration Subscriptions. 2. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Column Mappings tab. Expand the Journal Control Fields list and select a journal control field that is compatible with the data type of the target column. 7. Drag and drop the journal control field to Source area to map it to a target column. 8. Click Apply. When you start replication on the subscription, InfoSphere CDC populates the target column with system information. Related concepts Mapping journal control fields to target columns 3. 4. 5. 6.

Mapping expressions to target columns


Mapping expressions to a target columnExpressions are stored and evaluated on target columns. For example, you can create an expression that: v Converts integer data on the source column to character data using the column function %TOCHAR. An expression such as %TOCHAR(OrderID, 6) would convert integer data to a string of six characters in the source column OrderID so that it is compatible with the target column that you want to populate. v Calls a stored procedure that you have configured in a user exit program. You can specify an expression that contains a valid call to the %STPROC column

158

InfoSphere Change Data Capture Management Console: Administration Guide

manipulation function. If you are calling a stored procedure that is not owned by the InfoSphere CDC user, you must provide the name in the form <schema>.<stored procedure name>. Mapping accumulation and deduction expressions to a target columnIf you have mapped your tables using Summarization in the Map Tables wizard, then you can map accumulation or deduction expressions to a target column. When you map tables for summarization, the target table is largely a repository of numerical data increments or decrements in response to source row-level operations transferred by refresh or mirroring activity. For example, if you have a target column such as REVENUE and you want the value in this column to increment each time a product gets sold in the SALESAMOUNT source column, then you can map SALESAMOUNT to REVENUE. Drag and drop the source column from the list beside the target column to which you want to map. See also: To map an expression to a target column To accumulate or deduct numeric data on a target column Related concepts Mapping to summarize data on page 113 Related tasks To configure a derived column or an expression that calls %STPROC (Oracle and Sybase) on page 218

To map an expression to a target column


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. 4. Right-click and select Edit Mapping Details. 5. Click the Column Mappings tab. 6. Expand the Expressions list and drag and dropNew Expression to the target column you want to map. 7. Build an expression. 8. Click Save to save the expression. You should see the expression mapped to the target column on the Column Mappings tab. 9. Click Apply. When you start replication, InfoSphere CDC evaluates the expression on the target column. Related concepts Mapping expressions to target columns on page 158

To accumulate or deduct numeric data on a target column


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. This should be mapped for Summarization. 4. Right-click and select Edit Mapping Details. 5. Click the Column Mappings tab.
Mapping columns

159

6. Depending on which source columns you want to summarize data, map your source columns to target columns. 7. Expand the Summarization list and drag and drop eitherAccumulation or Deduction expressions on the source and target column mapping. You can also build an expression that summarizes data. 8. Select the source column and clickOK. Depending on how you want to summarize data, the source column in the list updates with a plus or minus sign. 9. Click Apply. When you start replication on the subscription, InfoSphere CDC accumulates or deducts the summarized data in response to row-level operations occurring on the source table. Related concepts Mapping expressions to target columns on page 158

Mapping source and target columns automatically


Use the Map Columns Automatically dialog box to customize how you want to map source and target columns. For example, you may have wanted to map a particular target column to a source column, but because the column names did not match, the Map Tables wizard did not map them as you wanted. The Map Tables wizard cannot map a source column such as LOC to the target column LOCATION. Instead, you can map columns using a different mapping mode based on criteria such as ordinal position. See also: To map columns automatically Related concepts Column Mappings tab on page 7

To map columns automatically


1. 2. 3. 4. 5. 6. Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Column Mappings tab. Click Auto Map.

7. Enable one of the following mapping modes: v Original positionmaps columns based on changes made on the Column Mapping tab before you opened the Map Columns Automatically dialog box. v Ordinal positionmaps columns based on the order of columns in the source and target tables. The first column in the target table is mapped to the first column in the source table, the second column in the target table is mapped to the second column in the source table, and so on. If the number of columns in the target table is greater than the number of the columns in the source table, then initial values are used for trailing columns in the target table. If the number of columns in the source table is greater than the number of columns in the target table, then trailing columns in the source table remain unmapped. You can only map by ordinal position provided the data types are compatible.

160

InfoSphere Change Data Capture Management Console: Administration Guide

v Name to namemaps columns based on matching column names. For example, if a column in the source table is called EMPNAME, then this column is automatically mapped to the column in the target table called EMPNAME. v Name to descriptionmaps columns based on matching target column names in source column descriptions. This is useful when you are working on an iSeries database platform and you need to map the source table names to target columns. 8. Click OK. 9. Click Apply. You should see your target columns mapped in the mode you selected on the Column Mappings tab. When you start replication on the subscription, InfoSphere CDC populates the target columns using the mapping mode you set. Related concepts Mapping source and target columns automatically on page 160

Mapping initial values to target columns


Use the Column Mappings tab to map initial values to unmapped target columns. After you have mapped your tables using the Map Tables wizard, there may be target columns that remain unmapped. Target columns can remain unmapped if the source and target column names do not match, or if there is a greater number of target columns than source columns. For these target columns, you can define an initial value such as a constant to populate the target column, or use the default value of the target column as specified in your RDBMS. See also: To define an initial value for a target column

To define an initial value for a target column


Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Column Mappings tab. You should see an unmapped target columns. 6. Place your cursor beside the target column that you want to populate with an initial value, and click the Initial Value column. 1. 2. 3. 4. 5. to open the Set Initial Value dialog box. 7. Click 8. Enable one of the following: v ConstantPopulates the target column with a constant. The constant is limited to 25 characters. If you select this option, you need to type a constant in the Constant box. v NullPopulates the target column with a null value. The data type of the target column must be nullable. v BlankPopulates the target column with a blank character. The data type of the target column must be character or a binary data type.

Mapping columns

161

v ZeroPopulates the target column with a value of zero. The data type of the target column must be numeric. v Database DefaultPopulates the target column with the default specified in your RDBMS. Whenever a row gets inserted into the target table, the value that populates this column is determined from the column defaults defined in your RDBMS. v Current DatePopulates the target column with the current date. The data type of the target column must be datetime. If your subscription uses InfoSphere CDC for z/OS as a target datastore, and you have mapped your tables using the LiveAudit mapping type, then both the before image and the after image of an update operation are populated with the same current date. 9. Click OK. 10. Click Apply. When you start replication on the subscription, InfoSphere CDC populates this target column with the initial value you specified. Related concepts Mapping initial values to target columns on page 161

Adding and mapping derived columns to target columns


Derived columns let you move the processing of an expression from the target system to the source system. For example, you may have already defined an expression that concatenates the values of two source columns, FIRSTNAME and LASTNAME, and mapped this expression to a target column named called FULLNAME. When you start replication, InfoSphere CDC evaluates the expression on the target system and stores the results in the FULLNAME target column. However, it may become necessary in your environment to move the processing of this expression to the source system. Using this same example, you can build a derived column on the source table named FULLNAME and define an expression that concatenates the values of the two source columns FIRSTNAME and LASTNAME. You can then map the derived column named FULLNAME to the target column named FULLNAME. When you start replication, InfoSphere CDC evaluates the expression on the source system and sends the results to the target column. You can also create a derived column to: v Extract characters from string data by using functions such as %SUBSTRING, and then store the result in a derived column. For example, you can extract a persons initial from a column named FIRSTNAME, by using the expression SUBSTRING(FIRSTNAME,1,1). v Call a stored procedure that you have configured in a user exit program. You can specify an expression that contains a valid call to the %STPROC column manipulation function. If you are calling a stored procedure that is not owned by the InfoSphere CDC user, you must provide the name in the form <schema>.<stored procedure name>. v Retrieve information from a lookup table using %GETCOL. You can create a derived column on the source table using %GETCOL so that you can retrieve data from a lookup table. You can then map the source table using one-to-many consolidation.

162

InfoSphere Change Data Capture Management Console: Administration Guide

In each of these scenarios, you can then map the derived column to the appropriate target column. InfoSphere CDC will evaluate the expression on the source table and send the results to the target column. See also: To add a derived column To map a derived column to a target column on page 164 To modify a derived column on page 164 To delete a derived column on page 165

To add a derived column


1. Click Configuration Subscriptions. 2. Select the subscription. 3. 4. 5. 6. 7. 8. 9. 10. 11. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Column Mappings tab. Expand the Source Columns list, double-click New Derived Column. Type a name for the derived column in the Name box. This name must be unique. Type a brief description of the derived column in the Description box. Select a data type of the result from the Data Type list. Type the maximum length for the returned value in the Length box. Select an evaluation frequency:
Description Select this option when you want InfoSphere CDC to evaluate the expression in the derived column for the after image of the source table. Select this option when you want InfoSphere CDC to evaluate the expression in the derived column for both the before and after images of the source table.

Option After Image Only

Before and After Images

12. 13. 14. 15.

For performance reasons, evaluate the After Image Only value. An evaluation frequency of Before and After Images (*BTH) is only necessary when you are performing conflict detection and resolution, which requires the before image to recognize conflicts, or when you are auditing so that you can audit the full before image. You also need to select this evaluation frequency if the target column to which you mapped the derived column is a primary key column. This maintains database integrity. Click Editor to build the expression for the derived column. Click Verify to verify the syntax of the expression. Click OK to return to the Define Derived Column dialog box. Click OK.

16. Click Apply. You should see the new derived column listed in the Source Columns list of the Column Mappings tab. You can map this derived column to a target column so that InfoSphere CDC can populate the results of the derived column in the target column.
Mapping columns

163

Notes: v If you already have a source column in your RDBMS on which you want to base the properties of your derived column, click Copy Column and select the column from the list of tables. The properties of this column (the data type, length, and any precision) are used as the properties of your derived column. v Derived columns and the expressions you build for them are evaluated on source tables. v Since the derived expression is evaluated each time a change is replicated to the target table, the complexity of the expression can affect overall performance.

To map a derived column to a target column


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. 4. Right-click and select Edit Mapping Details. 5. Click the Column Mappings tab. 6. Expand the Source Columns list, and drag and drop the derived column and map it to the appropriate target column. 7. Click Apply to save your mapping. When you start replication on the subscription, InfoSphere CDC populates the target column with the results stored in the derived column. Related concepts Adding and mapping derived columns to target columns on page 162 Related tasks To add a derived column on page 163 To modify a derived column To delete a derived column on page 165

To modify a derived column


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. 4. Right-click and select Edit Mapping Details. 5. Click the Column Mappings tab. 6. Expand the Source Columns list, select and right-click on an existing derived column and click Modify Derived Column. 7. Make the necessary changes and click OK. 8. Click Verify to ensure the expression is valid. 9. Click Apply. When you start replication on the subscription, InfoSphere CDC populates the target column with the results stored in the derived column. Related concepts Adding and mapping derived columns to target columns on page 162 Related tasks To add a derived column on page 163 To delete a derived column on page 165

164

InfoSphere Change Data Capture Management Console: Administration Guide

To delete a derived column


Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Column Mappings tab. Expand the Source Columns list, select and right-click on an existing derived column and click Delete Derived Column. 7. Click Apply. Related concepts Adding and mapping derived columns to target columns on page 162 Related tasks 1. 2. 3. 4. 5. 6. To end replication on page 199 To add a derived column on page 163 To modify a derived column on page 164

Mapping columns

165

166

InfoSphere Change Data Capture Management Console: Administration Guide

Filtering rows and columns


Use theFiltering tab to include or exclude rows or columns for replication. In this section, you will learn: Filtering rows Selecting critical columns to filter rows on page 168 Filtering columns on page 168

Filtering rows
In order to include or exclude particular rows for replication, you need to build a row-filtering expression. All row-filtering expressions that you define must return a boolean result. For example, you may have a source column such as SALARY that maintains the salary for each employee in your organization. You may only want to replicate those rows to the target table for those employees that have a salary greater than $48,000. In this scenario, you would need to define a row-filtering expression (SALARY > 48000). You can use column manipulation functions, basic numeric operators, and SQL SELECT WHERE clauses in your row-filtering expressions. The following are examples of valid row-filtering expressions: v (SALES < 10000) OR (SALES > 90000) v ((AIRPORT = JFK) OR (AIRPORT = LAX)) v %IF(COUNTRY = US, PRODUCTPRICE, PRODUCTPRICE *1.2) > 50 v PRODUCTPRICE * (1 + TAX) > 20000 See also: To filter rows

To filter rows
Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Filtering tab. Click Editor and build a row-filtering expression. The expression must return a boolean result. 7. Click Verify to check the syntax of the expression and click OK to return to the Filtering tab. 8. Choose one of the following options in the Row-filtering area: v Select rows that match the expressionSelect this option if you want InfoSphere CDC to replicate the source rows that satisfy your row-filtering expression. v Omit rows that match the expressionSelect this option if you want InfoSphere CDC to select for replication all rows except those that satisfy your row-filtering expression. 1. 2. 3. 4. 5. 6.
Copyright IBM Corp. 2008

167

9. Click Apply. When you start replication on the subscription, InfoSphere CDC excludes this column for replication. Related concepts Filtering rows on page 167

Selecting critical columns to filter rows


When you start replication on the subscription, InfoSphere CDC replicates the row based on the criteria you specified in your row-filtering expression. By default, InfoSphere CDC replicates inserts, updates, and deletes to the target table during replication. However, you can control the updates that InfoSphere CDC replicates using the select critical column feature. When you select a column as critical, InfoSphere CDC only replicates update operations when any critical column has changed value. For example, you may have a source table that maintains customer account information. Instead of receiving every update made to the source table, you may only want to receive the row when the customer account balance is updated. In this scenario, you would select the column (Customer_Account_Balance) as a critical column. InfoSphere CDC will only replicate this row when there are updates made to the Customer_Account_Balance column. See also: To select critical columns

To select critical columns


1. Click Configuration Subscriptions. 2. 3. 4. 5. 6. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Filtering tab. Select the columns you want to set as critical in theCritical check box.

If you are using InfoSphere CDC for AS/400 on the source, then you need to enable the Critical Column Filtering system parameter to *YES. Related reference Critical Column Filtering on page 452

Filtering columns
By default, InfoSphere CDC replicates all mapped source columns to the target table. If there is a source column you want to exclude for replication, then you can clear it on the Filtering tab. Excluding source columns for replication may become necessary if the column contains confidential information that you do not want the target to receive. See also: To filter columns on page 169

168

InfoSphere Change Data Capture Management Console: Administration Guide

To filter columns
Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Filtering tab. Source columns that you can clear for replication are selected with a green check mark in the Replicate column. 6. If you do not want InfoSphere CDC to replicate data from a source columns, then clear the green checkmark for that column. 7. Click Apply. 1. 2. 3. 4. 5. Note: You cannot clear a source columns from replication if you have already mapped them to target columns. You need to unmap the source column on the Column Mappings tab. When you start replication on the subscription, InfoSphere CDC excludes this column for replication. Related concepts Filtering columns on page 168

Filtering rows and columns

169

170

InfoSphere Change Data Capture Management Console: Administration Guide

Setting data translations on column mappings


Use the Translation tab to add, modify, and delete a data translation. When you add a data translation and start replication, InfoSphere CDC converts data from the source columns into the new data you set for a mapped target column. You can also import and export data translations. In this section, you will learn: Setting data translations Importing and exporting data translations on page 173

Setting data translations


Management Console lets you translate specific data in your source columns to new data to mapped target columns. For example, you may have a source column called CITY that has data such as NY, TO, and LON and want these codes translated to a target column in their full names (New York, Toronto, and London). By specifying data translations, you can convert specific data values during data replication. You can define data translations for different data types and should only be used when there is a limited number of translations, such as translating product codes to their descriptions. If you need to convert numerical or date information (where the number of possible data types are limitless), it is best to use an appropriate column function or write a user exit program to convert this kind of information. Before adding a data translation, consider the following: v You can add a data translation for columns that contain integer data. However, InfoSphere CDC does not support translations that convert to and/or from fractional data. For example, InfoSphere CDC supports translations to and/or from 1 and 100, but does not support translations to and/or from 1.01 and 100.01. If you use fractional data to represent whole numbers (for example, 1.0 and 100.0), then InfoSphere CDC translates these whole numbers if you have defined corresponding integer translations (for 1 and 100 respectively). You can add a data translation only if the target column is already mapped to a source column. You cannot add data-to-data translations for target columns with large object (LOB) data types. If you have created a subscription that targets a InfoSphere CDC Event Server datastore, then you can only add a data translation for source columns that are mapped to target staging columns. You cannot set a data translation for source columns that are mapped to XML elements and attributes.

v v v

See also: To add a data translation on page 172 To modify a data translation on page 172 To delete a data translation on page 173
Copyright IBM Corp. 2008

171

Related tasks To add a data translation To modify a data translation To delete a data translation on page 173 To import a data translation on page 173 To export a data translation on page 174

To add a data translation


1. 2. 3. 4. Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details.

5. Click the Translation tab. 6. Select a mapped source and target column. 7. ClickAdd. 8. Type the data you want to translate in the From box. 9. If you want to translate a NULL data type, then check the Translate from NULL box. 10. Type the value to which you want to translate, in the To Value box. 11. If you want to translate to a NULL value, check the Translate to NULL box. 12. If you want to add another translation, ClickAdd. 13. Click OK to add the translation to your list of data translations. When you start replication on the subscription, InfoSphere CDC converts the value in the source column to the value you specified, and populates the mapped target column with the converted value. Related concepts Mapping tables on page 91 Starting and ending replication on subscriptions on page 197

To modify a data translation


1. 2. 3. 4. 5. 6. 7. Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Translation tab. Select an existing translation that you have added and clickModify. Make the necessary changes and clickOK.

When you start replication on the subscription, InfoSphere CDC converts the value in the source column to the value you specified, and populates the mapped target column with the converted value. Related concepts Mapping tables on page 91 Starting and ending replication on subscriptions on page 197

172

InfoSphere Change Data Capture Management Console: Administration Guide

To delete a data translation


1. 2. 3. 4. 5. 6. Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Translation tab. Select an existing data translation and ClickDelete. Related concepts Mapping tables on page 91 Starting and ending replication on subscriptions on page 197

Importing and exporting data translations


You can import and export data translations for mapped source and target columns. It may be necessary to export a data translation when you know of multiple column mappings that require the same translation. Instead of manually specifying the translation for each column mapping, you can import the data translation and apply it for each column mapping. When you import a data translation into Management Console, any existing translations are replaced with the imported translations. See also: To import a data translation To export a data translation on page 174

To import a data translation


1. 2. 3. 4. 5. 6. 7. 8. 9. Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Translation tab. Select a mapped source and target column. Ensure you have exported a data translation for this mapping. ClickImport. Locate the CSV file and clickOK.

Notes: v If you want to apply the data translation to the column mapping, select the translation and clickApply. v When you import a data translation into Management Console, any existing translations are replaced with the imported translations. Related concepts Importing and exporting data translations Related tasks To export a data translation on page 174

Setting data translations on column mappings

173

To export a data translation


1. 2. 3. 4. 5. 6. 7. 8. 9. Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Translation tab. Select a mapped source and target column. Ensure you have added a data translation for this mapping. Click Export. Save the data translation as a CSV file and clickOK. Related concepts Importing and exporting data translations on page 173 Related tasks To import a data translation on page 173

174

InfoSphere Change Data Capture Management Console: Administration Guide

Setting multibyte and Unicode character set conversions


If you have installed InfoSphere CDC Version 6.0 or higher, then you can specify how InfoSphere CDC converts character sets on source columns during replication. For other InfoSphere CDC products, you can specify how InfoSphere CDC handles Unicode character encodings during replication. In this section, you will learn: Setting multibyte conversionscommon scenarios Converting multibyte character sets Handling Unicode character encodings on page 176

Setting multibyte conversionscommon scenarios


Use the following scenarios as guidelines when you want to perform encoding conversions.

Scenario 1: Converting character sets between iSeries and DB2 UDB


In this scenario, you may have a configuration with consistent character sets, but the source that contains the character set is an iSeries system, and the target that contains the other character set is a Windows system. For example, you may want to convert from Simplified Chinese on your source to Simplified Chinese on the target. Note: Because of the encoding differences between platforms, it is important to note that not all characters will convert with equivalent characters.

Scenario 2: Converting from national language character set to Unicode


In this scenario, you may have a configuration in which data needs to be converted from a national language character set to Unicode. For example, the character set on the source is in a character set such as Chinese, and the character set on the target to which you want to convert is Unicode. Related concepts Converting multibyte character sets Handling Unicode character encodings on page 176 Resolving conflicts for source or target wins on page 189 Mapping using Adaptive Apply on page 110

Converting multibyte character sets


Use the Translation tab to set conversion on multibyte character sets. During replication, InfoSphere CDC converts the character set. Multibyte character sets (MBCSs) are an alternative to Unicode for supporting character sets, such as Japanese and Chinese, that cannot be represented in a single byte. If you are replicating data for an international market, consider using Unicode or MBCS. InfoSphere CDC supports single, double, multibyte national language character sets, and Unicode.
Copyright IBM Corp. 2008

175

Management Console provides standard character sets and encodings. If you want to add more character sets and encodings, then you need to add it to the CSV (comma separated variable) template. Conversion of multibyte character sets is supported on InfoSphere CDC Version 6.0 or higher. See also: To convert multibyte character sets

To convert multibyte character sets


Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Translation tab. Select the source column that supports a multibyte character set encoding. This enables the Encoding Conversion area. 7. Select the character encoding of the data stored in your source column from the Source list. For example, if your data is stored in Chinese characters, then you can select from either Traditional or Simplified encodings. 8. Select the character encoding to which you want to convert from the Target list. For example, you may be replicating your data to an organization that stores their data in the Unicode version of Chinese characters. 9. Click Apply. 1. 2. 3. 4. 5. 6. When you start replication on the subscription, InfoSphere CDC converts the character encoding in the source column to the encoding you specified and populates the mapped target column with data in the new encoding. Related concepts Converting multibyte character sets on page 175

Handling Unicode character encodings


Use the Translation tab to set how InfoSphere CDC handles data from the source column. If your source column contains character data stored in multibyte, double-byte, or Unicode character set, then you can indicate how InfoSphere CDC handles data from this source column when replicating to a target column. Management Console provides standard character sets and encodings. If you want to add more character sets and encodings, then you need to add it to the CSV template. Before you can set how InfoSphere CDC handles data, you need to set the Unicode Handling system parameter to one of the following: v CHARInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v NOCHANGEInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this encoding when Unicode columns contain

176

InfoSphere Change Data Capture Management Console: Administration Guide

non-single-byte character data. NOCHANGE ensures that InfoSphere CDC handles non-single-byte character data in the same way as previous InfoSphere CDC releases. See also: To set handling for Unicode character encodings

To set handling for Unicode character encodings


1. 2. 3. 4. 5. Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Translation tab.

6. Select the source column that supports character handling from the Source Columns list. This enables the Encoding Conversion area. 7. Select Character Handling from the Source list. 8. If you have set the system parameter Unicode Handling to use the system default method to handle the character set, select System Default. 9. If you want to use an encoding for the character set, select from one of the following: v CHARSelect this if you have set the system parameter Unicode Handling to CHAR. InfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this encoding when Unicode columns contain single-byte character data. v NOCHANGESelect this if you have set the system parameter Unicode Handling to NO CHANGE. InfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this encoding when Unicode columns contain non-single-byte character data. NOCHANGE ensures that InfoSphere CDC handles non-single-byte character data in the same way as previous InfoSphere CDC releases. 10. Click Apply. 11. Depending on the platform on which you have installed InfoSphere CDC, set one of the following system parameters: v For InfoSphere CDC for AS/400, see Unicode Handling on page 444. v For InfoSphere CDC for Oracle, see UNICODE_HANDLING on page 364. v For InfoSphere CDC for Microsoft SQL Server, see Unicode Handling on page 325. Related concepts Handling Unicode character encodings on page 176 Related reference Unicode Handling on page 444

Setting multibyte and Unicode character set conversions

177

178

InfoSphere Change Data Capture Management Console: Administration Guide

Controlling row operations


Management Console lets you set how a target table responds to changes made on the source table. In this section, you will learn: Suppressing the apply of row operations Preventing the audit of row operations on page 180 Detecting conflicts on row operations on page 181 Enabling the apply of soft deletes (InfoSphere CDC for Oracle) on page 182

Suppressing the apply of row operations


Use the Operations tab to suppress an insert, update, or a delete from replicating to the target table. You may decide to suppress row-level operations from replicating to a target table if you have a target-side application on which you do not want any updates or deletes to occur. For example, if your target-side application is a data warehouse, you may only want inserts to occur on your data warehouse tables or other third party applications. You can suppress operations if you mapped tables using either Standard or Adaptive Apply replication. See also: To suppress an insert, update, or delete Related concepts Mapping using standard replication on page 91 Mapping using Adaptive Apply on page 110

To suppress an insert, update, or delete


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. This table mapping should be configured for Standard or Adaptive Apply replication. Right-click and select Edit Mapping Details. Click the Operation tab. Choose one or more of the following: v Do not insertprevents InfoSphere CDC from applying an insert to a mapped target table. v Do not updateprevents InfoSphere CDC from applying an update to a mapped target table. v Do not deleteprevents InfoSphere CDC from applying a delete to a mapped target table. Click Apply.

4. 5. 6.

7.

Depending on your selections, when you start replication, InfoSphere CDC does not apply the row operation.
Copyright IBM Corp. 2008

179

Related concepts Suppressing the apply of row operations on page 179

Preventing the audit of row operations


Use the Operations tab to prevent InfoSphere CDC from the auditing of row operations. If you have mapped your tables using LiveAudit, then InfoSphere CDC audits row level operations taking place on the source. You can also restrict auditing so that your target table only audits the after image when there is a change to a row in the source table. This is especially useful if you want to reduce the size of your audit trails for recovery purposes. See also: To prevent row operations from being audited To audit only the after image Related concepts Mapping using LiveAudit on page 100

To prevent row operations from being audited


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. This table mapping should be configured for Standard or LiveAudit replication. 4. Right-click and select Edit Mapping Details. 5. Click the Operation tab. 6. Choose one or more of the following: v Do not insertprevents InfoSphere CDC from auditing an insert to a mapped target table. v Do not updateprevents InfoSphere CDC from auditing an update to a mapped target table. v Do not deleteprevents InfoSphere CDC from auditing a delete to a mapped target table. 7. Click Apply. Depending on your selections, when you start replication, InfoSphere CDC does not audit the row operation. Related concepts Preventing the audit of row operations

To audit only the after image


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. This table mapping should be configured for Standard or LiveAudit replication. 4. Right-click and select Edit Mapping Details. 5. Click the Operation tab. 6. Select Audit After Image from the On Update list. 7. Click Apply.

180

InfoSphere Change Data Capture Management Console: Administration Guide

When you start replication, the target table only audits the source table when there is a change made to the after image. Related concepts Preventing the audit of row operations on page 180

Detecting conflicts on row operations


Use the Operations tab to set conflict detection between row operations on the source and target. If you have mapped your tables using Adaptive Apply , then InfoSphere CDC forces the target table into consistency with row-level operations taking place on the source table. However, when InfoSphere CDC applies an insert, update, or delete and it is not the same as the row level operation applied to a target table, then this creates a conflict. For example, you may have inserted a row in the source table, but the resulting row-level operation on the target table is an update because that row already exists in the target table. To ensure that the target table is always consistent with the source table, you can set detection on row-level conflicts. When there is a conflict against an insert, update or a delete operation, InfoSphere CDC generates a message. You can view these messages in the Event Log view. See also: To detect conflicts on row operations Related concepts Resolving conflicts for source or target wins on page 189 Mapping using Adaptive Apply on page 110

To detect conflicts on row operations


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. This table mapping should be configured for Standard or Adaptive Apply replication. 4. Right-click and select Edit Mapping Details. 5. Click the Operation tab. 6. Choose one or more of the following: v On Insertgenerates a message when there is an insert on the source, but the responding row-level operation on the target is an update. Select Update Row if Exists, else insert and check the Log changed database action box. v On Updategenerates a message when there is an update on the source, but the responding row-level operation on the target is an insert. Select Update Row if Exists, else insert and check the Log changed database action box. v On Deletegenerates a messages when there is a delete on the source, but there is no responding row-level operation to apply to the target. Select Delete Row if Exists and check the Log changed database action box. 7. Click Apply. Related concepts Resolving conflicts for source or target wins on page 189 Detecting conflicts on row operations

Controlling row operations

181

Enabling the apply of soft deletes (InfoSphere CDC for Oracle)


You can introduce a flag that audits the current state of an existing target table which indicates that a row has been deleted (this is called a soft delete) instead of actually deleting the row (a hard delete). If you have mapped your target tables using Adaptive Apply, then you can enable InfoSphere CDC for Oracle to apply a soft delete on the target table. This means that when there is a delete on the source table, InfoSphere CDC either: v updates a row on the target table if the row exists, or v inserts a row on the target table if it does not exist. When InfoSphere CDC applies the soft delete, the target table will contain: v the before image of the row that was deleted and v the journal entry type Delete. Depending on whether you want InfoSphere CDC for Oracle to apply the soft delete to all mapped target tables or to apply the soft delete on a specific target table in the subscription, you must enable one of the following system parameters: v DM_ADAPTIVE_APPLY_SOFT_DELETESInfoSphere CDC for Oracle applies a soft delete on all target tables mapped using Adaptive Apply in a subscription. v DM_ADAPTIVE_APPLY_<SCHEMA>.<TABLENAME>InfoSphere CDC for Oracle applies a soft delete on a specific target table mapped using Adaptive Apply in a subscription. See also: To enable InfoSphere CDC for Oracle to apply a soft delete

To enable InfoSphere CDC for Oracle to apply a soft delete


1. Ensure you have set either the DM_ADAPTIVE_APPLY_SOFT_DELETES system parameter or the DM_ADAPTIVE_APPLY_<SCHEMA>.<TABLENAME> system parameter to ON. 2. Click Configuration Subscriptions. 3. Select the subscription. 4. Click the Table Mappings view and select the table mapping. This table mapping should be configured for Standard or Adaptive Apply replication. 5. Right-click and select Edit Mapping Details. 6. Click the Operation tab. 7. Choose Delete Row, if exists from the On Delete list. 8. Click Apply. Related reference DM_ADAPTIVE_APPLY_SOFT_DELETES on page 359 DM_ADAPTIVE_APPLY_<SCHEMA>.<TABLENAME> on page 360

182

InfoSphere Change Data Capture Management Console: Administration Guide

Controlling table operations


By default, InfoSphere CDC truncates the target table in response to a table-level clear or refresh operation. You can control this so that InfoSphere CDC preserves all or some of the rows. In this section, you will learn: Controlling the apply of refresh operations Specifying SQL to control refresh operations on page 184

Controlling the apply of refresh operations


Use the Operations tab to control how InfoSphere CDC applies table-level clear or refresh operations to a target table. You can do this if you have mapped your tables using one of Standard, Adaptive Apply, Summarization, or Consolidation. Also, if you have mapped your tables using LiveAudit, then you can specify that InfoSphere CDC provide an audit trail each time there is an table-level clear or refresh operation applied to the target table. See also: To keep all rows on a refresh To delete all rows on a refresh on page 184 To audit rows on a refresh on page 184

To keep all rows on a refresh


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. This should be mapped for Standard, Adaptive Apply, or Summarization. 4. Right-click and select Edit Mapping Details. 5. Click the Operation tab. 6. From the On Clear/Truncate list, select Do Not Delete. 7. Click Apply. When you start a refresh on a table mapping, InfoSphere CDC does not delete the rows in the target table. Related concepts Mapping using standard replication on page 91 Mapping using LiveAudit on page 100 Mapping using Adaptive Apply on page 110 Mapping to summarize data on page 113 Starting a refresh on a subscription on page 198 Controlling the apply of refresh operations

Copyright IBM Corp. 2008

183

To delete all rows on a refresh


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. This should be mapped for Standard, Adaptive Apply, or Summarization. 4. Right-click and select Edit Mapping Details. 5. Click the Operation tab. 6. From the On Clear/Truncate list, select Delete All. 7. Click Apply. Note: When you start a refresh on the table mapping, InfoSphere CDC deletes all the rows in the table in response to a table clear or refresh operation. Related concepts Mapping using standard replication on page 91 Mapping using Adaptive Apply on page 110 Mapping to summarize data on page 113 Starting a refresh on a subscription on page 198

To audit rows on a refresh


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. This should be mapped for LiveAudit. 4. Right-click and select Edit Mapping Details. 5. Click the Operation tab. 6. From the On Clear/Truncate list, select Audit. 7. Click Apply. Note: When you start a refresh on the table mapping, InfoSphere CDC audits the table-level clear or refresh operations applied to the target table. Related concepts Mapping using standard replication on page 91 Mapping using LiveAudit on page 100 Mapping using Adaptive Apply on page 110 Mapping to summarize data on page 113 Starting a refresh on a subscription on page 198

Specifying SQL to control refresh operations


By default, InfoSphere CDC deletes all rows in the target table in response to a table-level clear or refresh operation. Use the Operation tab to specify a SQL WHERE clause that restricts the rows you want InfoSphere CDC to delete in response to a table clear or refresh operation. InfoSphere CDC only deletes or truncates the rows for which the condition is true. For example, you may want to use the WHERE clause to delete rows from the supplier table. The SQL statement SupplierName= IBM would delete all rows from the supplier table where the SupplierName is IBM.

184

InfoSphere Change Data Capture Management Console: Administration Guide

You can also specify additional SQL statements that execute after InfoSphere CDC applies a table refresh or truncate/clear operation to the target table. For all InfoSphere CDC products (except for InfoSphere CDC for z/OS and InfoSphere CDC for DB2 UDB), you need to run the DMSQL command to enable the Additional SQL feature in Management Console. For more information, see the commands section of the appropriate InfoSphere CDC End-User Documentation for your InfoSphere CDC product. If you have installed InfoSphere CDC for z/OS, then you need to set the keyword ALLOWSQL to YES to enable theAdditional SQL feature in Management Console. You can add this keyword to the TSDDBMxx Configuration Control data set member. For more information about this keyword, see Section 4.3 Modifying DBMS LOAD Configuration Control Statements in the InfoSphere CDC for z/OS End-User Documentation. If you have installed InfoSphere CDC for DB2 UDB, then you need to create a metadata table to enable the Additional SQL feature in Management Console. For more information, see InfoSphere CDC for DB2 UDB End-User Documentation. Before issuing SQL statements in Management Console, consider the following: v If you are referencing a database, table, or column name that contains spaces, then you must enclose the name in square brackets. For example, to reference the table name EMP NY, you must enter it as [EMP NY]. v If your delete WHERE clause references a character column, the specified value must be enclosed in single quotes. For example, MGR = Anna Kim. v You cannot reference LOB columns in delete WHERE clauses. v Specify only SQL INSERT, UPDATE, and DELETE statements. v SQL statements must be 4,000 bytes or less in length. If you specify SQL statements that do not fit on one line, do not press the Enter key to break the statements over more than one line. The text will feed automatically to the next line. v No support for logical branching and iteration. v The database running on the target server must recognize the syntax of the SQL statements. v Separate multiple SQL statements by semi-colons (;). If a character string in a SQL statement contains a semi-colon, specify two semi-colons consecutively (;;) in the string. v Management Console does not verify SQL statements for syntactical correctness. The target DBMS verifies statements during replication. See also: To specify additional SQL after a refresh To delete selected rows on a refresh on page 186

To specify additional SQL after a refresh


1. 2. 3. 4. 5. Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Operation tab.
Controlling table operations

185

6. From the On Clear/Truncate list, select Delete Selected Rows. 7. Click Additional SQL. 8. If you want InfoSphere CDC to execute SQL after a truncate operation, then type SQL statement in the SQL Immediately After Truncate box. 9. If you want InfoSphere CDC to execute SQL after a refresh operation, then type SQL in the SQL Immediately After Refresh box. 10. Click OK to save your changes. 11. Click Apply. Note: If InfoSphere CDC encounters an error during execution of a SQL statement, it ignores all remaining statements. Also, depending on the system parameters you have set, InfoSphere CDC either continues or ends data replication in response to the error. Related concepts Specifying SQL to control refresh operations on page 184 Related tasks To delete selected rows on a refresh

To delete selected rows on a refresh


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. 4. Right-click and select Edit Mapping Details. 5. Click the Operation tab. 6. From the On Clear/Truncate list, select Delete Selected Rows. 7. Click Editor to specify a SQL WHERE clause for the selected rows. 8. Expand the Target Columns list and select the target columns on which you want to restrict deletions. 9. Click Verify to make sure the SQL WHERE clause is valid and click OK. 10. Click Apply to apply the SQL WHERE clause to your subscription. Note: When you start a refresh on the table mapping, InfoSphere CDC deletes only those rows for which you have specified a SQL statement. Related concepts Specifying SQL to control refresh operations on page 184 Starting a refresh on a subscription on page 198

186

InfoSphere Change Data Capture Management Console: Administration Guide

Setting member identifiers


iSeries environments supports a table concept known as multi-member files, in which one table can possess several different members. Each member is part of the same table and shares the same schema, but the members are uniquely named and have unique data. If you have installed InfoSphere CDC for AS/400 on your source system and want to replicate a multi-member source table to a single-member target table, then you need to identify each member in the source table. InfoSphere CDC requires an identifier so that it does not truncate rows when it applies a refresh to a single-member target table. If you do not specify an identifier for your multi-member source table, then each time InfoSphere CDC applies a refresh to the single-member target, the member data on the target is overwritten by data from another member. In this section, you will learn: Setting member identifiers for multi-member source tables

Setting member identifiers for multi-member source tables


You can add, modify, or delete member identifiers when you have installed InfoSphere CDC for AS/400 on your source system and you are replicating a multi-member source table to a single-member target table on any platform. Before adding a member identifier, you need to create a column on the target table that can maintain the identifiers for the members in your source table. After creating the target column, map the journal control field &MEMBER to this column. See also: To add a member identifier To modify a member identifier on page 188 To delete a member identifier on page 188

To add a member identifier


1. 2. 3. 4. 5. 6. Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Operation tab. Click Member Identifiers. Member Identifiers is only enabled if you have mapped an iSeries multi-member source table to a single-member target table on any platform. Click Add. Type the name of the member for which you want to add an identifier in the Member Name box. Expand the Target Columns tree and double-click to select the target column you want to include in the member identifier WHERE clause. Click Verify to make sure the expression is valid and click OK.

7. 8. 9. 10.
Copyright IBM Corp. 2008

187

You can continue adding identifiers for each member in your source table. 11. Click OK. 12. Click Apply. Related concepts Setting member identifiers for multi-member source tables on page 187

To modify a member identifier


1. 2. 3. 4. 5. Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Operation tab.

6. Click Member Identifiers. 7. Click Modify. 8. Make the necessary changes and clickOK. You can continue making changes to other member identifiers or click OK to save your changes. 9. Click Apply. Related concepts Setting member identifiers for multi-member source tables on page 187

To delete a member identifier


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. 4. 5. 6. 7. 8. 9. Right-click and select Edit Mapping Details. Click the Operation tab. Click Member Identifiers. Select the member identifier that you want to delete and click Delete. Click OK to save your changes. Click Apply. Related concepts Setting member identifiers for multi-member source tables on page 187

188

InfoSphere Change Data Capture Management Console: Administration Guide

Setting conflict detection and resolution


Conflict detection and resolution lets you detect, log, and act on inconsistent data on the target. This ensures your replication environment handles data conflicts automatically and in accordance with your business rules. Set conflict detection so that InfoSphere CDC can detect and resolve conflicts as they occur. As conflicts are detected and resolved, InfoSphere CDC logs them in a conflict resolution audit table. During replication, InfoSphere CDC detects conflicts when you: v Insert a row and the rows key already exists in the target table. This violates the unique key constraint. v Update a row and the rows key does not exist in the target table. v Update a row and the contents of the rows in the source table and target table, before the update, do not match. v Delete a row and the rows key does not exist in the target table. v Delete a row and the contents of the rows in the source table and target table, before the delete, do not match. InfoSphere CDC does not detect conflicts in target columns that are: v Populated with expressions using the %BEFORE, %CURR, %GETCOL, %STPROC, and %USER column functions. v Populated with journal control fields. v Not populated by a value. Notes: v InfoSphere CDC does not detect conflicts in columns that have Large Object (LOB) data types. v Conflict detection and resolution is only available when you map your tables using Standard replication. Conflict detection and resolution is supported for InfoSphere CDC Version 5.3 and higher. In this section, you will learn: Resolving conflicts for source or target wins Resolving conflicts for largest or smallest value wins on page 191 Resolving conflicts with user exits on page 194

Resolving conflicts for source or target wins


Resolving conflicts for source wins
Use the Conflicts tab to set conflict detection and resolution so that the source wins. When InfoSphere CDC resolves conflicts so that the source column wins, it applies the row from the source table to the target table. This ensures the target table row matches the data in your source table upon replication. For example, a remote location ships 100 books and updates their INVENTORY table to the latest quantity of the books. When InfoSphere CDC attempts to replicate the update to the target table, it detects a conflict because there is no row to update. In this scenario, InfoSphere CDC resolves the conflict by inserting the row from the source
Copyright IBM Corp. 2008

189

to the target.

Resolving conflicts for target wins


Use the Conflicts tab to set conflict detection and resolution so that the target wins. When InfoSphere CDC resolves conflicts for target wins, it does not apply any source changes to the target table. This preserves the row in the target table as InfoSphere CDC does not apply data from the source in the event of a conflict. For example, a remote location ships 25 pens and reduces the quantity of their pens to 175. Before starting replication with InfoSphere CDC, a clerk accidently changes the quantity of the pens to 300 on the target table. If InfoSphere CDC is configured to resolve conflicts for target wins, then no change is made to the target table and it is the same both before and after replication.

Note: Conflict detection and resolution is only available when you map your tables using Standard replication. Conflict detection and resolution is supported for InfoSphere CDC version 5.3 and higher. See also: To resolve conflicts for source row wins To resolve conflicts for target row wins on page 191 Related concepts Resolving conflicts for source or target wins on page 189 Mapping using standard replication on page 91

To resolve conflicts for source row wins


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. This should be mapped for Standard replication. 4. Right-click and select Edit Mapping Details. 5. Click the Conflicts tab.

190

InfoSphere Change Data Capture Management Console: Administration Guide

The Target Column displays all of the columns in the target table. 6. Select the columns on which you want to detect conflicts. 7. Select Source Wins from the Conflict Resolution Method list. 8. Click Apply. When you start replication on the subscription, if InfoSphere CDC detects a conflict in the target column, the source data is replicated to the target. Note: Conflict detection and resolution is only available when you map your tables using Standard replication. Conflict detection and resolution is supported for InfoSphere CDC version 5.3 and higher. Related concepts Resolving conflicts for source or target wins on page 189 Mapping using standard replication on page 91

To resolve conflicts for target row wins


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. This should be mapped for Standard replication. 4. Right-click and select Edit Mapping Details. 5. Click the Conflicts tab. The Target Column displays all of the columns in the target table. 6. Select the columns on which you want to detect conflicts. 7. Select Target Wins from the Conflict Resolution Method list. 8. Click Apply. When you start replication on the subscription, if InfoSphere CDC detects a conflict in the target column, the source data is replicated to the target. Note: Conflict detection and resolution is only available when you map your tables using Standard replication. Conflict detection and resolution is supported for InfoSphere CDC version 5.3 and higher. Related concepts Resolving conflicts for source or target wins on page 189 Mapping using standard replication on page 91

Resolving conflicts for largest or smallest value wins


Use the Conflicts tab to set conflict detection and resolution so that the largest value wins or the smallest value wins.

Resolving conflicts for largest value wins


When InfoSphere CDC resolves conflicts for largest value wins, it applies the change to the target if the source row has a larger value than the corresponding row on the target table. For example, if the comparison column contains revision times, then the target row matches the row that was most recently updated (largest time value). When resolving conflicts for largest value wins, InfoSphere CDC treats NULL values as the smallest possible value. If the row does not exist on the target table,
Setting conflict detection and resolution

191

then InfoSphere CDC uses NULL as the comparison value. If InfoSphere CDC detects the conflict while deleting a row, then it uses the before image of the source table and compares it to the target value. If both the source and target values are the same, then InfoSphere CDC resolves the conflict using the Target Wins method (no change is applied to the target).

Resolving conflicts for smallest value wins


When InfoSphere CDC resolves conflicts for smallest value wins, it only applies the change to the target if the value in the source row is smaller than the corresponding row on the target table. For example, if the comparison column contains quantities, then InfoSphere CDC matches the target row with the row that has the smaller quantity.

When resolving conflicts for smallest value wins, InfoSphere CDC treats NULL values as the smallest possible value. If the row does not exist on the target table, then InfoSphere CDC uses NULL as the comparison value. If InfoSphere CDC detects the conflict while deleting a row, then it uses the before image of the source table and compares it to the target value. If both the source and target values are the same, then InfoSphere CDC resolves the conflict using the Target Wins method (no change is applied to the target). If both the source and target values are the same, then InfoSphere CDC resolves it using the Target Wins method (no change is applied to the target). Note: Conflict detection and resolution is only available when you map your tables using Standard replication. Conflict detection and resolution is supported for InfoSphere CDC version 5.3 and higher. See also: To resolve conflicts for largest value wins on page 193 To resolve conflicts for smallest value wins on page 193 Related concepts Mapping using standard replication on page 91

192

InfoSphere Change Data Capture Management Console: Administration Guide

To resolve conflicts for largest value wins


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. This should be mapped for Standard replication. 4. Right-click and select Edit Mapping Details. 5. Click the Conflicts tab. The Target Column displays all of the columns in the target table. 6. Select the target columns on which you want to detect conflicts in the Detect Conflicts area. 7. Select Largest Value Wins from the Conflict Resolution Method list. 8. Select the column on the target table that you want to compare to the row on the source table from the Value Comparison Column . 9. Click Apply. When you start replication on the subscription, if InfoSphere CDC detects a conflict in the target column, the source data is replicated to the target. Note: Conflict detection and resolution is only available when you map your tables using Standard replication. Conflict detection and resolution is supported for InfoSphere CDC version 5.3 and higher. Related concepts Resolving conflicts for source or target wins on page 189 Mapping using standard replication on page 91

To resolve conflicts for smallest value wins


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. This should be mapped for Standard replication. 4. Right-click and select Edit Mapping Details. 5. Click the Conflicts tab. The Target Column displays all of the columns in the target table. 6. Select the columns on which you want to detect conflicts. 7. Select Smallest Value Wins from the Conflict Resolution Method list. 8. Select the column on the target table that you want to compare to the row on the source table from the Value Comparison Column. 9. Click Apply. When you start replication on the subscription, if InfoSphere CDC detects a conflict in the target column, the source data is replicated to the target. Note: Conflict detection and resolution is only available when you map your tables using Standard replication. Conflict detection and resolution is supported for InfoSphere CDC version 5.3 and higher. For more information on the requirements to configure a user exit program for conflict detection and resolution, see the User Exits section in the InfoSphere CDC documentation for your platform. Related concepts
Setting conflict detection and resolution

193

Resolving conflicts for source or target wins on page 189 Mapping using standard replication on page 91

Resolving conflicts with user exits


Use the Conflicts tab to resolve conflicts with user exit programs.

Resolving conflicts with user exit programs


When InfoSphere CDC resolves conflicts with a user exit program, it applies the image returned by the user exit program to the target table. Configuring a user exit program lets you specify the row you want InfoSphere CDC to use to resolve the conflict on the target table. When your user exit program returns a row, InfoSphere CDC applies that row to the target table to resolve the conflict. For example, a remote location receives a new shipment of erasers with a quantity of 400 and updates their INVENTORY table by inserting a new row. When InfoSphere CDC attempts to replicate the new insert, it detects a conflict because the row already exists in the target table. Since the database administrator has configured a user exit program that: v Receives data from the Eraser row from both the source and target table. v Concatenates values of both tables. InfoSphere CDC resolves the conflict according to the specifications in the user exit program.

Note: Conflict detection and resolution is only available when you map your tables using Standard replication. Conflict detection and resolution is supported for InfoSphere CDC version 5.3 and higher. See also: To resolve conflicts with user exit programs on page 195 Related concepts Mapping using standard replication on page 91

194

InfoSphere Change Data Capture Management Console: Administration Guide

To resolve conflicts with user exit programs


1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. This should be mapped for Standard replication. 4. Right-click and select Edit Mapping Details. 5. Click the Conflicts tab. The Target Column displays all of the columns in the target table. 6. Select the columns on which you want to detect conflicts. 7. Select User Exit from the Conflict Resolution Method list. 8. Type the full path and file name of the user exit program you want to call when InfoSphere CDC detects a conflict in the User Exit (with path) box. 9. Click Apply. When you start replication on the subscription, if InfoSphere CDC detects a conflict in the target column, the source data is replicated to the target. For more information on conflict resolution user exit programs, see the User Exits section in the InfoSphere CDC documentation for your platform. Note: Conflict detection and resolution is only available when you map your tables using Standard replication. Conflict detection and resolution is supported for InfoSphere CDC version 5.3 and higher. Related concepts Resolving conflicts for source or target wins on page 189 Mapping using standard replication on page 91

Setting conflict detection and resolution

195

196

InfoSphere Change Data Capture Management Console: Administration Guide

Starting and ending replication on subscriptions


InfoSphere CDC lets you mirror data from all source tables (using change data capture technology) to mapped target tables. InfoSphere CDC provides two types of mirroring: continuous and net-change mirroring. You can also refresh tables in a subscription. You can manage mirroring on subscriptions from the Monitoring perspective in Management Console. In this section, you will learn: Starting mirroring on a subscription Starting a refresh on a subscription on page 198 Ending replication on a subscription on page 198 Sending XML messages to a JMS message destination on page 199

Starting mirroring on a subscription


v Continuous MirroringInfoSphere CDC applies changes to a target table as they occur (in real-time) on the source table. Continuous mirroring is appropriate when you need the latest information at all times and if your environment experiences frequent changes to large volumes of data. Instead capturing these changes using a batch transfer, you can replicate changes to the target on a continuous basis. v Net-change MirroringInfoSphere CDC accumulates changes that are occurring on the source table at a specific point in time and replicates these changes to the target table. When InfoSphere CDC completes sending the accumulated changes to the target table, net-change mirroring stops. You should use net-change mirroring when it is not necessary to have source and target tables synchronized at all times, and when you want to perform replication during off-peak periods or from a specific point in time. See also: To start continuous mirroring To start net-change mirroring

To start continuous mirroring


1. Ensure the subscription has at least one table mapping with replication method set to Mirror. You set this when mapping tables in the Map Tables wizard. 2. Click Monitoring Subscriptions. 3. Select the subscription. 4. Right-click and select Start Mirroring (Continuous). Related concepts Starting mirroring on a subscription Mapping tables on page 91

To start net-change mirroring


1. Ensure the subscription has at least one table mapping with replication method set to Mirror. You set this when mapping tables in the Map Tables> wizard. 2. Click Monitoring Subscriptions.
Copyright IBM Corp. 2008

197

3. Select the subscription. 4. Right-click and select Start Mirroring (Net-change) . Related concepts Starting mirroring on a subscription on page 197

Starting a refresh on a subscription


When you start a refresh on a subscription, InfoSphere CDC sends a complete copy of the data in a source table to the target table. This operation overwrites any existing rows in the target table. The following list provides some possible scenarios for why you would want to use refresh instead of mirroring: v To create a periodic updated copy of your production environment for testing and development purposes. This is useful when you have promoted a set of subscriptions from a test to a production environment. v To gain performance in your environment. If you have a source table with a very small number of rows that gets a very large number of updates, this may consume a lot of bandwidth. Performing a refresh on these source tables on a weekly, daily, or hourly basis may be the best solution. See also: To start a refresh Related concepts Promoting changes to subscriptions on page 201

To start a refresh
1. Specify the rows on which you want InfoSphere CDC to apply a refresh. You can do this by specifying SQL statements in the Operation tab of Management Console. If you do not specify rows, then InfoSphere CDC refreshes all rows in the target table. 2. Click Monitoring Subscriptions. 3. Select the subscription. 4. Right-click and select Start Refresh. 5. Select the tables you want to refresh. Note: If you have installed InfoSphere CDC for AS/400 or InfoSphere CDC for Microsoft SQL Server, then you need to make sure that there are no changes taking place on the source table while InfoSphere CDC refreshes the target table. Related concepts Controlling the apply of refresh operations on page 183

Ending replication on a subscription


You can end replication on your subscriptions when you want to prepare for any off-line maintenance activities. For example, you may want to start a full backup on a database or perform a regularly scheduled reboot of your server. Ending replication becomes necessary if you want to update and make changes to your subscription by: v Adding a table mapping to the subscription. v Deleting a table mapping from the subscription. v Temporarily removing a table mapping from the subscription (parking a table).

198

InfoSphere Change Data Capture Management Console: Administration Guide

v Modifying mapping details such as source and target column mappings, derived columns, data translations, row and column selections, user exits, and so on. v Updating the properties of a subscription when the structure of your source and/or target tables change. v Synchronizing source and target tables before restarting mirroring. See also: To end replication

To end replication
1. Click Monitoring Subscriptions. 2. Select the subscription. 3. Right-click and select End Replication. 4. Choose one of the following options:
Option Controlled Description Lets InfoSphere CDC complete all in-progress operations and apply pending changes to the target table. Interrupts any current operations. InfoSphere CDC does not apply pending changes to the target table.

Immediate

Sending XML messages to a JMS message destination


For InfoSphere CDC Event Server to send the XML message to a JMS message destination, you must start mirroring on the subscription that contains the table mapping. When you start mirroring on the subscription, InfoSphere CDC Event Server sends a complete copy of all the rows in your source table to the JMS message destination, to the staging target table, or both. The subscription stays active and waits for additional events to occur on the source table. See also: To send an XML message to a JMS message destination or a staging target database

To send an XML message to a JMS message destination or a staging target database


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select the subscription that contains the table mapping to a message destination, a staging target table, or both. 4. Click the Table Mappings view and select the table mapping. Ensure you have set the replication method for this table mapping to Mirror (Change Data Capture).
Starting and ending replication on subscriptions

199

5. Click Monitoring Subscriptions. 6. Select the subscription that contains the table mapping, right-click Start Mirroring. If this is the first time you are starting replication, InfoSphere CDC Event Server sends a copy of all the rows to your message destination, staging target table, or both. After this is complete, it switches to Mirror Continuous. Related concepts Sending XML messages to multiple JMS message destinations on page 226 Related tasks To create an XML message on page 143

200

InfoSphere Change Data Capture Management Console: Administration Guide

Promoting changes to subscriptions


Change management is the process by which you can develop, modify, and retire subscriptions. If your organization has implemented a succession of development stages, then you may want to test your subscriptions before making them available in your production environment. The Promote Subscription wizard promotes the configuration details you set for your table mapping in the Mapping Details area of the Management Console to the new environment. When you are finished promoting your changes, the subscription is relocated into the new environment and uses new source and target datastores. In this section, you will learn: Before you promote a subscription Promoting subscriptions on page 202 Exporting and importing subscriptions on page 205

Before you promote a subscription


You should consider the following points before promoting a subscription: v End replicationensure you have ended replication on the subscription. v Organize subscriptions into projectsorganize the subscription that you want to promote into a project. The purpose of promoting subscriptions is to relocate your subscription from one environment to another. Placing subscriptions into projects are a useful organizational tool to distinguish between an existing and newly promoted subscription. v Review mapping details for the subscriptionensure that you have reviewed mapping details you set for the subscription. These mapping details are promoted to the new environment. InfoSphere CDCManagement Console promotes the properties of your subscription, including the source database, source tables, table mappings, the replication method, source and target column mappings, any notifications you set for the subscription, data translations, and any expressions into the new environment. v Identify database name and owneridentify the database name and owner of the new source database. If you have built an expression on the source such as %GETCOL, then this kind of expression will reference the names of columns from other tables. Before you promote these expressions to the new environment, you should know the name and owner of the new source database that contain the table referenced in the expression. For example, you may have built a derived column on the source that references values from another table located in another database:
%GETCOL(JobTitle, "Northwind.dbo.CustomerData", "Sales Manager")

When promoting expressions to a new environment, the table called CustomerData might exist in another database, other than Northwind. If so, then you need to specify the name of the new source database that contains this table in the Promote Subscription wizard. v Identify the full path name or program name of user exits called by an expressionif you have an expression that calls a stored procedure on the source using the %USER column function, you need to make sure that stored

Copyright IBM Corp. 2008

201

procedure exists in the new source database and specify the location of the stored procedure (for example, the DLL path) in the Promote Subscription wizard. Also, if you have an expression that calls a stored procedure on the target using the %STPROC function, you need to make sure that stored procedure exists in the new target database. You should also know the location (full path) for the stored procedure. Related concepts Promoting changes to subscriptions on page 201 Related tasks To end replication on page 199

Promoting subscriptions
Use the Promote Subscription wizard to promote your subscription to a new environment. For example, you can promote your subscription from a development environment and into a production environment when you are ready to use that subscription in replication activities. Using the Promotion Wizard, you can: v Promote a Subscription to a New Environmentin this scenario, you are promoting a subscription to a new environment. For example, you may have projects that are exclusive for development or testing purposes. You can promote subscriptions into one of these environments. v Promote Changes to an Existing Subscriptionin this scenario, you have made changes to a subscription that has already been promoted to another environment. For example, the subscription may already exist in a project that you have reserved for testing subscriptions, but you may have made some minor changes on the subscription. To make sure the subscription in the test environment includes the changes that you made, you need to promote your changes to the into the testing environment. Note: When promoting changes to an existing subscription, InfoSphere CDC maintains synchronization between your source and target tables and you do not need to set the log position in the new environment. However, if you are making changes that causes you to lose synchronization between your source and target tables (such as updating the definition of a source table), then InfoSphere CDC does not maintain the log position and you will have to resynchronize your source and target tables in the original and in the new environment. For more information on how to synchronize source and target tables in a table mapping, see Flagging a source table for a refresh on page 135. See also: To promote a subscription to a new environment To promote changes to an existing subscription on page 204

To promote a subscription to a new environment


1. Click Configuration Subscriptions. 2. Right-click on a subscription and select Promote Subscription. 3. Select Promote to a new subscription. 4. Type the name of the new subscription in the Name box.

202

InfoSphere Change Data Capture Management Console: Administration Guide

5. Type the description of the new subscription in the Descriptionbox. 6. Select a project for the new subscription from the Project list or click New Project to create a new project. 7. If you want to specify advanced settings for the subscription, click Advanced Settings. Modify the following properties and click OK, then click Next.
Option Source ID Firewall Port TCP Host Description Type the source ID for the new subscription. Type a port number for the new subscription. Specifies the TCP host that your source datastore will use to recognize the target datastore when the computer where InfoSphere CDC is installed has multiple network cards. This is useful if you want to specify a host that is different from the host that you specified in the Access Manager perspective. The default option is Auto-selectwhich will automatically select the network card that can communicate with the target datastore. The host that you specified in theAccess Manager perspective also appears by default as well as any alias that you configured in the Datastore Propertiesdialog box. Propagation Control Click Addand select the source ID for any subscription for which you want to prevent data from being replicated to the target. Specifies that you want to prevent replication from all subscriptions.

Do not replicate data received from any subscriptions

8. Select the name of the new source datastore from the New Source Datastore list. 9. Select the name of the database and owner from the New Name list and click Next. If you have built a derived column on the source that references another table in another database using the %GETCOL column function, specify the name of the database and owner that contains the table that is referenced in the %GETCOL function. Also, make sure that the table referenced in the derived column exists in the new source database. 10. Select the name of the new target datastore from the New Target Datastore list. 11. If you have added an alias for the target datastore that the source system can recognize, then click Advanced Settings and choose a valid alias and click OK. 12. Select the name of the database and owner from the New Name list and click Next. 13. If you have configured expressions with column functions that call user exit programs, such as %USER or %STPROC, then specify the full path that contains the stored procedure, or the name of the user exit program referenced in the expression, then click Next. Make sure that the stored procedure or user exit program already exists in the new source database.
Promoting changes to subscriptions

203

14. If you have built a derived column, an expression, or a row-filtering expression that uses the %SELECT column function, then confirm the list of displayed expressions and click Next. After the promotion, make sure that the table or column referenced in the %SELECT expression exists in the new database. 15. Click View XML to confirm the location and attributes of the promoted subscription. 16. Review the list of changes and click Finish. Note: If you do not select a project, Management Console places the new subscription into the Default Project. Related concepts Before you promote a subscription on page 201 Promoting subscriptions on page 202

To promote changes to an existing subscription


1. Click Configuration Subscriptions. 2. Right-click on a subscription and select Promote Subscription. 3. Select Promote to an existing subscription. 4. Select the subscription to which you want to promote changes from the Promote To list, and click Next. 5. Confirm the source datastore and the name of the database and owner from which you want to promote the changes, then click Next. If you have built a derived column on the source that references another table in another database using the %GETCOL column function, specify the name of the database and owner that contains the table that is referenced in the %GETCOL function. Also, make sure that the table referenced in the derived column exists in the new source database. 6. Confirm the target datastore and the name of the database and owner to which you want to promote the changes, then click Next. 7. If you have configured expressions with column functions that call user exit programs, such as %USER or %STPROC, specify the full path that contains the stored procedure, or the name of the user exit program referenced in the expression, then click Next. Make sure that the stored procedure or user exit program already exists in the new source database. 8. If you have built a derived column, an expression, or a row-filtering expression that uses the %SELECT column function, confirm the list of displayed expressions and click Next. After promotion, make sure that the table or column referenced in the %SELECT expression exists in the new database. 9. Click View XML to confirm the location and attributes of the promoted subscription. 10. Review the list of changes and click Finish. Related concepts Before you promote a subscription on page 201 Promoting subscriptions on page 202

204

InfoSphere Change Data Capture Management Console: Administration Guide

Exporting and importing subscriptions


Using InfoSphere CDC export and import capabilities, you can prepare XML files that include details you have set on your subscription, and you can save these files on your local computer or elsewhere. See also: To import a subscription from an XML file To export a subscription into an XML file

To import a subscription from an XML file


1. 2. 3. 4. Click Configuration Subscriptions. Right-click on a subscription and select Import Subscription. Select an XML file and click Open. Depending on how you want to import the settings of your subscription, select one of the following options:
Description Copies the settings in the XML file into a new subscription. Copies the settings in the XML file into an existing subscription.

Option Import to a new subscription Import changes to an existing subscription

Note: The steps to importing a new or existing subscription are the same as promoting a new or existing subscription. Related concepts Exporting and importing subscriptions Related tasks To promote a subscription to a new environment on page 202 To promote changes to an existing subscription on page 204

To export a subscription into an XML file


1. Click Configuration Subscriptions. 2. Right-click on a subscription and select Export Subscription. 3. Type the name for the XML file and click Save. Related concepts Exporting and importing subscriptions Related tasks To promote a subscription to a new environment on page 202 To promote changes to an existing subscription on page 204

Promoting changes to subscriptions

205

206

InfoSphere Change Data Capture Management Console: Administration Guide

Configuring user exits


A user exit lets you define a set of actions that InfoSphere CDC can run before or after a database event occurs on a specified table. When using InfoSphere CDC, a database event is defined as either a row-level operation or as a table-level operation. Row-level operations include an insert, update, or a delete. Table-level operations include a refresh or a truncate operation. For example, you can configure a row-level user exit program that sends an alert after InfoSphere CDC replicates a delete operation on a particular target table. User exits can be grouped as either a Before User Exit or an After User Exit: v Before User Exitruns before InfoSphere CDC replicates any row-level or table-level operations to the target table. v After User Exitruns after InfoSphere CDC replicates any row-level or table-level operations to the target table. The following list identifies common scenarios for developing a user exit program before or after row or table-level operations: Customize when InfoSphere CDC replicates a row-level operation to the target table. For example, you can develop logic for insert, update, or delete operations so that these occur based on some specified criteria, such as the original invoice date. InfoSphere CDC can run the user exit and apply the row-level operation (insert, update, or delete) to the appropriate target table based on the original invoice date, such as, January 2004, February 2004, November 2006, and so on. v Disable the default row-level or table-level operations, and replace them by invoking a user exit program that performs custom operations. For example, in response to a table-level truncate operation, you can develop a user exit that lets you do a soft delete rather than a hard delete on the target table. v In this section, you will learn: Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB Configuring user exits for InfoSphere CDC for Oracle or InfoSphere CDC for Sybase on page 216 Configuring user exits for InfoSphere CDC for AS/400 (version 6.2 and below) or InfoSphere CDC for z/OS on page 219 Creating a custom data format for IBM WebSphere DataStage on page 220

Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB
You can configure the following types of user exits with InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB: IDispatch COM DLL (InfoSphere CDC for Microsoft SQL Server)You can invoke at run-time a function you defined using IDispatch. When configuring an IDispatch COM DLL user exit,Management Console lets you enable or disable user exits developed for IDispatch. Before you can use Management Console to configure a user exit, you need to do the following in Microsoft SQL Server: v Create the user-defined function.
Copyright IBM Corp. 2008

207

Create the user exit. Extract or build the DLL file and place it in a location. For example, C:\Program Files\Microsoft SQL Server\MSSQL\Binn (or wherever appropriate). v If you are using Visual Basic, you must reference the library dts_usrext.tlb after starting Visual Basic. InfoSphere CDC provides a pre-defined interface (IDTS_UserExit) so that InfoSphere CDC can interact with the server object you define. The interface contains four pre-defined user exit program stubs that you should not modify. As a result, you can only select (not name) the functions that you want to call at the various processing points. For more information, see your user exits documentation for InfoSphere CDC for Microsoft SQL Server. v v C or C++ (InfoSphere CDC for Microsoft SQL Server)you can specify a DLL library that contains the compiled user exit program. Stored Procedure (InfoSphere CDC for Microsoft SQL Server (version 5.3)you can configure a user exit as a stored procedure for InfoSphere CDC for Microsoft SQL Server Version 5.3. Depending on how you have configured the stored procedure, you need to identify temporary or permanent tables so that InfoSphere CDC can populate these tables with the images of the row-level operations applied to the target table. Your stored procedure user exit can then retrieve the image of the row from these tables and use them as required. Stored Procedure (InfoSphere CDC for Microsoft SQL Server (version 6.1))you can configure a stored procedure user exit for InfoSphere CDC for Microsoft SQL Server Version 6.1 and higher. You need to identify the schema that contains the stored procedure and identify the InfoSphere CDC operations on which you want to run the user exit. Java Class (InfoSphere CDC for Microsoft SQL Server (version 6.1), InfoSphere CDC for DB2 UDB)for Java class user exits, method names are pre-defined. This means that you can only enable and disable user exit programs. You need to configure a user exit in java that implements the UserExitIF interface class provided by InfoSphere CDC for DB2 UDB and InfoSphere CDC for Microsoft SQL Server (version 6.0). For more information about this class, see the InfoSphere CDC End-User Documentation for each of these platforms. See also: To configure for IDispatch COM DLL on page 209 To configure for C or C++ on page 210 To configure a stored procedure (Microsoft SQL Server version 5.3) on page 211 To configure a stored procedure (Microsoft SQL Server (version 6.0 and higher) and DB2 UDB (version 6.1 and higher)) on page 213 To configure a derived column or an expression that calls %STPROC (Microsoft SQL Server 6.0 and above and DB2 UBD 6.1 and above) on page 214 To configure a user exit for a Java class on page 214 Related concepts Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207

208

InfoSphere Change Data Capture Management Console: Administration Guide

To configure for IDispatch COM DLL


Note: This information is applicable to InfoSphere CDC for Microsof SQL Server. 1. Click Configuration Subscriptions. 2. Select the subscription. 3. Select the table mapping. 4. Right-click and select Edit Mapping Details. 5. Click the User Exits tab. 6. Select IDispatch COM DLL from the User Exit Type list. 7. Type the name of the class module and project that contains the user exit program that you want run in the DLL Name box. 8. If you want InfoSphere CDC to retrieve the current constant value from the target and pass it to a user exit program that runs before or after InfoSphere CDC replicates an update operation to the target table, then enable Update All Columns. 9. Type the name of the user exit programs you want InfoSphere CDC to call beside one or more of the following operations:
Option Before Insert After Insert Before Update After Update Before Delete After Delete Before Refresh After Refresh Before Truncate After Truncate Description InfoSphere CDC runs the user exit before replicating an insert operation. InfoSphere CDC runs the user exit after replicating an insert operation. InfoSphere CDC runs the user exit before replicating an update operation. InfoSphere CDC runs the user exit after replicating an update operation. InfoSphere CDC runs the user exit before replicating a delete operation. InfoSphere CDC runs the user exit after replicating a delete operation. InfoSphere CDC runs the user exit before replicating a refresh operation. InfoSphere CDC runs the user exit after replicating a refresh operation. InfoSphere CDC runs the user exit before replicating a truncate operation. InfoSphere CDC runs the exist after replicating a truncate operation.

10. Click Apply. In some environments, the target table may contain one or more columns that store user-defined constants. Other applications usually maintain these constant values, and they are not affected by InfoSphere CDC. If you do not enable Update All Columns, then InfoSphere CDC passes the default column value (for example, zero, blank, or NULL) to the user exit program. Due to performance reasons, it is important that you clear this box if you do not need to pass the user-defined constant values. Related concepts

Configuring user exits

209

Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207

To configure for C or C++


Note: This information is applicable to InfoSphere CDC for Microsoft SQL Server. 1. Click Configuration Subscriptions. 2. Select the subscription 3. Click the Table Mappings view and select the table mapping. 4. Right-click and select Edit Mapping Details. 5. Click the User Exits tab. 6. Select C/C++ DLL from the User Exit Type list. 7. Type the full path name of a DLL library that contains the compiled user exit program in the DLL Name box. 8. If you want InfoSphere CDC to retrieve the current constant value from the target and pass it to a user exit program that runs before or after InfoSphere CDC replicates an update operation to the target table, then enable Update All Column. 9. Type the name of the user exit programs you want to call in the Function Name list. 10. Type the name of the user exit programs you want InfoSphere CDC to call beside one or more of the following operations:
Option Before Insert After Insert Before Update After Update Before Delete After Delete Before Refresh After Refresh Before Truncate After Truncate Description InfoSphere CDC runs the user exit before replicating an insert operation. InfoSphere CDC runs the user exit after replicating an insert operation. InfoSphere CDC runs the user exit before replicating an update operation. InfoSphere CDC runs the user exit after replicating an update operation. InfoSphere CDC runs the user exit before replicating a delete operation. InfoSphere CDC runs the user exit after replicating a delete operation. InfoSphere CDC runs the user exit before replicating a refresh operation. InfoSphere CDC runs the user exit after replicating a refresh operation. InfoSphere CDC runs the user exit before replicating a truncate operation. InfoSphere CDC runs the exist after replicating a truncate operation.

11. Click Apply. In some environments, the target table may contain one or more columns that store user-defined constants. Other applications usually maintain these constant values, and they are not affected by InfoSphere CDC. If you do not enable Update All Columns, then InfoSphere CDC passes the default column

210

InfoSphere Change Data Capture Management Console: Administration Guide

value (for example, zero, blank, or NULL) to the user exit program. Due to performance reasons, it is important that you clear this box if you do not need to pass the user-defined constant values. Related concepts Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207

To configure a stored procedure (Microsoft SQL Server version 5.3)


Note: This information is applicable to InfoSphere CDC for Microsoft SQL Server version 5.3. 1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. 4. Right-click and select Edit Mapping Details. 5. Click the User Exits tab. 6. Select Stored Procedure from the User Exit Type list. 7. Type the database owner of the stored procedure, in the Database Owner box. 8. If you have a stored procedure that runs after InfoSphere CDC replicates an update operation to the target table, then provide the name of the temporary or permanent table in the Update Table Image box. During replication, InfoSphere CDC populates this table with the after image of the update operation that was applied to the target. Your stored procedure user exit then retrieves the after image of the row from this table. 9. If you have a stored procedure that requires access to a specific row, then provide the name of the temporary or permanent table in the Key Table Image box. Depending on the kind of row-level operation applied to the target table, InfoSphere CDC populates this table with either the after or before images of the key column data. Your stored procedure user exit then retrieves the after or before image of the key column data from this table. 10. If you have a stored procedure that requires access to journal information for each updated row, then provide the name of the temporary or permanent table in the Journal Table Image box. InfoSphere CDC populates this table with the journal header information. Journal header information includes journal control fields and journal codes that indicate what kind of update was made on the row. For more information about journal control fields, see Using journal control fields for auditing replication activities on page 245. 11. If you have configured a stored procedure that runs before a row-level operation is replicated to the target table, then provide the name of the temporary or permanent table in the Before Table Image box. During replication, InfoSphere CDC populates this table with the before image of the rows in the source table. Your stored procedure user exit then retrieves the before image of the row from this table. Notes: v InfoSphere CDC supports fully qualified image table names to a maximum of 100 characters in length, but database naming restrictions still apply. Note that InfoSphere CDC does not verify whether an image table name
Configuring user exits

211

conforms to a database naming convention. If you are referencing a database or table that contains spaces, then you must enclose the name in square brackets. For example, to reference the table name EMP NY, you must enter it as [EMP NY]. v The image tables and the target tables should reside in different databases to prevent any possibility of locking the database. 12. If you want to create permanent tables using Management Console, then click Create Tables. 13. If you want to retrieve the current constant value (also known as the before or after image of the source row) and pass it to a user exit program that runs before or after a row-level operation is replicated to the target table, then check the Update All Columns box. 14. Type the name of the user exit programs you want InfoSphere CDC to call beside one or more of the following operations:
Option Before Insert After Insert Before Update After Update Before Delete After Delete Before Refresh After Refresh Before Truncate After Truncate Description InfoSphere CDC runs the user exit before replicating an insert operation. InfoSphere CDC runs the user exit after replicating an insert operation. InfoSphere CDC runs the user exit before replicating an update operation. InfoSphere CDC runs the user exit after replicating an update operation. InfoSphere CDC runs the user exit before replicating a delete operation. InfoSphere CDC runs the user exit after replicating a delete operation. InfoSphere CDC runs the user exit before replicating a refresh operation. InfoSphere CDC runs the user exit after replicating a refresh operation. InfoSphere CDC runs the user exit before replicating a truncate operation. InfoSphere CDC runs the exist after replicating a truncate operation.

15. Click Apply. In some environments, the target table may contain one or more columns that store user-defined constants. Other applications usually maintain these constant values, and they are not affected by InfoSphere CDC. If you do not enable Update All Columns, then InfoSphere CDC passes the default column value (for example, zero, blank, or NULL) to the user exit program. Due to performance reasons, it is important that you clear this box if you do not need to pass the user-defined constant values. Related concepts Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207 Related tasks To configure a stored procedure (Microsoft SQL Server (version 6.0 and higher) and DB2 UDB (version 6.1 and higher)) on page 213

212

InfoSphere Change Data Capture Management Console: Administration Guide

To configure a stored procedure (Microsoft SQL Server (version 6.0 and higher) and DB2 UDB (version 6.1 and higher))
Note: This information is applicable to InfoSphere CDC for Microsoft SQL Server (version 6.0 and higher) and InfoSphere CDC for DB2 UDB (version 6.1 and higher). 1. Click Configuration Subscriptions. 2. Select the subscription. 3. Select the table mapping in the Table Mappings view. 4. Right-click and select Edit Mapping Details. 5. Click the User Exits tab. 6. Select Stored Procedure from the User Exit Type list. Note: Use the Stored Procedure - Deprecated option to maintain user exits that were created using InfoSphere CDC for Microsoft SQL Server (version 5.3). Use the Stored Procedure option for all new user exits. 7. Type the name of the schema that contains the stored procedure in the Schema box. 8. Type the name of the user exit programs you want InfoSphere CDC to call beside one or more of the following operations:
Option Before Insert After Insert Before Update After Update Before Delete After Delete Before Refresh After Refresh Before Truncate After Truncate Description InfoSphere CDC runs the user exit before replicating an insert operation. InfoSphere CDC runs the user exit after replicating an insert operation. InfoSphere CDC runs the user exit before replicating an update operation. InfoSphere CDC runs the user exit after replicating an update operation. InfoSphere CDC runs the user exit before replicating a delete operation. InfoSphere CDC runs the user exit after replicating a delete operation. InfoSphere CDC runs the user exit before replicating a refresh operation. InfoSphere CDC runs the user exit after replicating a refresh operation. InfoSphere CDC runs the user exit before replicating a truncate operation. InfoSphere CDC runs the exist after replicating a truncate operation.

9. Click Apply. Related concepts Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207 Related tasks

Configuring user exits

213

To configure a stored procedure (Microsoft SQL Server version 5.3) on page 211

To configure a derived column or an expression that calls %STPROC (Microsoft SQL Server 6.0 and above and DB2 UBD 6.1 and above)
Note: This information is applicable to InfoSphere CDC for Microsoft SLQ Server (version 6.0 and above) and InfoSphere CDC for DB2 UBD (version 6.1 and above). 1. Click the User Exits tab, and configure a stored procedure. 2. Click the Column Mappings tab, and do one of the following: v If you want InfoSphere CDC to evaluate an expression on the source table, then add a derived column. v If you want InfoSphere CDC to evaluate an expression on the target table, then build an expression. Make sure the expression you define contains a valid call to the %STPROC column function. If you are calling a stored procedure that is not owned by the InfoSphere CDC user, you must provide the name in the form <schema>.<stored procedure name>. 3. Map the derived column or the expression to the target column. Related concepts Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207 Related tasks To configure a stored procedure (Microsoft SQL Server version 5.3) on page 211 To configure a stored procedure (Microsoft SQL Server (version 6.0 and higher) and DB2 UDB (version 6.1 and higher)) on page 213 To add a derived column on page 163 To map a derived column to a target column on page 164 To map an expression to a target column on page 159

To configure a user exit for a Java class


Note: This information is applicable to InfoSphere CDC for Microsoft SQL Server (version 6.0 or higher) and InfoSphere CDC for DB2 UDB. 1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. 4. Right-click and select Edit Mapping Details. 5. Click the User Exits tab. 6. Select Java Class from the User Exit Type list. 7. Type the name of the Java class user exit that implements the UserExitIF interface in the Class Name box. For example, you may have imported the UserExitIF interface, and the user exit program class that implements this interface in your function has the following definition: public class UE1 implements UserExitIF

214

InfoSphere Change Data Capture Management Console: Administration Guide

In the Class Name box, you need to type:


Option UE1 <Java package>.UE1 Description If it is a stand-alone class If the class is included in a Java package (for example, com.datamirror.interface.UE1)

The files you generate from compiling the user exit program must be located in a library or folder that is referenced by the CLASSPATH environment variable. 8. Type the parameters that you want to make available to the user exit program in the Parameter box. You can access the parameters in the user exit program class by invoking the getParameter( ) method during the initialization process. There are no conventions for specifying the parameters. The values you type in this box are free-form. The string of parameter values cannot exceed 255 characters in length. 9. Type the name of the user exit programs you want InfoSphere CDC to call beside one or more of the following operations:
Option Before Insert After Insert Before Update After Update Before Delete After Delete Before Refresh After Refresh Before Truncate After Truncate Description InfoSphere CDC runs the user exit before replicating an insert operation. InfoSphere CDC runs the user exit after replicating an insert operation. InfoSphere CDC runs the user exit before replicating an update operation. InfoSphere CDC runs the user exit after replicating an update operation. InfoSphere CDC runs the user exit before replicating a delete operation. InfoSphere CDC runs the user exit after replicating a delete operation. InfoSphere CDC runs the user exit before replicating a refresh operation. InfoSphere CDC runs the user exit after replicating a refresh operation. InfoSphere CDC runs the user exit before replicating a truncate operation. InfoSphere CDC runs the exist after replicating a truncate operation.

10. Click Apply. Related concepts Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207

Configuring user exits

215

Configuring user exits for InfoSphere CDC for Oracle or InfoSphere CDC for Sybase
C Shared Libraryyou can configure a C user exit program for InfoSphere CDC. You can configure the InfoSphere CDC to run the user exit program before or after an insert, update, delete, or truncate operation. Stored Procedureyou can configure a stored procedure user exit for InfoSphere CDC. You need to identify the schema that contains the stored procedure and identify the InfoSphere CDC operations on which you want to run the user exit. InfoSphere CDC can call your stored procedure from either the source or target when you use the %STPROC column function in an expression. If you want InfoSphere CDC to evaluate and call your stored procedure on the source, then you need to add a derived column. If you want InfoSphere CDC to evaluate and call your stored procedure on the target, then you need to build an expression. See also: To configure a C shared library To configure a stored procedure (Oracle and Sybase) on page 217 To configure a derived column or an expression that calls %STPROC (Oracle and Sybase) on page 218

To configure a C shared library


Note: This information is applicable to InfoSphere CDC for Oracle andInfoSphere CDC for Sybase). 1. Click Configuration Subscriptions. 2. Select the subscription. 3. Select the table mapping. 4. Right-click and select Edit Mapping Details. 5. Click the User Exits tab. 6. Select C Shared Library from the User Exit Type list. 7. Type the full path name of the file containing the shared library in the File (path) box. 8. If you want InfoSphere CDC to retrieve the current constant value from the target and pass it to a user exit program that runs before or after InfoSphere CDC replicates an update operation to the target table, then check the Retrieve Current Values box. 9. Type the name of the user exit programs you want InfoSphere CDC to call beside one or more of the following operations:
Option Before Insert After Insert Before Update After Update Description InfoSphere CDC runs the user exit before replicating an insert operation. InfoSphere CDC runs the user exit after replicating an insert operation. InfoSphere CDC runs the user exit before replicating an update operation. InfoSphere CDC runs the user exit after replicating an update operation.

216

InfoSphere Change Data Capture Management Console: Administration Guide

Option Before Delete After Delete Before Refresh After Refresh Before Truncate After Truncate

Description InfoSphere CDC runs the user exit before replicating a delete operation. InfoSphere CDC runs the user exit after replicating a delete operation. InfoSphere CDC runs the user exit before replicating a refresh operation. InfoSphere CDC runs the user exit after replicating a refresh operation. InfoSphere CDC runs the user exit before replicating a truncate operation. InfoSphere CDC runs the exist after replicating a truncate operation.

Specify the parameters that you want InfoSphere CDC to pass to the user exit program. 11. Click Apply. In some environments, the target table may contain one or more columns that store user-defined constants. Other applications usually maintain these constant values, and they are not affected by InfoSphere CDC. If you do not enable Retrieve Current Value, then InfoSphere CDC passes the default column value (for example, zero, blank, or NULL) to the user exit program. Due to performance reasons, it is important that you clear this box if you do not need to pass the user-defined constant values. 10. Related concepts Configuring user exits for InfoSphere CDC for Oracle or InfoSphere CDC for Sybase on page 216

To configure a stored procedure (Oracle and Sybase)


Note: This information is applicable to InfoSphere CDC for Oracle and InfoSphere CDC for Sybase. 1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. 4. Right-click and select Edit Mapping Details. 5. Click the User Exits tab. 6. Select Stored Procedure from the User Exit Type list. 7. Type the name of the schema that contains the stored procedure in the Schema box. 8. If you want InfoSphere CDC to retrieve the current constant value from the target and pass it to a user exit program that runs before or after InfoSphere CDC replicates an update operation to the target table, then check the Retrieve Current Values box. 9. Type the name of the user exit programs you want InfoSphere CDC to call beside one or more of the following operations:
Option Before Insert Description InfoSphere CDC runs the user exit before replicating an insert operation.
Configuring user exits

217

Option After Insert Before Update After Update Before Delete After Delete Before Refresh After Refresh Before Truncate After Truncate

Description InfoSphere CDC runs the user exit after replicating an insert operation. InfoSphere CDC runs the user exit before replicating an update operation. InfoSphere CDC runs the user exit after replicating an update operation. InfoSphere CDC runs the user exit before replicating a delete operation. InfoSphere CDC runs the user exit after replicating a delete operation. InfoSphere CDC runs the user exit before replicating a refresh operation. InfoSphere CDC runs the user exit after replicating a refresh operation. InfoSphere CDC runs the user exit before replicating a truncate operation. InfoSphere CDC runs the exist after replicating a truncate operation.

10. Click Apply. In some environments, the target table may contain one or more columns that store user-defined constants. Other applications usually maintain these constant values, and they are not affected by InfoSphere CDC. If you do not enable Retrieve Current Value, then InfoSphere CDC passes the default column value (for example, zero, blank, or NULL) to the user exit program. Due to performance reasons, it is important that you clear this box if you do not need to pass the user-defined constant values. Related concepts Configuring user exits for InfoSphere CDC for Oracle or InfoSphere CDC for Sybase on page 216

To configure a derived column or an expression that calls %STPROC (Oracle and Sybase)
Note: This information is applicable to InfoSphere CDC for Oracle and InfoSphere CDC for Sybase. 1. Click the User Exits tab, and configure a stored procedure. 2. Click the Column Mappings tab, and do one of the following: v If you want InfoSphere CDC to evaluate an expression on the source table, then add a derived column. v If you want InfoSphere CDC to evaluate an expression on the target table, then build an expression. Make sure the expression you define contains a valid call to the %STPROC column function. If you are calling a stored procedure that is not owned by the InfoSphere CDC user, you must provide the name in the form <schema>.<stored procedure name>. 3. Map the derived column or the expression to the target column. Related tasks To configure a stored procedure (Oracle and Sybase) on page 217

218

InfoSphere Change Data Capture Management Console: Administration Guide

To add a derived column on page 163 To map a derived column to a target column on page 164 To map an expression to a target column on page 159

Configuring user exits for InfoSphere CDC for AS/400 (version 6.2 and below) or InfoSphere CDC for z/OS
You can write standard function user exits in RPG, COBOL, and C/C++. See also: To configure a standard function

To configure a standard function


Note: This information is applicable to InfoSphere CDC for AS/400 and InfoSphere CDC for z/OS. 1. Click Configuration Subscriptions. 2. Select the subscription. 3. Click the Table Mappings view and select the table mapping. 4. Right-click and select Edit Mapping Details. 5. Click the User Exits tab. 6. Select Standard Function from the User Exit Type list. 7. Type the name of the user exit programs you want InfoSphere CDC to call beside one or more of the following operations:
Option Before Insert After Insert Before Update After Update Before Delete After Delete Before Refresh After Refresh Before Truncate After Truncate Description InfoSphere CDC runs the user exit before replicating an insert operation. InfoSphere CDC runs the user exit after replicating an insert operation. InfoSphere CDC runs the user exit before replicating an update operation. InfoSphere CDC runs the user exit after replicating an update operation. InfoSphere CDC runs the user exit before replicating a delete operation. InfoSphere CDC runs the user exit after replicating a delete operation. InfoSphere CDC runs the user exit before replicating a refresh operation. InfoSphere CDC runs the user exit after replicating a refresh operation. InfoSphere CDC runs the user exit before replicating a truncate operation. InfoSphere CDC runs the exist after replicating a truncate operation.

8. Click Apply. Related concepts

Configuring user exits

219

Configuring user exits for InfoSphere CDC for AS/400 (version 6.2 and below) or InfoSphere CDC for z/OS on page 219

Creating a custom data format for IBM WebSphere DataStage


By specifying a Java class, you can customize the data that is being sent to WebSphere DataStage. By customizing the data, the DSX file that is generated by Management Console and imported into WebSphere DataStage may no longer be relevant. You are responsible for ensuring that the DSX file is still relevant in WebSphere DataStage. For example, you may have an existing WebSphere DataStage file-based job that will not read the default data format generated by Management Console. In this case, it may be easier for you to specify a Java class to customize the data format rather than modifying your existing WebSphere DataStage job. A Java class that creates a custom data format must implement the DataStageDataFormatIF interface. For more information on the DataStageDataFormatIF interface, see the Javadocs that are installed with your InfoSphere CDC for WebSphere DataStage installation. See also: To create a custom data format for WebSphere DataStage Related concepts Creating a custom data format for WebSphere DataStage on page 242

To create a custom data format for WebSphere DataStage


1. Click Configuration Subscriptions. 2. 3. 4. 5. 6. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Flat File or Direct Connect tab depending on your mapping type. Type the name of the Java class that implements the DataStageDataFormatIF interface in the Class Name box. For example, you may have imported the DataStageDataFormatIF interface, and the class that implements this interface in your function has the following definition:
public class CustomFormat1 implements DataStageDataFormatIF

In the Class Name box in the Custom Data Format area, you need to type:
Option CustomFormat1 <Java package>.CustomFormat1 Description If it is a stand-alone class. If the class is included in a Java package (for example, com.datamirror.interface.CustomFormat1 ).

The files you generate from compiling the class must be located in a library or folder that is referenced by the CLASSPATH environment variable. 7. Click Apply.

220

InfoSphere Change Data Capture Management Console: Administration Guide

Configuring user exits for InfoSphere CDC Event Server


You can configure a user exit to define a set of actions that InfoSphere CDC Event Server can run either before or after applying a row-level operation to a staged target table or to a JMS message destination. Row-level operations include an insert, update, or a delete. You can develop the user exit using Java. Before User Exitruns before InfoSphere CDC Event Server applies a row-level operation to either a table you have staged in a staging database and/or before applying the operation to a JMS message destination. After User Exitruns after InfoSphere CDC Event Server applies a row-level operation to either a table you have staged in a staging database or after applying the operation to a JMS message destination. Note: All Java user exits must be compiled with Java 2 Platform, Standard Edition, version 1.4.2. In this section, you will learn: Overriding JMS message header properties Sending the XML message to a different JMS message destination on page 223 Creating XML output and applying XSLT to an XML message on page 224 Sending XML messages to multiple JMS message destinations on page 226 Querying a Web service to access content on page 227 Content based routing on page 228

Overriding JMS message header properties


You can override the default JMS message header properties you had set for a source table to XML mapping in the XML Settings tab. Depending on the JMS message property you want to override, InfoSphere CDC Event Server lets you specify parameters for the following methods in the EventServerIF interface: v setJmsCorrelationID() v setJmsCustomProperty() v setJmsDeliveryMode() v setJmsPriority() v setJmsReplyTo() v setJmsTimeToLive() v setJmsType() For an example of a user exit that overrides the JMS properties of an existing source table to XML mapping, see SampleUserExit1.java located in the samples folder or directory of your InfoSphere CDC Event Server installation. See also: To override JMS message header properties on page 222

Copyright IBM Corp. 2008

221

To override JMS message header properties


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Ensure you have created at least one source table to XML message destination mapping within this subscription. 4. Select the table mapping and right-click Edit Mapping Details. 5. Click the User Exits tab. 6. Choose Java Class from the User Exit Type box. 7. In the Class Name box, type the Java class name of the user exit that implements the UserExitIF interface if you have developed the user exit in Java. For example, you may have imported the EventServerIF interface, and the Java class user exit that implements this interface in your function has the following definition: public class UE1 implements UserExitIF. In the Class Name box, type: 8. Type the parameters that you want to make available to the user exit program in the Parameter box. You can access the parameters in the Java class by invoking the getParameter() method during the initialization process. There are no conventions for specifying the parameters. The values you type in this box are free-form. The string of parameter values cannot exceed 255 characters in length. 9. Enable the Before check box for one or more of the following operations:
Option Insert Description InfoSphere CDC Event Server runs the user exit before applying an insert operation to a table you have staged and/or before applying an insert operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying an update operation to a table you have staged and/or before applying an update operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying a delete operation to a table you have staged and/or before applying a delete operation to a JMS message destination.

Update

Delete

Related concepts Sending XML messages to multiple JMS message destinations on page 226 Defining the JMS message header on page 151 Overriding JMS message header properties on page 221 Configuring user exits for InfoSphere CDC Event Server on page 221

222

InfoSphere Change Data Capture Management Console: Administration Guide

Sending the XML message to a different JMS message destination


You can develop a user exit that lets you send an XML message to a different JMS message destination than the one you added using the InfoSphere CDC Configuration tool. Using the setDestination() method in a user exit with the EventServerIF interface, you can send an XML message to a different JMS message destination. For an example of a user exit that sends an XML message to a different JMS message destination, see SampleUserExit2.java located in the samples folder or directory of your InfoSphere CDC Event Server installation. See also: To send the XML message to another JMS message destination

To send the XML message to another JMS message destination


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Ensure you have created at least one source table to XML message destination mapping within this subscription. 4. Select the table mapping and right-click Edit Mapping Details. 5. Click the User Exits tab. 6. Choose Java Class from the User Exit Type box. 7. In the Class Name box, type the Java class name of the user exit that implements the UserExitIF interface if you have developed the user exit in Java. For example, you may have imported the EventServerIF interface, and the Java class user exit that implements this interface in your function has the following definition: public class UE1 implements UserExitIF. In the Class Name box, type: 8. Type the parameters that you want to make available to the user exit program in the Parameter box. You can access the parameters in the Java class by invoking the getParameter() method during the initialization process. There are no conventions for specifying the parameters. The values you type in this box are free-form. The string of parameter values cannot exceed 255 characters in length. 9. Enable the Before check box for one or more of the following operations:
Option Insert Description InfoSphere CDC Event Server runs the user exit before applying an insert operation to a table you have staged and/or before applying an insert operation to a JMS message destination.

Configuring user exits for InfoSphere CDC Event Server

223

Option Update

Description InfoSphere CDC Event Server runs the user exit before applying an update operation to a table you have staged and/or before applying an update operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying a delete operation to a table you have staged and/or before applying a delete operation to a JMS message destination.

Delete

10. Click Apply. You can start mirroring on the subscription that contains the source table assigned to a JMS message destination. The user exit program will set the new destination before InfoSphere CDC Event Server applies the operation to a JMS message destination. Related concepts Sending XML messages to a JMS message destination on page 199 Sending the XML message to a different JMS message destination on page 223 Configuring user exits for InfoSphere CDC Event Server on page 221

Creating XML output and applying XSLT to an XML message


You can develop a user exit which lets you create an XML message and then format the XML message using XSL Transformations (XSLT). InfoSphere CDC Event Server lets you specify parameters for the following methods in the EventServerIF interface: v createXmlOutput() v apply Xslt() For example, the following user exit applies XSLT on an existing XML message:
} /** * Apply XSLT transform to the output message * @throws UserExitException */ private void applyXslt(EventServerIF eventServer, ReplicationEventIF p_Event) throws UserExitException { //Get TS/ES XML Engine to create the xml file String xml = eventServer.createXmlOutput(p_Event); // Apply XSLT transform to the xml message String xsltOutput = eventServer.applyXslt("xslt/dbxml.xsl", xml); //Set the xml message that TS/ES is going to send eventServer.setOutputTextMessage(xsltOutput); } public boolean processReplicationEvent(ReplicationEventIF p_Event) throws UserExitException { boolean retValue = true; int eventType = p_Event.getEventType(); if (eventType == ReplicationEventTypes.BEFORE_INSERT_EVENT) { EventServerIF eventServer = p_Event.getEventServer(); // Apply XSLT transform

224

InfoSphere Change Data Capture Management Console: Administration Guide

applyXslt(eventServer, p_Event); } return retValue; }

See also: To create an XML message and apply XSLT

To create an XML message and apply XSLT


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Ensure you have created at least one source table to XML message destination mapping within this subscription. 4. Select the table mapping and right-click Edit Mapping Details. 5. Click the User Exits tab. 6. Choose Java Class from the User Exit Type box. 7. In the Class Name box, type the Java class name of the user exit that implements the UserExitIF interface if you have developed the user exit in Java. For example, you may have imported the EventServerIF interface, and the Java class user exit that implements this interface in your function has the following definition: public class UE1 implements UserExitIF. In the Class Name box, type: 8. Type the parameters that you want to make available to the user exit program in the Parameter box. You can access the parameters in the Java class by invoking the getParameter() method during the initialization process. There are no conventions for specifying the parameters. The values you type in this box are free-form. The string of parameter values cannot exceed 255 characters in length. 9. Enable the Before check box for one or more of the following operations:
Option Insert Description InfoSphere CDC Event Server runs the user exit before applying an insert operation to a table you have staged and/or before applying an insert operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying an update operation to a table you have staged and/or before applying an update operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying a delete operation to a table you have staged and/or before applying a delete operation to a JMS message destination.

Update

Delete

10. Click Apply.

Configuring user exits for InfoSphere CDC Event Server

225

You can start mirroring on the subscription that contains the source table assigned to a JMS message destination. The user exit program will set the new destination before InfoSphere CDC Event Server applies the operation to a JMS message destination. Related concepts Sending XML messages to a JMS message destination on page 199 Creating XML output and applying XSLT to an XML message on page 224 Configuring user exits for InfoSphere CDC Event Server on page 221

Sending XML messages to multiple JMS message destinations


You can send an XML message to a different JMS queue or topic than the one you configured in InfoSphere CDC Event Server using standard Java methods. This lets you override the JMS message destination you selected when configuring InfoSphere CDC. For an example of a user exit that sends to a different JMS message destination, see SampleUserExit2.java located in the samples folder or directory of your InfoSphere CDC Event Server installation. You need to create the JMS destination you want to send the XML message to using Java JMS methods. For more information, see http://java.sun.com/ products/jms/javadoc-102a/index.html. See also: To send an XML message to a different JMS message destination

To send an XML message to a different JMS message destination


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. Ensure you have created at least one source table to XML message destination mapping within this subscription. Select the table mapping and right-click Edit Mapping Details. Click the User Exits tab. Choose Java Class from the User Exit Type box. In the Class Name box, type the Java class name of the user exit that implements the UserExitIF interface if you have developed the user exit in Java. For example, you may have imported the EventServerIF interface, and the Java class user exit that implements this interface in your function has the following definition: public class UE1 implements UserExitIF.

3. 4. 5. 6. 7.

In the Class Name box, type: 8. Type the parameters that you want to make available to the user exit program in the Parameter box. You can access the parameters in the Java class by invoking the getParameter() method during the initialization process. There are no conventions for specifying the parameters. The values you type in this box are free-form. The string of parameter values cannot exceed 255 characters in length.

226

InfoSphere Change Data Capture Management Console: Administration Guide

9. Enable the Before check box for one or more of the following operations:
Option Insert Description InfoSphere CDC Event Server runs the user exit before applying an insert operation to a table you have staged and/or before applying an insert operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying an update operation to a table you have staged and/or before applying an update operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying a delete operation to a table you have staged and/or before applying a delete operation to a JMS message destination.

Update

Delete

10. Click Apply. You can start mirroring on the subscription that contains the source table assigned to a JMS message destination. The user exit program will set the new destination before InfoSphere CDC Event Server applies the operation to a JMS message destination. Related concepts Sending XML messages to a JMS message destination on page 199 Sending XML messages to multiple JMS message destinations on page 226 Configuring user exits for InfoSphere CDC Event Server on page 221

Querying a Web service to access content


You can query a Web service using standard Java methods. By developing a user exit, you can call a web service with InfoSphere CDC Event Server. For example, you may be using a web service application to keep track of new customers that have just registered online. You can access content from the Web service application to include it in an XML message you configured with InfoSphere CDC Event Server. For an example of a user exit that queries a Web service, see SampleUserExit3.java located in the samples folder or directory of your InfoSphere CDC Event Server installation. See also: To query a Web service to access content

To query a Web service to access content


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database.

Configuring user exits for InfoSphere CDC Event Server

227

3. Ensure you have created at least one source table to XML message destination mapping within this subscription. 4. Select the table mapping and right-click Edit Mapping Details. 5. Click the User Exits tab. 6. Choose Java Class from the User Exit Type box. 7. In the Class Name box, type the Java class name of the user exit that implements the UserExitIF interface if you have developed the user exit in Java. For example, you may have imported the EventServerIF interface, and the Java class user exit that implements this interface in your function has the following definition: public class UE1 implements UserExitIF. In the Class Name box, type: 8. Type the parameters that you want to make available to the user exit program in the Parameter box. You can access the parameters in the Java class by invoking the getParameter() method during the initialization process. There are no conventions for specifying the parameters. The values you type in this box are free-form. The string of parameter values cannot exceed 255 characters in length. 9. Enable the Before check box for one or more of the following operations:
Option Insert Description InfoSphere CDC Event Server runs the user exit before applying an insert operation to a table you have staged and/or before applying an insert operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying an update operation to a table you have staged and/or before applying an update operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying a delete operation to a table you have staged and/or before applying a delete operation to a JMS message destination.

Update

Delete

10. Click Apply. You can start mirroring on the subscription that contains the source table assigned to a JMS message destination. The user exit program will set the new destination before InfoSphere CDC Event Server applies the operation to a JMS message destination. Related concepts Sending XML messages to a JMS message destination on page 199 Querying a Web service to access content on page 227 Configuring user exits for InfoSphere CDC Event Server on page 221

Content based routing


You can develop a user exit that lets you send an XML message to a specific JMS message destination based on the content of the message.

228

InfoSphere Change Data Capture Management Console: Administration Guide

For example, you may want to create a simple XML message whenever a new employee is created. You can detect new employees by monitoring inserts into the dbo.Employee table and create an source table to XML mapping using all columns from this table. You can then send the XML message to a JMS queue called HR1 and also send this XML message to another queue called IT1 each time a new employee is added to the IT department. See also: To route the content of an XML message to another JMS message destination

To route the content of an XML message to another JMS message destination


1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Ensure you have created at least one source table to XML message destination mapping within this subscription. 4. Select the table mapping and right-click Edit Mapping Details. 5. Click the User Exits tab. 6. Choose Java Class from the User Exit Type box. 7. In the Class Name box, type the Java class name of the user exit that implements the UserExitIF interface if you have developed the user exit in Java. For example, you may have imported the EventServerIF interface, and the Java class user exit that implements this interface in your function has the following definition: public class UE1 implements UserExitIF. In the Class Name box, type: 8. Type the parameters that you want to make available to the user exit program in the Parameter box. You can access the parameters in the Java class by invoking the getParameter() method during the initialization process. There are no conventions for specifying the parameters. The values you type in this box are free-form. The string of parameter values cannot exceed 255 characters in length. 9. Enable the Before check box for one or more of the following operations:
Option Insert Description InfoSphere CDC Event Server runs the user exit before applying an insert operation to a table you have staged and/or before applying an insert operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying an update operation to a table you have staged and/or before applying an update operation to a JMS message destination.

Update

Configuring user exits for InfoSphere CDC Event Server

229

Option Delete

Description InfoSphere CDC Event Server runs the user exit before applying a delete operation to a table you have staged and/or before applying a delete operation to a JMS message destination.

10. Click Apply. You can start mirroring on the subscription that contains the source table assigned to a JMS message destination. The user exit program will set the new destination before InfoSphere CDC Event Server applies the operation to a JMS message destination. Related concepts Sending XML messages to multiple JMS message destinations on page 226 Content based routing on page 228 Configuring user exits for InfoSphere CDC Event Server on page 221

230

InfoSphere Change Data Capture Management Console: Administration Guide

Monitoring your subscriptions


After configuring your replication environment and starting replication for your subscriptions, you can monitor and analyze replication activities for each subscription in the Monitoring perspective. The Monitoring perspective lets you diagnose potential problems by allowing you to: v View the replication state and status for your subscriptions. State information will tell you if your subscription is inactive or if it is replicating. Status information will tell you if replication is behaving normally or if there is an error. v Check system messages and events that relate to a subscription or a datastore in the Event Log view. You can view messages for each subscription and datastore in your replication configuration. v Examine the amount of latency for a subscription. You can set latency thresholds and notifications for your subscriptions to help you determine when latency is becoming a problem. v Depending on the platform on which you have InfoSphere CDC, you can to set a DEADBAND PERCENTAGE system parameter to greater than zero on your target datastore if you want InfoSphere CDC to apply padding around your latency threshold. In this section, you will learn: About the state and status of your subscriptions Displaying event messages during replication on page 232 Profiling the latency and throughput performance of your subscription on page 235 Displaying a graphical view of your subscription on page 238 Related concepts Setting notifications on page 69 Disk resource system parameters on page 386

About the state and status of your subscriptions


State and status information help you determine if a subscription is behaving the way you expect. For example, if you start mirroring for a subscription and the state of the subscription remains Inactive, you can look at the subscriptions status to see if it is Normal or if Management Console is reporting an error. If the status of the subscription is Error, you can inspect the Event Log view for the subscription to see if there is a problem. In this way, state and status work together to provide you with information you need to monitor replication activity. See also: Subscription state on page 232 Subscription status on page 232 Related concepts Displaying event messages during replication on page 232

Copyright IBM Corp. 2008

231

Subscription state
Subscriptions configured in Management Console can be in one of the following states: v StartingIndicates that InfoSphere CDC is starting replication for the subscription. v RefreshIndicates that InfoSphere CDC is refreshing data from the source to the target. After completing the refresh, InfoSphere CDC starts mirroring the subscription or returns to a state of Inactive, depending on the replication method that you have selected for the subscription. v Mirror ContinuousIndicates that InfoSphere CDC is mirroring data between the source and target. This occurs when you have started continuous mirroring on the subscription. Mirror Net ChangeIndicates that InfoSphere CDC is mirroring changes that were made to the source since replication last ended. InfoSphere CDC ends replication after the changes are mirrored to the target. v EndingIndicates that InfoSphere CDC is close to completing replication activity on the subscription and is in the process of shutting down. v InactiveIndicates that InfoSphere CDC is not replicating data on the subscription. v UnknownIndicates that InfoSphere CDC cannot determine the state of the subscription. This may be a result of a lack of communication between the monitoring process and the datastores, or your subscription is using an external source datastore. Related concepts Starting mirroring on a subscription on page 197 Setting up subscriptions for datastores outside of your organization on page 86 v

Subscription status
Subscriptions configured in Management Console can have one of the following statuses: v NormalIndicates that the subscription is normal and there are no known problems. v ErrorIndicates that a problem is preventing InfoSphere CDC from replicating data on the subscription. You can use the Event Log view to monitor and diagnose any errors that occur during replication. v UnknownIndicates that InfoSphere CDC cannot determine the status of the subscription. This may be a result of a lack of communication between the monitoring process and the datastores, or your subscription is using an external source datastore. Related concepts Displaying event messages during replication

Displaying event messages during replication


The Event Log view lets you view events and messages generated by InfoSphere CDC during replication activities. It allows you to monitor and/or identify problems with the replication activity of your subscriptions. With the Event Log view, you can do the following: v View events generated by specific subscriptions or datastores. v Filter events based on severity.

232

InfoSphere Change Data Capture Management Console: Administration Guide

Copy events. You can then paste the event into another application. For example, you may want to copy an event into an email for technical support reasons. v Clear the Event Log view of messages that you no longer need to investigate. v Export events to your local computer. v The Event Log view displays the following four categories of events which are listed by increasing severity: v Informationthese events provide feedback about InfoSphere CDC operations. These events do not indicate that an error has occurred. v Diagnosticthese events contain information that helps you diagnose or solve a problem that may occur as a result of a certain action or operation. v Warning or Noticethese events describe situations that InfoSphere CDC has detected, which alerts you about a potential error. v Error or Escapethese events describe an error that InfoSphere CDC has detected, or explain conditions that led to InfoSphere CDC shutting down. See also: To show the event log for a subscription To view event details To copy events on page 234 To clear events on page 234 To export events on page 235

To show the event log for a subscription


1. Click Monitoring Subscriptions. 2. Select a subscription and right-click Show Event Log. 3. Select one of the following options from the Log list:
Option Source General Source Replication Target General Target Replication Description Displays events generated by the source datastore. Displays events generated by the subscription on the source datastore. Displays events generated by the target datastore. Displays events generated by the subscription on the target datastore.

Related concepts Displaying event messages during replication on page 232

To view event details


1. Click Monitoring Subscriptions. 2. Select a subscription and right-click Show Event Log.

Monitoring your subscriptions

233

3. Select one of the following options from the Log list:


Option Source General Source Replication Target General Target Replication Description Displays events generated by the source datastore. Displays events generated by the subscription on the source datastore. Displays events generated by the target datastore. Displays events generated by the subscription on the target datastore.

4. Right-click in the list of events and select Event Details. Related concepts Displaying event messages during replication on page 232

To copy events
1. Click Monitoring Subscriptions. 2. Select a subscription and right-click Show Event Log. 3. Select one of the following options from the Log list:
Option Source General Source Replication Target General Target Replication Description Displays events generated by the source datastore. Displays events generated by the subscription on the source datastore. Displays events generated by the target datastore. Displays events generated by the subscription on the target datastore.

4. Right-click in the list of events and select Copy Events. Related concepts Displaying event messages during replication on page 232

To clear events
1. Click Monitoring Subscriptions. 2. Select a subscription and right-click Show Event Log. 3. Select one of the following options from the Log list:
Option Source General Source Replication Target General Target Replication Description Displays events generated by the source datastore. Displays events generated by the subscription on the source datastore. Displays events generated by the target datastore. Displays events generated by the subscription on the target datastore.

234

InfoSphere Change Data Capture Management Console: Administration Guide

4. Right-click in the list of events and select Clear Events. Note: If you have installed InfoSphere CDC for Microsoft SQL Server, you must set the registry entry (AllowEventLogClear in HKEY_LOCAL_MACHINE\ Software\DataMirror\InfoSphere CDC\SQL Server\<TS_instance_name>\Agent) to 1. Related concepts Displaying event messages during replication on page 232

To export events
1. Click Monitoring Subscriptions. 2. Select a subscription and right-click Show Event Log. 3. Select one of the following options from the Log list:
Option Source General Source Replication Target General Target Replication Description Displays events generated by the source datastore. Displays events generated by the subscription on the source datastore. Displays events generated by the target datastore. Displays events generated by the subscription on the target datastore.

4. Right-click in the list of events and select Export Events. 5. You are prompted to save the list of events in a formatted text file to your local computer. Related concepts Displaying event messages during replication on page 232

Profiling the latency and throughput performance of your subscription


After you configure mapping details on a subscription, develop a performance baseline to determine how replication behaves with a workload that is typical for your applications and topology. Use the Statistics View to determine typical numbers for latency and throughput. After you have established baseline numbers for latency, set latency notifications and thresholds. Replication performance can be measured along the following two dimensions: Latency InfoSphere CDC measures latency as the amount of time that passes between when data changes on a source table and when it changes on the target table. For example, if an application inserts a row into the source table at 10:00 and InfoSphere CDC applies that row to the target table at 10:15, then the latency for the subscription is 15 minutes. It is up to you to decide how much latency you are willing to tolerate in your environment. A subscription can experience latency in the following situations: v Insufficient network bandwidth for the volume of transactions that you are processing. This increases the amount of time between changes on the source table and the same change on the target table. To resolve this problem, contact your network administrator.
Monitoring your subscriptions

235

v A large refresh is occurring. v Resource intensive batch jobs or background tasks on the source or target. This will likely result in increased latency for a subscription until these processes are complete. v InfoSphere CDC is replicating tables with Large Objects (LOB). The large size of the table rows may increase latency for a subscription. v Database lock contention on the target database. An application such as a reporting system on the target database may unexpectedly lock data in the database, forcing InfoSphere CDC to wait for the locks to be released. Note: For each machine where you have installed InfoSphere CDC, make sure that your system time is synchronized and that the time zone matches the time zone of your region. InfoSphere CDC calculates latency based on your system time and the offset from Coordinated Universal Time (UTC). To receive accurate latency statistics on a subscription, make sure these settings are correct. Throughput The amount of replication activity (measured in the number of operations or size of data) a system can sustain over time. See also: To start profiling the performance of a subscription To stop profiling the performance of a subscription on page 237 To view and save plotted performance statistics of a subscription on page 237 Related concepts Setting latency thresholds and notifications on page 78 Related tasks To set a latency threshold and notification on page 79

To start profiling the performance of a subscription


1. 2. 3. 4. Ensure that you have set a latency threshold on the subscription. Ensure that you have started mirroring on the subscription you want to profile. Click Monitoring Subscriptions. Right-click on a subscription and select Statistics, Collect Statistics.

5. If you want to save the collected statistics as a plotted graph, then click Show Statistics and click Save Data. The plotted graph is saved in .csv format to your local computer. Note: If you click Show Statistics to view the plotted graph, you will see a timestamp that indicates when you started profiling the performance of the subscription. Related concepts Starting mirroring on a subscription on page 197 Profiling the latency and throughput performance of your subscription on page 235 Related tasks To set a latency threshold and notification on page 79 To view and save plotted performance statistics of a subscription on page 237 To start profiling the performance of a subscription

236

InfoSphere Change Data Capture Management Console: Administration Guide

To stop profiling the performance of a subscription


1. Click Monitoring Subscriptions. 2. Right-click on a subscription and select Statistics, Do Not Collect Statistics. 3. If you want to save the collected statistics as a plotted graph, then click Show Statistics and click Save Data. The plotted graph is saved in .csv format to your local computer. Notes: v If you click Show Statistics to view the plotted graph, you will see a timestamp that indicates when you stopped profiling the performance of the subscription. v If you decide to stop collecting statistics and end mirroring on the subscription, InfoSphere CDC maintains the performance statistics that were collected prior to ending mirroring. You will only lose performance statistics if you stop and restart collecting statistics on the same subscription. Related concepts Profiling the latency and throughput performance of your subscription on page 235 Related tasks To view and save plotted performance statistics of a subscription To start profiling the performance of a subscription on page 236

To view and save plotted performance statistics of a subscription


1. Click Monitoring Subscriptions. 2. Right-click on a subscription and select Show Statistics. 3. Depending on the version of InfoSphere CDC you have installed and which database platform you are using, you can view the following performance statistics: Latency
Option Current Description Indicates the amount of time the subscription is latent in replicating data to the target. Indicates the highest amount of time a subscription has experienced latency since you opened the Statistics View. Indicates the least amount of time a subscription has experienced latency since you opened the Statistics View. Indicates the average amount of time a subscription has experienced latency since you opened the Statistics View.

High

Low

Average

Throughput Depending on the InfoSphere CDC product you have installed, you can also view throughput information for the subscription.

Monitoring your subscriptions

237

Option Current

Description Indicates the current rate of throughput for the subscription since you opened the Statistics view. Throughput is the amount of data (in bytes) or the number of operations that InfoSphere CDC applies on the target database process per second. Indicates the highest rate of throughput for the subscription since you opened the Statistics view. Throughput is the amount of data (in bytes) or the number of operations that InfoSphere CDC applies on the target database process per second. Indicates the lowest rate of throughput for the subscription since you opened the Statistics view. Throughput is the amount of data (in bytes) or the number of operations that InfoSphere CDC applies on the target database process per second. Indicates the average rate of throughput for the subscription since you opened the Statistics view. Throughput is the amount of data (in bytes) or the number of operations that InfoSphere CDC applies on the target database process per second.

High

Low

Average

4. In the Graph area, select one of the following from the list:
Option Latency Throughput Operation/second Description Displays a graph that illustrates the latency of your subscription. Displays a graph that illustrates the number of operations that InfoSphere CDC applies to the target database per second. Displays a graph that illustrates the amount of data (in bytes) that InfoSphere CDC applies to the target database per second.

Throughput Bytes/second

5. You should see a graph that plots performance for the subscription. 6. If you want to save and export the graph in .csv format, then click Save Data. Related concepts Setting latency thresholds and notifications on page 78 Displaying event messages during replication on page 232

Displaying a graphical view of your subscription


The Replication Diagram view in the Monitoring perspective uses a schematic diagram to visually represent the relationship between subscriptions and datastores in your replication configuration. When monitoring your subscriptions, you may find that the Replication Diagram view is a useful visual alternative to the Subscriptions view which displays the same information in a grid format.

238

InfoSphere Change Data Capture Management Console: Administration Guide

In the Replication Diagramview, you can do the following: v Monitor the activity of subscriptions in a specific project by using the project list in the toolbar. v View state, status, and latency information for each subscription. v Right-click a datastore to connect to a datastore, set a datastore notification, view properties, and show related subscriptions. v Right-click a subscription to start or stop replication, start a refresh, show table mappings, set a subscription notification, and view properties. v Determine the source and target datastore for a subscription by examining the arrows that point to the target datastore.

Monitoring your subscriptions

239

240

InfoSphere Change Data Capture Management Console: Administration Guide

Using InfoSphere CDC with IBM WebSphere DataStage


With InfoSphere CDC for WebSphere DataStage you can replicate data to IBM WebSphere DataStage based on table mapping details configured in InfoSphere CDC Management Console. Management Console lets you manage the source tables you want to replicate and provides you with mapping options to map your source tables according to your replication requirements. You can also customize the data based on your business requirements. In this section, you will learn: Before configuring InfoSphere CDC for WebSphere DataStage Configuring InfoSphere CDC to send data to WebSphere DataStage Starting replication in Management Console on page 243

Before configuring InfoSphere CDC for WebSphere DataStage


Before configuring InfoSphere CDC for WebSphere DataStage in Management Console, you must do the following: 1. Install and configure InfoSphere CDC for WebSphere DataStage. For more information on how to do this, see your InfoSphere CDC for WebSphere DataStage End-User Documentation. 2. Create a datastore in Management Console. Related tasks To add a new datastore on page 24

Configuring InfoSphere CDC to send data to WebSphere DataStage


There are several configuration tasks that are required in InfoSphere CDC Management Console before you can send data to WebSphere DataStage. See also: Adding a subscription for WebSphere DataStage Mapping tables to WebSphere DataStage on page 242 Customizing your WebSphere DataStage table mappings on page 242 Generating a WebSphere DataStage Definition File on page 242 Creating a custom data format for WebSphere DataStage on page 242

Adding a subscription for WebSphere DataStage


You must add a subscription that uses InfoSphere CDC for WebSphere DataStage as a target datastore. For more information on how to add a subscription in Management Console, see Setting up subscriptions on page 83. You can also modify WebSphere DataStage properties for the subscription that control the number of changed rows and the amount of time elapsed before subscription data is sent to WebSphere DataStage. Related concepts Setting up subscriptions on page 83

Copyright IBM Corp. 2008

241

Setting properties for a subscription that targets IBM WebSphere DataStage on page 89

Mapping tables to WebSphere DataStage


After adding a subscription, you must map one or more source tables to the target system, IBM WebSphere DataStage. You can create as many table mappings as you feel necessary, and this may depend on the number of tables that you want to replicate to the target system. Related concepts Mapping using WebSphere DataStage on page 106

Customizing your WebSphere DataStage table mappings


After mapping your tables to WebSphere DataStage, you have the option of customizing your table mappings by creating derived columns, filtering rows and columns, and specifying how InfoSphere CDC converts character sets on source columns during replication: v Derived ColumnsWith a derived column you can create an expression that is evaluated by InfoSphere CDC on a source column. The results of the expression are sent to the target system, WebSphere DataStage. v Multibyte and Unicode Character Set ConversionsYou can specify how InfoSphere CDC converts character sets on source columns during replication. v Filtering Rows and ColumnsYou can include or exclude rows or columns for replication. Note: When customizing your WebSphere DataStage table mappings in Management Console, you will have access to a sub-set of functionality that is normally available for database targets. Functionality that is not available for WebSphere DataStage table mappings is not displayed or disabled. Related concepts Setting multibyte and Unicode character set conversions on page 175 Filtering rows and columns on page 167 Related tasks To add a derived column on page 163

Generating a WebSphere DataStage Definition File


After mapping one or more source tables, you can generate a WebSphere DataStage definition file (*.dsx) that creates a job sequence and two utility routines in WebSphere DataStage. You can import this file into IBM WebSphere DataStage Designer and then customize it to meet your business requirements. For more information about running a WebSphere DataStage job, see your WebSphere DataStage documentation. Related concepts Generating a WebSphere DataStage definition file for a subscription on page 90

Creating a custom data format for WebSphere DataStage


By specifying a Java class, you can customize the data that is being sent to WebSphere DataStage. By customizing the data, the the DSX file that is generated by Management Console and imported into WebSphere DataStage may no longer

242

InfoSphere Change Data Capture Management Console: Administration Guide

be relevant. If you customize the data that is sent to WebSphere DataStage, you are responsible for ensuring that the DSX file is still relevant in WebSphere DataStage. Related concepts Creating a custom data format for IBM WebSphere DataStage on page 220

Starting replication in Management Console


You can start replication for a subscription that uses InfoSphere CDC for WebSphere DataStage like any other subscription in Management Console. For the appropriate way to start and stop subscriptions and WebSphere DataStage jobs, see your InfoSphere CDC for WebSphere DataStage documentation. Related concepts Starting and ending replication on subscriptions on page 197

Using InfoSphere CDC with IBM WebSphere DataStage

243

244

InfoSphere Change Data Capture Management Console: Administration Guide

Using journal control fields for auditing replication activities


In this section, you will learn: About journal control fields About journal codes on page 257 Translating journal codes into meaningful information on page 259

About journal control fields


Journal control fields provide information about the log entry on the source system. When a change is made on the source system, the database records the change in a log entry that contains the changed data plus extra information about what type of change was made, who made the change, and when the change was made. When a relevant log entry triggers a replication event to the target system, InfoSphere CDC replicates the changed data along with the extra log entry information to the target system. InfoSphere CDC makes the extra log entry information available through journal control fields. InfoSphere CDC provides many journal control fields that contain log entries from your source systems. You can map journal control fields to columns on the target system. InfoSphere CDC replicates the log information from the source system and applies this information to the mapped columns on your target system. For example, you may want to maintain when the last replicated change was applied to each row in a table on the source system. To capture this information for each row in a table on the target system, you can add a column to the table and map that column to the appropriate journal control field. You can also include journal control fields in row selection and derived expressions. Before using a journal control field, you should consider the following: v If you have installed InfoSphere CDC Version 5.2 or higher, some journal control fields contain non-character data. Depending on the source and target database vendors, InfoSphere CDC converts these values to character data before they are passed to a user exit program. For more information, see the appropriate User Exits section for your platform. v Depending on the type of platform you have installed InfoSphere CDC and the replication method (mirror or refresh), some journal control fields may or may not be supported. v If you have installed InfoSphere CDC for z/OS and you want to build an expression with &MEMBER, then you need to enclose this journal control field in single quotes. v InfoSphere CDC does not support the mapping of journal control fields to LOB columns in a target table. See also: Commit Cycle ID (&CCID) on page 246 Source RRN (&CNTRRN) on page 246 Entry Type Code (&CODE) on page 247 Entry Type (&ENTTYP) on page 247 Source Job Name (&JOB) on page 248
Copyright IBM Corp. 2008

245

Source Job Number (&JOBNO) on page 249 Source Job User (&JOBUSER) on page 250 Journal Name (&JOURNAL) on page 250 Source Table Library (&LIBRARY) on page 251 Source Table Member Name (&MEMBER) on page 252 Source Table Name (&OBJECT) on page 252 Source Program Name (&PROGRAM) on page 253 Journal Sequence Number (&SEQNO) on page 254 Source Server Name (&SYSTEM) on page 254 Record Modification Time (&TIMESTAMP) on page 255 Record Modification User (&USER) on page 256

Commit Cycle ID (&CCID)


An identifier for the transaction with the update. Data TypeInteger (InfoSphere CDC 5.x) InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400Support for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to a default value of 0. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available only when InfoSphere CDC refreshes data, and is not available when mirroring data. v InfoSphere CDC for Microsoft SQL ServerSupport for this journal control field is not available. If you decide to use this journal control field when mirroring data, InfoSphere CDC sets this journal control field to a default value of 0. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to a default value of 1. v InfoSphere CDC for DB2 UDBSupport for this journal control field is available only when refreshing data, and is not available when mirroring data. When refreshing data, InfoSphere CDC sets this journal control field to a default value of 0. v InfoSphere CDC for z/OSSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data.

Source RRN (&CNTRRN)


The relative record number of the source table that recorded the journal entry. Data TypeInteger (InfoSphere CDC 5.x) InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products.

246

InfoSphere Change Data Capture Management Console: Administration Guide

v InfoSphere CDC for AS/400Support for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for Microsoft SQL ServerSupport for this journal control field is available only when InfoSphere CDC refreshes data, and is not available when mirroring data. If you decide to use this journal control field when mirroring data, InfoSphere CDC sets this journal control field to a default value of 0. v InfoSphere CDC for DB2 UDB Support for this journal control field is available only when InfoSphere CDC refreshes data, and is not available when mirroring data. If you decide to use this journal control field when mirroring data, InfoSphere CDC sets this journal control field to a default value of 0. v InfoSphere CDC for z/OSSupport for this journal control field is not available.

Entry Type Code (&CODE)


The code that identifies the type of journal entry. U for refresh and R for mirror. Data TypeCharacter InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400Support for this journal control field is available only when mirroring data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to a default value of U on the subscriber. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available only when InfoSphere CDC refreshes data, and is not available when mirroring data. When refreshing data, InfoSphere CDC sets this journal control field to a default value of R. If you decide to use this journal control field when mirroring data, InfoSphere CDC sets this journal control field to NULL. v InfoSphere CDC for Microsoft SQL ServerSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for DB2 UDBSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for z/OSSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data.

Entry Type (&ENTTYP)


Indicates the type of update. For each journal entry code there are one or more possible journal entry types that provide more detailed information about the entry. For more information, see Using journal control fields for auditing replication activities on page 245. You can use journal entry types for auditing events that occur between your source and target tables. For example, you can use a journal entry type to label each audit
Using journal control fields for auditing replication activities

247

record with the event that occurred on your source table that caused the audit record to be written to the target table. This is represented by a distinct two-letter code. Data TypeCharacter InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400Support for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to a default value of RR on the subscriber. InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for Microsoft SQL ServerSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for DB2 UDBSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for z/OSSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v

Source Job Name (&JOB)


The name of the job that made the update on the source system. Data TypeCharacter InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400Support for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to UNKNOWN on the subscriber. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the program that performed the operation on the source table. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to NULL. v InfoSphere CDC for Microsoft SQL Server (V5.3)Support for this journal control field is not available. If you decide to use this journal control field when mirroring data, this journal control field contains data that is not consistent with the defined contents of the journal control field. If you decide to use this journal control field when refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for Microsoft SQL Server (V6.0)Support for this journal control field is not available. If you decide to use this journal control field when

248

InfoSphere Change Data Capture Management Console: Administration Guide

mirroring data, InfoSphere CDC leaves it empty. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to InfoSphere CDC. v InfoSphere CDC for DB2 UDBSupport for this journal control field is not available. If you decide to use this journal control field when mirroring data, InfoSphere CDC leaves it empty. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to InfoSphere CDC. v InfoSphere CDC for z/OSSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the Logical Unit of Works Correlation ID. The Correlation ID is an internal DB2 identifier. It is usually the name of the job that created the Logical Unit of Work.

Source Job Number (&JOBNO)


The operating system user ID of the update process. Data TypeCharacter InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400Support for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to a default value of 0 on the subscriber. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the process ID (UNIX) and the process name (Windows) that performed the operation on the source table. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to NULL. v InfoSphere CDC for Microsoft SQL Server (V5.3)Support for this journal control is not available. If you decide to use this journal control field when mirroring data, InfoSphere CDC sets this journal control field to a default value of 0. If you decide to use this journal control field when refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for Microsoft SQL Server (V6.0)Support for this journal control field is not available. If you decide to use this journal control field when mirroring data, InfoSphere CDC leaves this journal control field empty. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to 000000. v InfoSphere CDC for DB2 UDBSupport for this journal control field is not available. If you decide to use this journal control field when mirroring data, InfoSphere CDC leaves this journal control field empty. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to 000000. v InfoSphere CDC for z/OSSupport for this journal control field is not available. When mirroring data, InfoSphere CDC sets this journal control field to 000000. If you decide to use this journal control when refreshing data, the journal control field contains an empty string.
Using journal control fields for auditing replication activities

249

Source Job User (&JOBUSER)


The operating system user at the time of the update. Data TypeCharacter InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400Support for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to UNKNOWN on the subscriber. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the name of the user that performed the operation on the source table. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to NULL. v InfoSphere CDC for Microsoft SQL Server (V5.3)Support for this journal control field is not available. If you decide to use this journal control field when mirroring or refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for Microsoft SQL Server (V6.0+)Support for this journal control field is not available. If you decide to use this journal control field when mirroring data, InfoSphere CDC sets this journal control field to the database user name on the subscriber. The name is set to the database user that owns the InfoSphere CDC metadata tables. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to TS. v InfoSphere CDC for DB2 UDBSupport for this journal control field is not available. If you decide to use this journal control field when mirroring data, InfoSphere CDC sets this journal control field to the database user name on the subscriber. The name is set to the database user that owns the InfoSphere CDC metadata tables. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to TS. v InfoSphere CDC for z/OSSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring data, this journal control field contains the Authorization ID that the job used to connect to DB2. This is usually the User ID of the job. When refreshing data, this journal control field contains the User ID of the InfoSphere CDC address space.

Journal Name (&JOURNAL)


The name of the journal. Depending on the version of InfoSphere CDC you install, the high byte of this journal control field identifies the name of the journal, and the low byte of this field identifies the library where it resides. For example, JRN1 LIB1. Data TypeCharacter

250

InfoSphere Change Data Capture Management Console: Administration Guide

InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. If both the name and library are included in this journal control field, then &JRNLIB journal control field is not supported by InfoSphere CDC. v InfoSphere CDC for AS/400Support for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, it contains the journal name and journal library. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to UNKNOWN on the subscriber. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the journal name in the format <schema>.<journal>. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to NULL. InfoSphere CDC for Microsoft SQL ServerSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for DB2 UDBSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for z/OSSupport for this journal control field is only available when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the name of the DB2 subsystem or data sharing group to which InfoSphere CDC is connected. v

Source Table Library (&LIBRARY)


The name of the source table schema or its alias. Data TypeCharacter InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400Support for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the journal name in the format <schema>.<journal>. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to a default value of N. v InfoSphere CDC for Microsoft SQL ServerSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data.

Using journal control fields for auditing replication activities

251

v InfoSphere CDC for DB2 UDBSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for z/OSSupport for this journal control field is only available when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, the journal control field contains the database name in which the table was created and owner ID of the table in the format <dbname.owner>.

Source Table Member Name (&MEMBER)


The name of the source table or its alias. Data TypeCharacter InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400Support for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring or refreshing data, this journal control field contains the name of the source table. v InfoSphere CDC for Microsoft SQL Server (V5.3)Support for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring or refreshing data, this journal control field contains the name of the source table. v InfoSphere CDC for Microsoft SQL Server (V6.0)Support for this journal control field is not available. If you decide to use this journal control field when mirroring or refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for DB2 UDBSupport for this journal control field is not available. If you decide to use this journal control field when mirroring or refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for z/OSSupport for this journal control field is not available.

Source Table Name (&OBJECT)


The name of the source table or its alias. Data TypeCharacter InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400Support for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available only when InfoSphere CDC mirrors data. When mirroring or refreshing data, this journal control field contains the name of the source table.

252

InfoSphere Change Data Capture Management Console: Administration Guide

InfoSphere CDC for Microsoft SQL ServerSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data v InfoSphere CDC for DB2 UDBSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. v InfoSphere CDC for z/OSSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring or refreshing data, this journal control field contains the name of the source table. v

Source Program Name (&PROGRAM)


The name of the program on the source system that made the update. Data TypeCharacter InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400Support for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to UNKNOWN on the subscriber. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the program that performed the operation on the source table. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to NULL v InfoSphere CDC for Microsoft SQL Server (V5.3)Support for this journal control field is not available. If you decide to use this journal control field when mirroring or refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for Microsoft SQL Server (V6.0)Support for this journal control field is not available. If you decide to use this journal control field when mirroring data, InfoSphere CDC sets this journal control field to UNKNOWN. If you decide to use this journal control field when refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for DB2 UDBSupport for this journal control field is not available. If you decide to use this journal control field when mirroring data, InfoSphere CDC sets this journal control field to UNKNOWN. If you decide to use this journal control field when refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for z/OSSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring or refreshing data, this journal control field contains the DB2 plan name to which the user is connected. A plan describes the SQL that accesses the tables, paths, indices used and so on.

Using journal control fields for auditing replication activities

253

Journal Sequence Number (&SEQNO)


The sequence number of this update in the journal. Data TypeInteger (InfoSphere CDC 5.x) InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400Support for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to relative record number on the target. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the sequence number. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to NULL. v InfoSphere CDC for Microsoft SQL ServerSupport for this journal control field is not available. If you decide to use this journal control field when mirroring or refreshing data, InfoSphere CDC sets this journal control field to a default value of 0. v InfoSphere CDC for DB2 UDBSupport for this journal control field is not available. If you decide to use this journal control field when mirroring or refreshing data, InfoSphere CDC sets this journal control field to a default value of 0. v InfoSphere CDC for z/OSSupport for this journal control field is only available when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the RBA or LRSN integer. DB2 uses RBAs and LRSNs to keep track of log positions. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to a default value of 0.

Source Server Name (&SYSTEM)


The host name of the source system. Data TypeCharacter InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400Support for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring or refreshing data, this journal control field contains the name of the source system.

254

InfoSphere Change Data Capture Management Console: Administration Guide

InfoSphere CDC for Microsoft SQL Server (V5.x)Support for this journal control field is not available. If you decide to use this journal control field when mirroring or refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for Microsoft SQL Server (V6.x)Support for this journal control field is not available. If you decide to use this journal control field when mirroring or refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for DB2 UDBSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data v InfoSphere CDC for z/OSSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring or refreshing data, this journal control field contains the system name on which InfoSphere CDC is running. The system name is extracted from the root control block (CVT) of the z/OS operating system. v

Record Modification Time (&TIMESTAMP)


The date and time of when the update or refresh was made on the source. In environments that support microsecond precision, the date and time format of this journal control field is YYYY-MM-DD-HH:MM:SS.UUUUUU. Otherwise, InfoSphere CDC sets the microsecond component UUUUUU to zeroes or does not include it at all. Data TypeTimestamp (InfoSphere CDC 5.x) InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400support for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring data, this journal control field contains the date and time of when InfoSphere CDC applied the row-level operation (insert, update, or delete) to the source table. When refreshing data, this journal control field contains the current date and time. v InfoSphere CDC for Oracle and Sybasesupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring data, this journal control field contains the data and time of when InfoSphere CDC applied the operation to the source table. When refreshing data, this journal control field contains the current date and time. v InfoSphere CDC for Microsoft SQL Server (V5.3)support for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring data, this journal control field contains the date and time of when InfoSphere CDC applied the row-level operation (insert, update, or delete) to the source table. When refreshing data, this journal control field contains the date and time of when InfoSphere CDC replicated the row in the source table. v InfoSphere CDC for Microsoft SQL Server (V6.0)support for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring data, this journal control field contains the date and time of when InfoSphere CDC applied the row-level operation (insert, update, or delete) to the source table. When refreshing data, this journal control field contains the date and time of when InfoSphere CDC refreshed the first row. v InfoSphere CDC for DB2 UDBsupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring data,
Using journal control fields for auditing replication activities

255

this journal control field contains the date and time of when InfoSphere CDC applied the row-level operation (insert, update, or delete) to the source table. When refreshing data, this journal control field contains the date and time of when InfoSphere CDC refreshed the first row. v InfoSphere CDC for z/OSsupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring data, this journal control field contains the time when InfoSphere CDC applied the row-level operation (insert, update, or delete) to the source table. When refreshing data, this journal control field contains the current date and time.

Record Modification User (&USER)


The user ID that made the update on the source. Data TypeCharacter InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400support for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to UNKNOWN on the subscriber. v InfoSphere CDC for Oracle and Sybasesupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the name of the database user that performed the operation on the source table. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to NULL. v InfoSphere CDC for Microsoft SQL Server (V5.3)support for this journal control field is only available when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the name of the user or if the user that made the change is the system administrator, it contains the name of the dbo. v InfoSphere CDC for Microsoft SQL Server (V6.0)support for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to NOT SET. v InfoSphere CDC for DB2 UDBsupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to NOT SET. v InfoSphere CDC for z/OSsupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the Authorization ID that the job used to connect to DB2. This is usually the User ID of the job.

256

InfoSphere Change Data Capture Management Console: Administration Guide

About journal codes


The &ENTTYP journal control field generates journal codes that provide you with the information you need to identify the exact table operations on the source system that generated the audit record in the table on the target system. By mapping the &ENTTYP journal control field to the added audit column in the table on the target system, you can determine the events that generated each audit record. In the target database, the &ENTTYPjournal control field contains the two-character journal code that identifies the specific event that happened at the source table level and which generated the audit record on the target system. InfoSphere CDC generates multiple journal codes. Journal codes represent events that take place in your source database. You can customize the journal codes by building an expression with the %IF column function. For more information, see Translating journal codes into meaningful information on page 259. You can customize the journal codes generated by InfoSphere CDC. See also: Table Clear Delete on page 258 Insert on page 258 Update Before on page 258 Update After on page 259

Table Clear
The Table Clear events clear data in a table on the source system. Depending on the type of Table Clear event that has taken place on the source system, InfoSphere CDC supports an iSeries journal code.

iSeries journal codes


v CRindicates that a file, table, or member has been cleared on the source system. v MDindicates that a file, table, or member has been deleted on the source system. This uses journal control fields for auditing replication activities. v RSindicates that prior to a refresh, a file, table, or member has been cleared on the source system. In this case, the refresh is a result of an implied table restore. v AYJjournal Change Apply Start, which indicates the starting point for a set of journal entries applied to a file, table, or member on the source system. InfoSphere CDC appends this entry to the audit table on the target system. v AZJournal Change Apply End, which indicates the ending point for a set of journal entries applied to a file, table, or member on the source system. InfoSphere CDC appends this entry to the audit table on the target system. v RCJournal Change Remove Start, which indicates the starting point for a set of journal entries and reverses previous applies that were made to a file, table, or member on the source system. InfoSphere CDC appends this entry to the audit table on the target system. v RZJjournal Change Remove End, which indicates the ending point for a set of journal entries and reverses previous applies that were made to a file, table, or member on the source system. InfoSphere CDC appends this entry to the audit table on the target system. RZ is a journal code generated by InfoSphere CDC. It is not an iSeries journal code.
Using journal control fields for auditing replication activities

257

v JMindicates that journaling on the file or table has been started on the source system. v EJindicates that journaling on the file or table ended on the source system. v RGindicates that a file, table, or member has been reorganized on the source system. v MNBefore Rename, which indicates when the file or member has been renamed on the source system. InfoSphere CDC appends this entry to the audit table on the target system. v NZAfter Rename, which indicates that a new name has been given to a file or member on the source system. InfoSphere CDC appends this entry to the audit table on the target system. v MMBefore Publication File Move, which indicates when the file has been moved on the source system. InfoSphere CDC appends this entry to the audit table on the target system. v MZAfter Publication File Move, which indicates a new location for a file that has been moved on the source system. InfoSphere CDC appends this entry to the audit table on the target system. MZ is a journal code generated by InfoSphere CDC. It is not an iSeries journal code. v MRindicates that a file on the source system has been restored. v CHindicates that a file on the source system has been changed. When a non-schema change is applied to the audit table on the source system, InfoSphere CDC appends this entry to the audit table on the target system.

Delete
The Delete events delete records in a table on the source system. Depending on the type of Delete event that has taken place on the source system, InfoSphere CDC supports an iSeries journal code.

iSeries journal codes


v DLIndicates that a record from a table on the source system has been deleted. v DRIndicates that a record from a table on the source system has been deleted because of a rollback operation of an inserted record.

Insert
The Insert events insert rows in a table on the source system. Depending on the type of Insert event that has taken place on the source system, InfoSphere CDC supports an iSeries journal code.

iSeries journal codes


v PTIndicates that a record in a table on the source system has been inserted. v PXIndicates that a record in a table on the source system has been inserted by re-establishing a deleted record. v URIndicates that a record in a table on the source system has been inserted through a rollback of a deleted record. v RRIndicates that a record in a table on the source system has been refreshed.

Update Before
The Update Before events provide you with the before image of records updated in a table on the source system. Depending on the type of Update Before event that has taken place on the source system, InfoSphere CDC generates a journal code.

258

InfoSphere Change Data Capture Management Console: Administration Guide

iSeries journal codes


v UBIndicates the before image of a record updated in a table on the source system. v FDIndicates the before image of a record updated in a table on the source system that satisfies a row selection expression. InfoSphere CDC appends this entry to the audit table on the target system as a Filtered Record Delete. FD is a journal code generated by InfoSphere CDC. It is not an iSeries journal code. v v FBIndicates the before image of a record updated in a table on the source system that does not satisfy a row selection expression. InfoSphere CDC appends this entry to the audit table on the target system as a Filtered Record Insert. This record is only placed in the audit table when the corresponding after image satisfies the row selection expression (FI) and you want to include both images in the audit table. Otherwise, InfoSphere CDC only includes a single record (FI) in the audit table. You can audit both images using a InfoSphere CDC system parameter. For more information, see the appropriate InfoSphere CDC User Manual for your platform. FB is a journal code generated by InfoSphere CDC. It is not an iSeries journal code. v BRIndicates the before image of a record updated for rollback in a table on the source system.

Update After
The Update After events provide you with the after image of records updated in a table on the source system. Depending on the type of Update After event that has taken place on the source system, InfoSphere CDC generates a journal code.

iSeries journal codes


v UPIndicates the after image of a record updated in a table on the source system. v FIIndicates the after image of a record updated in a table on the source system that satisfies a row selection expression. InfoSphere CDC appends this entry to the audit table on the target system as a Filtered Record Insert. FD is a journal code generated by InfoSphere CDC. It is not an iSeries journal code. v FPIndicates the after image of a record updated in a table on the source system that does not satisfy a row selection expression. InfoSphere CDC appends this entry to the audit table on the target system as a Filtered Record Delete. This record is only placed in the audit table when the corresponding before image satisfies the row selection expression (FD) and you want to include both images in the audit table. Otherwise, InfoSphere CDC only includes a single record (FD) in the audit table. You can audit both images using an InfoSphere CDC system parameter. For more information, see the appropriate InfoSphere CDC documentation for your platform. FP is a journal code generated by InfoSphere CDC. It is not an iSeries journal code. v URIndicates the after image of a record updated for rollback in a table on the source system.

Translating journal codes into meaningful information


When you map your tables using LiveAudit, you can map your audit columns to the &ENTTYP journal control field to let you know what kind of change has been made on your source table. Because there are many changes that can take place, if you map a journal control field to a target column, InfoSphere CDC generates a distinct two-letter journal code on your audit table to help you identify the event that occurred on the source. For example, if there has been a row inserted in your
Using journal control fields for auditing replication activities

259

source table, then in response to this update, InfoSphere CDC inserts a row into the target table with the journal code PT. The journal codes your system generates depend on the database platform that you are using. You may want to customize journal codes so that they are more meaningful in your organization. For example, instead of having the journal code PT to indicate that there has been a new row inserted in your source table, you may want to use a one-letter code such as I to identify the insert. The %IF column function evaluates conditional expressions and returns different values if the expression is true or false. The example below illustrates how you can use the %IF column function to convert journal codes into custom letters
%IF(&ENTTYP=PT OR &ENTTYP="RR","I", %IF(&ENTTYP= "UB", "B", %IF(&ENTTYP= "UP", "A", %IF(&ENTTYP="DL","D","R"))))

This expression does the following: v If a row has been inserted or refreshed on the source table, then InfoSphere CDC generates I on the audit table. v If the before image on the source table has been updated, then InfoSphere CDC generates B on the audit table. v If the after image has been updated on the source table then InfoSphere CDC generates A in the audit table. v If a row on the source table has been deleted, then InfoSphere CDC generates D on the audit table, otherwise it generates R on the audit table.

260

InfoSphere Change Data Capture Management Console: Administration Guide

Column functions
InfoSphere CDC provides a number of column functions that you can use in expressions when mapping target columns. This topic describes each of the column functions, their syntax and parameters, and also provides examples that illustrate how to use them. In this section, you will learn: Conventions in using column functions String functions on page 262 Date and time functions on page 269 Conversion functions on page 274 Conditional and variable functions on page 282 Data functions on page 284 User exit functions on page 297 %GETCOL column function scenarios (DB2 UDB for iSeries) on page 305 %GETCOL column function scenarios (Dynamic SQL) on page 307 Publishing multiple derived columns using the %GETCOL function (Dynamic SQL) on page 309

Conventions in using column functions


Before using column functions in expressions, you should consider the following: v Depending on the InfoSphere CDC you have installed, some column functions may not be supported. v Names of column functions are case sensitive. InfoSphere CDC only supports uppercase characters. v For some column functions, you cannot specify a Large OBject (LOB) column as a function parameter. For more information about LOB data type support, see the appropriateInfoSphere CDC documentation. v You can specify character literals in their internal numeric representation, as parameters for column functions. To do this, use the double-angled bracket notation (<< >>). This notation lets you work with character literals that contain both printable and non-printable characters. v Specifying character values as decimal integers: The values you specify within brackets are decimal integers that represent either American Standard Code for Information Interchange (ASCII) or Extended Binary Coded Decimal Interchange Code (EBCDIC) characters. For ASCII characters, these values must be in the range of 0 to 127. For EBCDIC, these values must be in the range of 0 to 255. For example, <<32>> represents a blank character in ASCII. Do not prefix these values with zeroes. If you have installed InfoSphere CDC for z/OS or InfoSphere CDC for AS/400 as a target system, and the column function manipulates a value from a target column, then specify integers in EBCDIC format. For all other InfoSphere CDC products installed on the target system, you can specify integers in ASCII format. v InfoSphere CDC for z/OS does not support the double-angled bracket notation.

Copyright IBM Corp. 2008

261

v You can specify multiple characters in the same character literal. For example, if you are using the ASCII character set, the notation <<65>><<78>><<78>><<65>> and <<65>>NN<<65>> represent the string ANNA. v If you do not follow the double-angled bracket notation, such as <45>>, then InfoSphere CDC does not generate an error. Instead, InfoSphere CDC treats it as a sequence of characters (<, 4, 5, >, and >), and returns the result based on this sequence. v To specify NULL as a parameter in a column function, enter NULL without any delimiter.

String functions
Use these functions when you want InfoSphere CDC to manipulate strings. During replication, you can have InfoSphere CDC concatenate multiple strings, remove blank characters from a string, change the case of the characters in a string, replace characters of a string with other characters, or extract a substring from a string. Note: Some examples in this section use the double-angled bracket notation (<< >>) and are based on the American Standard Code for Information Interchange (ASCII) character set. Under a different character set, these examples do not produce the same results as described. See also: Concatenation%CONCAT Lowercase%LOWER on page 263 Left trim%LTRIM on page 263 Capitalization%PROPER on page 264 Character substitution%REPLACE on page 265 Right trim%RTRIM on page 266 Substring%SUBSTRING on page 267 Uppercase%UPPER on page 268

Concatenation%CONCAT
Use this function when you want InfoSphere CDC to concatenate multiple character fields and literals to form a single string. You can concatenate up to 20 character fields and literals up to a total length of 2,048 characters.

Syntax
%CONCAT(<parm1>, <parm2>, ...<parm20>)

Parameters
parm1 to parm20Specify character columns, literals, or column functions that return character strings.

Result data type


Character-based.

Examples
%CONCAT(FNAME, " ", LNAME)

262

InfoSphere Change Data Capture Management Console: Administration Guide

Concatenates the values from the FNAME and LNAME columns with a blank character inserted between them. For example, if FNAME = Ray and LNAME = Kennedy, this function returns Ray Kennedy.
WITH P %CONCAT("InfoSphere", " ", "CDC", "Management", "Console")

Returns the string InfoSphere CDC Management Console.


%CONCAT("Anna", "<<32>>", "Kim<<0>>")

Returns the NUL-terminated ASCII string Anna Kim. For information about the double-angled bracket notation, see String functions on page 262.

Lowercase%LOWER
Use this function when you want InfoSphere CDC to trim all leading blank characters from a character string during replication.

Syntax
%LOWER(<parm>)

Parameters
parmSpecifies a character column, literal, or column function that returns a character string.

Result data type


Character-based. Returns NULL if parm is NULL.

Examples
%LOWER(DEPARTMENT)

Returns the strings in the DEPARTMENT column in lowercase. For example, accounting, marketing, and so on.
%LOWER("BrUcE JoNeS")

Returns the string bruce jones.


%LOWER(%SUBSTRING("BrUcE JoNeS",3,2))

Returns the string uc.


%LOWER("<<65>><<78>><<78>><<65>><<32>><<75>><<73>><<77>>")

Returns the ASCII string anna kim. Related concepts String functions on page 262 Related reference Substring%SUBSTRING on page 267

Left trim%LTRIM
Use this function when you want InfoSphere CDC to convert all uppercase characters in a string to lowercase during replication.

Column functions

263

Syntax
%LTRIM(<parm>)

Parameters
parmSpecifies a character column, literal, or column function that returns a character string.

Result data type


Character-based. Returns NULL if parm is NULL.

Examples
%LTRIM(" George Smith")

Returns the string George Smith, with no leading blank characters.


%LTRIM("Andrea Moss ")

Returns the string Andrea Moss . The %LTRIM function does not trim trailing and embedded blank characters.
%LTRIM("<<32>><<32>><<32>>Anna Kim")

Returns the ASCII string Anna Kim, with no leading blank characters. Related concepts String functions on page 262

Capitalization%PROPER
Use this function when you want InfoSphere CDC to convert the first letter of each word to uppercase, and the remaining letters to lowercase during replication. A word is a consecutive sequence of non-blank characters encapsulated by blank characters and string boundaries.

Syntax
%PROPER(<parm>)

Parameters
parmSpecifies a character column, literal, or column manipulation function that returns a character string.

Result data type


Character-based. Returns NULL if parm is NULL.

Examples
%PROPER(NAME)

Returns the value in the NAME column with the first letter of each word capitalized. For example, Steve Malone.
%PROPER("TiNa MaNcInI")

Returns the string Tina Mancini.


%PROPER(%SUBSTRING("tInA mAnCiNi",3,6))

264

InfoSphere Change Data Capture Management Console: Administration Guide

Returns the string Na Man.


%PROPER("mary-lou fernandez")

Returns the string Mary-lou Fernandez. Note that lou is not converted to Lou.
%PROPER("<<97><<110>><<110>><<97>><<32>><<107>><<105>><<109>>")

Returns the ASCII string Anna Kim. Related concepts String functions on page 262 Related reference Substring%SUBSTRING on page 267

Character substitution%REPLACE
Use this function when you want InfoSphere CDC to replace leading, trailing, or all occurrences of a specified character with another character during replication. It provides a character-by-character replacement. You can use this function to replace leading blank characters with zeros.

Syntax
%REPLACE(<parm>, "<type>", "<str1>", "<str2>")

Parameters
v parmSpecifies a character column, literal, or column function that returns a character string. v typeSpecifies the substitution type. You must enclose values of this parameter in double quotes. *ALLReplaces all occurrences of the specified character. *TRAILReplaces all trailing occurrences of the specified character. *LEADReplaces all leading occurrences of the specified character. v str1Specifies the set of characters to be replaced. v str2Specifies the set of characters to replace those specified in str1 . If the number of characters in str1 is greater than that in str2 , the extraneous characters in str1 are deleted in the result. If the number of characters in str1 is less than that in strthe extraneous characters in str2 are ignored. If you specify str2 as two consecutive double quotes () , you can remove instances of a character from str1.

Result data type


Character.

Examples
%REPLACE(CUSTNO, "*LEAD", " ", "0")

Replaces all leading blank characters in the CUSTNO column with zeros.
%REPLACE(CUSTNO, "*LEAD", "ABC", "123")

Replaces all leading occurrences of A with 1, B with 2, and C with 3 in the CUSTNO column. Evaluation begins with the first character and continues until a character other than A, B or C
Column functions

265

is found. For example, if a column value is AC7777, this example returns 137777. If a column value is ADC7777, this example returns 1DC7777.
%REPLACE(PHONENO, "*ALL", " ", "")

Removes all blank characters in the PHONENO column. This example illustrates how the %REPLACE function can be used to remove a character from a string instead of replacing it with another character.
%REPLACE(PHONENO, "*LEAD", " ", "")

Removes all leading blank characters in the PHONENO column. This example is similar to the previous example, except that only leading blank characters are removed. To remove leading blank characters, you can also use the %LTRIM function. To remove trailing blank characters, use the %RTRIM function.
%REPLACE(PARTNO, "*TRAIL", "ACY", "acy")

Replaces all trailing occurrences of A with a, C with c, and Y with y in the PARTNO column. Evaluation begins with the last character and continues until a character other than A, C or Y is found. For example, if a column value is 2361ACY, this example returns 2361acy. If a column value is 2361ADY, this example returns 2361ADy.
%REPLACE("259899", "*ALL", "29", "4")

Returns 458. Replaces all occurrences of 2 with 4, and removes all occurrences of 9.
%REPLACE("259899", "*ALL", "2", "45")

Returns 459899. Replaces all occurrences of 2 with 4. Does not remove occurrences of 5.
%REPLACE(PRODDESC, "*ALL", "<<0>><<13>>", "<<32>><<32>>")

On platform that use the ASCII character set, this functions replaces all occurrences of NUL and carriage return in the PRODDESC column with blank characters. Related concepts String functions on page 262 Related reference Left trim%LTRIM on page 263 Right trim%RTRIM

Right trim%RTRIM
Use this function when you want InfoSphere CDC to trim all trailing blank characters from a character string during replication.

Syntax
%RTRIM(<parm>)

Parameters
v parmSpecifies a character column, literal, or column function that returns a character string. v posSpecifies the starting position. This value must be greater than or equal to 1.

266

InfoSphere Change Data Capture Management Console: Administration Guide

v lenSpecifies the length of the substring. This value must be greater than or equal to 1.

Result data type


Character-based. Returns NULL if parm is NULL.

Examples
Related concepts String functions on page 262

Substring%SUBSTRING
Use this function when you want InfoSphere CDC to create a character string that is a subset of an existing string that begins at a specified starting position and continues for a specified length.

Syntax
%SUBSTRING(<parm>, <pos>, <len>)

Parameters
v parmSpecifies a character column, literal or column function that returns a date value accepted by the function. v typeSpecifies the format of the input date. You must enclose values of this parameter in double quotes. *YMDThe input format is yymmdd. *MDYThe input format is mmddyy. *DMYThe input format is ddmmyy. *YMThe input format is yymm. *MYThe input format is mmyy. *JULThe input format is yyjjj, where jjj represent the sequence number of a day in the calendar year. jjj must be between 1, which represents January 1st, and 366, which represents December 31st in a leap year. For jjj values less than 100, you must specify the leading zero or zeros. For example, the Julian date for February 4th is 035, which represents the 35th day of the year. v centurylineSpecifies the year in the century used to determine which century is added to the date. All years that precede the century line year will be designated as being in the 21st century. All years including and following the century line year will be designated as being in the 20th century. If centuryline is greater than 99, all years are designated as being in the 21st century. For example, if centuryline is set to 30 and the two-digit year specified by parm is 19, this function returns 2019. If centuryline is set to 20 and the two-digit year specified by parm is 33, this function retrrns 1933. This parameter is optional. If you omit this parameter, InfoSphere CDC assumes a default value of 40.

Result data type


Character-based. Returns NULL if parm is NULL. If pos is greater than the length of parm , then the function returns a string of blank characters, with a length of len. If pos is less than the length of parm, but pos + len
Column functions

267

is greater then the length of parm , then the function returns a string of length len that has the portion of parm that starts at pos and ends at the end of parm, right-padded with blank characters.

Examples
%SUBSTRING(DIVISION,3,2)

Returns two characters from the DIVISION column beginning from the third position.
%SUBSTRING("Tony Jackson",0,2)

Generates a runtime error because the starting position cannot be less than 1.
%SUBSTRING("Anna<<32>>Kim<<0>>", 1, 8)

Returns the ASCII string Anna Kim with no NUL-termination. Related concepts String functions on page 262

Uppercase%UPPER
Use this function when you want InfoSphere CDC to convert all lowercase characters in a string to uppercase during replication.

Syntax
%UPPER(<parm>)

Parameters
parmspecifies a character column, literal, or column function that returns a character string.

Result data type


Character-based. Returns NULL if parm is NULL.

Examples
%UPPER(DEPARTMENT)

Returns the strings in the DEPARTMENT column in uppercase. For example, ACCOUNTING, MARKETING, and so on.
%UPPER("AnDrEa MoSs")

Returns the string ANDREA MOSS.


%UPPER("[emp ny]")

Returns the string [EMP NY].


%UPPER(%SUBSTRING("AnDrEa MoSs",3,2))

Returns the string DR. For information about the %SUBSTRING function, see .
%UPPER("<<97>><<110>><<110>><<97>><<32>><<75>><<73>><<77>>")

Returns the ASCII string ANNA KIM. Related concepts

268

InfoSphere Change Data Capture Management Console: Administration Guide

String functions on page 262 Related reference Substring%SUBSTRING on page 267 Uppercase%UPPER on page 268

Date and time functions


Use these functions when you want InfoSphere CDC to manipulate date and time values during replication. You can add a two-digit century specification to a date, or retrieve the current date and time. See also: Century%CENTURY Current date%CURDATE on page 270 Current time%CURTIME on page 271 Current timestamp%CURTMSTP on page 273

Century%CENTURY
Use this function when you want InfoSphere CDC to add a two-digit century specification to a date that identifies the year without the century during replication. This function accepts a character date value specified in one of six different formats.

Syntax
%CENTURY(<parm>, "<type>", [centuryline])

Parameters
v parmSpecifies a character column, literal or column function that returns a date value accepted by the function. v typeSpecifies the format of the input date. You must enclose values of this parameter in double quotes. *YMDThe input format is yymmdd. *MDYThe input format is mmddyy. *DMYThe input format is ddmmyy. *YMThe input format is yymm. *MYThe input format is mmyy. *JULThe input format is yyjjj, where jjj represent the sequence number of a day in the calendar year. jjj must be between 1, which represents January 1st, and 366, which represents December 31st in a leap year. For jjj values less than 100, you must specify the leading zero or zeros. For example, the Julian date for February 4th is 035, which represents the 35th day of the year. v centurylineSpecifies the year in the century used to determine which century is added to the date. All years that precede the century line year will be designated as being in the 21st century. All years including and following the century line year will be designated as being in the 20th century. If centuryline is greater than 99, all years are designated as being in the 21st century. For example, if centuryline is set to 30 and the two-digit year specified by parm is 19, this function returns 2019. If centuryline is set to 20 and the two-digit year specified by parm is 33, this function returns 1933.

Column functions

269

This parameter is optional. If you omit this parameter, InfoSphere CDC assumes a default value of 40.

Result data type


Character if parm is character. Otherwise, it returns a numeric value.

Examples
Input Date (parm) 101001 211197 032080 0493 2001 99365 Input Format (type) *YMD *DMY *MDY *MY *YM *JUL 92 0 60 80 Input century line (centuryline) Result 20101001 (October 1, 2010) 21111997 (November 21, 1997) 03201980 (March 20, 1980) 041993 (April 1993) 202001 (January 2002) 1999365 (December 31, 1999)

Related concepts Date and time functions on page 269

Current date%CURDATE
Use this function when you want InfoSphere CDC to return the current date during data replication (refresh or mirroring) activities on the source or target. For example, you may want to track when InfoSphere CDC inserts a record or when it performs updates on source and target columns. This function uses the system clock you have set on the source or target. Note: InfoSphere CDC for AS/400 and InfoSphere CDC for Microsoft SQL Server do not support this function. Table 1 Input Date (parm) Input Format (type) Input century line Result 101001 *YMD 20101001 (October 1, 2010) 211197 *DMY 0 21111997 (November 21, 1997) 032080 *MDY 60 03201980 (March 20, 1980) 0493 *MY 80 041993 (April 1993) 2001 *YM 202001 (January 2020) 99365 *JUL 92 1999365 (December 31, 1999) Mapping a target column to an expression that uses the %CURDATE function is not the same as defining the current date as the initial value for the target column. When you map a target column to an expression, InfoSphere CDC populates the target column with the current date when a record is inserted or updated in the target table. However, when you define the initial value as the current date, InfoSphere CDC populates the target column with the current date only when it inserts a record into the target table.

Syntax
%CURDATE("<timezone>")

270

InfoSphere Change Data Capture Management Console: Administration Guide

Parameters
timezoneSpecifies the time zone of the result. You must enclose values of this parameter in double or single quotes. v *LOCReturns the date local to the source or target. v *UTCReturns the date in Coordinated Universal Time (UTC). v *GMTReturns the date in Greenwich Mean Time (GMT). This is the same as *UTC.parmSpecifies a character column, literal, or column function that returns a character string.

Result data type


Character, in the format CCYY-MM-DD.

Examples
%CURDATE("*LOC")

If the local time is March 11, 2004, this function returns 2004-03-11.
%CURDATE("*UTC")

For a server located in the Japan Standard Time (JST) zone, on August 28, 2007, at 1:21 AM, this function returns 2007- 08-27. JST is 9 hours ahead of UTC (UTC+9).
%CURDATE("*GMT")

For a server located in the Japan Standard Time (JST) zone, on August 28, 2007, at 1:21 AM, this function returns 2007- 08-27. JST is 9 hours ahead of UTC (UTC+9). This example is equivalent to %CURDATE (*UTC).
%SUBSTRING(%TOCHAR(%CURDATE("*LOC"), 10), 6, 5)

Returns the month and day of the %CURDATE function invocation local to the source or target. You can use this example if you require the month and day only. For example, if the local date is January 29, 2007, the expression returns 01-29. The %TOCHAR function extracts the month, separator character, and day. Related concepts Date and time functions on page 269 Mapping initial values to target columns on page 161 Related reference Character conversion%TOCHAR on page 274 Substring%SUBSTRING on page 267

Current time%CURTIME
Use this function when you want InfoSphere CDC to return the time when it inserts or updates a row on source and target columns. This function uses the system clock on the source or target. Note: InfoSphere CDC for AS/400 and InfoSphere CDC for Microsoft SQL Server do not support this function.

Syntax
%CURTIME("<timezone>")

Column functions

271

Parameters
timezoneSpecifies the time zone of the result. You must enclose values of this parameter in double or single quotes. v *LOCReturns the time local to the source or target. v *UTCReturns the time in Coordinated Universal Time (UTC). v *GMTReturns the time in Greenwich Mean Time (GMT). This is the same as *UTC.

Result data type


Character, in the format HH.MM.SS.

Examples
%CURTIME("*LOC")

If the local time is 11:25:22 PM (local), this function returns 23.25.22.


%CURTIME("*UTC")

For a server located in the Hawaiian Standard Time (HST) zone, at 9:14:33 PM, this function returns 07.14.33. HST is 10 hours behind UTC (UTC-10). %CURTIME(*GMT) For a server located in the Hawaiian Standard Time (HST) zone, at 9:14:33 PM, this function returns 07.14.33. HST is 10 hours behind UTC (UTC-10). This example is equivalent to %CURTIME (*UTC).
%TOCHAR(%IF(%VAR(EST, %TONUMBER(%REPLACE(%TOCHAR(%CURTIME("*LOC"), 8), "*ALL", ".", "")) + 30000) < 240000, %VAR(EST), %VAR(EST) 240000), 6)

Returns the time of the %CURTIME function invocation three time zones ahead relative to the local time zone on the source or target. This example illustrates that an expression can be defined to convert local time to the equivalent time in any other time zone (not necessarily UTC). It returns a character result after performing time calculations. For example, if this expression is evaluated on a server located in the Pacific Standard Time (PST) zone at 3:22:48 PM, the expression returns 182248. The result represents the same time in the Eastern Standard Time (EST) zone, which is 3 hours ahead of PST (PST+3). In the event that the returned Pacific time is in the interval from 9:00:00 PM to 12:00:00 AM, the %IF function ensures that the expression returns the equivalent Eastern time on the following day. To modify the above expression to select a different time zone ahead or behind the local time zone, change + 30000 to a different sign and value. For example, changing +30000 to +20000 returns the equivalent time in the Central Standard Time (CST) zone.
%IF(%VAR(DIFF, %TONUMBER(%TOCHAR(%CURTIME("*LOC"), 2)) %TONUMBER(%TOCHAR(%CURTIME("*UTC"), 2))) > 12, %VAR(DIFF) 24, %IF(%VAR(DIFF) < 12, %VAR(DIFF) + 24, &VAR(DIFF)))

Returns the time difference between UTC and the time zone of the source or target where the %CURTIME functions are invoked.

272

InfoSphere Change Data Capture Management Console: Administration Guide

For example, if this expression is evaluated on a server located in the Central Europe Time (CET) zone at 6:43:07 PM, the expression returns 1. If the server is located in the Mountain Standard Time (MST) zone and the functions are invoked at 1:22:13 AM, the expression returns -7. Note: This example compares equivalent times after obtaining two separate time samples, which may not always produce the correct results. The expression will not produce the correct result if %CURTIME ("*LOC") is invoked at 7:59:59 AM, local time, and %CURTIME ("*UTC") is invoked one second later at 8:00:00 AM, local time.

Current timestamp%CURTMSTP
Use this function to when you want InfoSphere CDC to track the date and time when it inserts or updates a row in source and target columns. This function uses the system clock on the source or target. Note: InfoSphere CDC for AS/400 and InfoSphere CDC for Microsoft SQL Server do not support this function.

Syntax
%CURTMSTP("<timezone>")

Parameters
timezoneSpecifies the time zone of the result. You must enclose values of this parameter in double or single quotes. v *LOCReturns the time local to the source or target. v *UTCReturns the time in Coordinated Universal Time (UTC). v *GMTReturns the time in Greenwich Mean Time (GMT). This is the same as *UTC.

Result data type


Character, in the format CCYY-MM-DD-HH.MM.SS.UUUUUU, where UUUUUU represents the number of microseconds. For example, 2008-12-09-03.11.34.849217. For environments that do not support microsecond precision, zeroes will be used to right-pad the result to a six-digit length. In the examples for this function, the results do not show microseconds.

Examples
%CURTMSTP("*LOC")

If the local time is 2:05:54 AM on June 18, 2005, this function returns 2005-06-18-02.05.54.
%CURTMSTP("*UTC")

For a server located in the Japan Standard Time (JST) zone, at 4:31:01 AM on September 22, 2011, this function returns 2011-09-21-19.31.01. JST is 9 hours ahead of UTC (UTC+9).
%CURTMSTP("*GMT")

For a server located in the Japan Standard Time (JST) zone, at 4:31:01 AM on September 22, 2011, this function returns 2011-09-21-19.31.01. JST is 9 hours ahead of UTC (UTC+9). This example is equivalent to %CURTMSTP(*UTC).
Column functions

273

%TOCHAR(%CURTMSTP("*UTC"), 16)

Returns the date and time (hours and minutes only) of the %CURTMSTP function invocation in UTC. You can use this example if you do not require the number of seconds and microseconds. For example, if the %CURTMSTP function is invoked on a server located in the Western Standard Time (WST) zone on April 24, 2013 at 4:05:22 AM, the expression returns 2013-04-23-20.05. WST is 8 hours ahead of UTC (UTC+8). The %TOCHAR function converts the date to character data and returns the first 16 characters of the timestamp returned by the %CURTMSTP function. For information about the %TOCHAR function, Character conversion%TOCHAR.

Conversion functions
Use these functions when you want InfoSphere CDC to convert values from one data type to another during replication. You can convert from any value to a character string or a numeric value, or from a numeric or character value to a datetime-type value. See also: Character conversion%TOCHAR Date conversion%TODATE on page 275 Date and time conversion%TODATETIME on page 277 Number conversion%TONUMBER on page 279 Time conversion%TOTIME on page 280

Character conversion%TOCHAR
Use this function to convert any value to a character string.

Syntax
%TOCHAR(<parm>, <length>, [decimal])

Parameters
v parmSpecifies a column name or literal. v lenSpecifies the number of characters to be returned. A decimal place counts as a returned value. For example, if you specify that you want to return three characters, this function returns the three leftmost or high order digits of parm. Note: Specify a negative value for this parameter if you would like %TOCHAR to treat the incoming value as unsigned. This feature is only available with InfoSphere CDC for z/OS. v decimalAn integer value that specifies the number of decimal places in the returned value. This parameter is optional and is only available with InfoSphere CDC for z/OS. The following table provides several examples with integers that have a defined number of decimal places and an example of how InfoSphere CDC for z/OS converts real floating decimals.
Input value 1.2345 1234.5 Length 6 7 Decimal 2 2 Result 001.23 1234.50

274

InfoSphere Change Data Capture Management Console: Administration Guide

Input value 1.02 1.02 (Real floating decimal)

Length 7 7

Decimal 2 2

Result 0001.02 1.02000

Result data type


If len specifies a value greater than the length of parm, the result is left-padded or right-padded with blank characters.

Examples
Input value (parm) 12345 123.45 0.123 1234 Input length (len) 3 5 3 6 Decimal places (decimal) Not specified. Not specified. Not specified. Not specified. Result 123 123.4 0.1 001234 The integer value is left-padded with zeros to return a string of six characters. 1.02 7 Not specified. 1.020000 The decimal part is right-padded with zeros to return a string of seven characters. 45699 9 2 000456.99 The integer value is left-padded with zeros and two decimal places to return a string of nine characters. Note: The decimal parameter is only supported by InfoSphere CDC for z/OS. $SEQNO -20 Not specified. 13878964169332555778. By specifying a negative length, %TOCHAR treats the &SEQNO journal control field as unsigned. Note: The ability to specify negative lengths is only supported by InfoSphere CDC for z/OS.

Date conversion%TODATE
Use this function when you want InfoSphere CDC to convert a numeric or character data type value to a datetime-data type during replication. You can convert dates from packed-numeric, zoned-numeric, or from character formats without century, to datetime or character-type values with century.
Column functions

275

Syntax
%TODATE(<date>, "<type>")

Parameters
v datespecifies the input date. If date is the name of a column containing a character string, the length of that string must match the length for the format specified by type, as indicated below. InfoSphere CDC generates an error if the length is any other value.
type value *YMD (yymmdd) *MDY (mmddyy) *DMY (ddmmyy) *YYMD (ccyymmdd) *CYMD (cyymmdd) *JUL (yyjjj) *CJUL (cyyjjj) *YJUL (ccyyjjj) Length of date 6 digits 6 digits 6 digits 8 digits 7 digits 6 digits 6 digits 7 digits

v typespecifies the format of the input date. You must enclose values of this parameter in double quotes. *YMDthe input format is yymmdd. MDYthe input format is mmddyy. *DMYthe input format is ddmmyy. *YYMDthe input format is ccyymmdd, where cc represents the century. *CYMDthe input format is cyymmdd, where c represents the century. A value of 0 for c represents the 20th century. Any other value represents the 21st century. *JULthe input format is yyjjj, where jjj represent the sequence number of a day in the calendar year. jjj must be between 1, which represents January 1st, and 366, which represents December 31st in a leap year. For jjj values less than 100, you must specify the leading zero or zeros. For example, the Julian date for February 4th is 035, which represents the 35th day of the year. When you set type to *JUL, if you specify a value for yy between 40 and 99, the %TODATE function returns the corresponding year in the 20th century. For example, 1940. If you specify a value for yy between 0 and 39, the %TODATE function returns the corresponding year in the 21st century. For example, 2039. *CJULthe input format is cyyjjj, where c represents the century. A value of 0 for c represents the 20th century. Any other value represents the 21st century. *YJULthe input format is ccyyjjj, where cc represents the century.

Result data type


Character, in standard ISO (International Organization for Standardization) format, that is CCYY-MM-DD. If the input date contains an invalid value for the year, month, or day, the %TODATE function returns the default value 1901-01-01.

276

InfoSphere Change Data Capture Management Console: Administration Guide

Examples
These examples show the hyphen (-) as the separator character in the returned ISO dates. Depending on your environment, a different character may separate the year, the month, and the day in the output date.
Input date (date) 760704 100195 000000 010768 19560205 1100216 95004 102032 1991359 Input format (type) *YMD *MDY *MDY *DMY *YYMD *CYMD *JUL *CJUL *YJUL Result 1976-07-04 (July 4, 1976) 1995-10-01 (October 10, 1995) 1901-01-01 (January 1, 1901) 1968-07-01 (July 1, 1968) 1956-02-05 (February 5, 1956) 2010-02-16 (February 16, 2010) 1995-01-04 (January 4, 1995) 2002-02-01 (February 2, 2002) 1991-12-25 (December 25, 1991)

Date and time conversion%TODATETIME


Use this function when you want InfoSphere CDC to convert a numeric or character data type to a datetime data type during replication. You can convert dates from packed-numeric, zoned-numeric, or from character formats without century, to datetime or character-type values with century. You can also convert time data types from packed-numeric, zoned-numeric, or character formats into datetime or character-type values with century. Note: InfoSphere CDC for AS/400 does not support this function.

Syntax
%TODATE(<date>, "<type>", <time>)

Parameters
v datespecifies the input date. If date is the name of a column containing a character string, the length of that string must match the length for the format specified by type, as indicated below. InfoSphere CDC generates an error if the length is any other value.
type value *YMD (yymmdd) *MDY (mmddyy) *DMY (ddmmyy) *YYMD (ccyymmdd) *CYMD (cyymmdd) *JUL (yyjjj) *CJUL (cyyjjj) *YJUL (ccyyjjj) Length of date 6 digits 6 digits 6 digits 8 digits 7 digits 6 digits 6 digits 7 digits

Column functions

277

v typespecifies the format of the input date. You must enclose values of this parameter in double quotes. *YMDthe input format is yymmdd. MDYthe input format is mmddyy. *DMYthe input format is ddmmyy. *YYMDthe input format is ccyymmdd, where cc represents the century. *CYMDthe input format is cyymmdd, where c represents the century. A value of 0 for c represents the 20th century. Any other value represents the 21st century. *JULthe input format is yyjjj, where jjj represent the sequence number of a day in the calendar year. jjj must be between 1, which represents January 1st, and 366, which represents December 31st in a leap year. For jjj values less than 100, you must specify the leading zero or zeros. For example, the Julian date for February 4th is 035, which represents the 35th day of the year. When you set type to *JUL, if you specify a value for yy between 40 and 99, the %TODATE function returns the corresponding year in the 20th century. For example, 1940. If you specify a value for yy between 0 and 39, the %TODATE function returns the corresponding year in the 21st century. For example, 2039. *CJULthe input format is cyyjjj, where c represents the century. A value of 0 for c represents the 20th century. Any other value represents the 21st century. *YJULthe input format is ccyyjjj, where cc represents the century. v timeSpecifies the input time. The table below indicates the length and format for this parameter, depending on the data type of the input time.
Data type Numeric Length 5 digits 6 digits Character 8 digits Format HMMSS. For example, 71500 represents 7:15 AM. HHMMSS. For example, 223000 represents 10:30 PM. HH:MM:SS. You must enclose values of this parameter in double quotes. For example, 10:30:00 represents 10:30 AM.

Result data type


Character, in standard ISO (International Organization for Standardization) format. If the input date contains an invalid value for the year, month, or day, the %TODATETIME function returns the default value 1901-01-01 for the date.

Examples
The table below provides examples for this function. These examples show the hyphen (-) as the separator character in the returned ISO dates, and the colon (:) as the separator in the returned ISO time values. Depending on your environment, a different character may separate the year, the month, and the day in the output date. Also, a different character may separate the hours, the minutes, and the seconds in the output time.

278

InfoSphere Change Data Capture Management Console: Administration Guide

Input date (date) 891102

Input format (type) *YMD

Input time (time) 112500

Result 1989-11-02 11:25:00 (November 2, 1989 at 11:25 AM) 1996-03-04 13:42:00 (March 4, 1996 at 1:42 PM) 1901-01-01 10:55:00 (January 1, 1901 at 10:55 AM) 1970-05-21 09:05:00 (May 21, 1970 at 9:05 AM) 2010-09-02 02:30:00 (February 9, 2010 at 2:30 AM) 2006-07-23 19:33:00 (July 23, 2006 at 7:33 PM) 1991-03-01 22:01:00 (March 1, 1991 at 10:01 PM) 1997-04-16 04:35:00 (April 16, 1997 at 4:35 AM) 2002-04-02 17:15:00 (April 2, 2002 at 5:15 PM)

030496

*MDY

13:42:00

000000

*MDY

10:55:00

210570

*DMY

09:05:00

20100902

*YYMD

023000

1060723

*CYMD

193300

91060

*JUL

220100

097106

*CJUL

043500

2002092

*YJUL

17:15:00

Number conversion%TONUMBER
Use this function when you want InfoSphere CDC to convert a character field or literal to a numeric value during replication.

Syntax
%TONUMBER(<parm>)

Parameters
v parmSpecifies a character column, literal or column function that returns a character string. It must be in the following format:
[<whitepsace>] [<sign>] [<digits>] [.<digits>] [{e | E} [<sign>] <digits>]

In the specification above, the white space can consist of one or more blank or tab characters. The signs must be plus (+) or minus (-), and you can specify only decimal digits. At least one digit must appear after the decimal point. The decimal digits may be followed by an exponent that consists of the letter E (in upper or lower case) and an optionally signed decimal integer. Note the following when using the %TONUMBER function: If parm does not follow the format above, the %TONUMBER function returns zero. If you convert a correctly formed character field or literal that contains an exponent, the %TONUMBER function returns a floating point number.
Column functions

279

Floating point values expressed in character form are converted to 8-byte floating-point data types. Integer values expressed in character form are converted to 4-byte integer data types. Precision may be lost when you convert numerical values expressed in character form that exceed a certain number of digits.

Result data type


Numeric.

Examples
Input value (parm) 12.45 Result Returns a floating point value of 12.45. If this function is mapped to an integer column, then it truncates the decimal part is truncated and returns 12. Returns an integer value of 3. Returns a floating point value of -12.4. Returns an integer of -920824. Leading zeros are removed. If the column from which this function is called is nullable, this function returns NULL. Otherwise, it returns an integer value of 0. Returns an integer value of 0, because the %TONUMBER function cannot convert character strings that do not conform to the data format described for parm. Returns an integer value of 0. InfoSphere CDC generates a message in Event Log. The input value is valid as a character string, but it cannot be converted to a numeric value. Returns a non-zero result, but precision may be lost. Returns an integer value of 0. Returns an integer value of 0. Returns a floating point value of 220. Returns a floating point value of 4500. Returns an integer value of 0. Returns a floating point value of -0.1. Returns an integer value of 0. Returns a floating point value of 66.67

3 -12.4 -0920824 NULL

ABC

12345678901234567.89 - 10 911HELLO +2.2e+2 4.5E3 $1000 -.1e0 44 90 66.67

Time conversion%TOTIME
Use this function when you want InfoSphere CDC to convert a character, numeric, or time data type to a time data type during replication. You can convert from different formats based on the type of the input value.

280

InfoSphere Change Data Capture Management Console: Administration Guide

Note: InfoSphere CDC for Microsoft SQL Server does not support this function. Use this function to when you want InfoSphere CDC to track the date and time when it inserts or updates a row in source and target columns. This function uses the system clock on the source or target. Note: InfoSphere CDC for AS/400 and InfoSphere CDC for Microsoft SQL Server do not support this function.

Syntax
%TOTIME(<time>)

Parameters
timeSpecifies a column or literal that can have one of the following types: v Time, in the format HMMSS or HHMMSS. For example, 71500 represents 7:15 AM and 223000 represents 10:30 PM. v Numeric. This value must be positive, and if it contains a fractional part, the fraction must be zero. v Character, in one of the following formats:
[whitespace] digit digit digit digit digit digit [whitespace]

This format lets you specify a time value that contains six consecutive digits. Any number of blank characters can precede or follow the six digits. For example, %TOTIME ( 012537 ) returns 01:25:37.
[whitespace] digit [digit] separator digit [digit] [separator digit [digit]] [whitespace]

This format lets you specify a time value that contains valid separator characters (colon, comma, period or one or more spaces) between hours, minutes, and seconds. Any number of blank characters can precede the first digit or follow the last digit. You cannot specify more than one separator character in the time value. For example, %TOTIME (12:05.20) is not valid. You can omit the number of seconds, in which case the %TOTIME function assumes zero seconds. For example, %TOTIME ("12:05") returns 12:05:00. You can omit leading zeros in the number of hours, minutes, and seconds. For example, %TOTIME ("12 5 20") returns 12:05:20.
[whitespace] digit [digit] separator digit [digit] [whitespace] {A | a | P | p} [{M | m}] [whitespace]

This format lets you specify a time value that indicates AM or PM. You can specify AM and PM in a number of different ways, such as A, AM, Am, a, aM, am, P, or PM. Any number of blank characters can precede the first digit or follow the AM/PM specification. You cannot specify more than one separator character in the time value. For example, %TOTIME ("04: 20 PM") is not valid. You cannot specify seconds in this format. If you do so, the %TOTIME function assumes zero seconds. You can omit leading zeros in the number of hours and minutes. For example, %TOTIME ("3 5 P") returns 15:05:00.

Result data type


These examples show the colon (:) as the separator character in the returned ISO (International Organization for Standardization) time values. Depending on your
Column functions

281

environment, a different character may separate the hours, minutes, and seconds in the output time.

Examples
Input value (parm) 012537 22:4:12 4:05P 2 5 Am 204521 91035.0000 250521 10: 10:35 Result 01:25:37 22:04:12 16:05:00 02:05:00 20:45:21 09:10:35 00:00:00 00:00:00

Conditional and variable functions


Use the %IF column function when you want InfoSphere CDC to evaluate an expression and return different results. Use the %VAR function when you want InfoSphere CDC to declare a new variable, assign a value to it, or retrieve the value of an existing variable. See also: Conditional%IF Variable%VAR on page 283

Conditional%IF
Use this function when you want InfoSphere CDC to evaluate a conditional expression and return different results during replication.

Syntax
%IF(<conditional>, <expression_if_true>, <expression_if_false>)

Parameters
v conditionalspecifies a conditional expression that evaluates to true or false. The conditional expression must compare identical data types. v expression_if_truespecifies an expression that is evaluated if the condition is true. v expression_if_falsespecifies an expression that is evaluated if the condition is false. The values returned by expression_if_true and expression_if_false must both be of the same data type.

Result data type


The type of data returned by the true (expression_if_true) and false (expression_if_false) expressions.

282

InfoSphere Change Data Capture Management Console: Administration Guide

Examples
%IF(ID=1, "ID is 1", "ID is not 1")

If the value in the ID column is equal to 1, this function returns the string ID is 1. Otherwise, it returns the string ID is not 1.
%IF(DATSTR="010101", %TODATE(19010101, "*YYMD"), %IF(DATSTR="999999", NULL, %TODATE(DATSTR, "*YMD")))

If a value in the DATSTR column is 010101, this function returns 1901-01-01. If a value in DATSTR is 999999, it returns NULL. In all other cases, it returns equivalent dates to values in DATSTR. For example, for a value of 710723 in the DATSTR column, this example returns 71-07-23. For information about the %TODATE function, see Date conversion%TODATE on page 275. Related reference Date conversion%TODATE on page 275

Variable%VAR
Use this function when you want InfoSphere CDC to evaluate a conditional expression and return different results during replication.

Syntax
%VAR(<variable_name>, [expression])

Parameters
v variable_nameSpecifies the name of the defined or retrieved variable. v expressionSpecifies a literal or a complex expression. This parameter is optional. If you specify it, the function creates a new variable, assigns the given value to it, and returns the value of the variable. If the variable already exists, the function assigns the new value to it. If you omit this parameter, the function retrieves the value of the variable, provided that the variable is defined (using the %VAR function) in a preceding column or previously in the current expression. You can pass a variable in the same row, from column to column, in ascending column sequence. However, you cannot pass a variable between rows.

Result data type


The type of data assigned to the variable (variable_name).

Examples
%VAR(SBTTL, PRICE*QTY)

If the value in the PRICE column is 10 and the value in the QTY column is 5, then this function assigns the value 50 to the SBTTL variable, and returns the value 50. %VAR(SBTTL) If SBTTL is defined either in an expression for a preceding column or earlier in the current expression, this function returns the current value of the SBTTL variable.
%IF(%VAR(QTY, QTYORD + QTYBACKORD) <100, %VAR(QTY) * PRICE, %VAR(QTY) * PRICE * (1- DISCOUNT))

Sets the QTY variable to QTYORD plus QTYBACKORD. If QTY is less than 100, then the result of the expression is QTY * PRICE. Otherwise, the result of the expression is QTY * PRICE * (1 - DISCOUNT). For information about the %IF
Column functions

283

function, see Conditional%IF on page 282. Related reference Conditional%IF on page 282

Data functions
Use these functions when you want InfoSphere CDC to retrieve column values during replication. When you use these functions, InfoSphere CDC can return the value of a source column before applying an update, the value of a target column before applying an update, and the value of a column for a specific row in a table. See also: Before value%BEFORE Current value%CURR Retrieve column%GETCOL (DB2 UDB for iSeries) on page 285 Retrieve column%GETCOL (Dynamic SQL) on page 288 Retrieve column%SELECT on page 293

Before value%BEFORE
Use this function when you want InfoSphere CDC to retrieve the value of a source column before applying an update.

Syntax
%VAR(<parm>)

Parameters
parmSpecifies the name of a source column. You cannot specify a journal control field, an expression, or a column function as the input parameter.

Result data type


The data type of the source column (parm). When a row is inserted into the target table, including all rows that are inserted during a refresh, this function returns NULL. Otherwise, this function returns the appropriate default value for the data type of the target column.

Examples
%VAR(CRLIMIT)

Returns the previous value in the CRLIMIT column, before it was updated on the source by the change being replicated.

Current value%CURR
Use this function when you want InfoSphere CDC to retrieve the value of a target column before applying an update on a source column. Note: InfoSphere CDC for z/OS does not support this function.

Syntax
%VAR(<parm>)

284

InfoSphere Change Data Capture Management Console: Administration Guide

Parameters
parmSpecifies the name of a source column. You cannot specify a journal control field, an expression, or a column function as the input parameter.

Result data type


The data type of the target column (parm). When a row is inserted into the target table, including all rows that are inserted during a refresh, this function returns the appropriate default value for the data type of the target column. The %CURR function returns the value of the target column as single-byte characters, even if the source column contains multi-byte data.

Examples
%CURR(BALANCE)

Returns the current value of the target column BALANCE. In an expression, the current balance would be placed in the derived column before the update to BALANCE is applied to the target table.
%CURR(BALANCE) - %BEFORE(BALANCE)

Calculates the difference between the values in the source and target columns before an update is made. If the result is not equal to zero, the column values were not the same before the update was applied on the source and on the target. You can use this example only for numeric fields.
(SRCCNT - %BEFORE(SRCCNT)) + %CURR(TGTTOT)

You can use this example to maintain the total of two or more numeric column values that are contained in the same table on different datastores. In each source table, the SRCCNT column is mapped to the corresponding target column with the same name. The expression in this example is assigned to the derived column TGTTOL on the target. When a value in a SRCCNT column is updated, the difference between the new value and the previous value is calculated using the %BEFORE function. This difference is added to the current sum stored in the derived column TGTTOL. The result of the expression is assigned to the derived column.
%CURR(%TONUMBER(EMPNO))

InfoSphere CDC generates an error when verifying the expression, because %CURR does not accept another column function (in this example, %TONUMBER) as its parameter. Related reference Before value%BEFORE on page 284

Retrieve column%GETCOL (DB2 UDB for iSeries)


Use this function when you want InfoSphere CDC to retrieve the value of a column for a specific row in a table. You can also use this function, with a subset of parameters, so that InfoSphere CDC returns additional columns when it has previously invoked a %GETCOL function.

Column functions

285

You can use the %GETCOL function in expressions to perform the following operations: v Obtain columns from one or more keyed secondary tables and join them with an existing primary table before sending data to the target. The primary table refers to the source table being replicated. The secondary tables refer to tables referenced in the %GETCOL function. v Specify how keys of the secondary tables are populated, to allow InfoSphere CDCto perform the necessary secondary reads. v Use columns from secondary tables that were retrieved previously to populate keys for subsequent reads (the population of key column values is not restricted to primary columns only). v Specify the order that table reads are performed. v Condition the table reads that are performed. v Read tables external to InfoSphere CDC to perform dynamic translations on the target. Note: This topic contains information about the %GETCOL function supported by InfoSphere CDC for AS/400.

Long syntax formatreads from database


%GETCOL(<column_name>, <table_name>, [default_value], [record_format],[<key_count>], <key_value1>, <key_value2>, ..., <key_valuen>])

This function reads a table and returns the value of the column specified, based on the key column values that are identified. If more than one row satisfy the key requirements specified, then this function returns the first row only. If the read is unsuccessful, then this function returns the default value specified and sends a message to the appropriate message queue. The specified column in the table must exist when specifying the expression.

Short syntax formatreads from existing &GETCOL result


%GETCOL(<column_name>, <table_name>) %GETCOL(<column_name>, <table_name>, [default_value]) %GETCOL(<column_name>, <table_name>, [default_value]), [record_format])

This function returns the value of the specified column from a row retrieved by a previous %GETCOL function invocation. The short syntax lets you retrieve more than one column from a table (that was read previously using the %GETCOL function), without reading the table again. The previous %GETCOL function invocation must be for the same journal entry during continuous mirroring or the same row during refresh. The table_name and record_format parameters specified in the short format of the %GETCOL function invocation must match the table_name and record_format parameters specified in the long format of the %GETCOL function invocation.

Parameters
v column_nameSpecifies the name of a column. You cannot specify an expression for this parameter. v table_nameSpecifies the name of a table. This table must be keyed. You cannot specify an expression for this parameter. You can specify the table name using one of the following formats:

286

InfoSphere Change Data Capture Management Console: Administration Guide

The library, file, and member names are specified. For example, LIBRARY/FILE(MEMBER). The library and file are specified. InfoSphere CDC assumes a default value of *FIRST for the member name. For example, LIBRARY/FILE. The file is specified. InfoSphere CDC assumes a default value of *LIBL for the library name and a default value of *FIRST for the member name. For example, FILE. The file and member names are specified. InfoSphere CDC assumes a default value of *LIBL for the library name. For example, FILE(MEMBER). v default_valueSpecifies a default value to return if the read fails. This value must be a literal or constant, depending on the data type of the specified column. For character, date, time, and timestamp data types, you must enclose values of this parameter in double quotes. For example, NO SALESREP or 1995-05-10. If you specify NULL as the default value, then the column must be nullable. You cannot specify an expression for this parameter. If you omit this parameter, then you must enter a comma instead of the parameter value to indicate its position in the parameter list. If you omit this parameter, then this function returns a default value according to the data type of the column specified.
Field type Character Decimal (packed) Numeric (zoned) Real (4byte floating point) Float (8byte floating point) Date Default value Blank character Zero Zero Zero Zero 0001-01-01 (Date Zero). This applies to all date formats except *JUL (Julian). 1940-01-01 (Date Zero). This applies to the *JUL (Julian) date format. Time Integer (4 bytes) Small integer (2 bytes) Timestamp 00:00:00 (Time Zero) Zero Zero 0001-01-01 00:00:00 (Timestamp Zero)

v record_formatSpecifies the record format for the record to read. You cannot specify an expression for this parameter. Specify this parameter if more than one record format exist. If you omit this parameter, then you must enter a comma instead of the parameter value to indicate its position in the parameter list. If you omit this parameter, then InfoSphere CDC reads the first record format. v key_countIndicates the number of key values specified as parameters. It should be the number of key columns of the record format selected. It must be an integer greater than 0. You cannot specify an expression for this parameter. If you omit this parameter, then InfoSphere CDC assumes a default value of 1. v key_value1, key_value2, ...key_valuenSpecify the key values to use when performing the read. These key values must match the key columns of the table to read. Character data passed as key parameters is padded with blank characters, or truncated if the length does not match the length of the key column.

Column functions

287

The key value can be either a primary table column (direct column mapping) or an expression. Some examples include: An expression performed on a primary table column that matches the definition of the key column in the table to read. A column from a previous read using the %GETCOL function. An expression performed on a column that was previously read using the %GETCOL function. You must specify these parameters if the key_count parameter is specified.

Result data type


The data type of the column retrieved (column_name). The %GETCOL function returns the value of the column as single-byte characters, even if the source column contains multi-byte data.

Examples
The following examples are of scenarios where the %GETCOL function is used:
%GETCOL (CUSTNAME, "PRODLIB/CUSTMAST")

Retrieves the CUSTNAME column from a previous read of the CUSTMAST table in library PRODLIB, member *FIRST, and record format *FIRST. If the read is unsuccessful (for example, not found) and assuming that the data type for the CUSTNAME column is CHARACTER, then this function returns blanks characters.
%GETCOL (CUSTNAME, "PRODLIB/CUSTMAST", "NO CUSTMAST")

Retrieves the CUSTNAME column from a previous read of the CUSTMAST table in library PRODLIB, member *FIRST, and record format *FIRST. If the read is unsuccessful (for example, not found), then this function returns NO CUSTMAST.
%GETCOL (CUSTNAME, "PRODLIB/CUSTMAST", , "FMT2")

Retrieves the CUSTNAME column from a previous read of the CUSTMAST table in library PRODLIB, member *FIRST, and record format FMT2. The previous read must have FMT2 specified for the record format. If the read is unsuccessful (for example, not found) and assuming that the data type for the CUSTNAME column is CHARACTER, then this function returns blank characters. Related reference Retrieve column%GETCOL (Dynamic SQL) Retrieve column%SELECT on page 293

Retrieve column%GETCOL (Dynamic SQL)


Use this function to perform a secondary table column lookup based on the specified key columns in the primary and secondary tables. The %GETCOL function retrieves secondary table columns before replicating them along with primary table columns to the target. To use this function before replication, you must add a derived column to the primary table and enter an expression for that column that uses the %GETCOL function. You can also use this function when entering an expression for a target column.

288

InfoSphere Change Data Capture Management Console: Administration Guide

To use this function, the primary and secondary tables must have one or more key columns. The key columns in the primary and secondary tables are used to retrieve a different column in the secondary table. The key columns that are used to retrieve data can have different names and data types. However, if the key column data types are different, then you must convert them to the appropriate data types using conversion column functions, such as %TOCHAR. If you are using InfoSphere CDC for z/OS, then see %GETCOL and %SELECT Function Calls and Processing Efficiency in your InfoSphere CDC for z/OS documentation for information about performance considerations when using the %GETCOL or %SELECT column functions. Note: This topic contains information about the %GETCOL function supported by any InfoSphere CDC product except for InfoSphere CDC for AS/400.

Long syntax formatreads from database


%GETCOL(<column_name>, <table_name>,<,default_value>, <key_name>, <key_value1>, <key_value2>, ..., <key_name>, <key_valuen>)

This function reads a table and returns the value of the column specified, based on the key column names and values that are identified. If you specify a table or column name that contains spaces, then you must enclose that name in square brackets. For example, enter [EMP NY] to reference a table named EMP NY.

Short syntax formatreads from existing &GETCOL result


%GETCOL(<column_name>, <table_name>, <default_value>)

This function returns the value of a the specified column from a row retrieved by a previous %GETCOL function invocation. The short syntax lets you retrieve more than one column from a table (that was read previously using the %GETCOL function), without reading the table again. The table_name parameter specified in the short format of the %GETCOL function invocation must match the table_name parameter specified in the long format of the %GETCOL function invocation. If the read is unsuccessful or a previous %GETCOL function invocation was not performed, then InfoSphere CDC generates an error message and sets the values of the derived column in which the %GETCOL function is used to default values, based on the data type of the derived column.

Parameters
v column_nameSpecifies the name of a column. You cannot specify an expression for this parameter. If the specified column does not exist in the secondary table, then InfoSphere CDC generates an error message when verifying the expression that contains the %GETCOL function. v table_nameSpecifies the name of a table. Note the following when specifying this parameter: If you installed InfoSphere CDC for Oracle, you can specify the table name in the format <OWNER_NAME>.<TABLE_NAME>, where the owner and table are in uppercase. If you omit the owner name, then InfoSphere CDC assumes that the owner is the user that installed InfoSphere CDC. If ownership of the table cannot be determined, then InfoSphere CDC assumes the default value of PUBLIC for the owner name.If you installed InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for Sybase, you must specify the table name in the format ...
Column functions

289

If you installed InfoSphere CDC for z/OS, you must specify the table name in the format <owner_name>.<table_name> or <owner_name>.<table_name>. If you installed InfoSphere CDC for DB2 UDB or InfoSphere CDC for PointBase, you must specify the table name in the format [owner_name].<table_name> or [owner_name].<table_name>. v default_valueSpecifies a default value to return when no row can be found in the secondary table using the key value that matches the value of the referring (foreign) key column in the primary table row. If the corresponding row cannot be found in the secondary table, then the default value populates the derived column for the row sent to the target. If you specify NULL as the default value, then the column must be nullable. For certain InfoSphere CDC products, this is a required parameter. InfoSphere CDC generates an error if a default value is required, but is not specified in a %GETCOL function invocation. If you omit this parameter, then you must enter two consecutive commas (for the long syntax) or a comma (for the short syntax) prior to the right parenthesis to indicate its position in the parameter list. In this case, the %GETCOL function returns a default value according to the data type of the column specified. v key_nameIdentifies the key column name in the secondary table used to retrieve the secondary column specified by column_name. Note: The DB2 UDB for z/OS API requires that the column specified in key_name is not nullable. InfoSphere CDC for z/OS generates an error message if it encounters a NULL key value when processing the %GETCOL function. To ensure that the %GETCOL function is invoked only for records with non-NULL key values, use the %IF function. v key_valueSpecifies, for each key column, an associated key value. The key value can be any expression. If you specify a primary column name, then InfoSphere CDC uses the after image value of that column as the key_value for the key column in the secondary table to locate the corresponding row in the secondary table. You can specify multiple key name and value pairs. Note: For InfoSphere CDC for z/OS, you can specify up to nine key_name/key_value pairs.

Result data type


The data type of the column retrieved (column_name). The %GETCOL function returns the value of the column as singlebyte characters, even if the source column contains multi-byte data.

Examples
The following examples use the relationship between primary and secondary tables.

290

InfoSphere Change Data Capture Management Console: Administration Guide

%SELECT("SELECT COUNTRY FROM DB1.GSMITH.COUNTRY WHERE BRANCH = ?", EMPBRANCH)

Assuming the primary and secondary tables shown above, you map the %SELECT function to the EMPCOUNTRY column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table, this example returns their country from the COUNTRY secondary table record. If COUNTRY does not contain a record that satisfies the condition in the WHERE clause, then this function returns the default value for the data type of the COUNTRY column. For example, blank characters if the data type is character.
%SELECT("SELECT Q1, Q2, Q3, Q4 FROM DB1.GSMITH.SALES WHERE EMP = ? AND ? = 4", EMPID, EMPBRANCH, 0, 0, 0, 0)

Assuming the primary and secondary tables shown above, you map the %SELECT function to the EMPQ1 column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table, who works at Branch 4, this example returns their first quarter sales figure from the SALES secondary table record. Since this example returns more than one column value, InfoSphere CDC defines three variables, named Q2, Q3, and Q4, to maintain the second, third, and fourth quarter sales figures, respectively. You can retrieve these values using the %VAR function and map them to the EMPQ2, EMPQ3, and EMPQ4 columns in EMPLOYEE.

Column functions

291

If SALES does not contain a record that satisfies the condition in the WHERE clause, then the function returns 0. In addition, InfoSphere CDC sets the three variables Q2, Q3, and Q4 to 0.
%SELECT("SELECT INCOME, CODE, LASTADJDATE, NEXTADJDATE FROM DB1.GSMITH.SALARY WHERE EMP = ? AND BRANCH = ?", EMPID, EMPBRANCH, 0, "Z", 1970-01-01)

Assuming the primary and secondary tables shown in the table diagram previously, you map the %SELECT function to the EMPINCOME column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table, this example returns their income from the SALARY secondary table record. Since this example returns more than one column value, InfoSphere CDC defines three variables, named CODE, LASTADJDATE, and NEXTADJDATE, to maintain the other items of salary information. You can retrieve these values using the %VAR function and map them to columns that you must add to the primary table. If SALARY does not contain a record that satisfies the condition in the WHERE clause, then: v The %SELECT function returns 0. v The CODE variable is set to Z. v The LASTADJDATE variable is set to 1970-01-01. v The NEXTADJDATE variable is set to 19010101 (the z/OS default date value). In this example, you must specify a default value for LASTADJDATE only. Since this column is listed third in the SQL SELECT statement, you must also specify default values for the INCOME and CODE columns. To eliminate the need to specify a default value for CODE, reference LASTADJDATE before CODE in the SQL SELECT statement, as follows: %SELECT("SELECT INCOME, LASTADJDATE, CODE, NEXTADJDATE FROM DB1.GSMITH.SALARY WHERE EMP = ? AND BRANCH = ?", EMPID, EMPBRANCH, 0, 1970-01-01).
%SELECT("SELECT USED FROM DB1.GSMITH.VACATION WHERE EMP = ? AND EMPCOUNTRY IN (USA, UK, JAPAN, FRANCE)", EMPID, 0)

Assuming the primary and secondary tables shown in the previous image, you map the %SELECT function to the EMPVACUSED column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table located in United States, United Kingdom, Japan, or France, this example returns the amount of vacation used from the VACATION secondary table record. If VACATION does not contain a record that satisfies the condition in the WHERE clause, then the %SELECT function returns 0.
%SELECT("SELECT NEXT VALUE FOR SEQ1 FROM SYSIBM.SYSDUMMY1", 1)

This example returns the next value for sequence SEQ1. In this case, the data type of the result is the same as the data type of the sequence object. This example uses the %SELECT function to retrieve the next value for a sequence in DB2 UDB for z/OS V8 or higher. SYSDUMMY1 is an existing DB2 dummy system table referenced in the SQL SELECT statement to satisfy syntax requirements.

292

InfoSphere Change Data Capture Management Console: Administration Guide

You must enter any integer value for the second parameter, in order to call the function. For example, 1. For information about sequences and the types of values that you can generate from sequences, see your DB2 UDB for z/OS documentation.
%SELECT("SELECT PREVIOUS VALUE FOR SEQ2 FROM SYSIBM.SYSDUMMY1", 24)

This example returns the previous value for sequence SEQ2. In this case, the data type of the result is the same as the data type of the sequence object. This example uses the %SELECT function to retrieve the previous value for a sequence in DB2 UDB for z/OS V8 or higher. SYSDUMMY1 is an existing DB2 dummy system table referenced in the SQL SELECT statement to satisfy syntax requirements. You must enter any integer value for the second parameter, in order to call the function. For example, 24. For information about sequences and the types of values that you can generate from sequences, see your DB2 UDB for z/OS documentation. Related reference Character conversion%TOCHAR on page 274 Retrieve column%GETCOL (DB2 UDB for iSeries) on page 285 Conditional%IF on page 282

Retrieve column%SELECT
Use this function to specify a valid SQL SELECT statement that retrieves one or more column values from a secondary table so that they can be logically joined to a primary table record. For information about performance considerations when using the %GETCOL or %SELECT column functions, see the %GETCOL and %SELECT Function Calls and Processing Efficiency section in your InfoSphere CDC for z/OS documentation. You can specify only one SQL SELECT statement in each %SELECT function. To use this function, the z/OS user identifier that is used to start the InfoSphere CDC address space must have sufficient DB2 UDB for z/OS privileges to perform SQL SELECT statements. Note: This function is only supported by InfoSphere CDC for z/OS. CAUTION: The use of SQL SELECT statements may constitute a security concern in your environment. Certain clauses and functions may have side effects that result in the changing of DB2 table data and/or the generation of data outside of the control of DB2. Therefore, you should exercise caution when using the %SELECT function to issue SQL SELECT statements.

Syntax
%SELECT(<sql_select_stmt>, <parm>, <parm2>, ..., <parm>, [default_value], [default_value2], ...,[default_value])

Parameters
v sql_select_stmtSpecifies a character string containing a valid SQL SELECT statement. The statement must be valid according to DB2 UDB for z/OS usage rules. For usage rules, see your DB2 UDB for z/OS documentation. You must
Column functions

293

use parameter placeholders to refer to values that are not available until the expression is being executed. To identify parameter placeholders in the SQL SELECT WHERE clause, use question marks (?). In the SQL WHERE clause, you can use any operators that are supported by DB2 UDB for z/OS, such as IN. For information about other operators that you can use, see your DB2 UDB for z/OS documentation. v parm1, parm2, ..., parmnSpecify literals, column functions, expressions, expression variables, or primary table columns. In the WHERE clause, the value specified for parm1 replaces the first question mark, the value specified for parm2 replaces the second question mark in the WHERE clause, and so on. You cannot specify NULL for any parameter placeholder. default_value1, default_value2, ..., v default_valuemSpecify default values that the function returns for each column when the record specified by the WHERE clause does not exist in the secondary table. If you do not specify a default value for a column and the secondary table record does not exist, then this function returns an appropriate value, based on the data type of the column. For example, zero for numeric-based columns, zero-length strings for characterbased columns, and so on. To specify a default value for a column that is not listed first in the SQL SELECT statement, you must specify default values for all preceding columns. Note the following when specifying parameters for this function: The number of parameters cannot exceed 21. You must specify a minimum of two parameters. If you only want to specify the SQL SELECT statement parameter, then you must also specify another parameter for the function. See examples below for situations where you must specify an unused parameter.

Result data type


The data type of the first secondary table column listed in the SQL SELECT statement. The result of the %SELECT function is a value from the first column specified in the SQL SELECT statement. If two or more column values are retrieved by the SQL SELECT statement, then these values are assigned to variables. By default, the variable names are the same as the corresponding column names. If these variable names cannot be defined, then the names are set to COLn, where n is the numeric position, starting at 1, of the corresponding column in the SQL SELECT statement. Using the %VAR function in expressions, you can retrieve the values assigned to variables and map them to subsequent columns in the primary table. Using a single %SELECT function to retrieve all secondary table column values and then using the %VAR function to map to subsequent columns is more efficient than invoking the %SELECT function multiple times to retrieve each column value individually. Note: If you have defined variables that have the same names as those created by InfoSphere CDC automatically, then the previously defined variables will be overwritten. Therefore, make sure existing variable names that you have defined do not conflict with variable names created by InfoSphere CDC.

294

InfoSphere Change Data Capture Management Console: Administration Guide

Examples
The following examples use the relationship between primary and secondary tables:

%SELECT("SELECT COUNTRY FROM DB1.GSMITH.COUNTRY WHERE BRANCH = ?", EMPBRANCH)

Assuming the primary and secondary tables shown above, you map the %SELECT function to the EMPCOUNTRY column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table, this example returns their country from the COUNTRY secondary table record. If COUNTRY does not contain a record that satisfies the condition in the WHERE clause, then this function returns the default value for the data type of the COUNTRY column. For example, blank characters if the data type is character.
%SELECT("SELECT Q1, Q2, Q3, Q4 FROM DB1.GSMITH.SALES WHERE EMP = ? AND ? = 4", EMPID, EMPBRANCH, 0, 0, 0, 0)

Assuming the primary and secondary tables shown above, you map the %SELECT function to the EMPQ1 column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table, who works at Branch 4, this example returns their first quarter sales figure from the SALES secondary table record. Since this example returns more than one column value, InfoSphere CDC defines three variables, named Q2, Q3, and Q4, to maintain the second, third, and fourth

Column functions

295

quarter sales figures, respectively. You can retrieve these values using the %VAR function and map them to the EMPQ2, EMPQ3, and EMPQ4 columns in EMPLOYEE. If SALES does not contain a record that satisfies the condition in the WHERE clause, then the function returns 0. In addition, InfoSphere CDC sets the three variables Q2, Q3, and Q4 to 0.
%SELECT("SELECT INCOME, CODE, LASTADJDATE, NEXTADJDATE FROM DB1.GSMITH.SALARY WHERE EMP = ? AND BRANCH = ?", EMPID, EMPBRANCH, 0, "Z", 1970-01-01)

Assuming the primary and secondary tables shown in the previous image, you map the %SELECT function to the EMPINCOME column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table, this example returns their income from the SALARY secondary table record. Since this example returns more than one column value, InfoSphere CDC defines three variables, named CODE, LASTADJDATE, and NEXTADJDATE, to maintain the other items of salary information. You can retrieve these values using the %VAR function and map them to columns that you must add to the primary table. If SALARY does not contain a record that satisfies the condition in the WHERE clause, then: v The %SELECT function returns 0. v The CODE variable is set to Z. v The LASTADJDATE variable is set to 1970-01-01. v The NEXTADJDATE variable is set to 1901-01-01 (the z/OS default date value). In this example, you must specify a default value for LASTADJDATE only.Since this column is listed third in the SQL SELECT statement, you must also specify default values for the INCOME and CODE columns. To eliminate the need to specify a default value for CODE, reference LASTADJDATE before CODE in the SQL SELECT statement, as follows: %SELECT("SELECT INCOME, LASTADJDATE, CODE, NEXTADJDATE FROM DB1.GSMITH.SALARY WHERE EMP = ? AND BRANCH = ?", EMPID, EMPBRANCH, 0, 1970-01-01)
%SELECT("SELECT USED FROM DB1.GSMITH.VACATION WHERE EMP = ? AND EMPCOUNTRY IN (USA, UK, JAPAN, FRANCE)", EMPID, 0)

Assuming the primary and secondary tables shown in the previous image, you map the %SELECT function to the EMPVACUSED column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table located in United States, United Kingdom, Japan, or France, this example returns the amount of vacation used from the VACATION secondary table record. If VACATION does not contain a record that satisfies the condition in the WHERE clause, then the %SELECT function returns 0.
%SELECT("SELECT NEXT VALUE FOR SEQ1 FROM SYSIBM.SYSDUMMY1", 1)

This example returns the next value for sequence SEQ1. In this case, the data type of the result is the same as the data type of the sequence object. This example uses the %SELECT function to retrieve the next value for a sequence in DB2 UDB for z/OS V8 or higher. SYSDUMMY1 is an existing DB2 dummy system table referenced in the SQL SELECT statement to satisfy syntax requirements.

296

InfoSphere Change Data Capture Management Console: Administration Guide

You must enter any integer value for the second parameter, in order to call the function. For example, 1. For information about sequences and the types of values that you can generate from sequences, see your DB2 UDB for z/OS documentation.
%SELECT("SELECT PREVIOUS VALUE FOR SEQ2 FROM SYSIBM.SYSDUMMY1", 24)

This example returns the previous value for sequence SEQ2. In this case, the data type of the result is the same as the data type of the sequence object. This example uses the %SELECT function to retrieve the previous value for a sequence in DB2 UDB for z/OS V8 or higher. SYSDUMMY1 is an existing DB2 dummy system table referenced in the SQL SELECT statement to satisfy syntax requirements. You must enter any integer value for the second parameter, in order to call the function. For example, 24. For information about sequences and the types of values that you can generate from sequences, see your DB2 UDB for z/OS documentation.

User exit functions


Use these functions to call user exit programs from expressions. Depending on the InfoSphere CDC platform you have installed, you can call a stored procedure or another type of user exit program using a column function. See also: Stored procedure%STPROC User exit%USER on page 298 User exit%USER (InfoSphere CDC for Microsoft SQL 5.x) on page 302 User Exit%USERFUNC on page 303

Stored procedure%STPROC
Use this function to call a stored procedure. You can call a stored procedure from a derived column on the source or create an expression on the target. Note: InfoSphere CDC for z/OS and InfoSphere CDC for DB2 UDB do not support this function. On the z/OS platform, use the %USER function to call a user exit program that issues SQL statements.

Syntax
%STPROC(stored_procedure_name, <parm1>, <parm2>, ..., <parm20>)

Parameters
v stored_procedure_nameSpecifies the name of the stored procedure in the default database. You must enclose values of this parameter in single quotes. If you installed InfoSphere CDC for Microsoft SQL Server, you must specify the name of the stored procedure in the format <databae_name>.<owner_name>.<stored_procedure_name>. The database and owner name are not required if the stored procedure is defined in the default database.

Column functions

297

v parm1, parm2, ..., parm20Specify columns or literals that are passed as parameters to the stored procedure (maximum 20). The type and order of the parameters specified in the %STPROC function invocation must match the type and order of the parameters defined in the stored procedure. If you installed InfoSphere CDC for Sybase, the first parameter defined in the stored procedure specifies the value returned by the function. Do not specify this parameter in the list of parameters for the %STPROC function (parm1, parm2, ..., parm20). You can omit any number of trailing parameters. InfoSphere CDC assumes the default value if a parameter is not specified. For example, for a stored procedure with five parameters, if you specify values for the first two parameters only, InfoSphere CDC assigns default values to the last three parameters.

Result data type


The data type of the result returned by the stored procedure.

Examples
The following example returns the customer name that corresponds to a specified customer identification number. Perform the following steps: 1. Define a stored procedure, as presented below, in the default database: v If you installed InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for Sybase: create procedure CUSTNAME @CUSTNAME varchar(30) OUT, @CUSTID int as select @CUSTNAME=name from customer where custno=@CUSTID v If you installed InfoSphere CDC for Oracle:
create or replace function custname (custid integer) return varchar2 as nameFound varchar2(30); begin select name1 into nameFound from customer where custno = custid; return nameFound; end custname;

2. 2 Use the following column function:


%STPROC(CUSTNAME, CUSTOMER_ID)

This call returns the customer name that corresponds to the customer identification number CUSTOMER_ID. Related tasks To add a derived column on page 163 To map an expression to a target column on page 159 Related reference User exit%USER

User exit%USER
Use this function to call a user exit program from an expression. This function provides flexibility when complex logic that cannot be expressed using the provided column functions is required. You can use this function to call a user exit program with input parameters.

298

InfoSphere Change Data Capture Management Console: Administration Guide

For more information about user exit programs, see the appropriate InfoSphere CDC user exits guide. Note: InfoSphere CDC for Microsoft SQL Server does not support this function. If you are using a InfoSphere CDC product other than InfoSphere CDC for z/OS, you cannot use this function to call a stored procedure.

Syntax
%USER(<program_name>, <parm1>, <parm22>, ..., <parmn>

Parameters
v program_nameSpecifies the name of the user exit program. You must enclose values of this parameter in single quotes. You can write the user exit program in any high-level language. You must place an executable object for the user exit program in the InfoSphere CDC installation directory prior to starting refresh or mirroring. v parm1, parm2, ..., parmnSpecify columns or literals that are passed as parameters to the user exit program (maximum 20). In the user exit program that you write, you must declare a data structure that defines specific fields for the result and each input parameter (parm1, parm2, ..., parmn).
Field DATATYPE Length and data type Two-byte binary Description Specifies the data type of the result or input parameter: v 1Character v 2Date v 3Float v 4Integer v 5Packed numeric v 6Time v 7Zoned numeric LENGTH Two-byte integer Specifies the length of the result or input parameter in bytes. Specifies the number of digits in the result or input parameter. Specifies the number of decimal places in the result or input parameter. Specifies whether or not the result or input parameter is NULL: v 0Result or input parameter is not NULL. v 1Result or input parameter is NULL.

DIGITS

Two-byte binary

DECPLC

Two-byte binary

NULLIND

Two-byte binary

Column functions

299

Field DTMFMT

Length and data type Four-byte character

Description Specifies the date format in the result or input parameter: v *USAUnited States date format. v *ISOISO (International Organization for Standardization) date format. v *EUREuropean date format. v *JISJapanese Industrial Standard. v *YMDThe date format is yymmdd. v *MDYThe date format is mmddyy. v *DMYThe date format is ddmmyy.

<VALUE>

Specifies one of the following: v For each input parameter, the field that contains the input parameter value passed to the user exit program. v For the user exit program result, the field that contains the result returned by the user exit program. The name of this field in the user exit program is user-defined. For example, see the COBOL user exit program below.

Result data type


The data type of the result returned by the user exit program.

Examples
%USER(USERSEL1, BRANCH)

This function calls the COBOL program USERSEL1, passing the BRANCH column as a parameter. USERSEL1 checks whether or not BRANCH is set to 11. If it is, then the user exit program returns a one-byte character value of Y. Otherwise, it returns a character value of N. Note: This user exit program is provided for illustration purposes only. IBM recommends that you test this program before invoking it in your environment.
IDENTIFICATION DIVISION. PROGRAM-ID. USERSEL1. AUTHOR. DATAMIRROR CORP.

300

InfoSphere Change Data Capture Management Console: Administration Guide

INSTALLATION. DATAMIRROR CORP. DATE-COMPILED. ******************************************************************* * Program : USERSEL1. * ---------------* Version: 1.0 * ---------------* Description: SAMPLE COBOL USER ENTRY POINT PROGRAM * ---------------* ****************************************************************** ENVIRONMENT DIVISION. CONFIGURATION SECTION. SOURCE-COMPUTER. IBM-AS400. OBJECT-COMPUTER. IBM-AS400. ****************************************************************** * D A T A D I V I S I O N ****************************************************************** DATA DIVISION. ****************************************************************** * W O R K I N G S T O R A G E S E C T I O N ****************************************************************** WORKING-STORAGE SECTION. * 01 DATATYPES COMP-4. 03 TYP-CHAR PIC S9(4) VALUE 1. 03 TYP-DATE PIC S9(4) VALUE 2. 03 TYP-FLOAT PIC S9(4) VALUE 3. 03 TYP-INTEGER PIC S9(4) VALUE 4. 03 TYP-PACKED PIC S9(4) VALUE 5. 03 TYP-TIME PIC S9(4) VALUE 6. 03 TYP-ZONED PIC S9(4) VALUE 7. ****************************************************************** * L I N K A G E S E C T I O N ****************************************************************** LINKAGE SECTION. 01 RETURN-VALUE. 03 RV-DATATYPE PIC S9(4) COMP-4. 03 RV-LENGTH PIC S9(4) COMP-4. 03 RV-DIGITS PIC S9(4) COMP-4. 03 RV-DECPLC PIC S9(4) COMP-4. 03 RV-NULLIND PIC S9(4) COMP-4. 03 RV-DTMFMT PIC X(4). 03 RV-SELECT PIC X(1). 01 PARM-1. 03 P1-DATATYPE PIC S9(4) COMP-4. 03 P1-LENGTH PIC S9(4) COMP-4. 03 P1-DIGITS PIC S9(4) COMP-4. 03 P1-DECPLC PIC S9(4) COMP-4. 03 P1-NULLIND PIC S9(4) COMP-4. 03 P1-DTMFMT PIC X(4). 03 P1-BRANCH PIC X(2). ****************************************************************** * P R O C E D U R E D I V I S I O N ****************************************************************** PROCEDURE DIVISION USING RETURN-VALUE PARM-1. ML-0010. * * This example program checks parm 1 for a value of 11 and if found, * returns Y, else returns N. * * Define the Returned Value as a 1-byte character field. * MOVE TYP-CHAR TO RV-DATATYPE. MOVE 1 TO RV-LENGTH. MOVE ZERO TO RV-DIGITS.
Column functions

301

MOVE ZERO TO RV-DECPLC. MOVE ZERO TO RV-NULLIND. MOVE SPACES TO RV-DTMFMT. * * Test for a value of 11 in the first parameter. * IF P1-BRANCH IS EQUAL TO 11 MOVE Y TO RV-SELECT ELSE MOVE N TO RV-SELECT. EXIT PROGRAM.

Related reference Stored procedure%STPROC on page 297 User exit%USER (InfoSphere CDC for Microsoft SQL 5.x) User Exit%USERFUNC on page 303

User exit%USER (InfoSphere CDC for Microsoft SQL 5.x)


If you have installed InfoSphere CDC for Microsoft SQL Server, use this function to call a stored procedure on the source. This function allows you to specify Microsoft stored procedures as input parameters. To call stored procedures in expressions defined on the target, use the %STPROC function. For information about creating Microsoft SQL Server stored procedures, see InfoSphere CDC for Microsoft SQL Server User Exits Guide. Note: This function is only supported by InfoSphere CDC for Microsoft SQL Server on the source.

Syntax
%USER(<database_name>.<owner_name>.<stored_procedure_name>, <parm1>, <parm2>, ..., <parm20>

Parameters
v database_namespecifies the name of the database where the stored procedure resides. v owner_namespecifies the owner of the stored procedure. For example, dbo. v stored_procedure_namespecifies the name of the stored procedure. v parm1, parm2, ..., parm20specify columns or literals that are passed as parameters to the stored procedure (maximum 20). The type and order of the parameters specified in the %USER call must match the type and order of the parameters defined in the stored procedure. The first parameter defined in the stored procedure must be the OUTPUT parameter followed by the input parameters. Do not specify this parameter in the %USER parameter list (parm1, parm2, ..., parm20). The number of parameters specified in the stored procedure must match the number of parameters specified in Management Console. You can omit any number of trailing parameters. InfoSphere CDC assumes the default value if a parameter is not specified. For example, for a stored procedure with five parameters, if you specify values for the first two parameters only, InfoSphere CDC assigns default values to the last three parameters.

302

InfoSphere Change Data Capture Management Console: Administration Guide

Result data type


The data type of the result returned by the stored procedure.

Examples
%USER("datamirror.dbo.sp_date_diff",COL_DATE) %USER("datamirror.dbo.sp_date_diff","12-jan-2000")

The first call example specifies a source column name as input parameter (COL_DATE), while the second call example specifies a value as input parameter (12-jan-2000). These examples assume that a stored procedure, similar to the following, is defined in the database. The example stored procedure calculates the difference in days between the current date and a date specified as parameter:
CREATE PROCEDURE dbo.sp_date_diff @out_int int output, @in_date datetime AS select @out_int = DATEDIFF(day, @in_date, getdate()) GO %USER("datamirror.dbo.sp_join",col_item_number) %USER("datamirror.dbo.sp_join",12)

The first call example specifies a source column name as input parameter (col_item_number), while the second call example specifies a value as input parameter (12). These examples assume that a stored procedure, similar to the following, is defined in the database. The example stored procedure performs a join to a description table to get the description of an item given its item number:
CREATE PROCEDURE dbo.sp_join @out_item_description varchar(10) output @in_item_number int AS SELECT @out_item_description = inventory_db.dbo.description.item_desc FROM inventory_db.dbo.item_list INNER JOIN inventory_db.dbo.description ON inventory_db.dbo.item_list.item_number = inventory_db.dbo.description.item_number WHERE (inventory_db.dbo.description.item_number = @in_item_number) GO

Related reference Stored procedure%STPROC on page 297 User exit%USER on page 298 User Exit%USERFUNC

User Exit%USERFUNC
Use this function to call a Java class user exit program or a stored procedure from an expression. This function provides flexibility when complex logic that cannot be expressed using the provided column functions is required. You can use this function to call a user exit program with input parameters. This function also supports MBCS data. For more information about user exit programs, see your InfoSphere CDC user exits documentation.

Syntax
%USERFUNC(function_type, program_name, [<parm1>, <parm2>, ..., <parmn>]

Parameters
v function_typeIndicate the type of user exit. Specify JAVA to call a Java class user exit program or STOREDPROC to call a stored procedure user exit program. You must enclose these values in double quotes to indicate they are strings, not column names.

Column functions

303

The Java class should be placed in your lib directory. If your Java class has a package name then you must create the appropriate directories under the lib directory. The stored procedure must exist in your database and you must specify the database owner or schema. v program_nameThe name of your Java class or stored procedure. Stored procedures must exist in your database you must specify the database owner or schema as well as the name of the stored procedure. v parm1, parm2, ..., parmnSpecify columns or literals that are passed as parameters to the Java class user exit or stored procedure user exit.

Result data type


The data type of the result returned by the stored procedure.

Examples
%USERFUNC("JAVA", "USERSEL1", BRANCH)

This function calls the Java user exit program of USERSEL1 and passes the BRANCH column as a parameter. USERSEL1 checks whether or not BRANCH is set to 11. If it is, then the user exit program returns a one-byte character value of Y. Otherwise, it returns a character value of N.
%USERFUNC("STOREDPROC","dbo.sp_date_diff",COL_DATE) %USERFUNC("STOREDPROC","dbo.sp_date_diff","12-jan-2000")

The first call example specifies a source column name as input parameter (COL_DATE), while the second call example specifies a value as input parameter (12-jan-2000). These examples assume that a stored procedure, similar to the following, is defined in the database. The example stored procedure calculates the difference in days between the current date and a date specified as parameter. The stored procedure must exist in your database and you must specify the stored procedure name and database owner or schema:
CREATE PROCEDURE dbo.sp_date_diff @out_int int output, @in_date datetime AS select @out_int = DATEDIFF(day, @in_date, getdate()) GO %USERFUNC("STOREDPROC","dbo.sp_join",col_item_number) %USERFUNC("STOREDPROC","dbo.sp_join",12)

The first call example specifies a source column name as input parameter (col_item_number), while the second call example specifies a value as input parameter (12). These examples assume that a stored procedure, similar to the following, is defined in the database. The example stored procedure performs a join to a description table to get the description of an item given its item number. The stored procedure must exist in your database and you must specify the stored procedure name and database owner or schema.
CREATE PROCEDURE dbo.sp_join @out_item_description varchar(10) output @in_item_number int AS SELECT @out_item_description = inventory_db.dbo.description.item_desc FROM inventory_db.dbo.item_list INNER JOIN inventory_db.dbo.description ON

304

InfoSphere Change Data Capture Management Console: Administration Guide

inventory_db.dbo.item_list.item_number = inventory_db.dbo.description.item_number WHERE (inventory_db.dbo.description.item_number = @in_item_number) GO

Related concepts Setting multibyte and Unicode character set conversions on page 175 Related reference Stored procedure%STPROC on page 297 User exit%USER on page 298 User exit%USER (InfoSphere CDC for Microsoft SQL 5.x) on page 302

%GETCOL column function scenarios (DB2 UDB for iSeries)


The %GETCOL column function scenarios in this section are specific to InfoSphere CDCInfoSphere CDC for AS/400. If you are using a different InfoSphere CDC product, %GETCOL column function scenarios (Dynamic SQL) on page 307. See also: Retrieving a column from another table using the %GETCOL function (DB2 UDB for iSeries) Performing an outer join using the %GETCOL function (DB2 UDB for iSeries) on page 306 Nesting columns to join data using the %GETCOL function (DB2 UDB for iSeries) on page 306 Combining columns using the %GETCOL function (DB2 UDB for iSeries) on page 306

Retrieving a column from another table using the %GETCOL function (DB2 UDB for iSeries)
This example uses the relationship between a primary (EMPLOYEE) and secondary (BRANCE, STATE, and COUNTRY) tables.

In this example, you will retrieve the column NAME from the STATE table using the STATE column from the EMPLOYEE table. To use this example, perform the following steps: 1. Add a derived column, STNAME, based on the NAME column, to the STATE table. 2. Enter the following expression for the STNAME derived column: %GETCOL(NAME, PRODLIB/STATE, , , 1, STATE)
Column functions

305

Performing an outer join using the %GETCOL function (DB2 UDB for iSeries)
This example uses the relationship between primary and secondary tables. In this example, you will retrieve the column NAME from the COUNTRY table using the COUNTRY column from the STATE table. The COUNTRY column, used to read the COUNTRY table, is not from the primary table. To use this example, perform the following steps: 1. Add a derived column, CTNAME, based on the NAME column, to the COUNTRY table. 2. Enter the following expression for the CTNAME column: %GETCOL(NAME, PRODLIB/COUNTRY, , , 1, %GETCOL(COUNTRY, PRODLIB/STATE)) The second %GETCOL function retrieves the COUNTRY column from the STATE table. This column was retrieved in a previous %GETCOL invocation. In the first %GETCOL function, the default_value and record_format parameters are not specified, as they are specified in the long version of the %GETCOL function that performed the read.

Nesting columns to join data using the %GETCOL function (DB2 UDB for iSeries)
This example uses the relationship between primary and secondary tables. In this example, you will consolidate data from secondary tables without replicating the secondary tables. To use this example, perform the following steps: 1. Add a derived column, CTNAME, based on the NAME column, to the COUNTRY table. 2. Enter the following expression for the CTNAME column: %GETCOL(NAME, PRODLIB/COUNTRY, , , 1, %GETCOL(COUNTRY, PRODLIB/STATE, , , 1, STATE)) This function retrieves the NAME column from the COUNTRY table using the STATE column from the EMPLOYEE table and the COUNTRY column from the STATE table.

Combining columns using the %GETCOL function (DB2 UDB for iSeries)
This example uses the relationship between primary and secondary tables. In this example, you will combine the STATE and COUNTRY columns from the STATE table using the %CONCAT function. To use this example, perform the following steps: 1. Add a derived column, REGION, based on the STATE and COUNTRY columns in the STATE table. 2. Enter the following expression for the REGION column: %CONCAT(%GETCOL(STATE, PRODLIB/STATE, FAILED, , 1, STATE), -, %GETCOL(COUNTRY, PRODLIB/STATE, FAILED)) The second %GETCOL function retrieves the COUNTRY column from the STATE table. This column was retrieved in a previous %GETCOL function invocation. Related reference

306

InfoSphere Change Data Capture Management Console: Administration Guide

Concatenation%CONCAT on page 262

%GETCOL column function scenarios (Dynamic SQL)


The %GETCOL column function scenarios in this section apply to any InfoSphere CDC product except InfoSphere CDC for AS/400. For InfoSphere CDC for z/OS, you can also refer to Retrieve column%SELECT on page 293. See also: Retrieving a Retrieving a row from the Retrieving a page 308 column using the %GETCOL function (Dynamic SQL) column using the %GETCOL function without reading the same table on page 308 column using nested %GETCOL functions (Dynamic SQL) on

Filtering rows using the %GETCOL function (Dynamic SQL) on page 309

Retrieving a column using the %GETCOL function (Dynamic SQL)


This example refers to the primary (EMPLOYEE) and secondary (BRANCH, STATE, and COUNTRY) table relationship. The table names referenced in the examples follow the format for InfoSphere CDC for Microsoft SQL Server and InfoSphere CDC for Sybase. If you installed another InfoSphere CDC product, see the table_name parameter for information about specifying table names for this function, depending on your database.

To use the example, you must add a derived column to the MASTER.DBO.EMPLOYEE primary table and enter the specified %GETCOL function in that column. %GETCOL(NAMEB, MASTER.DBO.BRANCH, <NO NAME>, BRANCHB, BRANCH) This example retrieves the NAMEB column from the MASTER.DBO.BRANCH secondary table, using the value in the BRANCH column in the primary table and the key column BRANCHB in the secondary table. If a record in the primary table has a branch number that does not exist in the MASTER.DBO.BRANCH table, then this function returns for that record in the retrieved column.

Column functions

307

Retrieving a column using the %GETCOL function without reading the same row from the table
This example refers to the primary and secondary tables. The table names referenced in the examples follow the format for InfoSphere CDC for Microsoft SQL Server and InfoSphere CDC for Sybase. If you installed another InfoSphere CDC product, see the table_name parameter for information about specifying table names for this function, depending on your database. To use the example, you must add a derived column to the MASTER.DBO.EMPLOYEE primary table and enter the specified %GETCOL function in that column. %GETCOL(NAMES, MASTER.DBO.STATE, , STATES, STATE) This function call retrieves the NAMES column from the MASTER.DBO.STATE secondary table, using the key column STATE in the primary table and the key column STATES in the secondary table. If a record in the primary table has a state that does not exist in MASTER.DBO.STATE, then this function returns the default value for the data type of the NAMES column. For example, blank characters if the data type is character. %GETCOL(COUNTRYS, MASTER.DBO.STATE, ) Used after the previous %GETCOL function, this function call retrieves the COUNTRYS column from the MASTER.DBO.STATE secondary table, without reading again the same row from the table. If a record in the primary table has a state that does not exist in MASTER.DBO.STATE, then this function returns the default value for the data type of the COUNTRYS column. For example, blank characters if the data type is character.

Retrieving a column using nested %GETCOL functions (Dynamic SQL)


This example refers to the primary and secondary table relationship. The table names referenced in the examples follow the format for InfoSphere CDC for Microsoft SQL Server and InfoSphere CDC for Sybase. If you installed another InfoSphere CDC product, see the table_name parameter for information about specifying table names for this function, depending on your database. To use the example, you must add a derived column to the MASTER.DBO.EMPLOYEE primary table and enter the specified %GETCOL function in that column. %GETCOL(NAMES, MASTER.DBO.STATE, , STATES, STATE) This function call retrieves the NAMES column from the MASTER.DBO.STATE secondary table, using the key column STATE in the primary table and the key column STATES in the secondary table. If a record in the primary table has a state that does not exist in MASTER.DBO.STATE, then this function returns the default value for the data type of the NAMES column. For example, blank characters if the data type is character. %GETCOL(NAMEC, MASTER.DBO.COUNTRY, , COUNTRYC, %GETCOL(COUNTRYS, MASTER.DBO.STATE, ))

308

InfoSphere Change Data Capture Management Console: Administration Guide

Used after the previous %GETCOL function, the second %GETCOL function in this example is called first to retrieve the COUNTRYS column from the MASTER.DBO.STATE table. Then, the first %GETCOL function is called to retrieve the NAMEC column from the MASTER.DBO.COUNTRY table using the key column COUNTRYS in MASTER.DBO.STATE and the key column COUNTRYC in MASTER.DBO.COUNTRY. In this example you do not retrieve the NAMEC column in the MASTER.DBO.COUNTRY table directly, using the COUNTRYC key column, because the primary table does not contain a key column to retrieve NAMEC. Instead, you retrieve the NAMEC column indirectly using the COUNTRYS key column in MASTER.DBO.STATE and the COUNTRYC key column in MASTER.DBO.COUNTRY.

Filtering rows using the %GETCOL function (Dynamic SQL)


This example refers to the primary and secondary table relationship. The table names referenced in the examples follow the format for InfoSphere CDC for Microsoft SQL Server and InfoSphere CDC for Sybase. If you installed another InfoSphere CDC product, see the table_name parameter for information about specifying table names for this function, depending on your database. To use the example, you must add a derived column to the MASTER.DBO.EMPLOYEE primary table and enter the specified %GETCOL function in that column. %GETCOL(COUNTRYS, MASTER.DBO.STATE, , STATES, STATE) = USA This example uses the %GETCOL function in a row-filtering expression. The function retrieves values of the COUNTRYS column from the MASTER.DBO.STATE table and compares them with USA. Depending on your rowfiltering settings on the Filtering tab, rows in the MASTER.DBO.EMPLOYEE primary table, with a COUNTRYS value set to USA, are either selected or omitted for replication.

Publishing multiple derived columns using the %GETCOL function (Dynamic SQL)
This example refers to the primary and secondary table relationship. The table names referenced in the examples follow the format for InfoSphere CDC for Microsoft SQL Server and InfoSphere CDC for Sybase. If you installed another InfoSphere CDC product, see the table_name parameter for information about specifying table names for this function, depending on your database.

Column functions

309

This example combines the CUSTID and CUSTADDR tables into a single CUSTOMER table with all five columns. By calling the %GETCOL function twice, you retrieve values of two columns from the same row in the secondary table. The first call reads the entire row into memory and the second call retrieves data from the same row in memory, without reading the same table twice.

To use this example, perform the following steps: 1. Add a derived column, ADDR1, to the CUSTID source table and enter the following expression for the column: %GETCOL(ADDRESS1, MASTER.DBO.CUSTADDR, Not Found, CUSTNO, CUSTNO) 2. Add a derived column, ADDR2, to the CUSTID source table and enter the following expression for the column: %GETCOL(ADDRESS2, MASTER.DBO.CUSTADDR, Not Found) The expression for ADDR1 queries the CUSTADDR table and returns the value in the ADDRESS1 column where the two CUSTNO values match. The expression for ADDR2 uses the results returned by the previous %GETCOL function invocation without reading the CUSTADDR table. Instead, it uses matching rows from the ADDR2 definition to know when to return the value from the ADDRESS2 column. If either %GETCOL function cannot find a matching row, then it returns a value of Not Found.

310

InfoSphere Change Data Capture Management Console: Administration Guide

Related concepts Filtering rows and columns on page 167

Column functions

311

312

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Notes: v If you make changes to a system parameter during active replication, you must stop and restart replication for the changes to take effect. v When upgrading to a higher version of InfoSphere CDC, any pre-existing settings for system parameters are maintained. In this section, you will learn: General product system parameters Replication system parameters on page 317 Database translation log system parameters on page 319 Commitment control system parameters on page 323 Event log system parameters on page 325 Multibyte character set system parameters on page 325 Latency system parameters on page 326 Notification system parameters on page 329 Tracing system parameters on page 332 Data type system parameters on page 335 Lock detection system parameters on page 335

General product system parameters


General product system parameters let you control basic features of InfoSphere CDC and information you may have specified during installation. See also: AuthCode on page 314 DBMS on page 314 dbUser on page 314 dllname on page 314 DSN on page 314 NetServiceName on page 315 pwdencrypt on page 315 Startup Timeout on page 315 TSSrcCP on page 315
Copyright IBM Corp. 2008

313

TSTgtCP on page 316 TCP_KEEPALIVE_SECS on page 316 WindowsAuthentication on page 316

AuthCode
Use this system parameter to adjust the authorization code issued by IBM. You may need to modify your authorization code when: v Moving from a temporary license to a permanent license v Machine classes have changed v Upgrading to a new version of InfoSphere CDC Applies ToSource and Target Note: You can also modify the authorization using the Authorization Code Setup utility Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

DBMS
For information about setting this system parameter, see your IBM representative. Applies ToTarget

dbUser
For information about setting this system parameter, see your IBM representative. Applies ToSource and Target

dllname
For information about setting this system parameter, see your IBM representative. Applies ToTarget

DSN
Use this system parameter to identify ODBC data source name used by InfoSphere CDC to define the metadata database on either the source or target system. Applies ToSource and Target Note: This parameter was specified during InfoSphere CDC installation. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

314

InfoSphere Change Data Capture Management Console: Administration Guide

NetServiceName
For information about setting this system parameter, see your IBM representative. Applies ToTarget

pwdencrypt
Use this system parameter to encrypt or decrypt user identifiers and passwords stored in InfoSphere CDC metadata tables. Applies ToSource The pwdencrypt system parameters is set to either 0 or 1: v 0Do not encrypt user identifiers and passwords in metadata tables. v 1Encrypt user identifiers and passwords in metadata tables. Default Setting1 Guidelines Encryption or decryption does not affect existing user identifiers and passwords in InfoSphere CDC metadata tables. Any changes you make to this system parameter apply only to user identifiers and passwords added after setting the system parameter. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference Deadband Percentage on page 326

Startup Timeout
For information about setting this system parameter, see your IBM representative. Applies ToSource and Target Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

TSSrcCP
Use this system parameter to identify the code page InfoSphere CDC uses for each instance of a target database. Applies ToTarget Default SettingThe system code page when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)

315

Setting system parameters on source and target datastores on page 60

TSTgtCP
Use this system parameter to identify the source system code page of InfoSphere CDC. Applies ToSource Default SettingThe system code page when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

TCP_KEEPALIVE_SECS
Use this system parameter to determine the time (in seconds) InfoSphere CDC waits before sending a keep alive notification over the network. During idle periods, InfoSphere CDC sends a keep alive notification to keep the connection open. Applies ToSource and Target Default Setting300 seconds (5 min) Minimum Setting0 Guidelines v To prevent the firewall from closing during active data replication, set this parameter to a value lower than the configured firewall timeout. v To set TCP_KEEPALIVE_SECS: 1. Create a registry key called HKEY_LOCAL_MACHINE\SOFTWARE\ DataMirror\InfoSphere CDC\Comms 2. Create a string value called TCP_KEEPALIVE_SECS under the registry key created above. 3. Set TCP_KEEPALIVE_SECS to the value that you want. Note: It is important you set this system parameter when you have a firewall connection that has been configured to timeout. This prevents the firewall from closing the connection. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

WindowsAuthentication
For information about setting this parameter, see your IBM representative. Applies ToSource and Target

316

InfoSphere Change Data Capture Management Console: Administration Guide

Replication system parameters


Replication system parameters let you control how InfoSphere CDC behaves after detecting errors during replication. You can also control how often InfoSphere CDC communicates the status of replication activities, and how InfoSphere CDC should apply a refresh operation. See also: AutoRestart convertNotNullableColumns MirrorError on page 318 RefreshError on page 318 RefreshMode on page 319

AutoRestart
Use this system parameter to enable or disable InfoSphere CDC to automatically restart replication after detecting a failover in a clustered environment. Applies ToSource The AutoRestart system parameters is set to either 0 or 1: v 0Disables automatic restart of replication operations. v 1Enables automatic restart of replication operations. Default Setting0 Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference convertNotNullableColumns

convertNotNullableColumns
Use this system parameter to indicate whether or not NULL values will be converted to default values when replicating data that contains NULL values to non-nullable target columns. Applies ToTarget Set this parameter to one of the following: v OFFAn error message will be generated in Event Log. Replication will continue or not based on whether the MirrorError or RefreshError system parameters are set to END or ON. v ONInfoSphere CDC will automatically insert an appropriate default value in the target column. No error message is generated in Event Log and replication continues. Depending on the convertNotNullableMsg system parameter setting, a warning message may be generated in Event Log.

System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)

317

The default value depends on the data type of the subscription column. For example, zero for numeric data types, blank character for character data types, 1901-01-01 for date data types, and so on. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference MirrorError RefreshError convertNotNullableMsg on page 329 D_MIRROR_MIRROR_ERROR_STOP on page 405 D_MIRROR_REFRESH_ERROR_STOP on page 359

MirrorError
Use this system parameter to start or stop InfoSphere CDC from continuing mirroring when it encounters one or more errors. Applies ToTarget The MirrorEnd system parameter can be set to either END or GO: v ENDStops mirroring after InfoSphere CDC encounters an error. v GOContinues mirroring after InfoSphere CDC encounters an error. Default SettingEND Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

RefreshError
Use this system parameter to start or stop InfoSphere CDC from continuing mirroring when it encounters one or more errors. Applies ToTarget The RefreshError system parameter can be set to either END or GO: v ENDInfoSphere CDC ends a refresh operation after it encounters one or more errors. v GOInfoSphere CDC continues a refresh operation after it encountering one or more errors. Default SettingEND Related concepts

318

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

RefreshMode
Applies To
Target Use this system parameter to set how InfoSphere CDC applies rows to the target during a refresh operation. InfoSphere CDC can use BCP (bulk copy refresh) in which a block of rows are sent as a single unit during a refresh operation. This method is faster than the standard method of refreshing tables used by InfoSphere CDC.s The RefreshMode system parameter can be set to either BCP or SQL: BCP SQL Perform a bulk copy refresh. Perform a standard refresh.

Default Setting
BCP Note: Use the RefreshBlock system parameter to set the number of records in a block. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference RefreshBlock on page 324

Database translation log system parameters


Database transaction log system parameters let you control how InfoSphere CDC cleans the logs of the distribution database. You can also control often InfoSphere CDC reports its log position to the target and performs log synchronization between the source and the target. See also: Cleanup Interval Cleanup Log Events on page 320 Cleanup Record Count on page 320 LogCleanupMethod on page 321 Report Position Interval on page 322 Synchronization Interval on page 322

Cleanup Interval
Use this system parameter to set the time (in seconds) for InfoSphere CDC to clean up the distribution database on the source system.
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)

319

Applies ToSource Default Setting120 seconds Minimum Settings1 second Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

Cleanup Log Events


Use this system parameter to enable or disable InfoSphere CDC from generating a notification during a cleanup cycle. InfoSphere CDC can generate regular notifications to indicate how many processed log entries it deleted from the distribution database during a cleanup cycle. If the cleanup cycle completes in a short period of time, then InfoSphere CDC only generates notifications that mark the start and end of each cleanup cycle. Applies ToSource The Cleanup Log Events system parameter is set to either YES or NO: v YESGenerates notifications indicating the duration of the cleanup cycle and how many processed log entries have been deleted from the distribution database. v NODoes not generate notifications indicating the duration of the cleanup cycle and how many processed log entries have been deleted from the distribution database. Default SettingNO Notes: v InfoSphere CDC places notifications in the Event Log. v If you modify the value after setting the system parameter, InfoSphere CDC uses the modified value after completing the next cleanup cycle. v The time between consecutive cleanup cycles is determined by the Cleanup Interval system parameter. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Displaying event messages during replication on page 232 Setting system parameters on source and target datastores on page 60

Cleanup Record Count


Use this system parameter to increase or decrease the number of log entries InfoSphere CDC can delete from the distribution database during a cleanup cycle. Depending on the number of log entries you set for deletion and the amount of data being mirrored in your environment, multiple operations may be required to delete all processed log entries during a cleanup cycle. Applies ToSource

320

InfoSphere Change Data Capture Management Console: Administration Guide

Default Setting8000 log entries Minimum Settings100 log entries Maximum Settings100000 log entries Guidelines v You may want to reduce the number of operations applied to the distribution database and set this parameter to a higher number so that InfoSphere CDC can delete a greater number of log entries. Although this improves the performance of the cleanup cycle, a higher number of log entries can increase the amount of time it takes for InfoSphere CDC to complete the cleanup cycle. This can also conflict with other processes that use the distribution database (for example, the Microsoft log reader process and the InfoSphere CDC log scraper process). To avoid conflicts with other processes that access the distribution database, set this parameter to a smaller number of log entries that InfoSphere CDC can delete during a clean up cycle. v To ensure a short cleanup cycle, set this parameter to the approximate number of log entries that InfoSphere CDC can delete in your environment in 1 second. Notes: v If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. v If you modify the value after setting the system parameter, InfoSphere CDC uses the modified value after completing the next cleanup cycle. v The time between consecutive cleanup cycles is determined by the Cleanup Interval system parameter. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference Cleanup Log Events on page 320

LogCleanupMethod
Use this system parameter to enable or disable InfoSphere CDC from using IBM stored procedures to clean up transactions in the distribution database. Applies ToSource The LogCleanupMethod system parameter is set to either 0 or 1: v 0Use Microsoft stored procedures. v 1Use IBM stored procedures. Default Setting0 Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)

321

Report Position Interval


Use this system parameter to set how often (in milliseconds) InfoSphere CDC informs the target system about its log position. When the source system is in idle mode and there are no log entries for the subscription, the source system informs the target system of its current log position. The target system uses this information to advance its bookmarks. Applies ToSource Default Setting5000 milliseconds (5 seconds) Minimum Settings1000 milliseconds (1 second) Maximum Settings300000 milliseconds (5 minutes) Guidelines v If the number of milliseconds is set low, then the target system can provide accurate progress notifications that indicate how far replication has progressed. v If the number of milliseconds is set high, it may affect the accuracy of the information displayed in progress and bookmark notifications. Notes: v If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. v This system parameter can also prevent InfoSphere CDC from rereading log entries that do not apply to the table currently being replicated. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Synchronization Interval
Use this system parameter to set how often (in seconds) InfoSphere CDC performs log synchronization between the source and the target. Synchronization is achieved when the source reports to the target the position of the last committed change. Applies ToSource Default Setting60 seconds Minimum Settings1 second Maximum Settings3000 seconds (50 minutes) Guidelines If you are replicating large volumes of data, set this system parameter to a lower number of seconds to remove obsolete logs more frequently.

322

InfoSphere Change Data Capture Management Console: Administration Guide

Note: If a value outside the acceptable range is specified, the default setting is used. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Commitment control system parameters


Commitment control system parameters let you control how InfoSphere CDC issues commits to the target system. See also: CommitmentControl Commitment Group Size on page 324 RefreshBlock on page 324 SeparateCommits on page 325

CommitmentControl
Use this system parameter to enable or disable InfoSphere CDC from using commitment control. Enabling commitment control maintains transaction consistency during replication and ensures that all transactions are applied to the target system. If there is a communications or server failure and you have enabled this system parameter, then InfoSphere CDC rolls back the partially applied transaction to the last commit. Applies ToSource The CommitmentControl system parameter is set to either 0 or 2: v 0Disables commitment control for transaction processing. InfoSphere CDC does not maintain transaction consistency during replication. v 2Enables InfoSphere CDC to use commitment control against the target system after applying all rows. This setting provides true transaction consistency by ensuring that entire transactions are committed to the target database even in the event of a communications or server failure Default Setting0 Note: You can set the maximum number of rows that InfoSphere CDC can contain a committed transaction using the RefreshBlock system parameter. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference RefreshBlock on page 324

System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)

323

Commitment Group Size


Use this system parameter to set the number of rows InfoSphere CDC applies to the target system before issuing a commit. For example, if you set this system parameter to apply 10 rows, then InfoSphere CDC issues a commit to the target system after applying 10 rows. Applies ToTarget Set the Commitment Group Size system parameter to the number rows you want InfoSphere CDC to apply before issuing a commit. Default Setting0 (InfoSphere CDC will not use commit groups) Notes: v This system parameter improves the performance of the InfoSphere CDC apply process because commits to the target system are issued on an interval basis rather than on an transactional basis. This reduces the number of commits to the target system. v This system parameter affects the commit size only if you set the CommitmentControl system parameter to 0 Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference CommitmentControl on page 323

RefreshBlock
Use this system parameter to set the number of rows InfoSphere CDC can contain in a refresh block or a commit group. Depending on how you are refreshing data to the target, InfoSphere CDC can contain rows for bulk copy refresh or a commit group operations. Applies ToTarget Default Setting10000 records Guidelines v If the table you are replicating is relatively large, IBM recommends increasing the number of records (refresh block or commit group) to improve performance. v If you are encounter errors during replication, reduce the number of records. Although performance is affected, lowering the number of records may eliminate these errors during replication. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference CommitmentControl on page 323 SeparateCommits on page 325

324

InfoSphere Change Data Capture Management Console: Administration Guide

SeparateCommits
Use this system parameter to control how InfoSphere CDC commits bookmarks. InfoSphere CDC can commit bookmarks together or separate from the user data. For more information about bookmarks and how to retrieve bookmark values on the target, see Transformation Server for Microsoft SQL Server Commands Reference. Applies ToTarget The SeparateCommits system parameter can set to On or Off: v OnInfoSphere CDC commits the bookmark separate from user data. v OffInfoSphere CDC commits the bookmark together with the user data. Default SettingOff Guidelines IBM recommends that you set this parameter to On only for performance reasons. If you set this parameter to On and InfoSphere CDC encounters an error during the apply process and ends the apply process abnormally, then this may result in the bookmark not being synchronized with the target system. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

Event log system parameters


Event log system parameters let you control how InfoSphere CDC interacts with notify message queues. See also: AllowEventLogClear

AllowEventLogClear
For information about setting this system parameter, see your IBM representative. Applies ToSource

Multibyte character set system parameters


Multibyte character set system parameters let you control how InfoSphere CDC treats character sets during replication. See also: Unicode Handling

Unicode Handling
Use this system parameter to indicate the default method of treating data in defined Unicode columns. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)

325

columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Applies ToSource Data types Use this system parameter: v nchar v nvarchar This system parameter is set to either CHAR or NOCHANGE: v CHARInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v NOCHANGEInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain non-single-byte character data. NOCHANGE ensures InfoSphere CDC will handle non-single-byte character data in the same way as previous InfoSphere CDC releases. Default SettingNOCHANGE Note: NOCHANGE does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may need to apply user exit programs or other customization to properly represent the data in Unicode columns. For more information about user exit programs, see the InfoSphere CDC for Microsoft SQL Server User Exits Guide. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related tasks To set handling for Unicode character encodings on page 177

Latency system parameters


Latency system parameters let you control how often InfoSphere CDC generates a latency notification and updates latency statistics in the Event Log. See also: Deadband Percentage Monitor Sample Interval on page 329

Deadband Percentage
Applies ToTarget Identifies the size of the range around each latency threshold setting. Based on latency thresholds defined, a latency message is generated when latency has risen above or fallen below a threshold. Latency is calculated at regular intervals, where

326

InfoSphere Change Data Capture Management Console: Administration Guide

the interval is the current setting for the MONITOR_SAMPLE_INTERVAL system parameter. You can set notifications in response to a generated latency message. This system parameter, which is expressed as a percentage, allows you to pad a threshold equally on both sides to create a range around the threshold. By adjusting this system parameter, the size of the range around the threshold can be increased or decreased, and the threshold itself can be made thicker or thinner. A latency message is generated only when latency has risen above the upper limit of the range or fallen below the lower limit of the range. By changing the value assigned to this system parameter, you can control the number of latency messages placed in Event Log. For example, assume that a latency threshold is 5 minutes and this system parameter is set to 10. A 10% range is applied around the 5 minute threshold. The following calculations are performed to determine the lower and upper limits (in minutes) of the range around the threshold: v Padding = 10% of 5 minutes = 0.5 minutes (rounded up to 1 minute) v Padding is rounded up or down to the nearest whole minute: Upper limit of range = 5 minutes + 1 minute (padding) = 6 minutes Lower limit of range = 5 minutes - 1 minute (padding) = 4 minutes As a result, a latency message will be generated only when latency rises above 6 minutes or falls below 4 minutes. Given sample latency over a ten minute period where latency is calculated every minute, three latency messages are generated. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 10%:

If this DEADBAND_PERCENTAGE is set to 3 (the default setting) for the same example, no padding is applied to the latency threshold. Therefore, a latency message is generated each time latency crosses over the latency threshold of 5 minutes. Based on the same sample latency in the previous graph where latency is calculated every minute, five latency messages are generated when this system parameter is set to 3. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 3%:
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)

327

If the number of latency messages generated over the ten minute period for the 10% (3 latency messages) and 3% (5 latency messages) settings are averages, an additional 288 latency messages would be generated each day if this system parameter is not changed from its default setting to 10%. Since there are two latency thresholds that you can set (a warning threshold and a problem threshold), two separate ranges are defined when padding is at least one minute. In this case, each range is attached to its threshold, and the two ranges can overlap with no change in behavior. If a value outside the acceptable range is specified, the default setting is used. Default Setting3% Minimum Setting3% Maximum Setting10% Note: If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting latency thresholds and notifications on page 78 Setting system parameters on source and target datastores on page 60 Related reference pwdencrypt on page 315

328

InfoSphere Change Data Capture Management Console: Administration Guide

Monitor Sample Interval


Use this system parameter to set how often (in seconds) InfoSphere CDC updates replication latency metrics. InfoSphere CDC samples the target system to determine if latency has risen above or fallen below the specified threshold settings. Applies ToSource and Target Default Setting5 seconds Minimum Setting0 seconds. Replication latency metrics are not updated. Maximum Setting3600 seconds (one hour) Notes: v InfoSphere CDC generates latency notifications when latency rises above or falls below the thresholds and places these in the Event Log. v If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts Setting latency thresholds and notifications on page 78 System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Notification system parameters


Notification system parameters let you control if you should generate InfoSphere CDC messages in the Event Log for specific events. See also: convertNotNullableMsg DM_STATUS_INTERVAL on page 330 Heartbeat Timeout on page 331 InvalidNumericMsg on page 331

convertNotNullableMsg
Use this system parameter to indicate whether or not a warning message will be generated in Event Log each time data that contains NULL values is converted to default values for non-nullable target columns. Applies ToTarget This system parameter applies only when convertNotNullableColumns=ON. Otherwise, this parameter has no effect. Set this parameter to one of the following: v OFFNo warning message is generated in Event Log.

System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)

329

v ONA warning message is generated in Event Log each time a NULL value is converted to a default value. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference convertNotNullableColumns on page 317 DM_STATUS_INTERVAL Heartbeat Timeout on page 331 InvalidNumericMsg on page 331

DM_STATUS_INTERVAL
Use this system parameter to set how often (in seconds) InfoSphere CDC issues progress notifications about the status of replication activities. On the source, progress notifications identify: v The bookmark sent by the source v The corresponding log name v The subscription name to which the bookmark was sent On the target, progress notifications identify: v The bookmark received by the target v The corresponding log name v The source ID from which the bookmark was received Applies ToSource and Target Default Setting0 seconds. No progress notifications will be issued. Minimum Setting0 seconds. No progress notifications will be issued. Maximum Setting7200 seconds Notes: v InfoSphere CDC places progress notifications in the Event Log. v If a value outside the acceptable range is specified, the default setting is used. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

330

InfoSphere Change Data Capture Management Console: Administration Guide

Heartbeat Timeout
Use this system parameter to increase or decrease the communication timeout interval (in minutes) before InfoSphere CDC detects a communication problem and attempts to stop active replication processes. InfoSphere CDC sends internal heartbeat notifications between the source and target systems to verify communications and the status of replication processes for each active subscription. If the source or target do not receive a reply to a notification within the specified timeout interval, then InfoSphere CDC determines that a problem has occurred and attempts to stop all its source and target processes for each active subscription. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Notes: v InfoSphere CDC places notifications (message identifiers 3165 and 11010) in the Event Log when a heartbeat timeout occurs. v If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Displaying event messages during replication on page 232 Setting system parameters on source and target datastores on page 60

InvalidNumericMsg
Use this system parameter to enable or disable InfoSphere CDC from generating a notification each time it detects an invalid numeric field. Applies ToTarget The InvalidNumericMsg system parameter can be set to YES, NO, or NB. v YESGenerate a notification for each invalid numeric field detected by InfoSphere CDC. v NODo not generate a notification for each invalid numeric field detected by InfoSphere CDC. v NBGenerate a notification for certain types of invalid numeric fields detected by InfoSphere CDC. notifications are generated for each invalid numeric fields except those that are not initialized. Default SettingYES Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)

331

Setting system parameters on source and target datastores on page 60

Tracing system parameters


Tracing system parameters let you perform diagnostic activities with InfoSphere CDC. See also: CommTrace ProgramTrace traceActive on page 333 TraceLevel on page 333 trcCleanup on page 333 trcCOMM on page 333 trcFiles on page 334 trcFncCalls on page 334 trcJrlSync on page 334 trcReplStatus on page 334 trcScan on page 334 trcSQL on page 334 trcThread on page 335

CommTrace
Use this system parameter to turn tracing of the communications module on or off. Applies ToTarget The CommTrace system parameter can be set to either ON or OFF: v ONActivates a communications module trace. v OFFDo not activate a communications module trace. Default SettingOFF Notes: v The trace should only be produced if requested by IBM technical support. v Activating a trace adversely affects performance. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

ProgramTrace
Use this system parameter to activate or deactivate InfoSphere CDC from tracing the update module. Applies ToTarget The ProgramTrace system parameter can be set to either ON or OFF: v ONActivate an update module trace.

332

InfoSphere Change Data Capture Management Console: Administration Guide

v OFFDo not activate an update module trace. Default SettingOFF Notes: v The trace is encrypted and should only be produced if requested by IBM technical support. v Activating a trace adversely affects performance. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

traceActive
For information about setting this system parameter, see your IBM representative. Applies ToSource

TraceLevel
Use this system parameter to set the level of detail produced by a program trace. Applies ToTarget The TraceLevel system parameter can be set to either 1, 2, or 3: v 1Produces a trace with the highest level of detail. v 2Produces a trace with a medium level of detail. v 3Produces a trace with the lowest level of detail. Default Setting3 Note: Contact IBM technical support for the suggested level of detail. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

trcCleanup
For information about setting this system parameter, see your IBM representative. Applies ToSource

trcCOMM
For information about setting this system parameter, see your IBM representative. Applies ToSource

System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)

333

trcFiles
Use this system parameter to identify the location of the file that contains information produced by an update or communications module trace. Applies ToSource and Target Default SettingInfoSphere CDC installation folder. Guidelines You must specify the full path of the folder where you want to place the trace file. Note: You can enable tracing using the ProgramTrace and CommTrace system parameters. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference CommTrace on page 332 ProgramTrace on page 332

trcFncCalls
For information about setting this system parameter, see your IBM representative. Applies ToSource

trcJrlSync
For information about setting this system parameter, see your IBM representative. Applies ToSource

trcReplStatus
For information about setting this system parameter, see your IBM representative. Applies ToSource

trcScan
For information about setting this system parameter, see your IBM representative. Applies ToSource

trcSQL
For information about setting this system parameter, see your IBM representative. Applies ToSource

334

InfoSphere Change Data Capture Management Console: Administration Guide

trcThread
For information about setting this system parameter, see your IBM representative. Applies ToSource

Data type system parameters


Data type system parameters let you control how InfoSphere CDC handles certain data types. See also: TrimVarchar

TrimVarchar
For information about setting this system parameter, see your IBM representative. Applies ToTarget

Lock detection system parameters


Lock detection system parameters let you control how InfoSphere CDC applies data when it detects a locked table or row. See also: DeadlockRetrys DM_LOCK_DETECTION DM_LOCK_TIMEOUT on page 336

DeadlockRetrys
Use this system parameter to identify the number of attempts InfoSphere CDC applies a table or row-level operation (clear table, insert, update, or delete) to the target table after detecting a deadlock. If the operation cannot be applied after the specified number of attempts has been made, InfoSphere CDC cancels the operation and generates an error notification in Event Log. Applies ToTarget Default Setting3 attempts Related concepts Displaying event messages during replication on page 232 System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

DM_LOCK_DETECTION
Use this system parameter to turn lock detection on or off. If InfoSphere CDC attempts to modify a table or row that has been locked by another process, then

System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)

335

turning lock detection ON enables InfoSphere CDC to wait for a specific amount of time before attempting to apply the data again. Applies ToSource and Target The DM_LOCK_DETECTION system can be set to either ON or OFF: v ONEnables table and row lock detection. v OFFDisables table and row lock detection. InfoSphere CDC waits until the locked row becomes available. Default SettingON Note: You can specify the time to wait using the DM_LOCK_TIMEOUT system parameter. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference DM_LOCK_TIMEOUT

DM_LOCK_TIMEOUT
Use this system parameter to set the amount of time (in seconds) that InfoSphere CDC waits before attempting to modify a locked user or metadata table. When InfoSphere CDC attempts to modify a locked table, it places a notification in the Event Log. These notifications identify the specific table and row that InfoSphere CDC could not modify. Applies ToTarget Default Setting30 seconds Minimum Setting1 second Maximum Setting60 seconds Notes: v If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. v Table locking notification is supported for tables containing user data and replication metadata tables. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60

336

InfoSphere Change Data Capture Management Console: Administration Guide

System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Notes: v If you make changes to a system parameter during active replication, you must stop and restart InfoSphere CDC for the changes to take effect. v When upgrading to a higher version of InfoSphere CDC, any pre-existing settings for system parameters are maintained. In this section, you will learn: Notification system parameters Maximize throughput system parameters on page 338 Encoding system parameters on page 341 Supplemental logging system parameters on page 342 Disk resource system parameters on page 343 Apply process system parameters on page 344 Authentication system parameters on page 345

Notification system parameters


Notification system parameters let you control if you should generate InfoSphere CDC messages in the Event Log for specific events. See also: global_shutdown_after_no_heartbeat_response_minutes global_conversion_not_possible_warning on page 338

global_shutdown_after_no_heartbeat_response_minutes
Use this system parameter to specify the duration, in minutes, of communication inactivity before active InfoSphere CDC processes for a subscription are stopped. If a value outside the acceptable range is specified, the default setting is used. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes

Copyright IBM Corp. 2008

337

Maximum Setting999 minutes Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60

global_conversion_not_possible_warning
Use this system parameter to control whether or not InfoSphere CDC generates a warning in the Management Console Event Log in the following situations: v Data conversion is not possible for a specific data value. v Converted data types are encountered that are out of range. Set this parameter to one of the following: truegenerates a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. falsedoes not generate a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. Applies ToTarget Default SettingFalse Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60

Maximize throughput system parameters


InfoSphere CDC system parameters allow you to significantly reduce the workload of the target database during mirroring. The InfoSphere CDC apply process groups transactions on the target to reduce the workload. Every commit on the target database will correspond with a commit on the target. However, it may not perform every commit that was done on the source. For example, if the source does three small transactions containing one operation each, the target may commit all three operations as part of a single transaction. You can use this grouping of system parameters to significantly reduce the resources required by the target database. The default settings are appropriate for most databases, but if your target system has limited resources and an increase in latency is acceptable, you can adjust the settings appropriately. See also: mirror_commit_after_max_transactions on page 339 mirror_commit_after_max_seconds on page 339 mirror_commit_after_max_operations on page 339 mirror_commit_on_transaction_boundary on page 340 refresh_commit_after_max_operations on page 340

338

InfoSphere Change Data Capture Management Console: Administration Guide

mirror_commit_after_max_transactions
This system parameter specifies a threshold used to determine when to issue a commit to the target database. Commits are issued to the target database in response to commits issued by applications running on the source, but not all source commits will be issued on the target. The frequency at which source commits are issued to the target database will vary depending on the volume of changes. When data volume is higher, less frequent commits on the target will allow for the higher data throughput required to maintain low latency. This system parameter is used to place a limit on how infrequent these target commits can become. If the source commit being processed has reached this threshold of source commits received since the last target commit was issued, then there will be a target commit issued for this source commit. Applies ToTarget Default Setting10 Minimum Setting1 Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60

mirror_commit_after_max_seconds
This system parameter specifies a threshold used to determine when to issue a commit to the target database. Commits are issued to the target database in response to commits issued by applications running on the source, but not all source commits will be issued on the target. The frequency at which source commits are issued to the target database will vary depending on the volume of changes. When data volume is higher, less frequent commits on the target will allow for the higher data throughput required to maintain low latency. This system parameter is used to place a limit on how infrequent these target commits can become. If the specified amount of time, in seconds, has elapsed since the last target commit it issued, then it will issue a target commit either immediately (if it isnt currently in the middle of a source transaction) or as soon as it receives the next source commit. Applies ToTarget Default Setting1 second Minimum Setting1 Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60

mirror_commit_after_max_operations
This system parameter specifies a threshold used to determine when to issue a commit to the target database. Commits are issued to the target database in
System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above)

339

response to commits issued by applications running on the source, but not all source commits will be issued on the target. The frequency at which source commits are issued to the target database will vary depending on the volume of changes. When data volume is higher, less frequent commits on the target will allow for the higher data throughput required to maintain low latency. This system parameter is used to place a limit on how infrequent these target commits can become. If the target has applied this number of operations since the last target commit was issued, then it will issue a target commit at the next source commit it receives from the source. Applies ToTarget Default Setting1000 Minimum Setting1 Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60

mirror_commit_on_transaction_boundary
This system parameter indicates whether or not the commits that InfoSphere CDC does on the target database will always correspond with a commit that occurred on the source database. If you choose to ignore the commitment control of the source database, InfoSphere CDC allows you to see the partial results of large transactions. Set this parameter to one of the following: v trueDoes not ignore the commitment control of the source database. Only records in a committed transaction are mirrored to the target. This setting provides true transaction consistency by ensuring that only committed transactions are sent to the target. v falseIgnores the commitment control of the source database. This value disables commitment control for transaction processing. No attempt to maintain transaction consistency is performed during mirroring. Applies ToTarget Default Settingtrue Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60

refresh_commit_after_max_operations
This system parameter identifies the number of rows comprising each transaction during refresh. To reduce the workload on the target database during refresh, InfoSphere CDC periodically commits the changes to the target database rather than performing the refresh as a single large transaction. Applies ToTarget

340

InfoSphere Change Data Capture Management Console: Administration Guide

Default Setting1000 Minimum Setting1 Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60

Encoding system parameters


For some system parameters, you can set the default method for treating data in defined Unicode columns, and you can set the default character encoding for your database. See also: global_unicode_as_char

global_unicode_as_char
This system parameter indicates the default method of treating data in defined Unicode columns. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Set this parameter to one of the following: v trueInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v falseInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain non-single-byte character data. Setting this system parameter to false ensures that InfoSphere CDC handles non-single-byte character data in the same way as previous InfoSphere CDC releases. Note: Setting this parameter to false does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may have to apply user exit programs or other customization to properly represent data in Unicode columns. For more information about user exit programs, see the InfoSphere CDC End-User Documentation for your platform. Applies ToSource Default Settingfalse Note: The following SQL Server data types are considered to be Unicode columns and are therefore affected by the value assigned to this system parameter: v nchar v nvarchar Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337
System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above)

341

Setting system parameters on source and target datastores on page 60 Setting multibyte conversionscommon scenarios on page 175 System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

Supplemental logging system parameters


Some system parameter control the database logging mechanism used by InfoSphere CDC. See also: mirror_logging_by_empty_triggers auto_configure_supplemental_logging on page 433 mirror_logging_by_empty_triggers on page 434

mirror_logging_by_empty_triggers
This system parameter allows you to choose empty triggers as your supplemental logging method for Microsoft SQL Server 2000. Set this parameter to one of the following: v trueEmpty triggers are used as your supplemental logging method for Microsoft SQL Server 2000. v falseThe Distribution Database is used as your supplemental logging method. This method of supplemental logging is available for Microsoft SQL Server 2000 and Microsoft SQL Server 2005. If you choose false and are using Microsoft SQL Server 2000, you must add your database to replication/publication with the following steps: 1. Set up Microsoft Replication and verify that the Distribution database exists. 2. Add the database to Microsoft Replication using the following query: EXEC sp_replicationdboption @dbname = your_db_name, @optname = publish, @value = true Where your_db_name is your database name. Note that you can use the following query to check if your database is enabled for Microsoft Replication: exec sp_helpreplicationdboption Applies ToSource Default Settingtrue Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60

342

InfoSphere Change Data Capture Management Console: Administration Guide

Disk resource system parameters


Some system parameters control memory usage in InfoSphere CDC. For improved performance, if you are able to allocate more than the default value of 512 MB for the InfoSphere CDC Java Virtual Machine, then you can adjust the disk resource system parameters to use the increased memory. See also: mirror_memory_txqueue_total_mb mirror_memory_txqueue_each_mb global_memory_lob_cache_mb mirror_queue_for_buffers_between_cdc_threads_operations on page 344

mirror_memory_txqueue_total_mb
This system parameter controls the amount of memory used to stage data on the source. For optimal performance, this system parameter should be large enough to hold the largest amount of uncommited data that will ever exist in the source database. Applies ToSource Default Setting15 Megabytes Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60

mirror_memory_txqueue_each_mb
This system parameter controls the amount of memory used to stage data on the source. For optimal performance, this system parameter should be large enough to hold the data for the largest transactions that occur on the source. Applies ToSource Default Setting3 Megabytes Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60

global_memory_lob_cache_mb
This system parameter controls the amount of memory that will be used to stage LOB values on the target. For optimal performance, this value should be large enough to hold the entire data for the largest LOB values that will be replicated. Default Setting2 Megabytes Applies ToTarget Related concepts
System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above)

343

System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60

mirror_queue_for_buffers_between_cdc_threads_operations
This system parameter controls the ability of InfoSphere CDCs log scraping to take advantage of multiple processors. The default setting is acceptable for most situations. You can increase this value for highly scalable environments. Applies ToSource Default Setting100 entries Minimum Setting100 entries Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60

Apply process system parameters


Some system parameters adjust the way InfoSphere CDC applies rows, column data, and error handling. See also: mirror_end_on_error refresh_end_on_error

mirror_end_on_error
Use this system parameter to indicate if you want to end mirroring after an apply error occurs on the target database. Set this parameter to one of the following: v trueEnd mirroring after an apply error on the target database. v falseDo not end mirroring after an apply error on the target database. Applies ToTarget Default Settingtrue Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60

refresh_end_on_error
Use this system parameter to indicate if you want to end a refresh after an apply error occurs. Set this parameter to one of the following:

344

InfoSphere Change Data Capture Management Console: Administration Guide

v v

trueEnd a refresh after an apply error occurs. falseDo not end a refresh after an apply error occurs.

Applies ToTarget Default Settingtrue Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60

Authentication system parameters


Some system parameters control authentication in InfoSphere CDC. See also: global_ts_user_authentication_method

global_ts_user_authentication_method
This system parameter allows you to specify the authentication method that InfoSphere CDC will use to authenticate the user/password combination specified in in the Access Manager perspective in Management Console. By default, this system parameter is set to the authentication method that you specify when configuring InfoSphere CDC. For more information on configuring InfoSphere CDC, see your InfoSphere CDC for Microsoft SQL Server documentation. Set this parameter to one of the following: Note: IBM recommends that you set these values with the dmset command. For more information, see your InfoSphere CDC for Microsoft SQL Server documentation. v db_authenticationIndicates that InfoSphere CDC uses SQL Server authentication. With this type of authentication, you must specify a SQL Server user/password combination when you create a datastore in the Access Manager perspective in Management Console. The Windows user must have a SELECT permission on the TS_AUTH metadata table. v validationIndicates that InfoSphere CDC verifies that a SQL Server user exists. The password is not verified. With this type of authentication, you must specify a SQL Server user when you create a datastore in the Access Manager perspective in Management Console . v windows_authenticationIndicates that InfoSphere CDC uses Windows authentication. With this type of authentication, you must specify a Windows user/password combination that has access to your SQL Server database when you create a datastore in the Access Manager perspective in Management Console. The Windows user must have a SELECT permission on TS_AUTH metadata table. For more information on how to create a datastore in the Access Manager perspective, see To add a new datastore on page 24. Default SettingNone
System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above)

345

Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60 Related tasks To add a new datastore on page 24

346

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Note: If you make changes to a system parameter during active replication, you must stop and restart replication for the changes to take effect. In this section, you will learn: General product system parameters Apply process system parameters on page 357 Cascading replication system parameters on page 365 Database journal (trigger) system parameters on page 366 Maximize throughput system parameters on page 367 Tracing system parameters on page 372 Refresh loader system parameters on page 375 User exit system parameters on page 379 Table mapping system parameters on page 380 Notification system parameters on page 381 Disk resource system parameters on page 386

General product system parameters


General product system parameters let you control basic features of InfoSphere CDC and information you may have specified during installation. See also: CODE_PAGE on page 348 DEFAULT_ORACLE_HOME on page 348 DEFAULT_ORACLE_SID on page 348 DEFAULT_ORACLE_USER on page 349 DM_COMMS_HOME on page 349 D_MIRROR_HOME on page 349 D_MIRROR_LOG on page 349 DM_DYNAMIC_PARAMETER_CHECK_INT on page 350 DM_MAX_MONITOR_ENTRIES on page 350 DM_TS_MAX_POOL_SIZE_MB on page 350 DM_TS_POOL_BLOCK_SIZE_MB on page 351 <subscription>_MAX_POOL_SIZE_MB on page 351
Copyright IBM Corp. 2008

347

<subscription>_POOL_BLOCK_SIZE_MB on page 352 LD_LIBRARY_PATH on page 353 LIBPATH on page 353 ORACLE_HOME on page 353 ORACLE_SID on page 353 PASSWORD on page 354 PUBLISH_METADATA on page 354 RLD_SYSTEM_TXQSIZE on page 354 <subscription>_TXQSIZE on page 355 SHLIB_PATH on page 355 STARTUP_TIMEOUT on page 355 TCP_KEEPALIVE_SECS on page 356 USER on page 356

CODE_PAGE
Use this system parameter to specify the code page associated with NLS_LANG. This value is set during installation and should not be modified except under the guidance of a IBM technical support. Applies ToSource and Target Default SettingThe system code page when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference NLS_LANG on page 362

DEFAULT_ORACLE_HOME
Use this parameter to specify the installation directory for the Oracle database instance that is started by default. Modify this parameter only if you installed InfoSphere CDC in multiple database instances. Applies ToSource Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

DEFAULT_ORACLE_SID
Use this system parameter to specify the Oracle SID for the Oracle database instance that is started by default. Modify this parameter only if you installed InfoSphere CDC in multiple database instances. Applies ToSource Default SettingThe Oracle SID specified when InfoSphere CDC was installed. Related concepts

348

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

DEFAULT_ORACLE_USER
Use this system parameter to specify the name of the user for the Oracle database instance that is started by default. Modify this parameter only if you installed InfoSphere CDC in multiple database instances. Applies ToSource Default SettingThe Oracle user specified when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

DM_COMMS_HOME
For information about setting this system parameter, see your IBM representative. This little command copies things.

D_MIRROR_HOME
Use this system parameter to specify the directory (full path) where InfoSphere CDC is installed on the server. Applies ToSource and Target Default SettingThe installation directory specified when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

D_MIRROR_LOG
Use this system parameter to specify the directory (full path) where InfoSphere CDC log files are located. Applies ToSource and Target Default SettingThe log subdirectory in the installation directory specified when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

349

DM_DYNAMIC_PARAMETER_CHECK_INT
Use this system parameter to specify how often, in seconds, InfoSphere CDC checks for changes to the values of dynamic system parameters during active replication to a subscription. For example, to check once a day, set this parameter to 216,000. Applies ToSource and Target The following system parameters are dynamic: v D_MIRROR_TRACE on page 414 v D_MIRROR_TRACE_ON_ERROR on page 414 (on the target only) v DM_PRINT_DIAGNOSTICS on page 374 v STATISTICS_INTERVAL on page 420 v SYNCHRONIZATION_COMMIT_ GROUP_SIZE on page 412 v SYNCHRONIZATION_INTERVAL on page 413 Default Setting300 seconds (5 minutes) Minimum Setting0. InfoSphere CDC does not check for changes to dynamic system parameters. Maximum Setting2,147,483,648 (maximum integer) Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

DM_MAX_MONITOR_ENTRIES
Use this system parameter to increase or decrease the number of subscriptions that InfoSphere CDC can support in the Monitor in Management Console. InfoSphere CDC allocates an entry for each source and target datastore within a subscription. For example, if you have a datastore that is being used as a source datastore within 20 subscriptions and as a target datastore within 10 subscriptions, then you must set this system parameter to at least 30. InfoSphere CDC will allocate 30 entries for this datastore. Applies ToSource Default Setting20 entries. By default, InfoSphere CDC can handle 20 subscriptions. Minimum Setting1 entry Maximum Setting1000 entries

DM_TS_MAX_POOL_SIZE_MB
Use this system parameter when you need to resize the staging store component of InfoSphere CDC. You can specify a value in megabytes (MB). After specifying the size of the staging store, you should specify the number of blocks you want InfoSphere CDC to create using the DM_TS_POOL_BLOCK_SIZE_MB system parameter.

350

InfoSphere Change Data Capture Management Console: Administration Guide

Applies ToSource This setting must be large enough to store data for the largest predicted transaction that occurs in the Oracle database. If the size of the active staging store is not large enough to accommodate all data, InfoSphere CDC issues an error message (Message ID 307) in the event log and shuts down. The staging store size should be at least 150% of the largest predicted transaction. Note: After changing the value of this parameter, you must set the journal position to the last applied position by running the setjrnpos command. Default Setting25% of the default setting for the RLD_SYSTEM_TXQSIZE system parameter which is 128 MB. For more information about the setjrnpos command, see the setjrnposset Jjournal position in the commands section of the InfoSphere CDC for Oracle End-User Documentation. To set the journal position, see Running the Bookmark Viewer Command and Setting the Journal Position on the Source in the Installing InfoSphere CDC section of the InfoSphere CDC for Oracle End-User Documentation. Related reference DM_TS_POOL_BLOCK_SIZE_MB RLD_SYSTEM_TXQSIZE on page 354

DM_TS_POOL_BLOCK_SIZE_MB
Use this system parameter when you are in the process of resizing the staging store component of InfoSphere CDC and need to specify a block size you want InfoSphere CDC to create for the staging store. You must have already specified the size of the staging store (in MB) using the DM_TS_MAX_POOL_SIZE_MB system parameter. The value you specify for DM_TS_POOL_BLOCK_SIZE_MB indicates the block size you want InfoSphere CDC to create for the staging store. The size you had specified with the DM_TS_MAX_POOL_SIZE_MB system parameter is adjusted based on the block size you specify. Applies ToSource Default SettingNone. If you do not specify a block size for this system parameter, then InfoSphere CDC will create a maximum of 4 blocks (no larger than 20 MB each) of space for the staging store. For example, you may have specified 100 MB for the staging store using the DM_TS_MAX_POOL_SIZE_MB system parameter. In this scenario, InfoSphere CDC will create a maximum 5 blocks of 20 MB each. Related reference DM_TS_MAX_POOL_SIZE_MB on page 350

<subscription>_MAX_POOL_SIZE_MB
Use this system parameter when you want to resize the staging store for a specific subscription. You can specify a value in megabytes (MB). After specifying the size

System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

351

of the staging store, you should specify the block size you want InfoSphere CDC to create using the <subscription>_POOL_BLOCK_SIZE_MB system parameter. Applies To--Source Default Setting--25% of the default setting for the RLD_SYSTEM_TXQSIZE system parameter which is 128 MB. This setting must be large enough to store data for the largest predicted transaction that occurs in the Oracle database. If the size of the active staging store is not large enough to accommodate all data, InfoSphere CDC issues an error message (Message ID 307) in the event log and shuts down. The staging store size should be at least 150% of the largest predicted transaction. Note: After changing the value of this parameter, you must set the journal position to the last applied position by running the setjrnpos command. For more information about the setjrnpos command, see the setjrnposset Jjournal position in the commands section of the InfoSphere CDC for Oracle End-User Documentation. To set the journal position, see Running the Bookmark Viewer Command and Setting the Journal Position on the Source in the Installing InfoSphere CDC section of the InfoSphere CDC for Oracle End-User Documentation. Related reference RLD_SYSTEM_TXQSIZE on page 354 <subscription>_POOL_BLOCK_SIZE_MB

<subscription>_POOL_BLOCK_SIZE_MB
Use this system parameter when you are in the process of resizing the staging store component for a specific subscription and need to specify a block size you want InfoSphere CDC to create for the staging store. You must have already specified the size of the staging store (in MB) using the <subscription>_TS_MAX_POOL_SIZE_MB system parameter. The value you specify for <subscription>_TS_POOL_BLOCK_SIZE_MB indicates the block size you want InfoSphere CDC to create for the staging store. The size you had specified with the <subscription>_TS_MAX_POOL_SIZE_MB system parameter is adjusted based on the block size you specify. Applies ToSource Default SettingNone. If you do not specify a block size for this system parameter, then InfoSphere CDC will create a maximum of 4 blocks (no larger than 20 MB each) of space for the staging store. For example, you may have specified 100 MB for the staging store using the <subscription>_TS_MAX_POOL_SIZE_MB system parameter. In this scenario, InfoSphere CDC will create a maximum 5 blocks of 20 MB each. Related reference <subscription>_MAX_POOL_SIZE_MB on page 351

352

InfoSphere Change Data Capture Management Console: Administration Guide

LD_LIBRARY_PATH
Use this system parameter to specify the path to the InfoSphere CDC libraries and the database libraries for Solaris and Linux operating systems. This value is set during installation and should not be modified. Applies ToSource and Target Default SettingThe path to the InfoSphere CDC libraries and the Oracle libraries when InfoSphere CDC was installed Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

LIBPATH
Use this system parameter to specify the path to the InfoSphere CDC libraries and the database libraries (for AIX operating systems). This value is set during installation and should not be modified. Applies ToSource and Target Default SettingThe path to the InfoSphere CDC libraries and the database libraries when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

ORACLE_HOME
Use this system parameter to specify the Oracle home directory. Applies ToSource Default SettingThe Oracle home directory specified when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

ORACLE_SID
Use this system parameter to specify the Oracle SID. Applies ToSource Default SettingThe Oracle SID specified when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

353

PASSWORD
Use this system parameter to identify the encrypted database password, which can be set using the dmsetpass command. For information about dmsetpass, see dmsetpassSet Password in the Commands section of the InfoSphere CDC for Oracle documentation. Applies ToSource This parameter was set during installation and should not be modified. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

PUBLISH_METADATA
Use this system parameter to enable or disable the display of InfoSphere CDC metadata tables in Management Console. Applies ToSource Set this parameter to one of the following: v OFFInfoSphere CDC metadata tables are not displayed in Management Console. v ONInfoSphere CDC metadata tables are displayed in the Add/Remove Tables dialog box, making them available to be selected for replication. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

RLD_SYSTEM_TXQSIZE
Use this system parameter to specify the size, in megabytes (MB), for the active transaction queue store maintained by InfoSphere CDC. The active transaction queue store contains data for concurrent transactions that have been extracted from the Oracle redo log. Applies ToSource This setting must be large enough to store data for all concurrent transactions that occur in the Oracle database. If the size of the active transaction queue store is not large enough to accommodate all data, InfoSphere CDC issues an error message and shuts down. Default Setting128 MB Minimum Setting5 MB Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

354

InfoSphere Change Data Capture Management Console: Administration Guide

<subscription>_TXQSIZE
Use this system parameter to specify the size, in megabytes (MB), you want to allocate per subscription for the active transaction queue store. This area represents the amount of space required to store data for a single transaction, extracted from the Oracle redo log. This system parameter is useful when you want to allocate a specific amount of queue storage for a specific subscription you have added in InfoSphere CDC Management Console. If you want all other subscriptions to use the same storage size, then use the RLD_SYSTEM_TXQSIZE to allocate queue storage size. Applies ToSource Default SettingThere is no default value for this system parameter. If you decide not to specify a value in megabytes for this system parameter, then InfoSphere CDC will use the value you specified for the RLD_SYSTEM_TXQSIZE system parameter. Notes: v The subscription name precedes the name of the system parameter (TXQSIZE). For example, sub1TXQSIZE. v The name of the system parameter is not case-sensitive. If you have added two subscriptions in Management Console named SUB1 and sub1, then both subscriptions will use the same value specified for the system parameter. v This system parameter applies only to the Redo Log edition of InfoSphere CDC for Oracle. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference RLD_SYSTEM_TXQSIZE on page 354

SHLIB_PATH
Use this system parameter to specify the path to the InfoSphere CDC libraries and the database libraries for HP-UX operating systems. This value is set during installation and should not be modified. Applies ToSource and Target Default SettingThe path to the InfoSphere CDC libraries and the database libraries when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

STARTUP_TIMEOUT
Use this system parameter to specify the maximum waiting period, in seconds, for process handling to complete during InfoSphere CDC startup. It indicates how long the communication program waits for the database setup program to start before timing out.
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

355

Applies ToSource and Target Default Setting120 Minimum Setting60 Maximum Setting3600 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

TCP_KEEPALIVE_SECS
Use this parameter to specify the time interval, during idle periods, to wait before sending a keep alive message over the network. If a connection is idle for the specified time interval, InfoSphere CDC sends a keep alive message to keep the connection open. Applies ToSource and Target Setting this system parameter is needed in environments that have firewalls with timeout connection values, to prevent them from closing the connection. Set this parameter to a value lower than the firewall timeout, so that the firewall does not close the connection during data replication. To set this system parameter, do the following: 1. Create a file named dmcommparms.cfg in the <InfoSphere CDC install dir>/lib directory. 2. Insert the following line in the file: TCP_KEEPALIVE_SECS = <value>; where value is the setting for this system parameter. For example, to set to 1 minute, enter: TCP_KEEPALIVE_SECS = 60; Default Setting300 seconds (5 min) Minimum Setting0 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

USER
Use this system parameter to specify the Oracle user name that was specified during installation. You can also set this user using the dmsetpass command. For information about dmsetpass, see the dmsetpassSet Password in the Commands section of the InfoSphere CDC for Oracle documentation. Applies ToSource Default SettingThe InfoSphere CDC user specified when InfoSphere CDC was installed.

356

InfoSphere Change Data Capture Management Console: Administration Guide

Apply process system parameters In this section, you will learn about system parameters that adjust how InfoSphere CDC applies rows, column data, and errors to the target. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

Apply process system parameters


Some system parameters adjust the way InfoSphere CDC applies rows, column data, and error handling. See also: convertNotNullableColumns D_MIRROR_MIRROR_ERROR_LIST on page 358 D_MIRROR_MIRROR_ERROR_STOP on page 358 D_MIRROR_REFRESH_ERROR_LIST on page 359 D_MIRROR_REFRESH_ERROR_STOP on page 359 DM_ADAPTIVE_APPLY_SOFT_DELETES on page 359 DM_ADAPTIVE_APPLY_<SCHEMA>.<TABLENAME> on page 360 DM_ADAPTIVE_APPLY_MIMIC_SOURCE_OPERATION on page 360 DM_ARRAY_BIND_MAX on page 361 FILTER_NOCHANGE_UPDATES_FOR_AUDIT on page 361 NLS_LANG on page 362 NLS_NCHAR on page 362 NOT_NULL_DATE_DEFAULT on page 362 TRIM_CHAR_TO_VARCHAR on page 362 TRIM_VARCHAR_TO_VARCHAR on page 363 TRIM_TO_NULL on page 363 UNICODE_HANDLING on page 364

convertNotNullableColumns
Use this system parameter to indicate whether or not NULL values will be converted to default values when replicating data that contains NULL values to non-nullable target columns. Applies ToTarget Set this parameter to one of the following: v OFFAn error message will be generated in Event Log. Replication will continue or not based on whether the MirrorError or RefreshError system parameters are set to END or ON. v ONInfoSphere CDC will automatically insert an appropriate default value in the target column. No error message is generated in Event Log and replication continues. Depending on the convertNotNullableMsg system parameter setting, a warning message may be generated in Event Log.

System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

357

The default value depends on the data type of the subscription column. For example, zero for numeric data types, blank character for character data types, 1901-01-01 for date data types, and so on. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference D_MIRROR_MIRROR_ERROR_STOP D_MIRROR_REFRESH_ERROR_STOP on page 359 convertNotNullableMsg on page 381

D_MIRROR_MIRROR_ERROR_LIST
Use this system parameter to allow certain errors to be ignored during mirroring. Applies ToTarget If the D_MIRROR_MIRROR_ERROR_STOP on page 405 system parameter is set to ON, use this parameter to allow certain errors to be ignored during mirroring. The value assigned to this parameter is a comma-delimited list of Oracle or Sybase database error numbers. For example, to ignore primary key violations, but to stop mirroring on any other update errors, set D_MIRROR_MIRROR_ERROR_LIST=1. This value corresponds to the Oracle error ORA-00001: unique constraint violated (<schema>.<constraint>). Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference D_MIRROR_MIRROR_ERROR_STOP

D_MIRROR_MIRROR_ERROR_STOP
Use this parameter to indicate whether or not mirroring continues after an error has occurred during a row insert, delete, or update operation. Applies ToTarget Set this parameter to one of the following: v ONMirroring stops after an error has occurred. v OFFMirroring continues after an error has occurred. Default SettingON Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference D_MIRROR_MIRROR_ERROR_LIST

358

InfoSphere Change Data Capture Management Console: Administration Guide

D_MIRROR_REFRESH_ERROR_LIST
Use this system parameter to allow certain errors to be ignored during data refresh. Applies ToTarget If the D_MIRROR_REFRESH_ERROR_STOP system parameter is set to ON, use this parameter to allow certain errors to be ignored during data refresh. The value assigned to this parameter is a comma-delimited list of Oracle or Sybase database error numbers. For example, to ignore primary key violations, but to stop refresh on any other update errors, set D_MIRROR_REFRESH_ERROR_LIST=1. This value corresponds to the Oracle error ORA-00001: unique constraint violated (<schema>.<constraint>). Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference D_MIRROR_MIRROR_ERROR_STOP on page 358

D_MIRROR_REFRESH_ERROR_STOP
Use this system parameter to indicate whether or not InfoSphere CDC should continue to perform a refresh after encountering an error during a row insert operation. Applies ToTarget Set this parameter to one of the following: v ONData refresh stops after an error has occurred. v OFFData refresh continues after an error has occurred. Default SettingON Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference D_MIRROR_REFRESH_ERROR_LIST D_MIRROR_MIRROR_ERROR_STOP on page 405

DM_ADAPTIVE_APPLY_SOFT_DELETES
Use this system parameter to enable InfoSphere CDC to apply a soft delete on all target tables mapped using Adaptive Apply in a subscription. Applies ToTarget Set this parameter to one of the following:
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

359

v ONWhen there is a delete on the source table, InfoSphere CDC either: updates the rows on all target tables if the rows exist, or inserts the rows on all target tables if the rows do not exist. v OFFWhen there is a delete on the source table, InfoSphere CDC either: deletes the rows on all target tables if the rows exist, or does nothing and issues an informational message in the Event log if the rows do not exist. See Enabling Apply of Soft Deletes in the InfoSphere CDC Management Console Administration Guide. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Enabling the apply of soft deletes (InfoSphere CDC for Oracle) on page 182

DM_ADAPTIVE_APPLY_<SCHEMA>.<TABLENAME>
Use this system parameter to enable InfoSphere CDC to apply a soft delete on a specific target table mapped using Adaptive Apply in a subscription. Applies ToTarget Set this parameter to one of the following: v ONWhen there is a delete on the source table, InfoSphere CDC either: updates the row on the target table if the row exists, or inserts the row on the target table if it does not exist. v OFFWhen there is a delete on the source table, InfoSphere CDC either: deletes the row on the target table if the row exists, or does nothing and issues an informational message in the Event log if the row does not exist. See Enabling Apply of Soft Deletes in InfoSphere CDC Management Console Administration Guide. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Enabling the apply of soft deletes (InfoSphere CDC for Oracle) on page 182

DM_ADAPTIVE_APPLY_MIMIC_SOURCE_OPERATION
Use this system parameter to modify the how InfoSphere CDC applies data to the target when you have mapped your source and target tables using Adaptive Apply. If you enable this system parameter, InfoSphere CDC avoids performing a SELECT query on the target table and you may benefit with performance improvement. For information about setting this system parameter, see your IBM representative. Applies ToTarget Set this parameter to one of the following:

360

InfoSphere Change Data Capture Management Console: Administration Guide

v ONInfoSphere CDC avoids performing a SELECT query on the target table. v OFFInfoSphere CDC performs a SELECT query on the target table. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

DM_ARRAY_BIND_MAX
Use this system parameter to specify the maximum number of rows that InfoSphere CDC can place in an array and apply to the target database. InfoSphere CDC collects rows and places them in an array (in memory) while receiving table-level operations from the source system. InfoSphere CDC applies the rows from the array when there is a change to a different table, when there is a new table-level operation, or when the maximum number of rows in an array has been reached. Applies ToTarget Default Setting25 Minimum Setting1 Maximum SettingMaximum number of rows (integer) Guidelines Before InfoSphere CDC places rows into an array, it allocates memory for the maximum number of rows you specify and multiplies this integer by the maximum length of a row. If the maximum number of rows is too large, then InfoSphere CDC cannot allocate enough memory and will shut down. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

FILTER_NOCHANGE_UPDATES_FOR_AUDIT
Use this system parameter to indicate whether or not updates that have identical before and after column images (that is, the row has been updated to the same value), are replicated to the target table for any tables configured for LiveAudit replication. Applies ToSource Set this parameter to one of the following: v OFFIf a row in a source table is updated to the same value, InfoSphere CDC replicates the value to the target table. v ONIf a row in a source table is updated to the same value, InfoSphere CDC does not replicate the value to the target table. This parameter only affects tables that are configured for LiveAudit replication. For non-audit tables, only updates that change the column data are replicated to the target tables.
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

361

Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

NLS_LANG
Use this system parameter to specify the database character set preceded with a period. For more information about setting this system parameter, see your IBM representative. Applies ToSource and Target Default SettingThe database character set, preceded with a period, corresponding to the language selected when the database was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

NLS_NCHAR
Use this system parameter to set the database national character set. For information about setting this system parameter, see your IBM representative.

NOT_NULL_DATE_DEFAULT
Applies ToTarget Specifies the default value that InfoSphere CDC assigns to a NULL date being replicated to a non-nullable date column on the target database. If this parameter is not specified, InfoSphere CDC uses the Default Setting. Default Setting1901-01-01 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference TRIM_TO_NULL on page 363

TRIM_CHAR_TO_VARCHAR
Use this system parameter to specify whether or not trailing blank characters are trimmed from source columns of CHAR data type when replicating data to target columns of VARCHAR data type. Applies ToTarget Set this parameter to one of the following: v OFFTrailing blanks are not trimmed.

362

InfoSphere Change Data Capture Management Console: Administration Guide

v ONTrailing blanks are trimmed. If TRIM_TO_NULL =OFF, InfoSphere CDC inserts a single blank character in the target column. If TRIM_TO_NULL =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference TRIM_TO_NULL

TRIM_VARCHAR_TO_VARCHAR
Use this system parameter to specify whether or not trailing blank characters are trimmed from source columns of VARCHAR data type when replicating data to target columns of VARCHAR data type. Applies ToTarget Set this parameter to one of the following: v OFFTrailing blanks are not trimmed. v ONTrailing blanks are trimmed. If TRIM_TO_NULL =OFF, InfoSphere CDC inserts a single blank character in the target column. If TRIM_TO_NULL =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference TRIM_TO_NULL

TRIM_TO_NULL
Use this system parameter to specify how source columns that contain blank characters only are handled during data replication. Applies ToTarget Set this parameter to one of the following: v OFFFor data mapped to VARCHAR columns, trailing blanks are trimmed or not to a single blank depending on the TRIM_CHAR_TO_VARCHAR and TRIM_VARCHAR_TO_VARCHAR system parameters. For data mapped to CHAR columns, setting this parameter to OFF has no effect. v ONFor data mapped to CHAR columns, if the target column is nullable, InfoSphere CDC inserts NULL in the column. For CHAR data mapped to VARCHAR columns, if TRIM_CHAR_TO_VARCHAR =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column. For VARCHAR data mapped to VARCHAR columns, if TRIM_VARCHAR_TO_VARCHAR =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column.

System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

363

If the target column is non-nullable, source columns that contain blank characters only are handled according to the convertNotNullableColumns system parameter. The table below explains how the TRIM_ system parameters affect the data replicated to the target for source columns that contain blank characters only.
TRIM_ parameter settings TRIM_CHAR_ TO_ VARCHAR ON ON OFF OFF ON ON OFF OFF TRIM_ VARCHAR_ TO_ VARCHAR ON OFF ON OFF ON OFF ON OFF TRIM_ TO_ NULL ON ON ON ON OFF OFF OFF OFF Target data CHAR to VARCHAR NULL NULL Source data Source data VARCHAR to VARCHAR NULL Source data NULL Source data Any data type to CHAR NULL NULL NULL NULL Blanks Blanks Blanks Blanks

Single blank Single blank Single blank Source data Source data Source data Single blank Source data

Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference TRIM_VARCHAR_TO_VARCHAR on page 363 TRIM_CHAR_TO_VARCHAR on page 362

UNICODE_HANDLING
Use this system parameter to indicate the default method of treating data in defined Unicode columns. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Applies ToSource The following Oracle data types are considered to be Unicode columns, and are therefore affected by the value assigned to this system parameter: v NCHAR v NVARCHAR2 v NCLOB This system parameter is set to either CHAR or NOCHANGE: v CHARInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v NOCHANGEInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain

364

InfoSphere Change Data Capture Management Console: Administration Guide

non-single-byte character data. NOCHANGE ensures InfoSphere CDC will handle non-single-byte character data in the same way as previous InfoSphere CDC releases. Note: If replicating data to a non-Oracle subscriber, NOCHANGE does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non single-byte character data, you may need to apply user exit programs or other customization to properly represent data in Unicode columns. For more information about user exit programs, see C user exits for table/row level operations in the User Exits section of the InfoSphere CDC for Oracle documentation. Default SettingNOCHANGE Note: NOCHANGE does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may need to apply user exit programs or other customization to properly represent the data in Unicode columns. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Setting multibyte and Unicode character set conversions on page 175

Cascading replication system parameters


Cascading replication system parameters control InfoSphere CDC cascading replication. See also: CASCADE_OMIT_TARGETS PREVENT_RECURSION

CASCADE_OMIT_TARGETS
Use this system parameter to indicate whether or not cascading replication will be disabled for specific subscriptions. Applies ToSource The value assigned to this parameter is a comma-separated list of subscription names. Changes applied by InfoSphere CDC are not replicated to these subscriptions, even if you set the system parameter PREVENT_RECURSION to OFF. The list of subscriptions cannot exceed 1023 bytes in length. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference PREVENT_RECURSION

PREVENT_RECURSION
Use this parameter to indicate whether or not to prevent cascading replication for bi-directional configurations.
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

365

Applies ToSource Set this parameter to one of the following: v ONChanges applied by InfoSphere CDC are not be replicated back to the source database from where it came from. v OFFChanges made by InfoSphere CDC are replicated, except when filtered out by the CASCADE_OMIT_TARGETS system parameter. Default SettingON Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference CASCADE_OMIT_TARGETS on page 365

Database journal (trigger) system parameters


Database journal or trigger system parameters let you manage the InfoSphere CDC journal table. See also: REPORT_POSITION_INTERVAL MONITOR_PURGE_INTERVAL on page 367 MONITOR_REFRESH_PERIOD on page 367 mirror_journal_schema on page 391

REPORT_POSITION_INTERVAL
Use this system parameter to specify how often (in seconds) the source informs the target about its position in the current journal during times of no activity. During times of no activity, when there are no journal entries to be processed pertaining to the current subscription, the source informs the target of its current position so that the target can advance its bookmarks accordingly. By specifying a low setting for this parameter, the target can reflect more accurately how far replication has progressed. Applies ToSource After a shutdown and restart, you can use this system parameter to prevent InfoSphere CDC from rereading entries that do not apply to the current replication configuration. The value of this parameter affects the information that is displayed in progress and bookmark messages. A high value for this parameter may result in information that is not up-to-date being displayed. Default Setting5 Minimum Setting1 Maximum Setting300 Related concepts

366

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

MONITOR_PURGE_INTERVAL
Use this system parameter to specify the time interval between journal purges. When this time interval has elapsed, InfoSphere CDC removes from its journals all records that have been committed on all targets to which they are replicated. Applies ToSource Specify this parameter in the format #h#m#s, where # is the number of hours, minutes, and seconds, respectively. For example, 1h30m represents 1 hour and 30 minutes. If a time specification value is 0, you can omit it. Default Setting1h Minimum Setting1m Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

MONITOR_REFRESH_PERIOD
Use this parameter to specify the time interval between journal polls. InfoSphere CDC performs journal polls to check for new changes on the source. Applies ToSource Note: If you replicate large volumes of data, set this parameter to its minimum value so that InfoSphere CDC checks for changes more frequently. Specify this parameter in the format #h#m#s, where # is the number of hours, minutes, and seconds, respectively. For example, 1h30m represents 1 hour and 30 minutes. If a time specification value is 0, you can omit it. Default Setting5s Minimum Setting1s Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

Maximize throughput system parameters


InfoSphere CDC system parameters allow you to significantly reduce the workload of the target database during mirroring. The InfoSphere CDC apply process groups transactions on the target to reduce the workload. Every commit on the target database will correspond with a commit on the target. However, it may not perform every commit that was done on the source. For example, if the source does three small transactions containing one operation each, the target may commit all three operations as part of a single transaction. You can use this grouping of system parameters to significantly reduce the resources required by the target

System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

367

database. The default settings are appropriate for most databases, but if your target system has limited resources and an increase in latency is acceptable, you can adjust the settings appropriately. See also: COMMIT_GROUP_SIZE COMMIT_LEVEL COMMIT_INTERVAL on page 369 MAINTAIN_TRANSACTION_CONSISTENCY on page 370 SYNCHRONIZATION_COMMIT_ GROUP_SIZE on page 370 SYNCHRONIZATION_INTERVAL on page 371 TRANSACTION_GROUP_SIZE on page 371 TRANSACTION_INTERVAL on page 372 TRANSACTION_RECORDS_THRESHOLD on page 372

COMMIT_GROUP_SIZE
Use this system parameter to specify the minimum number of rows InfoSphere CDC should apply to the database before a commit is issued. InfoSphere CDC issues a commit on the target when the transaction that contains the rows completes. Use the COMMIT_GROUP_SIZE and COMMIT_INTERVAL system parameters together. InfoSphere CDC issues a commit when either when the number of rows specified by COMMIT_GROUP_SIZE has been applied to the target, or when the time interval specified by COMMIT_INTERVAL has elapsed. Setting only one of these system parameters without the other can result in uncommitted data on the target. Applies ToTarget Default Setting5000 Minimum Setting0. InfoSphere CDC does not use commit groups to apply data to the target. Guidelines Set this parameter to 0 if D_MIRROR_MIRROR_ERROR_STOP=OFF. If a rollback occurs, InfoSphere CDC rolls back all outstanding rows in the commit group. Since InfoSphere CDC is set to continue on error, you may lose data. Note: Use this parameter only if InfoSphere CDC is not running under commitment control (COMMIT_LEVEL =0).

COMMIT_LEVEL
Use this system parameter to indicate the level of commitment control for InfoSphere CDC to process transactions. Applies ToTarget Set this parameter to one of the following:

368

InfoSphere Change Data Capture Management Console: Administration Guide

v 0Disables commitment control for transaction processing. No attempt to maintain transaction consistency is performed in the event that replication is interrupted. v 2When replication is interrupted, updates in a transaction that is partially applied on the source and target databases will be rolled back to the last transaction that was successfully committed. This level of commitment control provides true transaction consistency, and ensures that a transaction will not be partially applied on the target database. Replication resumes after the last transaction that was successfully committed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

COMMIT_INTERVAL
Use this system parameter to specify the time interval between commits, in seconds, to limit the number of commits InfoSphere CDC issues on the target database. Use the COMMIT_GROUP_SIZE and COMMIT_INTERVAL system parameters together. InfoSphere CDC issues a commit when either when the number of rows specified by COMMIT_GROUP_SIZE has been applied to the target, or when the time interval specified by COMMIT_INTERVAL has elapsed. Setting only one of these system parameters without the other can result in uncommitted data on the target. When the COMMIT_INTERVAL time expires, InfoSphere CDC issues a commit on the target database for transactions that completed within that time interval. Applies ToTarget Default Setting60 Minimum Setting0. InfoSphere CDC issues a commit on a target database for each completed transaction. Guidelines Set this parameter to 0 if D_MIRROR_MIRROR_ERROR_STOP=OFF. If a rollback occurs, InfoSphere CDC rolls back all outstanding rows in the commit group. Since InfoSphere CDC is set to continue on error, you may lose data. Note: Use this parameter only if InfoSphere CDC is not running under commitment control (COMMIT_LEVEL =0). Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference COMMIT_LEVEL on page 368 COMMIT_GROUP_SIZE on page 411 D_MIRROR_MIRROR_ERROR_STOP on page 358

System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

369

MAINTAIN_TRANSACTION_CONSISTENCY
Use this system parameter to Indicate whether or not to maintain commitment control. Applies ToSource Set this parameter to one of the following: v OFFCommitment control is disabled. In this case, the COMMIT_LEVEL system parameter is treated as 0. v ONCommitment control is enabled. In this case, the COMMIT_LEVEL system parameter must be 0 or 2. Note: To enable commitment control, you must set MAINTAIN_TRANSACTION_CONSISTENCY=ON and COMMIT_LEVEL=2 before configuring any tables for mirroring. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference COMMIT_LEVEL on page 368

SYNCHRONIZATION_COMMIT_ GROUP_SIZE
Use this system parameter to specify the number of transactions applied to the database before InfoSphere CDC performs synchronization between the source and target. Applies ToSource The SYNCRONIZATION_COMMIT_GROUP_SIZE and SYNCHRONIZATION_INTERVAL system parameters are intended to be used together. Synchronization occurs either when the number of transactions (specified by SYNCRONIZATION_COMMIT_GROUP_SIZE) have been applied or when the time interval (specified by SYNCHRONIZATION_INTERVAL) has elapsed, whichever comes first. Default Setting128 Minimum Setting0. InfoSphere CDC does not use commit groups to perform synchronization. Maximum Setting2,147,483,648 (maximum integer) DynamicYes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference SYNCHRONIZATION_INTERVAL on page 371

370

InfoSphere Change Data Capture Management Console: Administration Guide

SYNCHRONIZATION_INTERVAL
Use this system parameter to specify the interval, in seconds, at which synchronization is performed between the source and target. Synchronization is achieved when the target reports to the source the position of the last committed change. Applies ToSource The SYNCRONIZATION_INTERVAL and SYNCHRONIZATION_COMMIT_ GROUP_SIZE system parameters are intended to be used together. Synchronization occurs either when the number of transactions (specified by SYNCHRONIZATION_COMMIT_ GROUP_SIZE ) have been applied or when the time interval (specified by SYNCRONIZATION_INTERVAL) has elapsed, whichever comes first. Default Setting1 Minimum Setting1 Maximum Setting300 DynamicYes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference SYNCHRONIZATION_COMMIT_ GROUP_SIZE on page 370

TRANSACTION_GROUP_SIZE
Use this system parameter to specify the number of complete transactions applied to the database before InfoSphere CDC issues a commit. Use the TRANSACTION_GROUP_SIZE, TRANSACTION_INTERVAL, and TRANSACTION_RECORDS_THRESHOLDS system parameters together. InfoSphere CDC issues a commit after applying the number of transactions specified by the TRANSACTION_GROUP_SIZE, or when the time interval specified by TRANSACTION_INTERVAL has elapsed. Setting only one of these system parameters without the other can result in uncommitted transactions on the target. Applies ToTarget Default Setting500 Minimum Setting0 Guidelines To increase the throughput, set to a number of transactions that would be received when busy during the TRANSACTION_INTERVAL. Note: Use this parameter only if InfoSphere CDC is running under commitment control. The COMMIT_LEVEL system parameter should be set to2 on the target
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

371

database, and the MAINTAIN_TRANSACTION_CONSISTENCY system parameter should be set to ON on the source database.

TRANSACTION_INTERVAL
Use this system parameter to specify the time interval, in seconds, that can elapse between transactions before InfoSphere CDC issues a commit. If there are no transactions received by the target system, then InfoSphere CDC issues a commit immediately. Use this system parameter with the TRANSACTION_GROUP_SIZE system parameter. InfoSphere CDC issues a commit after applying the number of transactions specified by the TRANSACTION_GROUP_SIZE system parameter, or when the time interval specified by TRANSACTION_INTERVAL system parameter has elapsed. Setting only one of these system parameters without the other can result in uncommitted transactions on the target. Applies ToTarget Default Setting1 Minimum Setting0 Guidelines InfoSphere CDC issues a commit only when a commit is received by the target system and you have reached the transaction group size, or exceeded the time interval, or exceeded the records threshold.

TRANSACTION_RECORDS_THRESHOLD
Use this system parameter to specify the maximum number of operations within a transaction or group of transactions before InfoSphere CDC issues a commit Applies ToTarget Default Setting3000 Minimum Setting0

Tracing system parameters


Tracing system parameters let you perform diagnostic activities with InfoSphere CDC. See also: D_MIRROR_SP_TRACE on page 373 D_MIRROR_TRACE on page 373 D_MIRROR_TRACE_FILE_SIZE on page 373 D_MIRROR_TRACE_ON_ERROR on page 374 DM_PRINT_DIAGNOSTICS on page 374 D_MIRROR_ALARM_TRACE on page 375

372

InfoSphere Change Data Capture Management Console: Administration Guide

D_MIRROR_SP_TRACE
Use this system parameter to enable tracing for your stored procedure user exit. Applies ToTarget Set this parameter to one of the following: v OFFTracing is disabled. v ONTracing is enabled and InfoSphere CDC creates the appropriate trace files in the log directory. These trace files are not encrypted. It is a plain ASCII text file and can be read directly for troubleshooting purposes. Default SettingOFF DynamicNo

D_MIRROR_TRACE
Use this system parameter to indicate whether or not tracing is enabled. Applies ToSource and Target Set this parameter to one of the following: v OFFTracing is disabled. This setting has no effect when D_MIRROR_TRACE_ON_ERROR=ON. v ONTracing is enabled and InfoSphere CDC creates the appropriate trace files in the log directory. These trace files are encrypted, and are meant to be sent to IBM technical support for troubleshooting purposes. When enabling this setting, also set the size of the trace file to an appropriate value using the D_MIRROR_TRACE_FILE_SIZE system parameter. To avoid disk space problems, set the size of the trace file to a value that is not too high. Default SettingOFF DynamicYes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference D_MIRROR_TRACE_FILE_SIZE D_MIRROR_LOG on page 349 DIRPATH_LOGGING on page 378 D_MIRROR_ALARM_TRACE on page 375

D_MIRROR_TRACE_FILE_SIZE
Use this system parameter to specify the maximum size of a trace file in bytes. InfoSphere CDC creates two trace files. When the first trace file reaches its maximum size, InfoSphere CDC creates a second file. When the second trace file reaches its maximum size, InfoSphere CDC starts overwriting the first file.

System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

373

Applies ToSource and Target Default Setting10,000,000 bytes Minimum Setting1,000,000 bytes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

D_MIRROR_TRACE_ON_ERROR
Use this system parameter to specify whether or not InfoSphere CDC enables tracing automatically when an error occurs. Applies ToSource and Target Set this parameter to one of the following: v OFFInfoSphere CDC does not enable tracing when an error occurs. v ONInfoSphere CDC enables tracing when an error occurs. InfoSphere CDC creates the appropriate trace files in the InfoSphere CDC log directory. These trace files are encrypted, and are meant to be sent to IBM technical support for troubleshooting purposes. When enabling this setting, also set the size of the trace file to an appropriate value using the D_MIRROR_TRACE_FILE_SIZE system parameter. To avoid disk space problems, set the size of the trace file to a value that is not too high. Default SettingOFF DynamicYes (on the target only) Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference D_MIRROR_TRACE_FILE_SIZE on page 373

DM_PRINT_DIAGNOSTICS
Use this system parameter to Indicate whether or not to generate diagnostic messages in the InfoSphere CDC log files. Applies ToSource Set this parameter to one of the following: v OFFDiagnostic messages will not be generated. v ONDiagnostic messages will be generated. Note: If you enable tracing, it may cause large trace files to be created, which can consume a large amount of disk space and affect performance. To avoid running into disk space shortage problems, use this parameter only if advised by IBM technical support. Default SettingOFF

374

InfoSphere Change Data Capture Management Console: Administration Guide

Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

D_MIRROR_ALARM_TRACE
Use this system parameter to Indicate whether or not tracing for notification is enabled. Applies ToSource and Target Set this parameter to one of the following: v OFFTracing for notification is disabled. v ONTracing for notification is enabled. Tracing for notification is enabled when D_MIRROR_TRACE system parameter is also set to ON. The notification tracing will be located in the same trace file used for regular tracing located in the directory specified by the D_MIRROR_LOG system parameter. The trace files are encrypted and are meant to be sent to IBM for troubleshooting purposes. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference D_MIRROR_TRACE on page 373

Refresh loader system parameters


Some system parameters affect how InfoSphere CDC applies refresh operations. See also: DIRPATH_BUF_ROWS DIRPATH_BUF_SIZE on page 376 DIRPATH_CACHE_DATE_SIZE on page 377 DIRPATH_LOAD on page 377 DIRPATH_LOGGING on page 378 DIRPATH_DO_RECOVERY on page 378

DIRPATH_BUF_ROWS
Use this system parameter to specify the number of rows allocated in the internal buffer used for direct path loading. By setting this parameter to a value greater than 0, you can improve direct path loading performance. Applies ToTarget The table below explains how the DIRPATH_BUF_ROWS and DIRPATH_BUF_SIZE system parameters affect the size of the internal buffer that InfoSphere CDC uses for direct path loading.

System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

375

DIRPATH_BUF_ SIZE 0

DIRPATH_BUF_ ROWS 0

Internal buffer size Determined dynamically, based on the size of the table being loaded. As specified by DIRPATH_BUF_ROWS. InfoSphere CDC allocates an internal buffer that is large enough to store the number of rows specified by DIRPATH_BUF_ROWS. As specified by DIRPATH_BUF_SIZE. As specified by DIRPATH_BUF_SIZE.

Greater than 0

Greater than 0 Greater than 0

0 Greater than 0

Default Setting0 Minimum Setting0 Maximum Setting231 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference DIRPATH_BUF_SIZE

DIRPATH_BUF_SIZE
Use this system parameter to specify the size, in bytes, for the internal buffer used for direct path loading. By setting this parameter to a value greater than 0, you can improve direct path loading performance. Applies ToTarget The table below explains how the DIRPATH_BUF_SIZE and DIRPATH_BUF_ROWS system parameters affect the size of the internal buffer that InfoSphere CDC uses for direct path loading.
DIRPATH_BUF_ SIZE 0 DIRPATH_BUF_ ROWS 0 Internal buffer size Determined dynamically, based on the size of the table being loaded. As specified by DIRPATH_BUF_ROWS. InfoSphere CDC allocates an internal buffer that is large enough to store the number of rows specified by DIRPATH_BUF_ROWS. As specified by DIRPATH_BUF_SIZE.

Greater than 0

Greater than 0

376

InfoSphere Change Data Capture Management Console: Administration Guide

DIRPATH_BUF_ SIZE Greater than 0

DIRPATH_BUF_ ROWS Greater than 0

Internal buffer size As specified by DIRPATH_BUF_SIZE.

Default Setting0 Minimum Setting0 Maximum Setting231 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference DIRPATH_BUF_ROWS on page 375

DIRPATH_CACHE_DATE_SIZE
Use this system parameter to specify the number of DATE (date and timestamp) values to be cached per table being refreshed, during direct path loading. If the table being refreshed contains DATE data type columns, you can improve direct path loading performance by setting this parameter to a value higher than the default setting. If the table being refreshed does not contain any DATE data type columns, this parameter has no effect. Applies ToTarget Default Setting0. DATE values are not cached. Minimum Setting0 Maximum Setting2^32 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

DIRPATH_LOAD
Use this system parameter to enable or disable direct path loading. Applies ToTarget Set this parameter to one of the following: v ONDirect path loading is enabled. InfoSphere CDC uses Oracle Call Interface (OCI) functions to perform data refresh. By using OCI functions, InfoSphere CDC can load multiple rows by loading a direct path stream that contains data for multiple rows. Note: If you want to enable direct path loading, then you need perform a refresh on each subscription to send data to the target datastore. v OFFDirect path loading is disabled.

System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

377

Note: This setting is required in cascading replication configurations, to make sure that data changes are correctly replicated to the target tables. Default SettingON Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

DIRPATH_LOGGING
Applies ToTarget Indicates whether or not full image redo logging is performed. This system parameter corresponds to the Oracle NOLOGGING keyword. Set this parameter to one of the following: v OFFFull image redo logging is not performed. Oracle generates a minimum number of redo log entries, thus providing improved performance. However, in case of instance failure, records that were inserted are marked as logically corrupted and cannot be recovered. v ONFull image redo logging is performed. Oracle inserts data with full image redo logging, which ensures that the necessary information is available in case of instance failure. For more information about image redo logging, see your Oracle documentation. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

DIRPATH_DO_RECOVERY
Use this system parameter to modify how InfoSphere CDC handles rows that have conflicting unique index values. In Direct Path Load, InfoSphere CDC places an index in direct load state when it detects one or more conflicts after performing a refresh of all rows. Applies ToTarget OFFNo rows are removed and the index remains in direct load state and ROWID of duplicate rows are stored in the exception table as indicated in the event log. ONAll rows with conflicting unique index values will be removed and the index will be enabled. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

378

InfoSphere Change Data Capture Management Console: Administration Guide

User exit system parameters


Some system parameters control user exits. See also: D_MIRROR_SP_CONNECTION DM_FROM_CODEPAGE_V4USEREXIT DM_TO_CODEPAGE_V4USEREXIT on page 380 userexit_max_lob_size_kb on page 397

D_MIRROR_SP_CONNECTION
Use this system parameter to indicate whether or not a second connection to the Oracle database is established for a stored procedure user exit program to run. Applies ToTarget Set this parameter to one of the following: v OFFA second connection to the database is not established. The stored procedure user exit program and InfoSphere CDC will use the same, shared connection to the Oracle database. This setting ensures that changes to tables made by InfoSphere CDC are visible to the stored procedure user exit program. v ONA second connection to the database is established. The stored procedure user exit program will use this separate, second connection, to the Oracle database. Attention: If any stored procedure user exit program is issuing a commit or rollback, you must set this parameter to ON, otherwise data may be lost, or errors may be generated when applying data to the target database. Setting this parameter to ON does not affect stored procedure user exit programs for conflict resolution, or stored procedure user exit programs invoked within an expression, using the %STPROC column function. They will always use the same connection to the database as InfoSphere CDC. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

DM_FROM_CODEPAGE_V4USEREXIT
Applies ToTarget Set this parameter only if using before or after images in C user exit programs defined in InfoSphere CDC Version 4.x. In InfoSphere CDC Version 4.x, the before and after images in C user exit programs were received in the code page of the source. In Version 5.1 and greater, they are received in the code page of the target. To use the user exit program as defined in Version 4.x, data must be translated back from the code page of the target to the code page of the source.
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

379

Therefore, specify for this parameter the code page to translate from (the code page of the target). If this parameter is not set, no translation will be performed from the code page of the source to the code page of the target. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

DM_TO_CODEPAGE_V4USEREXIT
Applies ToTarget Set this parameter only if using before or after images in C user exit programs defined in InfoSphere CDC Version 4.x. In InfoSphere CDC Version 4.x, the before and after images in C user exit programs were received in the code page of the source. In Version 5.1 and higher, they are received in the code page of the target. To use the user exit program as defined in Version 4.x, data must be translated back from the code page of the target to the code page of the source. Therefore, specify for this parameter the code page to translate to (the code page of the source). If this parameter is not set, no translation will be performed from the code page of the target to the code page of the source. Table mapping system parameters In this section, you will learn about system parameters that control table mappings. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

Table mapping system parameters


Some system parameters control table mappings. See also: TS_DELETE_ASSIGNED_OBJECTS_DURING_DESCRIBE

TS_DELETE_ASSIGNED_OBJECTS_DURING_DESCRIBE
Use this system parameter (when describing source tables to subscriptions) to specify whether or not to remove references to target tables when the mapped source table no longer exists. Applies ToTarget Set this parameter to one of the following: v OFFInfoSphere CDC does not remove references to target tables when the assigned source table no longer exists.

380

InfoSphere Change Data Capture Management Console: Administration Guide

v ONInfoSphere CDC removes references to target tables when the assigned source table no longer exists. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

Notification system parameters


Notification system parameters let you control if you should generate InfoSphere CDC messages in the Event Log for specific events. See also: convertNotNullableMsg DEADBAND_PERCENTAGE DM_STATUS_INTERVAL on page 384 HEARTBEAT_TIMEOUT on page 384 LOG_EMAIL_USERNAME on page 385 MONITOR_SAMPLE_INTERVAL on page 385 STATISTICS_INTERVAL on page 386

convertNotNullableMsg
Use this system parameter to indicate whether or not NULL values will be converted to default values when replicating data that contains NULL values to non-nullable target columns. Applies ToTarget Set this parameter to one of the following: v OFFAn error message will be generated in Event Log. Replication will continue or not based on whether the MirrorError or RefreshError system parameters are set to END or ON. v ONInfoSphere CDC will automatically insert an appropriate default value in the target column. No error message is generated in Event Log and replication continues. Depending on the convertNotNullableMsg system parameter setting, a warning message may be generated in Event Log. The default value depends on the data type of the subscription column. For example, zero for numeric data types, blank character for character data types, 1901-01-01 for date data types, and so on. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

DEADBAND_PERCENTAGE
Applies ToTarget
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

381

Identifies the size of the range around each latency threshold setting. Based on latency thresholds defined, a latency message is generated when latency has risen above or fallen below a threshold. Latency is calculated at regular intervals, where the interval is the current setting for the MONITOR_SAMPLE_INTERVAL system parameter. You can set notifications in response to a generated latency message. This system parameter, which is expressed as a percentage, allows you to pad a threshold equally on both sides to create a range around the threshold. By adjusting this system parameter, the size of the range around the threshold can be increased or decreased, and the threshold itself can be made thicker or thinner. A latency message is generated only when latency has risen above the upper limit of the range or fallen below the lower limit of the range. By changing the value assigned to this system parameter, you can control the number of latency messages placed in Event Log. For example, assume that a latency threshold is 5 minutes and this system parameter is set to 10. A 10% range is applied around the 5 minute threshold. The following calculations are performed to determine the lower and upper limits (in minutes) of the range around the threshold: v Padding = 10% of 5 minutes = 0.5 minutes (rounded up to 1 minute) v Padding is rounded up or down to the nearest whole minute: Upper limit of range = 5 minutes + 1 minute (padding) = 6 minutes Lower limit of range = 5 minutes - 1 minute (padding) = 4 minutes As a result, a latency message will be generated only when latency rises above 6 minutes or falls below 4 minutes. Given sample latency over a ten minute period where latency is calculated every minute, three latency messages are generated. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 10%:

If this DEADBAND_PERCENTAGE is set to 3 (the default setting) for the same example, no padding is applied to the latency threshold. Therefore, a latency message is generated each time latency crosses over the latency threshold of 5 minutes. Based on the same sample latency in the previous graph where latency is

382

InfoSphere Change Data Capture Management Console: Administration Guide

calculated every minute, five latency messages are generated when this system parameter is set to 3. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 3%:

If the number of latency messages generated over the ten minute period for the 10% (3 latency messages) and 3% (5 latency messages) settings are averages, an additional 288 latency messages would be generated each day if this system parameter is not changed from its default setting to 10%. Since there are two latency thresholds that you can set (a warning threshold and a problem threshold), two separate ranges are defined when padding is at least one minute. In this case, each range is attached to its threshold, and the two ranges can overlap with no change in behavior. If a value outside the acceptable range is specified, the default setting is used. Default Setting3% Minimum Setting3% Maximum Setting10% Note: If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Disk resource system parameters on page 386 Setting latency thresholds and notifications on page 78

System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

383

DM_STATUS_INTERVAL
Use this system parameter to specify how often progress messages should be issued in seconds. These messages are displayed in Event Log to indicate how replication is advancing and to provide detailed information about InfoSphere CDC replication activities. Applies ToSource and Target Note: Low values of this parameter may result in many messages displayed in Event Log. In this situation, clear Event Log on a regular basis. Default Setting0 seconds. No progress notifications will be issued. Minimum Setting0 seconds. No progress notifications will be issued. Maximum Setting7200 seconds Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

HEARTBEAT_TIMEOUT
Use this parameter to specify the number of minutes of communication inactivity to wait before active InfoSphere CDC processes for a subscription are stopped. Heartbeat is a feature that manages InfoSphere CDC processes when a problem with communications or a process has been detected through the absence of communications over a specified period of time. For each active subscription, internal heartbeat messages are sent regularly between the source and the target to determine communications and process status. If a reply to a message is not received by the source or target within the specified timeout interval, then InfoSphere CDC determines that a problem has occurred, and attempts to stop all its source and target processes for the subscription. In addition, messages (message identifiers 2612 and 3165) are placed in Event Log when heartbeat timeouts occur. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Displaying event messages during replication on page 232

384

InfoSphere Change Data Capture Management Console: Administration Guide

LOG_EMAIL_USERNAME
Use this system parameter to specify the user name that receives email messages in response to invoking the dmreadlog command or the warning message that is generated when Event Log exceeds the threshold value set by the LOG_MAX_SIZE system parameter. Applies ToSource and Target In UNIX environments, the value assigned to this parameter is a comma-separated list of user names. The value of this parameter cannot exceed 30 bytes in length. To suppress all email messages, set this parameter to NOMAIL. Default SettingThe InfoSphere CDC account (UNIX user) specified when InfoSphere CDC was installed Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference STATISTICS_INTERVAL on page 386

MONITOR_SAMPLE_INTERVAL
Use this system parameter to identify the period of time, in seconds, between consecutive updates to a storage area that is used to maintain replication latency metrics. Management Console references this area to present replication latency information. Applies ToSource and Target On the target, this setting also represents how often the storage area is sampled to determine if latency has risen above or fallen below specified threshold settings. InfoSphere CDC generates latency messages when latency rises above or falls below the thresholds. In response to a generated message, you can set latency notifications. If a value smaller than the minimum setting is specified, the minimum setting is used. If a value larger than the maximum setting is specified, the maximum setting is used. Default Setting5 seconds Minimum Setting0 seconds. Replication latency metrics are not updated. Maximum Setting3600 seconds Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Setting latency thresholds and notifications on page 78

System parameters for InfoSphere CDC for Oracle (version 6.2 and below)

385

STATISTICS_INTERVAL
Use this system parameter to specify how often, in seconds, InfoSphere CDC issues messages that contain statistics information. These messages are displayed in Event Log. Applies ToSource and Target Note: Use this parameter only if advised by IBM technical support. Default Setting0. InfoSphere CDC does not provide statistics information. Minimum Setting0. InfoSphere CDC does not provide statistics information. Maximum Setting2,147,483,647 (maximum integer) DynamicYes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

Disk resource system parameters


Some system parameters control memory usage in InfoSphere CDC. For improved performance, if you are able to allocate more than the default value of 512 MB for the InfoSphere CDC Java Virtual Machine, then you can adjust the disk resource system parameters to use the increased memory. See also: LOG_MAX_SIZE

LOG_MAX_SIZE
Use this system parameter to specify the threshold size of Event Log in KB. A warning message is generated in Event Log when its size exceeds specified threshold. The messages in Event Log are deleted automatically when the size of Event Log is ten times the value specified by this parameter. Applies ToSource and Target If you do not want to specify a threshold size, set this parameter to NOMAX. Default Setting5000 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347

386

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for Oracle (version 6.3 and above)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Note: If you make changes to a system parameter during active replication, you must stop and restart replication for the changes to take effect. In this section, you will learn: General product system parameters Notification system parameters on page 388 Maximize throughput system parameters on page 389 Database journal (trigger) system parameters on page 366 Encoding system parameters on page 391 Disk resource system parameters on page 392 Apply process system parameters on page 393 User exit system parameters on page 379

General product system parameters


General product system parameters let you control basic features of InfoSphere CDC and information you may have specified during installation. See also: mirror_set_table_data_capture_timeout mirror_asm_oracle_path on page 388

mirror_set_table_data_capture_timeout
Use this system parameter to indicate how long (in minutes) InfoSphere CDC waits before declaring a failure when preparing a table for mirroring. Applies ToSource Default30 minutes Minimum0 minutes Maximum90 minutes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above)
Copyright IBM Corp. 2008

387

mirror_asm_oracle_path
Use this system parameter if the Oracle database uses ASM to manage its datafile or redo logs on a Linux box. Replace the ORCL label that references the common directory of the ASM-managed devices with the actual directory path.

Notification system parameters


Notification system parameters let you control if you should generate InfoSphere CDC messages in the Event Log for specific events. See also: events_max_retain global_shutdown_after_no_heartbeat_response_minutes global_conversion_not_possible_warning on page 389

events_max_retain
Use this system parameter when you want InfoSphere CDC to refresh a target table that contains multibyte object names. Set this parameter to one of the following: v trueInfoSphere CDC will not refresh the target table that contains multibyte object names. v falseInfoSphere CDC will refresh a target table that contains multibyte object names. Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

global_shutdown_after_no_heartbeat_response_minutes
Use this system parameter to specify the duration, in minutes, of communication inactivity before active InfoSphere CDC processes for a subscription are stopped. If a value outside the acceptable range is specified, the default setting is used. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

388

InfoSphere Change Data Capture Management Console: Administration Guide

global_conversion_not_possible_warning
Use this system parameter to control whether or not InfoSphere CDC generates a warning in the Management Console Event Log in the following situations: v Data conversion is not possible for a specific data value. v Converted data types are encountered that are out of range. Set this parameter to one of the following: truegenerates a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. falsedoes not generate a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. Applies ToTarget Default SettingFalse Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

Maximize throughput system parameters


InfoSphere CDC system parameters allow you to significantly reduce the workload of the target database during mirroring. The InfoSphere CDC apply process groups transactions on the target to reduce the workload. Every commit on the target database will correspond with a commit on the target. However, it may not perform every commit that was done on the source. For example, if the source does three small transactions containing one operation each, the target may commit all three operations as part of a single transaction. You can use this grouping of system parameters to significantly reduce the resources required by the target database. The default settings are appropriate for most databases, but if your target system has limited resources and an increase in latency is acceptable, you can adjust the settings appropriately. See also: mirror_commit_on_transaction_boundary mirror_sess_hist_age_threshold on page 390 mirror_src_ora_version on page 390 refresh_commit_after_max_operations on page 390 userexit_max_lob_size_queue on page 391

mirror_commit_on_transaction_boundary
This system parameter indicates whether or not the commits that InfoSphere CDC does on the target database will always correspond with a commit that occurred on the source database. If you choose to ignore the commitment control of the source database, InfoSphere CDC allows you to see the partial results of large transactions. Set this parameter to one of the following:
System parameters for InfoSphere CDC for Oracle (version 6.3 and above)

389

trueDoes not ignore the commitment control of the source database. Only records in a committed transaction are mirrored to the target. This setting provides true transaction consistency by ensuring that only committed transactions are sent to the target. v falseIgnores the commitment control of the source database. This value disables commitment control for transaction processing. No attempt to maintain transaction consistency is performed during mirroring. v Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

mirror_sess_hist_age_threshold
Use this system parameter to identify the number of days of session history to maintain. If the value is set to a positive number, the session history will be purged accordingly. A negative number results in the retention of all log information. Default Setting1 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

mirror_src_ora_version
This system parameter identifies the database version of the primary database. If the primary database is version 10g or higher, then you must set this parameter on both the primary and backup systems. Set this parameter to the full database version number. For example, 10.2.0.1.0. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

refresh_commit_after_max_operations
This system parameter identifies the number of rows comprising each transaction during refresh. To reduce the workload on the target database during refresh, InfoSphere CDC periodically commits the changes to the target database rather than performing the refresh as a single large transaction. Applies ToTarget Default Setting1000 Minimum Setting1 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

390

InfoSphere Change Data Capture Management Console: Administration Guide

userexit_max_lob_size_queue
Use this system parameter to set the maximum size of LOB data (in kb) that InfoSphere CDC can pass to a user exit. Applies ToTarget Default Setting128 kb MaximumNone MinimumNone Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

Database journal (trigger) system parameters


Database journal or trigger system parameters let you manage the InfoSphere CDC journal table. See also: REPORT_POSITION_INTERVAL on page 366 MONITOR_PURGE_INTERVAL on page 367 MONITOR_REFRESH_PERIOD on page 367 mirror_journal_schema

mirror_journal_schema
Use this system parameter to enable multiple instances of InfoSphere CDC to share the same trigger and journal table. To enable this system parameter, you must specify the name of the journal that you want shared with another instance of InfoSphere CDC. For example, if you have created an instance INSTANCE1 that specifies the journal SCHEMA1, and created another instance INSTANCE2 that specifies the journal SCHEMA2, then you would set the system parameter mirror_journal_schema on INSTANCE2 so that it points to the journal SCHEMA1. This enables both instances to share the same trigger and journal table. You can only set a value for this system parameter before mapping your tables and setting the subscription for mirroring. The value of this system parameter must refer to the name of an existing journal table. Applies ToSource Default SettingN/A

Encoding system parameters


For some system parameters, you can set the default method for treating data in defined Unicode columns, and you can set the default character encoding for your database. See also: global_unicode_as_char on page 392

System parameters for InfoSphere CDC for Oracle (version 6.3 and above)

391

global_unicode_as_char
Use this system parameter to indicate the default method of treating data in defined Unicode columns. For information about how data in each Unicode source column is treated and setting multibyte and Unicode character set conversions, see Setting multibyte and Unicode character set conversions on page 175. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Set this parameter to one of the following: TrueInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. FalseInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain non-single-byte character data. Setting this parameter to false ensures that InfoSphere CDC handles non-single-byte character data in the same way as previous InfoSphere CDC releases. Default Settingfalse Applies ToSource Note: Setting this parameter to false does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. Using Management Console, you can specify how InfoSphere CDC converts multibyte character sets on source columns during replication. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

Disk resource system parameters


Some system parameters control memory usage in InfoSphere CDC. For improved performance, if you are able to allocate more than the default value of 512 MB for the InfoSphere CDC Java Virtual Machine, then you can adjust the disk resource system parameters to use the increased memory. See also: mirror_queue_for_buffers_between_cdc_threads_operations mirror_global_disk_quota_mb on page 393

mirror_queue_for_buffers_between_cdc_threads_operations
Use this system parameter to set the capacity of InfoSphere CDC queues to store captured changes. The capacity is measured by the number of operations you want the queue to be able to store. This includes insert, update, and delete operations. Applies ToSource Default Setting7 database operations

392

InfoSphere Change Data Capture Management Console: Administration Guide

Maximum2 63-1 =9223372036854775807 operations Minimum1 database operation Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

mirror_global_disk_quota_mb
Use this system parameter to globally set a disk quota (in MB) for all capture components (including temporary files, transaction queues, staging stores, and operation queues). InfoSphere CDC will manage disk space utilization across all components as required. Applies ToSource and Target Default Setting0 MaximumNone MinimumNone Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

Apply process system parameters


Some system parameters adjust the way InfoSphere CDC applies rows, column data, and error handling. See also: convert_not_nullable_column global_max_batch_size on page 394 mirror_end_on_error on page 394 refresh_end_on_error on page 394 refresh_allow_fast_loader on page 395 refresh_allow_jdbc_batch on page 395 mirror_expected_errors_list on page 395 refresh_in_unicode on page 396 trim_char_to_varchar on page 396 trim_varchar_to_varchar on page 396

convert_not_nullable_column
Use this system parameter to specify whether or not InfoSphere CDC should strip or leave trailing blanks on string data of the column in the target table. Set this parameter to one of the following: v trueInfoSphere CDC strips the data of trailing blanks. v falseInfoSphere CDC does not strip the string data of trailing blanks.

System parameters for InfoSphere CDC for Oracle (version 6.3 and above)

393

Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

global_max_batch_size
Use this system parameter to specify the maximum number of rows that InfoSphere CDC can place in an array and apply to the target database during refresh or mirroring. InfoSphere CDC collects rows and places them in an array (in memory) while receiving table-level operations from the source system. InfoSphere CDC applies the rows from the array when there is a change to a different table, when there is a new table-level operation, or when the maximum number of rows in an array has been reached. You can use this parameter during mirroring only if mirror_end_on_error is true and mirror_expected_errors_list is empty. Use only during a refresh if refresh_end_on_error is true and refresh_expected_errors_list is empty. Before InfoSphere CDC places rows into an array, it allocates memory for the maximum number of rows you specify and multiplies this integer by the maximum length of a row. If the maximum number of rows is too large, then InfoSphere CDC cannot allocate enough memory and will shut down. Management Console references this area to present replication latency information. Applies ToTarget InfoSphere CDC for Sybase Default Setting25 rows Minimum Setting1 row

mirror_end_on_error
Use this system parameter to indicate if you want to end mirroring after an apply error occurs on the target database. Set this parameter to one of the following: v trueEnd mirroring after an apply error on the target database. v falseDo not end mirroring after an apply error on the target database. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

refresh_end_on_error
Use this system parameter to indicate if you want to end a refresh after an apply error occurs. Set this parameter to one of the following: v trueEnd a refresh after an apply error occurs.

394

InfoSphere Change Data Capture Management Console: Administration Guide

falseDo not end a refresh after an apply error occurs.

Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

refresh_allow_fast_loader
This parameter can be used to allow or prevent Oracle direct path (fast load) from being considered as a refresh method. Set this parameter to one of the following: trueAllows fast load when appropriate. falseDoes not allow fast load. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

refresh_allow_jdbc_batch
There are three apply modes for refresh: fastload, JDBC batch and JDBC. InfoSphere CDC chooses fastload if possible, then JDBC batch if possible and chooses JDBC if necessary. This parameter can be used to allow or prevent JDBC batch from being considered. Set this parameter to one of the following: trueallows JDBC batch to be considered as an apply mode. falseprevents JDCBC batch from being considered as an apply mode. Applies ToTarget Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

mirror_expected_errors_list
Use this system parameter when you want InfoSphere CDC to ignore specific database errors when applying data changes to the target during mirroring. You must specify the errors in a comma separated list. Applies ToTarget Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

System parameters for InfoSphere CDC for Oracle (version 6.3 and above)

395

refresh_in_unicode
Use this system parameter when you want InfoSphere CDC to refresh a target table that contains multibyte object names. Set this parameter to one of the following: v trueInfoSphere CDC will refresh the target table that contains multibyte object names. v falseInfoSphere CDC will not refresh a target table that contains multibyte object names. Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

trim_char_to_varchar
Use this system parameter to specify whether or not InfoSphere CDC should pad string data with trailing blanks to the length of the column in the target table. Set this parameter to one of the following: v v trueInfoSphere CDC does not pad the string data with trailing blanks. falseInfoSphere CDC pads the string data with trailing blanks.

Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

trim_varchar_to_varchar
Use this system parameter to specify whether or not InfoSphere CDC should strip or leave trailing blanks on string data of the column in the target table. Set this parameter to one of the following: v trueInfoSphere CDC strips the data of trailing blanks. v falseInfoSphere CDC does not strip the string data of trailing blanks. Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387

396

InfoSphere Change Data Capture Management Console: Administration Guide

User exit system parameters


Some system parameters control user exits. See also: D_MIRROR_SP_CONNECTION on page 379 DM_FROM_CODEPAGE_V4USEREXIT on page 379 DM_TO_CODEPAGE_V4USEREXIT on page 380 userexit_max_lob_size_kb

userexit_max_lob_size_kb
Use this system parameter to set the maximum size of LOB data (in kb) that InfoSphere CDC can pass to a user exit. Applies ToTarget Default Setting128 kb MaximumNone MinimumNone Related concepts System parameters for InfoSphere CDC Event Server on page 493 Setting system parameters on source and target datastores on page 60

System parameters for InfoSphere CDC for Oracle (version 6.3 and above)

397

398

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for Sybase (version 6.0 and below)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Note: If you make changes to a system parameter during active replication, you must stop and restart replication for the changes to take effect. In this section, you will learn: General product system parameters Apply process system parameters on page 404 Cascading replication system parameters on page 409 Database journal (trigger) system parameters on page 410 Maximize throughput system parameters on page 410 Tracing system parameters on page 413 Notification system parameters on page 415 Disk resource system parameters on page 420 Refresh loader system parameters on page 421

General product system parameters


General product system parameters let you control basic features of InfoSphere CDC and information you may have specified during installation. See also: CODE_PAGE on page 400 D_MIRROR_HOME on page 400 D_MIRROR_LOG on page 400 DM_DYNAMIC_PARAMETER_CHECK_INT on page 400 DM_MAX_MONITOR_ENTRIES on page 401 DSQUERY on page 401 LD_LIBRARY_PATH on page 401 LIBPATH on page 402 PUBLISH_METADATA on page 402 SYBASE on page 402 SYBASE_OCS on page 402 SHLIB_PATH on page 403 STARTUP_TIMEOUT on page 403 USER on page 403

Copyright IBM Corp. 2008

399

CODE_PAGE
Use this system parameter to specify the code page associated with NLS_LANG. This value is set during installation and should not be modified except under the guidance of a IBM technical support. Applies ToSource and Target Default SettingThe system code page when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference NLS_LANG on page 406

D_MIRROR_HOME
Use this system parameter to specify the directory (full path) where InfoSphere CDC is installed on the server. Applies ToSource and Target Default SettingThe installation directory specified when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

D_MIRROR_LOG
Use this system parameter to specify the directory (full path) where InfoSphere CDC log files are located. Applies ToSource and Target Default SettingThe log subdirectory in the installation directory specified when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

DM_DYNAMIC_PARAMETER_CHECK_INT
Use this system parameter to specify how often, in seconds, InfoSphere CDC checks for changes to the values of dynamic system parameters during active replication to a subscription. For example, to check once a day, set this parameter to 216,000. Applies ToSource and Target The following system parameters are dynamic: v D_MIRROR_TRACE on page 414

400

InfoSphere Change Data Capture Management Console: Administration Guide

v v v v v

D_MIRROR_TRACE_ON_ERROR on page 414 (on the target only) DM_PRINT_DIAGNOSTICS on page 374 STATISTICS_INTERVAL on page 420 SYNCHRONIZATION_COMMIT_ GROUP_SIZE on page 412 SYNCHRONIZATION_INTERVAL on page 413

Default Setting300 seconds (5 minutes) Minimum Setting0. InfoSphere CDC does not check for changes to dynamic system parameters. Maximum Setting2,147,483,648 (maximum integer) Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

DM_MAX_MONITOR_ENTRIES
Use this system parameter to increase or decrease the number of subscriptions that InfoSphere CDC can support in the Monitor in Management Console. InfoSphere CDC allocates an entry for each source and target datastore within a subscription. For example, if you have a datastore that is being used as a source datastore within 20 subscriptions and as a target datastore within 10 subscriptions, then you must set this system parameter to at least 30. InfoSphere CDC will allocate 30 entries for this datastore. Applies ToSource Default Setting20 entries. By default, InfoSphere CDC can handle 20 subscriptions. Minimum Setting1 entry Maximum Setting1000 entries

DSQUERY
Use this system parameter to specify the name of the Sybase server. Applies ToSource and Target

LD_LIBRARY_PATH
Use this system parameter to specify the path to the InfoSphere CDC libraries and the database libraries for Solaris and Linux operating systems. This value is set during installation and should not be modified. Applies ToSource and Target Default SettingThe path to the InfoSphere CDC libraries and the Sybase libraries when InfoSphere CDC was installed Related concepts

System parameters for InfoSphere CDC for Sybase (version 6.0 and below)

401

System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

LIBPATH
Use this system parameter to specify the path to the InfoSphere CDC libraries and the database libraries (for AIX operating systems). This value is set during installation and should not be modified. Applies ToSource and Target Default SettingThe path to the InfoSphere CDC libraries and the database libraries when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

PUBLISH_METADATA
Use this system parameter to enable or disable the display of InfoSphere CDC metadata tables in Management Console. Applies ToSource Set this parameter to one of the following: v OFFInfoSphere CDC metadata tables are not displayed in Management Console. v ONInfoSphere CDC metadata tables are displayed in the Add/Remove Tables dialog box, making them available to be selected for replication. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

SYBASE
Use this system parameter to specify the Sybase home directory. This value is set during the installation and should not be modified. Applies ToSource and Target Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

SYBASE_OCS
Use this system parameter to specify the Sybase Open Client directory. This value is set during the installation and should not be modified. Applies ToSource and Target Related concepts

402

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

SHLIB_PATH
Use this system parameter to specify the path to the InfoSphere CDC libraries and the database libraries for HP-UX operating systems. This value is set during installation and should not be modified. Applies ToSource and Target Default SettingThe path to the InfoSphere CDC libraries and the database libraries when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

STARTUP_TIMEOUT
Use this system parameter to specify the maximum waiting period, in seconds, for process handling to complete during InfoSphere CDC startup. It indicates how long the communication program waits for the database setup program to start before timing out. Applies ToSource and Target Default Setting120 Minimum Setting60 Maximum Setting3600 Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

USER
Use this system parameter to specify the database user name that was specified during installation. You can also set this user using the dmsetpass command. Applies ToSource Default SettingThe InfoSphere CDC user specified when InfoSphere CDC was installed. Apply process system parameters In this section, you will learn about system parameters that adjust how InfoSphere CDC applies rows, column data, and errors to the target. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

System parameters for InfoSphere CDC for Sybase (version 6.0 and below)

403

Apply process system parameters


Some system parameters adjust the way InfoSphere CDC applies rows, column data, and error handling. See also: convertNotNullableColumns on page 317 D_MIRROR_MIRROR_ERROR_STOP on page 405 D_MIRROR_REFRESH_ERROR_STOP on page 359 FILTER_NOCHANGE_UPDATES_FOR_AUDIT on page 405 NLS_LANG on page 406 TRANSACTION_GROUP_SIZE on page 406 TRANSACTION_INTERVAL on page 407 TRANSACTION_RECORDS_THRESHOLD on page 407 TRIM_CHAR_TO_VARCHAR on page 407 TRIM_VARCHAR_TO_VARCHAR on page 408 TRIM_TO_NULL on page 408

convertNotNullableColumns
Use this system parameter to indicate whether or not NULL values will be converted to default values when replicating data that contains NULL values to non-nullable target columns. Applies ToTarget Set this parameter to one of the following: v OFFAn error message will be generated in Event Log. Replication will continue or not based on whether the MirrorError or RefreshError system parameters are set to END or ON. v ONInfoSphere CDC will automatically insert an appropriate default value in the target column. No error message is generated in Event Log and replication continues. Depending on the convertNotNullableMsg system parameter setting, a warning message may be generated in Event Log. The default value depends on the data type of the subscription column. For example, zero for numeric data types, blank character for character data types, 1901-01-01 for date data types, and so on. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference MirrorError on page 318 RefreshError on page 318 convertNotNullableMsg on page 329

404

InfoSphere Change Data Capture Management Console: Administration Guide

D_MIRROR_MIRROR_ERROR_STOP D_MIRROR_REFRESH_ERROR_STOP on page 359

D_MIRROR_MIRROR_ERROR_STOP
Use this parameter to indicate whether or not mirroring continues after an error has occurred during a row insert, delete, or update operation. Applies ToTarget Set this parameter to one of the following: v ONMirroring stops after an error has occurred. v OFFMirroring continues after an error has occurred. Default SettingON Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference D_MIRROR_REFRESH_ERROR_STOP on page 359

D_MIRROR_REFRESH_ERROR_STOP
Use this system parameter to indicate whether or not InfoSphere CDC should continue to perform a refresh after encountering an error during a row insert operation. Applies ToTarget Set this parameter to one of the following: v ONData refresh stops after an error has occurred. v OFFData refresh continues after an error has occurred. Default SettingON Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference D_MIRROR_REFRESH_ERROR_LIST on page 359 D_MIRROR_MIRROR_ERROR_STOP

FILTER_NOCHANGE_UPDATES_FOR_AUDIT
Use this system parameter to indicate whether or not updates that have identical before and after column images (that is, the row has been updated to the same value), are replicated to the target table for any tables configured for LiveAudit replication. Applies ToSource
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)

405

Set this parameter to one of the following: v OFFIf a row in a source table is updated to the same value, InfoSphere CDC replicates the value to the target table. v ONIf a row in a source table is updated to the same value, InfoSphere CDC does not replicate the value to the target table. This parameter only affects tables that are configured for LiveAudit replication. For non-audit tables, only updates that change the column data are replicated to the target tables. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

NLS_LANG
Use this system parameter to specify the database character set preceded with a period. For more information about setting this system parameter, see your IBM representative. Applies ToSource and Target Default SettingThe database character set, preceded with a period, corresponding to the language selected when the database was installed. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

TRANSACTION_GROUP_SIZE
Use this system parameter to specify the number of complete transactions applied to the database before InfoSphere CDC issues a commit. Use the TRANSACTION_GROUP_SIZE, TRANSACTION_INTERVAL, and TRANSACTION_RECORDS_THRESHOLDS system parameters together. InfoSphere CDC issues a commit after applying the number of transactions specified by the TRANSACTION_GROUP_SIZE, or when the time interval specified by TRANSACTION_INTERVAL has elapsed. Setting only one of these system parameters without the other can result in uncommitted transactions on the target. Applies ToTarget Default Setting500 Minimum Setting0 Guidelines To increase the throughput, set to a number of transactions that would be received when busy during the TRANSACTION_INTERVAL. Note: Use this parameter only if InfoSphere CDC is running under commitment control. The COMMIT_LEVEL system parameter should be set to2 on the target

406

InfoSphere Change Data Capture Management Console: Administration Guide

database, and the MAINTAIN_TRANSACTION_CONSISTENCY system parameter should be set to ON on the source database. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

TRANSACTION_INTERVAL
Use this system parameter to specify the time interval, in seconds, that can elapse between transactions before InfoSphere CDC issues a commit. If there are no transactions received by the target system, then InfoSphere CDC issues a commit immediately. Use this system parameter with the TRANSACTION_GROUP_SIZE system parameter. InfoSphere CDC issues a commit after applying the number of transactions specified by the TRANSACTION_GROUP_SIZE system parameter, or when the time interval specified by TRANSACTION_INTERVAL system parameter has elapsed. Setting only one of these system parameters without the other can result in uncommitted transactions on the target. Applies ToTarget Default Setting1 Minimum Setting0 Guidelines InfoSphere CDC issues a commit only when a commit is received by the target system and you have reached the transaction group size, or exceeded the time interval, or exceeded the records threshold. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

TRANSACTION_RECORDS_THRESHOLD
Use this system parameter to specify the maximum number of operations within a transaction or group of transactions before InfoSphere CDC issues a commit Applies ToTarget Default Setting3000 Minimum Setting0 Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

TRIM_CHAR_TO_VARCHAR
Use this system parameter to specify whether or not trailing blank characters are trimmed from source columns of CHAR data type when replicating data to target columns of VARCHAR data type.

System parameters for InfoSphere CDC for Sybase (version 6.0 and below)

407

Applies ToTarget Set this parameter to one of the following: v OFFTrailing blanks are not trimmed. v ONTrailing blanks are trimmed. If TRIM_TO_NULL =OFF, InfoSphere CDC inserts a single blank character in the target column. If TRIM_TO_NULL =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference TRIM_TO_NULL

TRIM_VARCHAR_TO_VARCHAR
Use this system parameter to specify whether or not trailing blank characters are trimmed from source columns of VARCHAR data type when replicating data to target columns of VARCHAR data type. Applies ToTarget Set this parameter to one of the following: v OFF--Trailing blanks are not trimmed. v ON--Trailing blanks are trimmed. If TRIM_TO_NULL =OFF, InfoSphere CDC inserts a single blank character in the target column. If TRIM_TO_NULL =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference TRIM_TO_NULL

TRIM_TO_NULL
Use this system parameter to specify how source columns that contain blank characters only are handled during data replication. Applies ToTarget Set this parameter to one of the following: v OFFFor data mapped to VARCHAR columns, trailing blanks are trimmed or not to a single blank depending on the TRIM_CHAR_TO_VARCHAR and TRIM_VARCHAR_TO_VARCHAR system parameters. For data mapped to CHAR columns, setting this parameter to OFF has no effect. v ONFor data mapped to CHAR columns, if the target column is nullable, InfoSphere CDC inserts NULL in the column. For CHAR data mapped to VARCHAR columns, if TRIM_CHAR_TO_VARCHAR =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column. For VARCHAR

408

InfoSphere Change Data Capture Management Console: Administration Guide

data mapped to VARCHAR columns, if TRIM_VARCHAR_TO_VARCHAR =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column. If the target column is non-nullable, source columns that contain blank characters only are handled according to the convertNotNullableColumns system parameter. The table below explains how the TRIM_ system parameters affect the data replicated to the target for source columns that contain blank characters only.
TRIM_ parameter settings TRIM_CHAR_ TO_ VARCHAR ON ON OFF OFF ON ON OFF OFF TRIM_ VARCHAR_ TO_ VARCHAR ON OFF ON OFF ON OFF ON OFF TRIM_ TO_ NULL ON ON ON ON OFF OFF OFF OFF Target data CHAR to VARCHAR NULL NULL Source data Source data VARCHAR to VARCHAR NULL Source data NULL Source data Any data type to CHAR NULL NULL NULL NULL Blanks Blanks Blanks Blanks

Single blank Single blank Single blank Source data Source data Source data Single blank Source data

Default SettingOFF Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference TRIM_CHAR_TO_VARCHAR on page 407 TRIM_VARCHAR_TO_VARCHAR on page 408

Cascading replication system parameters


Cascading replication system parameters control InfoSphere CDC cascading replication. See also: PREVENT_RECURSION

PREVENT_RECURSION
Use this parameter to indicate whether or not to prevent cascading replication for bi-directional configurations. Applies ToSource Set this parameter to one of the following: v ONChanges applied by InfoSphere CDC are not be replicated back to the source database from where it came from.

System parameters for InfoSphere CDC for Sybase (version 6.0 and below)

409

v OFFChanges made by InfoSphere CDC are replicated, except when filtered out by the CASCADE_OMIT_TARGETS system parameter. Default SettingON Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

Database journal (trigger) system parameters


Database journal or trigger system parameters let you manage the InfoSphere CDC journal table. See also: REPORT_POSITION_INTERVAL

REPORT_POSITION_INTERVAL
Use this system parameter to specify how often (in seconds) the source informs the target about its position in the current journal during times of no activity. During times of no activity, when there are no journal entries to be processed pertaining to the current subscription, the source informs the target of its current position so that the target can advance its bookmarks accordingly. By specifying a low setting for this parameter, the target can reflect more accurately how far replication has progressed. Applies ToSource After a shutdown and restart, you can use this system parameter to prevent InfoSphere CDC from rereading entries that do not apply to the current replication configuration. The value of this parameter affects the information that is displayed in progress and bookmark messages. A high value for this parameter may result in information that is not up-to-date being displayed. Default Setting5 Minimum Setting1 Maximum Setting300 Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

Maximize throughput system parameters


InfoSphere CDC system parameters allow you to significantly reduce the workload of the target database during mirroring. The InfoSphere CDC apply process groups transactions on the target to reduce the workload. Every commit on the target database will correspond with a commit on the target. However, it may not perform every commit that was done on the source. For example, if the source does three small transactions containing one operation each, the target may commit all three operations as part of a single transaction. You can use this grouping of

410

InfoSphere Change Data Capture Management Console: Administration Guide

system parameters to significantly reduce the resources required by the target database. The default settings are appropriate for most databases, but if your target system has limited resources and an increase in latency is acceptable, you can adjust the settings appropriately. See also: COMMIT_GROUP_SIZE COMMIT_INTERVAL on page 412 SYNCHRONIZATION_COMMIT_ GROUP_SIZE on page 412 SYNCHRONIZATION_INTERVAL on page 413

COMMIT_GROUP_SIZE
Use this system parameter to specify the minimum number of rows InfoSphere CDC should apply to the database before a commit is issued. InfoSphere CDC issues a commit on the target when the transaction that contains the rows completes. Use the COMMIT_GROUP_SIZE and COMMIT_INTERVAL system parameters together. InfoSphere CDC issues a commit when either when the number of rows specified by COMMIT_GROUP_SIZE has been applied to the target, or when the time interval specified by COMMIT_INTERVAL has elapsed. Setting only one of these system parameters without the other can result in uncommitted data on the target. Applies ToTarget Default Setting5000 Minimum Setting0. InfoSphere CDC does not use commit groups to apply data to the target. Guidelines Set this parameter to 0 if D_MIRROR_MIRROR_ERROR_STOP on page 405=OFF. If a rollback occurs, InfoSphere CDC rolls back all outstanding rows in the commit group. Since InfoSphere CDC is set to continue on error, you may lose data. Note: Use this parameter only if InfoSphere CDC is not running under commitment control (COMMIT_LEVEL =0). Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference COMMIT_INTERVAL on page 369 COMMIT_LEVEL on page 368 D_MIRROR_MIRROR_ERROR_STOP on page 358 COMMIT_INTERVAL on page 412 D_MIRROR_MIRROR_ERROR_STOP on page 405

System parameters for InfoSphere CDC for Sybase (version 6.0 and below)

411

COMMIT_INTERVAL
Use this system parameter to specify the time interval between commits, in seconds, to limit the number of commits InfoSphere CDC issues on the target database. Use the COMMIT_GROUP_SIZE and COMMIT_INTERVAL system parameters together. InfoSphere CDC issues a commit when either when the number of rows specified by COMMIT_GROUP_SIZE has been applied to the target, or when the time interval specified by COMMIT_INTERVAL has elapsed. Setting only one of these system parameters without the other can result in uncommitted data on the target. When the COMMIT_INTERVAL time expires, InfoSphere CDC issues a commit on the target database for transactions that completed within that time interval. Applies ToTarget Default Setting60 Minimum Setting0. InfoSphere CDC issues a commit on a target database for each completed transaction. Guidelines Set this parameter to 0 if D_MIRROR_MIRROR_ERROR_STOP on page 405=OFF. If a rollback occurs, InfoSphere CDC rolls back all outstanding rows in the commit group. Since InfoSphere CDC is set to continue on error, you may lose data. Note: Use this parameter only if InfoSphere CDC is not running under commitment control (COMMIT_LEVEL =0). Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference COMMIT_GROUP_SIZE on page 411 D_MIRROR_MIRROR_ERROR_STOP on page 405

SYNCHRONIZATION_COMMIT_ GROUP_SIZE
Use this system parameter to specify the number of transactions applied to the database before InfoSphere CDC performs synchronization between the source and target. Applies ToSource The SYNCRONIZATION_COMMIT_GROUP_SIZE and SYNCHRONIZATION_INTERVAL system parameters are intended to be used together. Synchronization occurs either when the number of transactions (specified by SYNCRONIZATION_COMMIT_GROUP_SIZE) have been applied or when the time interval (specified by SYNCHRONIZATION_INTERVAL) has elapsed, whichever comes first. Default Setting128

412

InfoSphere Change Data Capture Management Console: Administration Guide

Minimum Setting0. InfoSphere CDC does not use commit groups to perform synchronization. Maximum Setting2,147,483,648 (maximum integer) DynamicYes Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference SYNCHRONIZATION_INTERVAL

SYNCHRONIZATION_INTERVAL
Use this system parameter to specify the interval, in seconds, at which synchronization is performed between the source and target. Synchronization is achieved when the target reports to the source the position of the last committed change. Applies ToSource The SYNCRONIZATION_INTERVAL and SYNCHRONIZATION_COMMIT_ GROUP_SIZE system parameters are intended to be used together. Synchronization occurs either when the number of transactions (specified by SYNCHRONIZATION_COMMIT_ GROUP_SIZE ) have been applied or when the time interval (specified by SYNCRONIZATION_INTERVAL) has elapsed, whichever comes first. Default Setting1 Minimum Setting1 Maximum Setting300 DynamicYes Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference SYNCHRONIZATION_COMMIT_ GROUP_SIZE on page 412

Tracing system parameters


Tracing system parameters let you perform diagnostic activities with InfoSphere CDC. See also: D_MIRROR_TRACE on page 414 D_MIRROR_TRACE_FILE_SIZE on page 414 D_MIRROR_TRACE_ON_ERROR on page 414

System parameters for InfoSphere CDC for Sybase (version 6.0 and below)

413

D_MIRROR_TRACE
Use this system parameter to indicate whether or not tracing is enabled. Applies ToSource and Target Set this parameter to one of the following: v OFFTracing is disabled. This setting has no effect when D_MIRROR_TRACE_ON_ERROR=ON. v ONTracing is enabled and InfoSphere CDC creates the appropriate trace files in the log directory. These trace files are encrypted, and are meant to be sent to IBM technical support for troubleshooting purposes. When enabling this setting, also set the size of the trace file to an appropriate value using the D_MIRROR_TRACE_FILE_SIZE system parameter. To avoid disk space problems, IBM recommends setting the size of the trace file to a value that is not too high. Default SettingOFF DynamicYes Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference D_MIRROR_TRACE_FILE_SIZE

D_MIRROR_TRACE_FILE_SIZE
Use this system parameter to specify the maximum size of a trace file in bytes. InfoSphere CDC creates two trace files. When the first trace file reaches its maximum size, InfoSphere CDC creates a second file. When the second trace file reaches its maximum size, InfoSphere CDC starts overwriting the first file. Applies ToSource and Target Default Setting10,000,000 bytes Minimum Setting1,000,000 bytes Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

D_MIRROR_TRACE_ON_ERROR
Use this system parameter to specify whether or not InfoSphere CDC enables tracing automatically when an error occurs. Applies ToSource and Target Set this parameter to one of the following: v OFFInfoSphere CDC does not enable tracing when an error occurs.

414

InfoSphere Change Data Capture Management Console: Administration Guide

v ONInfoSphere CDC enables tracing when an error occurs. InfoSphere CDC creates the appropriate trace files in the InfoSphere CDC log directory. These trace files are encrypted, and are meant to be sent to IBM technical support for troubleshooting purposes. When enabling this setting, also set the size of the trace file to an appropriate value using the D_MIRROR_TRACE_FILE_SIZE system parameter. To avoid disk space problems, IBM recommends setting the size of the trace file to a value that is not too high. Default SettingOFF DynamicYes (on the target only) Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference D_MIRROR_TRACE_FILE_SIZE on page 414

Notification system parameters


Notification system parameters let you control if you should generate InfoSphere CDC messages in the Event Log for specific events. See also: convertNotNullableMsg on page 329 DEADBAND_PERCENTAGE on page 416 DM_STATUS_INTERVAL on page 418 HEARTBEAT_TIMEOUT on page 418 LOG_EMAIL_USERNAME on page 419 MONITOR_SAMPLE_INTERVAL on page 419 STATISTICS_INTERVAL on page 420

convertNotNullableMsg
Use this system parameter to indicate whether or not a warning message will be generated in Event Log each time data that contains NULL values is converted to default values for non-nullable target columns. Applies ToTarget This system parameter applies only when convertNotNullableColumns=ON. Otherwise, this parameter has no effect. Set this parameter to one of the following: v OFFNo warning message is generated in Event Log. v ONA warning message is generated in Event Log each time a NULL value is converted to a default value. Default SettingOFF Related concepts

System parameters for InfoSphere CDC for Sybase (version 6.0 and below)

415

System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference convertNotNullableColumns on page 317 DM_STATUS_INTERVAL on page 330 Heartbeat Timeout on page 331 InvalidNumericMsg on page 331

DEADBAND_PERCENTAGE
Applies ToTarget Identifies the size of the range around each latency threshold setting. Based on latency thresholds defined, a latency message is generated when latency has risen above or fallen below a threshold. Latency is calculated at regular intervals, where the interval is the current setting for the MONITOR_SAMPLE_INTERVAL system parameter. You can set notifications in response to a generated latency message. This system parameter, which is expressed as a percentage, allows you to pad a threshold equally on both sides to create a range around the threshold. By adjusting this system parameter, the size of the range around the threshold can be increased or decreased, and the threshold itself can be made thicker or thinner. A latency message is generated only when latency has risen above the upper limit of the range or fallen below the lower limit of the range. By changing the value assigned to this system parameter, you can control the number of latency messages placed in Event Log. For example, assume that a latency threshold is 5 minutes and this system parameter is set to 10. A 10% range is applied around the 5 minute threshold. The following calculations are performed to determine the lower and upper limits (in minutes) of the range around the threshold: v Padding = 10% of 5 minutes = 0.5 minutes (rounded up to 1 minute) v Padding is rounded up or down to the nearest whole minute: Upper limit of range = 5 minutes + 1 minute (padding) = 6 minutes Lower limit of range = 5 minutes - 1 minute (padding) = 4 minutes As a result, a latency message will be generated only when latency rises above 6 minutes or falls below 4 minutes. Given sample latency over a ten minute period where latency is calculated every minute, three latency messages are generated. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 10%:

416

InfoSphere Change Data Capture Management Console: Administration Guide

If this DEADBAND_PERCENTAGE is set to 3 (the default setting) for the same example, no padding is applied to the latency threshold. Therefore, a latency message is generated each time latency crosses over the latency threshold of 5 minutes. Based on the same sample latency in the previous graph where latency is calculated every minute, five latency messages are generated when this system parameter is set to 3. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 3%:

If the number of latency messages generated over the ten minute period for the 10% (3 latency messages) and 3% (5 latency messages) settings are averages, an additional 288 latency messages would be generated each day if this system parameter is not changed from its default setting to 10%.
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)

417

Since there are two latency thresholds that you can set (a warning threshold and a problem threshold), two separate ranges are defined when padding is at least one minute. In this case, each range is attached to its threshold, and the two ranges can overlap with no change in behavior. If a value outside the acceptable range is specified, the default setting is used. Default Setting3% Minimum Setting3% Maximum Setting10% Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Setting latency thresholds and notifications on page 78 Disk resource system parameters on page 420

DM_STATUS_INTERVAL
Use this system parameter to specify how often progress messages should be issued in seconds. These messages are displayed in Event Log to indicate how replication is advancing and to provide detailed information about InfoSphere CDC replication activities. Applies ToSource and Target Note: Low values of this parameter may result in many messages displayed in Event Log. In this situation, clear Event Log on a regular basis. Default Setting0 seconds. No progress notifications will be issued. Minimum Setting0 seconds. No progress notifications will be issued. Maximum Setting7200 seconds Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

HEARTBEAT_TIMEOUT
Use this parameter to specify the number of minutes of communication inactivity to wait before active InfoSphere CDC processes for a subscription are stopped. Heartbeat is a feature that manages InfoSphere CDC processes when a problem with communications or a process has been detected through the absence of communications over a specified period of time. For each active subscription, internal heartbeat messages are sent regularly between the source and the target to determine communications and process status. If a reply to a message is not received by the source or target within the specified timeout interval, then InfoSphere CDC determines that a problem has occurred, and attempts to stop all its source and target processes for the subscription. In addition, messages (message identifiers 2612 and 3165) are placed in Event Log when heartbeat timeouts occur.

418

InfoSphere Change Data Capture Management Console: Administration Guide

Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Displaying event messages during replication on page 232

LOG_EMAIL_USERNAME
Use this system parameter to specify the user name that receives email messages in response to invoking the dmreadlog command or the warning message that is generated when Event Log exceeds the threshold value set by the LOG_MAX_SIZE system parameter. Applies ToSource and Target In UNIX environments, the value assigned to this parameter is a comma-separated list of user names. The value of this parameter cannot exceed 30 bytes in length. To suppress all email messages, set this parameter to NOMAIL. Default SettingThe InfoSphere CDC account (UNIX user) specified when InfoSphere CDC was installed Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference STATISTICS_INTERVAL on page 420

MONITOR_SAMPLE_INTERVAL
Use this system parameter to identify the period of time, in seconds, between consecutive updates to a storage area that is used to maintain replication latency metrics. Management Console references this area to present replication latency information. Applies ToSource and Target On the target, this setting also represents how often the storage area is sampled to determine whether or not latency has risen above or fallen below specified threshold settings. InfoSphere CDC generates latency messages when latency rises above or falls below the thresholds. In response to a generated message, you can set latency notifications. If a value smaller than the minimum setting is specified, the minimum setting is used. If a value larger than the maximum setting is specified, the maximum setting is used. Default Setting5 seconds
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)

419

Minimum Setting0 seconds. Replication latency metrics are not updated. Maximum Setting3600 seconds Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Setting latency thresholds and notifications on page 78

STATISTICS_INTERVAL
Use this system parameter to specify how often, in seconds, InfoSphere CDC issues messages that contain statistics information. These messages are displayed in Event Log. Applies ToSource and Target Note: Use this parameter only if advised by IBM technical support. Default Setting0. InfoSphere CDC does not provide statistics information. Minimum Setting0. InfoSphere CDC does not provide statistics information. Maximum Setting2,147,483,647 (maximum integer) DynamicYes Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

Disk resource system parameters


Some system parameters control memory usage in InfoSphere CDC. For improved performance, if you are able to allocate more than the default value of 512 MB for the InfoSphere CDC Java Virtual Machine, then you can adjust the disk resource system parameters to use the increased memory. See also: LOG_MAX_SIZE

LOG_MAX_SIZE
Use this system parameter to specify the threshold size of Event Log in KB. A warning message is generated in Event Log when its size exceeds specified threshold. The messages in Event Log are deleted automatically when the size of Event Log is ten times the value specified by this parameter. Applies ToSource and Target If you do not want to specify a threshold size, set this parameter to NOMAX. Default Setting5000 Related concepts

420

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399

Refresh loader system parameters


Some system parameters affect how InfoSphere CDC applies refresh operations. See also: D_HOME_BCP D_MIRROR_BCP D_MIRROR_BCP_ROWS D_MIRROR_FASTBCP on page 422 DM_BCP_PACKET_SIZE on page 422

D_HOME_BCP
Use this system parameter to specify the directory where InfoSphere CDC will place a BCP log file. The log file contains the statements that were used to re-create the indexes after the BCP operation was completed. Applies ToTarget Default Settingthe directory specified by the D_MIRROR_LOG system parameter.

D_MIRROR_BCP
Use this system parameter to indicate if BCP refresh operations are enabled. Under BCP, a block of data is accumulated and applied to target tables in a single operation. InfoSphere CDC accumulates records on the Sybase server, and then performs a bulk copy when the block contains a specific number of records. Applies ToTarget Set this parameter to one of the following: v ONInfoSphere CDC uses the Sybase Bulk Copy (BCP) library to perform data refresh. The bulk copy is generally faster. However, all updates performed under BCP cannot be reversed. v OFFInfoSphere CDC uses SQL inserts to perform data refresh. This setting lets InfoSphere CDC roll back the previous copy operation. Default SettingON Note: To enable InfoSphere CDC to refresh target tables using BCP, make sure that this parameter is set to ON, and that D_MIRROR_FASTBCP is set to OFF. If D_MIRROR_FASTBCP is set to ON as well, then fast BCP refresh is enabled.

D_MIRROR_BCP_ROWS
Use this system parameter to specify the number of rows that the server will buffer before InfoSphere CDC commits to the database in a single operation.You need to

System parameters for InfoSphere CDC for Sybase (version 6.0 and below)

421

consider the amount of storage available to buffer rows. For example, to copy blocks of 500 rows to target tables, you would set D_MIRROR_BCP_ROWS to a value of 500. Applies ToTarget Default Setting50000 rows. If the system parameter D_MIRROR_BCP is set to OFF or if D_MIRROR_BCP_ROWS is set to a negative number, then the server will buffer 50000 rows before InfoSphere CDC commits these blocks to target tables. Note: If you specify a value of zero, then the server will buffer all the rows in the table before committing data to the database.

D_MIRROR_FASTBCP
Use this system parameter to enable or disable fast BCP refresh operations. Fast BCP applies records in blocks, but provides better performance than BCP. Applies ToTarget Set this parameter to one of the following: v ONenables InfoSphere CDC to apply records to target tables using fast BCP. When you enable this parameter, InfoSphere CDC removes all indexes from the target table, loads the data into the table, and then rebuilds the indexes. If InfoSphere CDC cannot rebuild the indexes because of an error (for example, a duplicate value encountered in a unique index) then InfoSphere CDC generates an error in the Event Log and the command to rebuild the index is saved in a file in the log directory. You must also set the D_MIRROR_BCP system parameter to ON to enable fast BCP. v OFFdisables InfoSphere CDC from using fast BCP. Default SettingOFF

DM_BCP_PACKET_SIZE
Use this system parameter to specify the length (bytes) of the network packets you want InfoSphere CDC to send to the Sybase server when a BCP refresh is enabled. The value of this parameter impacts the speed at which the load of data will occur. You should specify network packet sizes larger than the default to improve the performance of BCP refresh operations. Applies ToTarget Default Setting512 bytes Minimum Setting512 bytes Maximum Setting65535 bytes Note: The number of bytes cannot be greater than the maximum network packet size value you have specified for the Sybase database. While Sybase documentation states that this is a negotiated value, the connection will fail if the size specified for this system parameter is larger than the Sybase database setting. Therefore, the maximum value for the Sybase database should be set to a value that allows large packet sizes.

422

InfoSphere Change Data Capture Management Console: Administration Guide

For more information about the Sybase configuration variables related to network communication, see your Sybase documentation.

System parameters for InfoSphere CDC for Sybase (version 6.0 and below)

423

424

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for Sybase (version 6.3 and above)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Note: If you make changes to a system parameter during active replication, you must stop and restart replication for the changes to take effect. In this section, you will learn: Notification system parameters Maximize throughput system parameters on page 426 Encoding system parameters on page 428 Disk resource system parameters on page 429 Apply process system parameters on page 431 Supplemental logging system parameters on page 342

Notification system parameters


Notification system parameters let you control if you should generate InfoSphere CDC messages in the Event Log for specific events. See also: events_max_retain global_shutdown_after_no_heartbeat_response_minutes on page 426 global_conversion_not_possible_warning on page 426

events_max_retain
Use this system parameter when you want InfoSphere CDC to refresh a target table that contains multibyte object names. Set this parameter to one of the following: v trueInfoSphere CDC will not refresh the target table that contains multibyte object names. v falseInfoSphere CDC will refresh a target table that contains multibyte object names. Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above)

Copyright IBM Corp. 2008

425

global_shutdown_after_no_heartbeat_response_minutes
Use this system parameter to specify the duration, in minutes, of communication inactivity before active InfoSphere CDC processes for a subscription are stopped. If a value outside the acceptable range is specified, the default setting is used. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

global_conversion_not_possible_warning
Use this system parameter to control whether or not InfoSphere CDC generates a warning in the Management Console Event Log in the following situations: v Data conversion is not possible for a specific data value. v Converted data types are encountered that are out of range. Set this parameter to one of the following: truegenerates a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. falsedoes not generate a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. Applies ToTarget Default SettingFalse Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

Maximize throughput system parameters


InfoSphere CDC system parameters allow you to significantly reduce the workload of the target database during mirroring. The InfoSphere CDC apply process groups transactions on the target to reduce the workload. Every commit on the target database will correspond with a commit on the target. However, it may not perform every commit that was done on the source. For example, if the source does three small transactions containing one operation each, the target may commit all three operations as part of a single transaction. You can use this grouping of system parameters to significantly reduce the resources required by the target database. The default settings are appropriate for most databases, but if your target system has limited resources and an increase in latency is acceptable, you can adjust the settings appropriately.

426

InfoSphere Change Data Capture Management Console: Administration Guide

See also: global_max_batch_size on page 394 mirror_commit_on_transaction_boundary refresh_commit_after_max_operations on page 428

global_max_batch_size
Use this system parameter to specify the maximum number of rows that InfoSphere CDC can place in an array and apply to the target database during refresh or mirroring. InfoSphere CDC collects rows and places them in an array (in memory) while receiving table-level operations from the source system. InfoSphere CDC applies the rows from the array when there is a change to a different table, when there is a new table-level operation, or when the maximum number of rows in an array has been reached. You can use this parameter during mirroring only if mirror_end_on_error is true and mirror_expected_errors_list is empty. Use only during a refresh if refresh_end_on_error is true and refresh_expected_errors_list is empty. Before InfoSphere CDC places rows into an array, it allocates memory for the maximum number of rows you specify and multiplies this integer by the maximum length of a row. If the maximum number of rows is too large, then InfoSphere CDC cannot allocate enough memory and will shut down. Management Console references this area to present replication latency information. Applies ToTarget InfoSphere CDC for Sybase Default Setting25 rows Minimum Setting1 row

mirror_commit_on_transaction_boundary
This system parameter indicates whether or not the commits that InfoSphere CDC does on the target database will always correspond with a commit that occurred on the source database. If you choose to ignore the commitment control of the source database, InfoSphere CDC allows you to see the partial results of large transactions. Set this parameter to one of the following: v trueDoes not ignore the commitment control of the source database. Only records in a committed transaction are mirrored to the target. This setting provides true transaction consistency by ensuring that only committed transactions are sent to the target. v falseIgnores the commitment control of the source database. This value disables commitment control for transaction processing. No attempt to maintain transaction consistency is performed during mirroring. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

System parameters for InfoSphere CDC for Sybase (version 6.3 and above)

427

refresh_commit_after_max_operations
This system parameter identifies the number of rows comprising each transaction during refresh. To reduce the workload on the target database during refresh, InfoSphere CDC periodically commits the changes to the target database rather than performing the refresh as a single large transaction. Applies ToTarget Default Setting1000 Minimum Setting1 Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

Encoding system parameters


For some system parameters, you can set the default method for treating data in defined Unicode columns, and you can set the default character encoding for your database. See also: global_unicode_as_char on page 341

global_unicode_as_char
This system parameter indicates the default method of treating data in defined Unicode columns. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Set this parameter to one of the following: v trueInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v falseInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain non-single-byte character data. Setting this system parameter to false ensures that InfoSphere CDC handles non-single-byte character data in the same way as previous InfoSphere CDC releases. Note: Setting this parameter to false does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may have to apply user exit programs or other customization to properly represent data in Unicode columns. For more information about user exit programs, see the InfoSphere CDC End-User Documentation for your platform. Applies ToSource Default Settingfalse

428

InfoSphere Change Data Capture Management Console: Administration Guide

Note: The following SQL Server data types are considered to be Unicode columns and are therefore affected by the value assigned to this system parameter: v nchar v nvarchar Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60 Setting multibyte conversionscommon scenarios on page 175 System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

Disk resource system parameters


Some system parameters control memory usage in InfoSphere CDC. For improved performance, if you are able to allocate more than the default value of 512 MB for the InfoSphere CDC Java Virtual Machine, then you can adjust the disk resource system parameters to use the increased memory. See also: global_memory_lob_cache_mb mirror_global_disk_quota_mb mirror_memory_txqueue_each_mb on page 430 mirror_memory_txqueue_total_mb on page 430 mirror_queue_for_buffers_between_cdc_threads_operations on page 430

global_memory_lob_cache_mb
This system parameter controls the amount of memory that will be used to stage LOB values on the target. For optimal performance, this value should be large enough to hold the entire data for the largest LOB values that will be replicated. Default Setting2 Megabytes Applies ToTarget Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

mirror_global_disk_quota_mb
Use this system parameter to globally set a disk quota (in MB) for all capture components (including temporary files, transaction queues, staging stores, and operation queues). InfoSphere CDC will manage disk space utilization across all components as required. Applies ToSource and Target Default Setting0

System parameters for InfoSphere CDC for Sybase (version 6.3 and above)

429

MaximumNone MinimumNone Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

mirror_memory_txqueue_each_mb
This system parameter controls the amount of memory used to stage data on the source. For optimal performance, this system parameter should be large enough to hold the data for the largest transactions that occur on the source. Applies ToSource Default Setting3 Megabytes Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

mirror_memory_txqueue_total_mb
This system parameter controls the amount of memory used to stage data on the source. For optimal performance, this system parameter should be large enough to hold the largest amount of uncommited data that will ever exist in the source database. Applies ToSource Default Setting15 Megabytes Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

mirror_queue_for_buffers_between_cdc_threads_operations
Use this system parameter to set the capacity of InfoSphere CDC queues to store captured changes. The capacity is measured by the number of operations you want the queue to be able to store. This includes insert, update, and delete operations. Applies ToSource Default Setting7 database operations Maximum2 63-1 =9223372036854775807 operations Minimum1 database operation Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

430

InfoSphere Change Data Capture Management Console: Administration Guide

Apply process system parameters


Some system parameters adjust the way InfoSphere CDC applies rows, column data, and error handling. See also: convert_not_nullable_column mirror_end_on_error refresh_end_on_error userexit_max_lob_size_kb on page 432 mirror_expected_errors_list on page 432 refresh_expected_errors_list on page 432 trim_char_to_varchar on page 433 trim_varchar_to_varchar on page 433

convert_not_nullable_column
Use this system parameter to specify whether or not InfoSphere CDC should strip or leave trailing blanks on string data of the column in the target table. Set this parameter to one of the following: v v trueInfoSphere CDC strips the data of trailing blanks. falseInfoSphere CDC does not strip the string data of trailing blanks.

Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

mirror_end_on_error
Use this system parameter to indicate if you want to end mirroring after an apply error occurs on the target database. Set this parameter to one of the following: v trueEnd mirroring after an apply error on the target database. v falseDo not end mirroring after an apply error on the target database. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

refresh_end_on_error
Use this system parameter to indicate if you want to end a refresh after an apply error occurs.
System parameters for InfoSphere CDC for Sybase (version 6.3 and above)

431

Set this parameter to one of the following: v trueEnd a refresh after an apply error occurs. v falseDo not end a refresh after an apply error occurs. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

userexit_max_lob_size_kb
Use this system parameter to set the maximum size of LOB data (in kb) that InfoSphere CDC can pass to a user exit. Applies ToTarget Default Setting128 kb MaximumNone MinimumNone Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

mirror_expected_errors_list
Use this system parameter when you want InfoSphere CDC to ignore specific database errors when applying data changes to the target during mirroring. You must specify the errors in a comma separated list. Applies ToTarget Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

refresh_expected_errors_list
Use this system parameter when you want InfoSphere CDC to ignore specific database errors when refreshing data to the target. You must specify the errors in a comma separated list. Applies ToTarget Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

432

InfoSphere Change Data Capture Management Console: Administration Guide

trim_char_to_varchar
Use this system parameter to specify whether or not InfoSphere CDC should pad string data with trailing blanks to the length of the column in the target table. Set this parameter to one of the following: v trueInfoSphere CDC does not pad the string data with trailing blanks. v falseInfoSphere CDC pads the string data with trailing blanks. Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

trim_varchar_to_varchar
Use this system parameter to specify whether or not InfoSphere CDC should strip or leave trailing blanks on string data of the column in the target table. Set this parameter to one of the following: v trueInfoSphere CDC strips the data of trailing blanks. v falseInfoSphere CDC does not strip the string data of trailing blanks. Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425

Supplemental logging system parameters


Some system parameter control the database logging mechanism used by InfoSphere CDC. See also: mirror_logging_by_empty_triggers on page 342 auto_configure_supplemental_logging mirror_logging_by_empty_triggers on page 434

auto_configure_supplemental_logging
Use this system parameter to specify how supplemental logging is performed. Set this parameter to one of the following: v trueInfoSphere CDC uses the value generated by the mirror_logging_by_empty_triggers system parameter. v falseIf the table is being replicated, InfoSphere CDC does not take any action as this will enable supplemental logging. If the Replication Server is being used, a fake replication subscription is created to signal to ASE that it must write supplementary information necessary for data replication
System parameters for InfoSphere CDC for Sybase (version 6.3 and above)

433

mirror_logging_by_empty_triggers
Use this system parameter to choose empty triggers as your supplemental logging method for Sybase. InfoSphere CDC only uses this system parameter if auto_configure_supplemental_logging is set to true. Set this parameter to one of the following: v true InfoSphere CDC uses an empty trigger as your supplemental logging method for Sybase. v falseYou must create your own triggers in the Sybase database. Applies ToSource Default Settingtrue

434

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with InfoSphere CDC replication configuration. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Notes: v If you make changes to a system parameter during active replication, you must stop and restart replication to for the changes to take effect. v When upgrading to a higher version of InfoSphere CDC, any preexisting settings for system parameters are maintained. In this section, you will learn: General product system parameters Replication system parameters on page 437 Cascading replication system parameters on page 439 Database journal (trigger) system parameters on page 440 Remote journal system parameters on page 442 Commitment control system parameters on page 443 Multibyte character set system parameters on page 444 Latency system parameters on page 445 Notification system parameters on page 447 Data type system parameters on page 450 Date and time column function system parameters on page 450 Row and column filtering system parameters on page 451 Event log system parameters on page 452 Lock detection system parameters on page 453

General product system parameters


General product system parameters let you control basic features of InfoSphere CDC and information you may have specified during installation. See also: Authorization Code on page 436 Enable *MAXOPT3 Option on page 436 Record Format Check on page 436 Startup Timeout on page 315 TCP_KEEPALIVE_SECS on page 437

Copyright IBM Corp. 2008

435

Authorization Code
Use this system parameter to adjust the authorization code issued by IBM. You may need to modify your authorization code when: v Moving from a temporary license to a permanent license v Machine classes have changed v Upgrading to a new version of InfoSphere CDC Applies ToSource and Target Note: You can also modify the authorization using the Authorization Code Setup utility Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Enable *MAXOPT3 Option


For information about setting this system parameter, see your IBM representative. Applies ToSource Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Record Format Check


Use this system parameter to enable or disable InfoSphere CDC from checking record formats of the physical and logical files. Applies ToTarget The Record Format Check system parameter can be set to either *YES or *NO: v *YESEnables InfoSphere CDC to check the record formats of the physical and logical files. Only a physical file that has the same record format as the logical file can be selected as a destination of mirrored data using a unique key. v *NODisables InfoSphere CDC from checking the record formats of the physical and logical files. You can select a physical file to be the destination of mirrored data using a unique key that does not have the same record format as the logical file. Default Setting*YES Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Startup Timeout
For information about setting this system parameter, see your IBM representative. Applies ToSource and Target

436

InfoSphere Change Data Capture Management Console: Administration Guide

Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

TCP_KEEPALIVE_SECS
Use this system parameter to determine the time (in seconds) InfoSphere CDC waits before sending a keep alive notification over the network. During idle periods, InfoSphere CDC sends a keep alive notification to keep the connection open. Applies ToSource and Target Default Setting300 seconds (5 min) Minimum Setting0 Guidelines It is important you set this system parameter when you have a firewall connection that has been configured to timeout. This prevents the firewall from closing the connection. To set this system parameter, do the following: 1. Create a data area named DMCOMMS by issuing the following command: CRTDTAARA DTAARA(<InfoSphere CDC product library>/DMCOMMS) TYPE(*CHAR) LEN(2000) 2. Set the timeout value by issuing the following command: CHGDTAARA DTAARA(<InfoSphere CDC product library>/DMCOMMS (521 10)) VALUE(<value>) where value is a 10-digit number that represents the setting for this system parameter. For example, to set to 1 minute, issue:
CHGDTAARA DTAARA(DMIRROR/DMCOMMS (521 10)) VALUE(0000000060)

To prevent the firewall from closing during active data replication, set this parameter to a value lower than the configured firewall timeout. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Replication system parameters


Replication system parameters let you control how InfoSphere CDC behaves after detecting errors during replication. You can also control how often InfoSphere CDC communicates the status of replication activities, and how InfoSphere CDC should apply a refresh operation. See also: Allow Refresh While Active on page 438 End on Error During Mirroring on page 438 End on Error During Refresh on page 438 Refresh After Restore on page 439
System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)

437

Allow Refresh While Active


Use this system parameter to enable or disable InfoSphere CDC from refreshing a target table while changes are being made to the source table. After InfoSphere CDC completes the refresh, it sends any remaining changes that were made on the source table during the refresh to the target table. Applies ToSource The Allow Refresh While Active system parameter can be set to either *YES or *NO: v *YESEnables InfoSphere CDC to refresh the target table while there are active changes being made on the source table. v *NODisables InfoSphere CDC from performing a refresh when there are active changes being made on the source table. Default Setting*YES Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

End on Error During Mirroring


Use this system parameter to end or continue mirroring when InfoSphere CDC encounters one or more errors. Applies ToTarget The End on Error During Mirroring system parameter can be set to either *YES or *NO: v *YESInfoSphere CDC ends mirroring immediately after it detects an error. v *NOInfoSphere CDC reports the error and continues mirroring after it detects the error. This is the recommended setting for this parameter. Default Setting*NO Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

End on Error During Refresh


Use this system parameter to end or continue a refresh operation after InfoSphere CDC encounters one or more errors. Applies ToTarget The End on Error During Refresh system parameter can be set to either *YES or *NO: v *YESInfoSphere CDC ends a refresh operation immediately after it detects an error. This is the recommended setting for this parameter. v *NOInfoSphere CDC reports the error and continues with the refresh operation after it detects the error.

438

InfoSphere Change Data Capture Management Console: Administration Guide

Default Setting*YES Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Refresh After Restore


Use this system parameter to set when InfoSphere CDC refreshes tables that have been restored. Applies ToSource The Refresh After Restore system parameter can be set to either *IMMED or *DELAY: v *IMMEDInfoSphere CDC starts a Refresh of the restored tables immediately. v *DELAYInfoSphere CDC delays the start of a Refresh of the restored tables until the next time a refresh operation is started. InfoSphere CDC also delays the start of a Refresh Before Mirror. Default Setting*IMMED Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Cascading replication system parameters


Cascading replication system parameters control InfoSphere CDC cascading replication. See also: Enable Cascading Replicates

Enable Cascading Replicates


Use this system parameter to enable or disable cascading replication. Applies ToSource The Enable Cascading Replicates system parameter can be set to either *YES or *NO: v *YESenables InfoSphere CDC to send replicated data from one target system to another target system. v *NOdisables InfoSphere CDC from sending replicated data from one target system to another target system. Default Setting*YES Guidelines Set this system parameter to *NO if there are one or more tables being maintained at the same time on two servers. Related concepts
System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)

439

System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Database journal (trigger) system parameters


Database journal or trigger system parameters let you manage the InfoSphere CDC journal table. See also: Default Journal Library Default Journal Name Report Position Interval on page 322 Synchronization Interval on page 322

Default Journal Library


Use this system parameter to identify the library where the default InfoSphere CDC journal resides. For more information about journals, see InfoSphere CDC for AS/400 Commands Reference. Applies ToSource The Default Journal Library system parameter can be set to either the name of the library, *LIBL, or *CURLIB: v The name of a library. v *LIBLSpecifies the set of libraries in your library list. The libraries are searched in order for the first occurrence of the specified default journal. v *CURLIBSpecifies the current library. Default Setting*CURLIB . Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Default Journal Name


Use this system parameter to identify the name of the InfoSphere CDC default journal. By default, tables mirrored by InfoSphere CDC use this journal. For more information about journals, see InfoSphere CDC for AS/400 Commands Reference. Applies ToSource Default SettingDMCJRN Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

440

InfoSphere Change Data Capture Management Console: Administration Guide

Report Position Interval


Use this system parameter to set how often (in milliseconds) InfoSphere CDC informs the target system about its log position. When the source system is in idle mode and there are no log entries for the subscription, the source system informs the target system of its current log position. The target system uses this information to advance its bookmarks. Applies ToSource Default Setting5000 milliseconds (5 seconds) Minimum Settings1000 milliseconds (1 second) Maximum Settings300000 milliseconds (5 minutes) Guidelines v If the number of milliseconds is set low, then the target system can provide accurate progress notifications that indicate how far replication has progressed. v If the number of milliseconds is set high, it may affect the accuracy of the information displayed in progress and bookmark notifications. Notes: v If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. v This system parameter can also prevent InfoSphere CDC from rereading log entries that do not apply to the table currently being replicated. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Synchronization Interval
Use this system parameter to set how often (in seconds) InfoSphere CDC performs log synchronization between the source and the target. Synchronization is achieved when the source reports to the target the position of the last committed change. Applies ToSource Default Setting60 seconds Minimum Settings1 second Maximum Settings3000 seconds (50 minutes) Guidelines If you are replicating large volumes of data, set this system parameter to a lower number of seconds to remove obsolete logs more frequently.

System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)

441

Note: If a value outside the acceptable range is specified, the default setting is used. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Remote journal system parameters


Remote journal system parameters let you control if InfoSphere CDC uses remote or local journaling when running source replication activities. See also: Data Origin TCP/IP Name Data Origin Port Relational Database Directory Entry on page 443

Data Origin TCP/IP Name


Use this system parameter to enable InfoSphere CDC Management Console and InfoSphere CDC (installed on the InfoSphere CDC/400 Source System) to use the IP address or hostname of the InfoSphere CDC/400 Data Origin Server (where your source files reside). Applies ToInfoSphere CDC/400 Data Origin Server v IP AddressEnables InfoSphere CDC Management Console to use the IP address or hostname of the InfoSphere CDC/400 Data Origin Server. This lets InfoSphere CDC (installed on the InfoSphere CDC/400 Source System) to retrieve source files from the InfoSphere CDC/400 Data Origin Server. The value can be either the hostname or the IP address of the InfoSphere CDC/400 Data Origin Server. v *LOCAL InfoSphere CDC Management Console uses the IP address or hostname of the InfoSphere CDC/400 Source System. Setting this system parameter to *LOCAL disables InfoSphere CDC from performing replication activities with a remote journal. Default Setting*LOCAL Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Data Origin Port


Use this system parameter to enable InfoSphere CDC Management Console and InfoSphere CDC (installed on the InfoSphere CDC/400 Source System) to use the port number of the InfoSphere CDC/400 Data Origin Server. The value that you specify for this system parameter must match the TCP listener port number of the InfoSphere CDC/400 Data Origin Server. Applies ToInfoSphere CDC/400 Data Origin Server

442

InfoSphere Change Data Capture Management Console: Administration Guide

Default Setting0 GuidelinesYou must enable the Data Origin TCP/IP Name system parameter to either the IP address or the hostname of the InfoSphere CDC/400 Data Origin Server for this system parameter to take affect.

Relational Database Directory Entry


Use this system parameter to specify the relational database directory entry added to the InfoSphere CDC/400 Source System which references the relational database directory entry on the InfoSphere CDC/400 Data Origin Server. Applies ToInfoSphere CDC/400 Data Origin Server Default Setting*NONE GuidelinesYou must enable the Data Origin TCP/IP Name system parameter to either the IP address or the hostname of the InfoSphere CDC/400 Data Origin Server for this system parameter to take affect.

Commitment control system parameters


Commitment control system parameters let you control how InfoSphere CDC issues commits to the target system. See also: Commitment Control

Commitment Control
Use this system parameter to enable or disable InfoSphere CDC from using commitment control. Enabling commitment control maintains transaction consistency during replication and ensures that all transactions are applied to the target system. If there is a communications or server failure, and you have enabled this system parameter, then InfoSphere CDC rolls back the partially applied transaction to the last commit. For more information about commitment control, see Considerations for Commitment Control (*LEVEL1) in InfoSphere CDC for AS/400 Commands Reference. Applies ToTarget The Commitment Control system parameter can be set to *NONE or *LEVEL1: v *NONEDisables commitment control for transaction processing. InfoSphere CDC does not maintain transaction consistency during replication and in the event of a communications or server failure. To ensure consistency across different platforms and previous releases of InfoSphere CDC, disabling commitment control is the default setting for this parameter. v *LEVEL1Enables InfoSphere CDC to use commitment control against the target system after applying all rows. This setting provides true transaction consistency by ensuring that entire transactions are committed to the target database even in the event of a communications or server failure. Default Setting*NONE

System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)

443

Guidelines If you select *LEVEL1, you must disable the system parameter Refresh While Active on the source. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435 Related reference Allow Refresh While Active on page 438

Multibyte character set system parameters


Multibyte character set system parameters let you control how InfoSphere CDC treats character sets during replication. See also: Unicode Handling

Unicode Handling
Use this system parameter to indicate the default method of treating data in defined Unicode columns. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Applies ToSource The following DB2 UDB for iSeries data types are considered to be Unicode columns and are affected by the value assigned to this system parameter: v GRAPHIC or VARGRAPHIC with code page 1208 (UTF-8) v CHARACTER or VARCHAR with code page 1208 (UTF-8) This system parameter is set to either CHAR or NOCHANGE: v CHARInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v NOCHANGEInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain non-single-byte character data. NOCHANGE ensures InfoSphere CDC will handle non-single-byte character data in the same way as previous InfoSphere CDC releases. Default SettingNOCHANGE Note: NOCHANGE does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may need to apply user exit programs or other customization to properly represent the data in Unicode columns. For more information about user exit programs, see the InfoSphere CDC for AS/400 User Exits Guide. Related concepts

444

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435 Related tasks To set handling for Unicode character encodings on page 177

Latency system parameters


Latency system parameters let you control how often InfoSphere CDC generates a latency notification and updates latency statistics in the Event Log. See also: Deadband Percentage Monitor Sample Interval on page 329

Deadband Percentage
Applies ToTarget Identifies the size of the range around each latency threshold setting. Based on latency thresholds defined, a latency message is generated when latency has risen above or fallen below a threshold. Latency is calculated at regular intervals, where the interval is the current setting for the MONITOR_SAMPLE_INTERVAL system parameter. You can set notifications in response to a generated latency message. This system parameter, which is expressed as a percentage, allows you to pad a threshold equally on both sides to create a range around the threshold. By adjusting this system parameter, the size of the range around the threshold can be increased or decreased, and the threshold itself can be made thicker or thinner. A latency message is generated only when latency has risen above the upper limit of the range or fallen below the lower limit of the range. By changing the value assigned to this system parameter, you can control the number of latency messages placed in Event Log. For example, assume that a latency threshold is 5 minutes and this system parameter is set to 10. A 10% range is applied around the 5 minute threshold. The following calculations are performed to determine the lower and upper limits (in minutes) of the range around the threshold: v Padding = 10% of 5 minutes = 0.5 minutes (rounded up to 1 minute) v Padding is rounded up or down to the nearest whole minute: Upper limit of range = 5 minutes + 1 minute (padding) = 6 minutes Lower limit of range = 5 minutes - 1 minute (padding) = 4 minutes As a result, a latency message will be generated only when latency rises above 6 minutes or falls below 4 minutes. Given sample latency over a ten minute period where latency is calculated every minute, three latency messages are generated. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 10%:

System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)

445

If this DEADBAND_PERCENTAGE is set to 3 (the default setting) for the same example, no padding is applied to the latency threshold. Therefore, a latency message is generated each time latency crosses over the latency threshold of 5 minutes. Based on the same sample latency in the previous graph where latency is calculated every minute, five latency messages are generated when this system parameter is set to 3. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 3%:

If the number of latency messages generated over the ten minute period for the 10% (3 latency messages) and 3% (5 latency messages) settings are averages, an additional 288 latency messages would be generated each day if this system parameter is not changed from its default setting to 10%.

446

InfoSphere Change Data Capture Management Console: Administration Guide

Since there are two latency thresholds that you can set (a warning threshold and a problem threshold), two separate ranges are defined when padding is at least one minute. In this case, each range is attached to its threshold, and the two ranges can overlap with no change in behavior. If a value outside the acceptable range is specified, the default setting is used. Default Setting3% Minimum Setting3% Maximum Setting10% Note: If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Monitor Sample Interval


Use this system parameter to set how often (in seconds) InfoSphere CDC updates replication latency metrics. InfoSphere CDC samples the target system to determine if latency has risen above or fallen below the specified threshold settings. Applies ToSource and Target Default Setting5 seconds Minimum Setting0 seconds. Replication latency metrics are not updated. Maximum Setting3600 seconds (one hour) Notes: v InfoSphere CDC generates latency notifications when latency rises above or falls below the thresholds and places these in the Event Log. v If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts Setting latency thresholds and notifications on page 78 System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Notification system parameters


Notification system parameters let you control if you should generate InfoSphere CDC messages in the Event Log for specific events. See also: Heartbeat Timeout on page 448
System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)

447

Messages on Column Not Null Capable Messages on Invalid Numerics on page 449 Progress Status Interval on page 449

Heartbeat Timeout
Use this system parameter to increase or decrease the communication timeout interval (in minutes) before InfoSphere CDC detects a communication problem and attempts to stop active replication processes. InfoSphere CDC sends internal heartbeat notifications between the source and target systems to verify communications and the status of replication processes for each active subscription. If the source or target do not receive a reply to a notification within the specified timeout interval, then InfoSphere CDC determines that a problem has occurred and attempts to stop all its source and target processes for each active subscription. InfoSphere CDC places notifications (message identifiers DMU3165 and DMU0647) in the Event Log when a heartbeat timeout occurs. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Note: If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Messages on Column Not Null Capable


Use this system parameter to enable or disable InfoSphere CDC from generating a message each time it attempts to replicate NULL to a target column that is non-nullable. Applies ToTarget The Messages on Column Not Null Capable system parameter can be set to either *YES or *NO: v *YESEnables InfoSphere CDC to generate a message each time it attempts to replicate NULL to a target column that is non- nullable. v *NODisables InfoSphere CDC from generating a message each time it attempts to replicate NULL to a target column that is non-nullable. For all instances, you are notified by a message. Default Setting*YES Related concepts

448

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Messages on Invalid Numerics


Use this system parameter to enable or disable InfoSphere CDC from generating a message each time it detects an invalid numeric field. Applies ToTarget The Messages on Invalid Numerics system parameter can be set to either *YES, *NO, or *NB: v *YESInfoSphere CDC generates a message for each invalid numeric field detected. *NOInfoSphere CDC does not generate a message for each invalid numeric field detected. If you are sure that numeric data does not have to be validated, set this parameter to *NO to maintain existing performance levels. v *NBInfoSphere CDC does not generate a message when blank or uninitialized numeric fields are detected. Messages for other types of invalid numeric data are still generated. v Default Setting*YES Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435 Related reference Numeric Column Validation on page 450

Progress Status Interval


Use this system parameter to set how often (in seconds) InfoSphere CDC issues progress notifications. InfoSphere CDC generates notifications on the source and target and these provide information about replication activities. On the v The v The v The On the v The v The v The source, progress notifications identify: bookmark sent by the source corresponding log name subscription name to which the bookmark was sent target, progress notifications identify: bookmark received by the target corresponding log name source ID from which the bookmark was received

Applies ToSource and Target Default Setting0 seconds. No progress messages are issued. Minimum Setting0 seconds Maximum Setting7200 seconds

System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)

449

Notes: v InfoSphere CDC places progress notifications in the Event Log. v If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Data type system parameters


Data type system parameters let you control how InfoSphere CDC handles certain data types. See also: Numeric Column Validation

Numeric Column Validation


Use this system parameter to enable or disable InfoSphere CDC from checking decimal and numeric columns for valid formats before applying numeric data to the target table. Applies ToTarget The Numeric Column Validation system parameter can be set to either *YES or *NO: v *YESEnables InfoSphere CDC to validate invalid packed/zoned data before applying it to the target table. If invalid packed/zoned data is found, then InfoSphere CDC generates a message is generated set the field to 0 automatically. v *NODisables InfoSphere CDC from validating packed/zoned data before applying it to the target table. If you are sure that numeric data does not have to be validated, set this parameter to *NO to maintain existing performance levels. Default Setting*YES Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Date and time column function system parameters


Date and time column function system parameters let you control how InfoSphere CDC handles date and time in tables. See also: Default Date On Error

Default Date On Error


Use this system parameter to set which date InfoSphere CDC returns when an invalid date is passed to the %TODATE column function. Applies ToTarget

450

InfoSphere Change Data Capture Management Console: Administration Guide

The Default Date On Error system parameter can be set to *NEW or *OLD: v *NEWReturns the date 1901-01-01. v *OLDReturns the date 0001-01-01. Default Setting*NEW Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435 Related reference Date conversion%TODATE on page 275

Row and column filtering system parameters


Row and column filtering system parameters let you control what kind of data InfoSphere CDC applies to the target system. See also: Audit Filtered Transactions Critical Column Filtering on page 452

Audit Filtered Transactions


Use this system parameter to set which images you want to audit after InfoSphere CDC applies a row update that satisfies a row-filtering expression. By default, InfoSphere CDC audits both the before and after images after applying a row update that satisfies a row-filtering expression. Applies ToSource The Audit Filtered Transactions system parameter can be set to either *YES or *NO: v *YESAudits both the before and after images when a row update results in only one of these images satisfying a defined row-filtering expression. v *NOAudits only the after image that satisfies or does not satisfy a defined row-filtering expression. Default Setting*YES Guidelines v You can use this system parameter to override a row-filtering expression when it is necessary to audit both before and after images in the target table, but only one of these images satisfies the row-filtering expression. In this scenario, you can use two journal codes (FP and FB) to identify the images in the target audit table that do not satisfy the row-filtering expression. You may want to enable this system parameter to *YES when: v Using LiveAudit to audit changes made on the source table. v Recording both the before and after images in the target audit table when a row update operation is applied to the assigned publication table. v Using row-filtering expressions to filter rows placed in the target audit table. Notes: v Previous releases of InfoSphere CDC do no support this system parameter.
System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)

451

v The listed default setting (*YES) applies only to new InfoSphere CDC installations on an iSeries server. The default setting for InfoSphere CDC upgrades is *NO. This setting maintains existing InfoSphere CDC behavior prior to support for this system parameter. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435 About journal control fields on page 245

Critical Column Filtering


Use this system parameter to enable critical column selection. Applies ToSource The Critical Column Filtering system parameter can be set to either *YES or *NO: v *YESEnables critical column selection. v *NODisables critical column selection. Default Setting*NO Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

Event log system parameters


Event log system parameters let you control how InfoSphere CDC interacts with notify message queues. See also: Notify Message Queue Notify Message Queue Library on page 453 Notify Message Threshold on page 453

Notify Message Queue


Use this system parameter to identify the name of the message queue that InfoSphere CDC uses to send notifications when the number of errors exceeds the notify message threshold system parameter. Applies ToSource and Target Default SettingQSYSOPR Note: You can set the notify message threshold using the Notify Message Threshold system parameter. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435 Related reference Notify Message Threshold on page 453

452

InfoSphere Change Data Capture Management Console: Administration Guide

Notify Message Queue Library


Use this system parameter to identify the name of the library where the notify message queue resides. Applies ToSource and Target You can set the Notify Message Queue Library system parameter to one of the following: v The name of a library v *LIBLSpecifies the set of libraries in your library list. The libraries are searched in order for the first occurrence of the specified message queue. v *CURLIBSpecifies the current library. Default Setting*LIBL Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435 Related reference Notify Message Queue on page 452

Notify Message Threshold


Use this system parameter to identify the number of errors that InfoSphere CDC generates before it sends a notification to the notify message queue. Applies ToSource and Target Default Setting1 error Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435 Related reference Notify Message Queue on page 452

Lock detection system parameters


Lock detection system parameters let you control how InfoSphere CDC applies data when it detects a locked table or row. See also: Lock Timeout Value

Lock Timeout Value


Use this system parameter to set the amount of time (in seconds) that InfoSphere CDC waits before attempting to modify a locked user or metadata table. When InfoSphere CDC attempts to modify a locked table, it places a notification in the Event Log. These notifications identify the specific table and row that InfoSphere CDC could not modify. Applies ToSource and Target
System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)

453

Default Setting30 seconds Minimum Setting2 seconds Maximum Setting60 seconds Notes: v If a table or row is locked, InfoSphere CDC waits for a specified timeout period to expire before attempting to apply data again. v If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435

454

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and target datastores. Note: If you make changes to a system parameter during active replication, you must stop and restart replication for the changes to take effect. When upgrading to a higher version of InfoSphere CDC, any pre-existing settings for system parameters are maintained. In this section, you will learn: General product system parameters Access Server system parameters on page 458 Cascading replication system parameters on page 461 Commitment control system parameters on page 461 Database translation log system parameters on page 464 Fastload system parameters on page 465 Latency system parameters on page 468 Lock detection system parameters on page 469 Multibyte character set system parameters on page 470 Notification system parameters on page 471 Replication system parameters on page 472 Tracing system parameters on page 474 Teradata TPump system parameters on page 475

General product system parameters


General product system parameters let you control basic features of InfoSphere CDC and information you may have specified during installation. See also: audit_auth_ code on page 456 auth_ code on page 456 db_password on page 456 db_user on page 456 debug on page 457 engine_ port on page 457 log_file_quota on page 457
Copyright IBM Corp. 2008

455

log_total_quota on page 457 md_db_url on page 457 md_schema on page 457 scrape_timeout on page 457 startup_timeout on page 457 target_assert on page 458 target_debug on page 458 target_initial_codepage on page 458 ts_password on page 458 ts_product on page 458 use_uni_listener on page 458

audit_auth_ code
This system parameter identifies the authorization code used to enable the LiveAudit feature in InfoSphere CDC. When assigning the authorization code to this system parameter, authorization codes are case-sensitive; therefore, the code assigned to this parameter must be identical to the one obtained from IBM. Applies ToSource and Target for InfoSphere CDC for PointBase and InfoSphere CDC for DB2 UDB Does Not Apply ToInfoSphere CDC for Teradata Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

auth_ code
This system parameter identifies the authorization code that is required to replicate and receive data with InfoSphere CDC. When assigning the authorization code to this system parameter, authorization codes are case-sensitive; therefore, the code assigned to this parameter must be identical to the one obtained from IBM. Applies ToSource and Target for InfoSphere CDC for PointBase and InfoSphere CDC for DB2 UDB Does Not Apply ToInfoSphere CDC for Teradata Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

db_password
For information about setting this system parameter, see your IBM representative.

db_user
For information about setting this system parameter, see your IBM representative.

456

InfoSphere Change Data Capture Management Console: Administration Guide

debug
For information about setting this system parameter, see your IBM representative.

engine_ port
This system parameter identifies the port number on the server that is being used for communications with client workstations running Management Console and other replication servers. This port number was specified during InfoSphere CDC installation. It can be changed by modifying this system parameter or using the Change Listener Port utility. For more information about this utility, see the appropriate InfoSphere CDC installation and user manual. The port number that you specify must be unused, and the same port number cannot be used for any other application installed on the same server. Applies ToSource and Target for InfoSphere CDC for DB2 UDB, Target only for InfoSphere CDC for Teradata and InfoSphere CDC for PointBase Default Setting11111 Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

log_file_quota
For information about setting this system parameter, see your IBM representative.

log_total_quota
For information about setting this system parameter, see your IBM representative.

md_db_url
For information about setting this system parameter, see your IBM representative.

md_schema
For information about setting this system parameter, see your IBM representative.

scrape_timeout
For information about setting this system parameter, see your IBM representative.

startup_timeout
This system parameter specifies the maximum waiting period, in seconds, for process handling to complete during InfoSphere CDC startup. This system parameter indicates how long the communication module waiInfoSphere CDC for the database initialization program to start before timing out.

System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)

457

Applies ToSource and Target for InfoSphere CDC for DB2 UDB and InfoSphere CDC for PointBase, Target only for InfoSphere CDC for Teradata Default Setting120 seconds Minimum Setting60 seconds Maximum Setting3,600 seconds Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

target_assert
For information about setting this system parameter, see your IBM representative.

target_debug
For information about setting this system parameter, see your IBM representative.

target_initial_codepage
For information about setting this system parameter, see your IBM representative.

ts_password
For information about setting this system parameter, see your IBM representative.

ts_product
For information about setting this system parameter, see your IBM representative.

use_uni_listener
For information about setting this system parameter, see your IBM representative.

Access Server system parameters


Access Server system parameters are for managing Access Server. See also: accessserver_udp_ listenport on page 459 agent_assert on page 459 agent_debug on page 459 agent_jdbcdb2_driver on page 459 agent_jdbcdb2_driver_net on page 459 agent_jdbcpb_driver on page 459 agent_jdbcpb_driver_net on page 459 agent_max_connections_num on page 460 agent_message_version on page 460

458

InfoSphere Change Data Capture Management Console: Administration Guide

agent_msg_resources_file on page 460 agent_src_engine_address on page 460 agent_src_engine_port on page 460 agent_src_engine_socket_tmout on page 460 agent_trace_in_message on page 460 agent_trace_out_message on page 460 agent_udp_ listenport on page 460

accessserver_udp_ listenport
This system parameter identifies the UDP listener port number used by Access Server to receive auto-discovery broadcast InfoSphere CDC from different datastores in your configuration. The port number that you specify must not already be in use on the client workstation, and must be the same port number specified in Management Console when logging on. If the port number is changed on a client workstation running Management Console, this system parameter must be set to the updated port number. Applies ToSource and Target for InfoSphere CDC for DB2 UDB, Source only for InfoSphere CDC for PointBase, Target only for InfoSphere CDC for Teradata Default Setting10101 Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

agent_assert
For information about setting this system parameter, see your IBM representative.

agent_debug
For information about setting this system parameter, see your IBM representative.

agent_jdbcdb2_driver
For information about setting this system parameter, see your IBM representative.

agent_jdbcdb2_driver_net
For information about setting this system parameter, see your IBM representative.

agent_jdbcpb_driver
For information about setting this system parameter, see your IBM representative.

agent_jdbcpb_driver_net
For information about setting this system parameter, see your IBM representative.

System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)

459

agent_max_connections_num
For information about setting this system parameter, see your IBM representative.

agent_message_version
For information about setting this system parameter, see your IBM representative.

agent_msg_resources_file
For information about setting this system parameter, see your IBM representative.

agent_src_engine_address
For information about setting this system parameter, see your IBM representative.

agent_src_engine_port
For information about setting this system parameter, see your IBM representative.

agent_src_engine_socket_tmout
For information about setting this system parameter, see your IBM representative.

agent_trace_in_message
For information about setting this system parameter, see your IBM representative.

agent_trace_out_message
For information about setting this system parameter, see your IBM representative.

agent_udp_ listenport
This system parameter identifies the port number on the replication server used by the UDP listener for auto-discovery broadcasts sent from Access Server. The port number that you specify must be unique. Applies ToSource and Target for InfoSphere CDC for DB2 UDB and InfoSphere CDC for PointBase, Target only for InfoSphere CDC for Teradata Default Setting2222 Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

460

InfoSphere Change Data Capture Management Console: Administration Guide

Cascading replication system parameters


Cascading replication system parameters control InfoSphere CDC cascading replication. See also: cascade_replication

cascade_replication
This system parameter indicates whether or not replicated data received from the source can be replicated (or cascaded) to other servers. This system parameter is set on the server that receives replicated data and can cascade the data to one or more other servers. It is applicable when implementing cascading replication. Applies ToSource for InfoSphere CDC for DB2 UDB, Source and Target for InfoSphere CDC for PointBase Does Not Apply ToInfoSphere CDC for Teradata Set this parameter to one of the following: v NPrevent replicated data received from the source from being cascaded to other servers. v YAllow replicated data received from the source to be cascaded to other servers. Default SettingY Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

Commitment control system parameters


Commitment control system parameters let you control how InfoSphere CDC issues commits to the target system. See also: commit_group_size commit_ interval on page 462 refresh_commit_ block_size on page 463 scraper_trans_ num_limit on page 463 target_default_commit_level on page 464

commit_group_size
This system parameter specifies the number of rows that must be applied to the target database before a commit is issued. Normally, commits issued to the target database are in response to commits issued by applications running on the source. This system parameter should only be used when you want manage commits by controlling how often they are issued to the
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)

461

target database. This approach can be used to reduce the overhead of frequent commits to the database. However, managing commits in this manner may result in inconsistent data in the source and target databases over time. To manage commits to the target database by setting the commit group size, you must disable commitment control on the target, by setting the target_default_commit_level on page 464 system parameter. To properly calibrate database commits in your environment, you must work with this system parameter and the dobatch on page 472 system parameter. If the commit interval frequently expires before a commit group with the specified number of applied rows has been formed, a smaller number of rows are committed. In this case, you can decrease the commit group size or increase the commit interval. However, when a commit group contains an insufficient number of applied rows for it to be committed, you must set the commit interval to ensure data is committed within a reasonable period of time. If this system parameter is set to 0, then: v Commits are issued at regular intervals when a non-zero commit interval is specified. v A commit is issued for each applied row when a zero commit interval is specified. When commit_group_size and dobatch on page 472 are both set to zero, InfoSphere CDC internally sets this system parameter to 1 row (default setting) to ensure commits are issued. Applies ToTarget, InfoSphere CDC for DB2 UDB only Default Setting1 row. A commit is issued for each applied row. Minimum Setting0 Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

commit_ interval
This system parameter specifies the amount of time, in seconds, between consecutive commits issued to the target database. Normally, commits issued to the target database are in response to commits issued by applications running on the source. This system parameter should only be used when you want to manage commits by controlling how often they are issued to the target database. This approach can be used to reduce the overhead of frequent commits to the database. However, managing commits in this manner may result in inconsistent data in the source and target databases over time. To manage commits to the target database by setting the interval between consecutive commits, you must disable commitment control on the target, by setting the target_default_commit_level on page 464 system parameter. To properly calibrate database commits in your environment, you must work with this system parameter and the commit_group_size on page 461 system parameter. For commit groups that have an insufficient number of applied rows for a commit to be issued, use this system parameter to prevent applied rows in the commit group from being uncommitted for a long period of time. In particular, you can use it to force commits during periods of transaction inactivity. However,

462

InfoSphere Change Data Capture Management Console: Administration Guide

if you set the commit interval so that it frequently expires before a commit group with the specified number of applied rows has been formed, a smaller number of rows are committed. In this case, you can increase the commit interval or decrease the commit group size. If this system parameter is set to 0, then: v A commit is issued every 5 seconds (default setting) when the size of the commit group is more than one row. In this case, InfoSphere CDC internally sets this system parameter to 5 seconds (default setting) to ensure that a commit group which cannot be committed due to an insufficient number of applied rows is committed in 5 seconds. v A commit is issued for each applied row when a zero commit group size is specified. When commit_group_size and dobatch on page 472 are both set to zero, InfoSphere CDC internally sets commit_group_size to 1 row (default setting) to ensure commits are issued. Applies ToTarget, InfoSphere CDC for DB2 UDB only Default Setting5 seconds Minimum Setting0 Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

refresh_commit_ block_size
This system parameter identifies the number of records to be inserted into a target table during a refresh operation before a commit is issued to make those records persistent. If the tables that you are replicating are relatively large, it is recommended that you increase the block size to improve performance. Applies ToTarget Default Setting1,000 records Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

scraper_trans_ num_limit
This system parameter identifies the number of row level entries that are staged in memory before they are sent to the target. This parameter should be set to the largest commitment cycle size on your server. Commitment cycle size is the number of transactions in one commitment cycle. For example, the size of the following commitment cycle is six:
insert insert insert insert insert commit into into into into into <table> <table> <table> <table> <table> <values> <values> <values> <values> <values>

System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)

463

Applies ToSource, InfoSphere CDC for DB2 UDB only Default Setting1,000,000 row level entries Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

target_default_commit_level
This system parameter indicates the commitment control level for transactions applied on the target. Applies ToTarget, InfoSphere CDC for DB2 UDB and InfoSphere CDC for PointBase Does Not Apply ToInfoSphere CDC for Teradata Set this parameter to one of the following: v 2A commit to the target database is performed when all records in a transaction have been received and applied. This setting provides true transaction consistency by ensuring that entire transactions are committed to the target database. If a communications or server failure occurs, a partially applied transaction in the target database is rolled back to the last transaction that was committed. v 0Disables commitment control for transaction processing. No attempt to maintain transaction consistency is performed during mirroring. Default Setting2 Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

Database translation log system parameters


Database transaction log system parameters let you control how InfoSphere CDC cleans the logs of the distribution database. You can also control often InfoSphere CDC reports its log position to the target and performs log synchronization between the source and the target. See also: report_position_interval

report_position_interval
This system parameter specifies how often, in seconds, the source informs the target about its position in the current log during inactive periods. During inactive periods, when there are no log entries pertaining to the current subscription, the source informs the target of its current position so that the target can advance its bookmarks accordingly. By specifying a low setting for this parameter, the target

464

InfoSphere Change Data Capture Management Console: Administration Guide

can reflect more accurately how far replication has progressed. This system parameter can also prevent the reprocessing of entries that do not apply to the table currently being replicated. The value of this parameter affects the information that is displayed in Management Console. A high setting for this parameter may result in presented information that is not up-to-date. Applies ToSource, InfoSphere CDC for DB2 UDB and InfoSphere CDC for PointBase Does Not Apply ToInfoSphere CDC for Teradata Default Setting5 seconds Minimum Setting1 second Maximum Setting300 seconds Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

Fastload system parameters


Fastload system parameters allow you to configure the Teradata Fastload utility. InfoSphere CDC for Teradata uses the Fastload utility to load replicated data into Teradata databases. See also: del_fastload_file dofastload on page 466 fastload_backup_path on page 466 fastload_in_whole on page 467 fastload_path on page 467 make_fastload_log_file on page 467 max_fastload_ file_size on page 468

del_fastload_file
This system parameter indicates whether or not Teradata FastLoad files are deleted after using the utility to refresh data in a Teradata database under standard replication. You can keep these files for future reference or delete them to increase available disk space. To refresh data in a Teradata database using the Teradata FastLoad utility, set dofastload =Y. For more information about the Teradata FastLoad utility, see your Teradata documentation. Applies ToTarget, InfoSphere CDC for Teradata only Set this parameter to one of the following:

System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)

465

v NKeep the Teradata FastLoad files after data has been refreshed in a Teradata database. v YDelete the Teradata FastLoad files after data has been refreshed in a Teradata database. Default SettingY Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

dofastload
This system parameter enables or disables a Fast Bulk Copy (BCP) refresh. Generally, a BCP refresh provides a better level of performance than a batch refresh (see dobatch on page 472) or the standard row-by-row refresh. Applies ToTarget, InfoSphere CDC for DB2 UDB and InfoSphere CDC for Teradata Does Not Apply ToInfoSphere CDC for PointBase Set this parameter to one of the following: v NDo not perform a BCP refresh. v YPerform a BCP refresh. In addition, you must: 1. Set the fastload_path on page 467 system parameter to the path of the temporary file. 2. Set the fastload_backup_path system parameter to the path of the stored backup image. 3. Ensure there are no large object (LOB) data types within your user data. BCP refresh cannot work with tables containing LOB data types. If a LOB column is found, a standard (row-by-row) refresh is performed. To determine if there is an error in the loading process for BCP refresh, examine the message appended to the loadmsg file in your InfoSphere CDC installation directory. Default SettingN Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

fastload_backup_path
This system parameter identifies the path to a stored backup image of the loaded data for a BCP refresh. The database user that owns the InfoSphere CDC metadata tables must have read and write permissions to the files whose locations are identified by the fastload_path on page 467and fastload_backup_path system parameters. Applies ToTarget, InfoSphere CDC for DB2 UDB only Related concepts

466

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

fastload_in_whole
This system parameter indicates how data is transferred to the Teradata FastLoad utility in order to refresh data in a Teradata database. Data can be refreshed in a single bulk operation or incrementally. The size of each data file passed to the Teradata FastLoad utility is determined by the max_fastload_ file_size on page 468 system parameter. For more information about the utility, see your Teradata documentation. Applies ToTarget, InfoSphere CDC for Teradata only Set this parameter to one of the following: v NSubmit a data file to the Teradata FastLoad utility immediately after the file has been filled with replicated data. v YSubmit all data to the Teradata FastLoad utility after it has been received from the publication server. Default SettingN Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

fastload_path
This system parameter identifies the path to the temporary file used for a Fast Bulk Copy (BCP) refresh. During a BCP refresh, a copy image of the loaded data is saved in this temporary file. The database user that owns the InfoSphere CDC metadata tables must have read and write permissions to the files whose locations are identified by the fastload_path and fastload_backup_path on page 466 system parameters. Applies ToSource and Target for InfoSphere CDC for DB2 UDB, Target only for InfoSphere CDC for Teradata Does Not Apply ToInfoSphere CDC for PointBase Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

make_fastload_log_file
This system parameter indicates whether or not Teradata FastLoad log files are created. Log files contain messages generated during refresh operations performed by the Teradata FastLoad utility. IBM recommends that you create log files and examine their contents to determine whether or not refresh operations were successful.
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)

467

Log files are named DM_<username>_<tablename>.log , where <username> is the database user name that owns the subscription table being refreshed and <tablename> is the name of the subscription table. These files are placed in the directory identified by the fastload_path on page 467 system parameter. The database user name and InfoSphere CDC installation directory were specified during the installation process. Applies ToTarget, InfoSphere CDC for Teradata only Set this parameter to one of the following: v NDo not create Teradata FastLoad log files to track data refresh operations. v YCreate the Teradata FastLoad log files to track data refresh operations. For more information about the Teradata FastLoad utility, see your Teradata documentation. Default SettingN Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

max_fastload_ file_size
This system parameter identifies the size, in bytes, that the data file must reach before the Teradata FastLoad utility refreshes data in a Teradata database. If the amount of refreshed data is larger than the specified size, InfoSphere CDC closes the data file after it has been filled and passes it to the Teradata FastLoad utility so that data is refreshed in the Teradata database. Additional data files are used to ensure the remaining data is refreshed. Applies ToTarget, InfoSphere CDC for Teradata only Default Setting2,000,000,000 bytes Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

Latency system parameters


Latency system parameters let you control how often InfoSphere CDC generates a latency notification and updates latency statistics in the Event Log. See also: monitor_sample_interval

monitor_sample_interval
This system parameter identifies the period of time, in seconds, between consecutive updates to a storage area that is used to maintain replication latency metrics. Management Console references this area to present replication latency information.

468

InfoSphere Change Data Capture Management Console: Administration Guide

Applies ToSource and Target for InfoSphere CDC for DB2 UDB and InfoSphere CDC for PointBase, Target only for InfoSphere CDC for Teradata Default Setting5 seconds Minimum Setting0 seconds. Replication latency metrics are not updated. Maximum Setting3,600 seconds (1 hour) Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

Lock detection system parameters


Lock detection system parameters let you control how InfoSphere CDC applies data when it detects a locked table or row. See also: dm_lock_detection dm_lock_timeout

dm_lock_detection
This system parameter indicates whether or not table and row locking detection is enabled. If a table or row has been locked by another process while InfoSphere CDC attempts to modify that table or row, InfoSphere CDC waits for a specific amount of time, specified by dm_lock_timeout, before attempting to apply data again. InfoSphere CDC generates messages, which can be displayed in Event Log, when an attempt is made to modify a locked target table or row. These messages identify the specific table or row that could not be modified. Applies ToSource and Target for InfoSphere CDC for DB2 UDB, Target only for InfoSphere CDC for Teradata Does Not Apply ToInfoSphere CDC for PointBase Set this parameter to one of the following: v YEnables table and row locking detection. v NDisables table and row locking detection. InfoSphere CDC waits until the locked table or row becomes available. Default SettingY Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

dm_lock_timeout
Applies ToSource and Target for InfoSphere CDC for DB2 UDB, Target only for InfoSphere CDC for Teradata
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)

469

Does Not Apply ToInfoSphere CDC for PointBase Specifies the amount of time, in seconds, InfoSphere CDC waits for a locked table or row to become available. This system parameter is applicable only when table and row locking detection is enabled, using the dm_lock_detection system parameter. Default Setting30 seconds Minimum Setting1 second Maximum Setting60 seconds Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

Multibyte character set system parameters


Multibyte character set system parameters let you control how InfoSphere CDC treats character sets during replication. See also: unicode_handling

unicode_handling
This system parameter indicates the default method of treating data in defined Unicode columns. For information about how data in each Unicode source column is treated, see Setting multibyte and Unicode character set conversions on page 175. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Applies ToSource for InfoSphere CDC for DB2 UDB Does Not Apply ToInfoSphere CDC for PointBase The following DB2 UDB data types are considered to be Unicode columns, and are therefore affected by the value assigned to this system parameter: v GRAPHIC v VARGRAPHIC v LONG VARGRAPHIC with code page 1200 (UCS-2 big endian) This system parameter is set to either CHAR or NOCHANGE: v CHARInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v NOCHANGEInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain

470

InfoSphere Change Data Capture Management Console: Administration Guide

non-single-byte character data. NOCHANGE ensures InfoSphere CDC will handle non-single-byte character data in the same way as previous InfoSphere CDC releases. Notes: v NOCHANGE does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may have to apply user exit programs or other customization to properly represent data in Unicode columns. For more information about user exit programs, see the InfoSphere CDC for DB2 UDB User Exits Guide. v If you are using IBM DB2 UDB Version 7 database, a BCP refresh locks the replication data tablespace during loading. For this reason, metadata is not updated during a BCP refresh if the metadata tables are located in the same tablespace as the replicated data. For more information on how to avoid this situation, see the appropriate InfoSphere CDC commands reference or user manual. Default SettingNOCHANGE Note: NOCHANGE does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may need to apply user exit programs or other customization to properly represent the data in Unicode columns. Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

Notification system parameters


Notification system parameters let you control if you should generate InfoSphere CDC messages in the Event Log for specific events. See also: dm_status_interval heartbeat_timeout on page 472

dm_status_interval
This system parameter specifies how often, in seconds, progress messages are issued. Progress messages are displayed in Event Log to provide detailed and regular information about InfoSphere CDC replication activities. On the source, these messages identify the current bookmark that was sent by the source, its corresponding log name, and the subscription name to which the bookmark was sent. On the target, progress messages identify the current bookmark that was received by the target, its corresponding log name, and the source ID from which the bookmark was received. Applies ToSource and Target for InfoSphere CDC for DB2 UDB, Target only for InfoSphere CDC for Teradata Does Not Apply ToInfoSphere CDC for PointBase
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)

471

Default Setting0 seconds. No progress messages are issued. Minimum Setting0 seconds Maximum Setting7200 seconds Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

heartbeat_timeout
This system parameter specifies the duration, in minutes, of communication inactivity before active InfoSphere CDC processes for a subscription are stopped. If a value outside the acceptable range is specified, the default setting is used. Applies ToSource, InfoSphere CDC for DB2 UDB and InfoSphere CDC for PointBase Does Not Apply ToInfoSphere CDC for Teradata Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

Replication system parameters


Replication system parameters let you control how InfoSphere CDC behaves after detecting errors during replication. You can also control how often InfoSphere CDC communicates the status of replication activities, and how InfoSphere CDC should apply a refresh operation. See also: dobatch source_default_active_refresh on page 473 source_default_replication_type on page 473 target_mirror_number_of_errors_before_abort on page 473 target_print_refresh_details on page 473 target_refresh_number_of_errors_before_abort on page 474

dobatch
This system parameter enables or disables a batch refresh. Generally, a batch refresh provides a better level of performance than the standard row-by-row refresh.

472

InfoSphere Change Data Capture Management Console: Administration Guide

Applies ToTarget, InfoSphere CDC for DB2 UDB and InfoSphere CDC for PointBase Does Not Apply ToInfoSphere CDC for Teradata Set this parameter to one of the following: v YPerform a batch refresh. In addition, you must ensure that there are no large objects (LOB) data types within your user data. A batch refresh cannot work with tables containing LOB data types. If a LOB column is found, a standard (row-by-row) refresh is performed. v NDo not perform a batch refresh. Default SettingY Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

source_default_active_refresh
For information about setting this system parameter, see your IBM representative.

source_default_replication_type
For information about setting this system parameter, see your IBM representative.

target_mirror_number_of_errors_before_abort
This system parameter indicates how many errors to accept on the target before stopping mirroring. To perform mirroring through any number of errors, set this parameter to -1. Applies ToTarget Attention: If you set this parameter to values greater than 0, data inconsistencies between the source and target tables may occur. Default Setting0 Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

target_print_refresh_details
For information about setting this system parameter, see your IBM representative. Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)

473

target_refresh_number_of_errors_before_abort
This system parameter indicates how many errors to accept on the target before stopping a refresh. To perform refresh through any number of errors, set this parameter to -1. Applies ToTarget Attention: Do not set this parameter to 0. This setting stops the refresh after the first record has been successfully refreshed. Default Setting1

Tracing system parameters


Tracing system parameters let you perform diagnostic activities with InfoSphere CDC. See also: message_handler_trace_level message_trace_level target_trace_logical_messages target_trace_physical_messages trace_level trace_on

message_handler_trace_level
For information about setting this system parameter, see your IBM representative.

message_trace_level
For information about setting this system parameter, see your IBM representative.

target_trace_logical_messages
For information about setting this system parameter, see your IBM representative.

target_trace_physical_messages
For information about setting this system parameter, see your IBM representative.

trace_level
For information about setting this system parameter, see your IBM representative.

trace_on
For information about setting this system parameter, see your IBM representative.

474

InfoSphere Change Data Capture Management Console: Administration Guide

Teradata TPump system parameters


Teradata TPump system parameters allow you to configure the Teradata TPump utility. InfoSphere CDC for Teradata uses the TPump utility to load replicated data into Teradata databases. See also: tpump_arc_data_files tpump_files_root_folder tpump_logging on page 476 tpump_max_file_size on page 477 tpump_script_params_file on page 477 tpump_script_val_file on page 477 tpump_ timeout on page 478

tpump_arc_data_files
This system parameter enables or disables the archiving of data (.dat) and script (.script) files that are used by the Teradata TPump utility. InfoSphere CDC generates the data and script files that are used by the Teradata TPump utility to load data into Teradata databases. Data files contain the replicated data that is loaded into Teradata, and script files specify what is contained in the data files and how data is loaded. These files are named DM_<timestamp>.dat and DM_<timestamp>.script, where <timestamp> is the number of milliseconds from midnight on January 1, 1970 to the time when the file was created. Applies ToTarget, InfoSphere CDC for Teradata only Set this parameter to one of the following: v NDisables the archiving of Teradata TPump data and script files. Teradata TPump data and script files are deleted immediately after data has been loaded into a Teradata database. v YEnables the archiving of Teradata TPump data and script files. For more information about the Teradata TPump utility in InfoSphere CDC, see the InfoSphere CDC for Teradata Installation Guide. Default SettingN Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

tpump_files_root_folder
This system parameter identifies the main directory that is created to accommodate all Teradata TPump files. This setting specifies where all Teradata TPump files are located. Subdirectories under the main directory are labeled with the name of the source ID that is used to receive replicated data. This means that for each source ID, Teradata TPump files are maintained in a separate directory. Applies ToTarget, InfoSphere CDC for Teradata only
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)

475

The three subdirectories that are defined are as follows: v <tpump_files_root_folder>\<source_id>\TPump Contains all data (.dat) and script (.script) files that are generated by InfoSphere CDC and used by the Teradata TPump utility to load data into Teradata databases. Data files contain the replicated data that is loaded into Teradata, and script files specify what is contained in the data files and how data is loaded. These files are named DM_<timestamp>.dat and DM_<timestamp>.script , where <timestamp> is the number of milliseconds from midnight on January 1, 1970 to the time when the file was created. v <tpump_files_root_folder>\<pubid>\TPump\archive Contains all archived data (.dat) and script (.script) files. v <tpump_files_root_folder>\<pubid>\TPump\log Contains all Teradata TPump log files. For more information about log files, see tpump_logging. These files are named DM_<timestamp>.log , where <timestamp> is the number of milliseconds from midnight on January 1, 1970 to the time when the file was created. where <tpump_files_root_folder> is the value assigned to this system parameter, and <source_id> is the source ID defined in Management Console that is used to receive replicated data. For example, if <tpump_files_root_folder> is d:\test, and <source_id> is NEWYORK, then the following three Teradata TPump subdirectories are created for the NEWYORK source ID: d:\test\NEWYORK\TPump, d:\test\NEWYORK\TPump\ archive, and d:\test\NEWYORK\TPump\log. For more information about the Teradata TPump utility in InfoSphere CDC, see InfoSphere CDC for Teradata Installation Guide. Default SettingInfoSphere CDC installation directory Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

tpump_logging
This system parameter indicates whether or not Teradata TPump log files are created. The tpump_files_root_folder on page 475system parameter specifies the location of these files. Log files are named DM_<timestamp>.log, where <timestamp> is the number of milliseconds from midnight on January 1, 1970 to the time when the file was created. Applies ToTarget, InfoSphere CDC for Teradata only Set this parameter to one of the following: v YCreate Teradata TPump log files to track data loading operations. v NDo not create Teradata TPump log files to track data loading operations. For more information about the Teradata TPump utility in InfoSphere CDC, see the InfoSphere CDC for Teradata Installation Guide. Default SettingY

476

InfoSphere Change Data Capture Management Console: Administration Guide

Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

tpump_max_file_size
This system parameter identifies the size, in bytes, that the data file (.dat) must reach before the Teradata TPump utility loads data into a Teradata database. Data files contain the replicated data that is loaded into Teradata. To optimize performance, you should set this system parameter so that the amount of time it takes for the Teradata TPump utility to load data into a Teradata database is approximately equivalent to the time it takes for the data file to reach the specified size. As a result, the next load operation can start shortly after the current load operation has been completed. Therefore, if the amount of time to load data is longer than the amount of time to fill the data file in preparation for the next load, decrease the number of bytes assigned to this system parameter. In addition to setting this system parameter, you must also set with the tpump_ timeout on page 478 system parameter to specify when the Teradata TPump utility loads data into a Teradata database. If the timeout period frequently expires before the data file reaches its specified size, you can increase the timeout period or decrease the data file size to allow loads to also be determined by data file size. However, when a data file contains an insufficient amount of data for a load to be performed, the timeout period must be set to ensure data is loaded within a reasonable period of time. For information about where the data file is located, see tpump_files_root_folder on page 475. For more information about the Teradata TPump utility in InfoSphere CDC, see InfoSphere CDC for Teradata Installation Guide. Applies ToTarget, InfoSphere CDC for Teradata only Default Setting100,000 bytes Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

tpump_script_params_file
For information about setting this system parameter, see your IBM representative.

tpump_script_val_file
Identifies the name of the XML file that InfoSphere CDC uses to generate script (.script) files during replication. Teradata TPump script files specify what is contained in the data files and how data in these files is loaded into Teradata databases. The file identified by this system parameter contains a set of Teradata TPump command parameter settings. You can modify the settings in this file so that the script files generated by InfoSphere CDC during replication are customized for your working environment. For more information about customizing the generated script files using the XML file identified by this system parameter, see InfoSphere CDC for Teradata Installation Guide.
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)

477

IBM recommends that you do not change the default setting for this system parameter. Instead, modify the tpumpscripttsdefaults.xml file so that it contains the command parameter settings that you want. If you want to specify a different XML, this file must exist in the InfoSphere CDC installation directory and contain the correct XML markup to generate valid script files. Generally, the default values in the tpumpscripttsdefaults.xml file are suitable for most working environments. If you want to modify the settings in this file, you must be familiar with XML and Teradata TPump. For more information about Teradata TPump commands and command parameters, see your Teradata documentation. Applies ToTarget, InfoSphere CDC for Teradata only Default Settingtpumpscripttsdefaults.xml Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

tpump_ timeout
This system parameter indicates the amount of time, in seconds, between consecutive Teradata TPump data loads into a Teradata database. You can use this system parameter to force data to be loaded when the data file (see tpump_max_file_size on page 477) contains insufficient data for a load to be performed. It can be used to prevent data in a data file from not being loaded for a long period of time. In particular, you can use this system parameter to force loads during periods of slow transaction activity. However, if you set the timeout period so that it frequently expires before a data file can reach the specified size, a smaller amount of data is loaded. In this case, you can increase the timeout period or decrease the data file size to allow loads to also be determined by data file size. For more information about the Teradata TPump utility in InfoSphere CDC, see the InfoSphere CDC for Teradata Installation Guide. Applies ToTarget, InfoSphere CDC for Teradata only Minimum Setting0 seconds. Disables the timeout so that a load is only performed when the data file reaches the size specified by the tpump_max_file_size system parameter. Default Setting5 seconds Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60

478

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and target datastores. Notes: v If you make changes to a system parameter during active replication, you must stop and restart InfoSphere CDC for the changes to take effect. v When upgrading to a higher version of InfoSphere CDC, any pre-existing settings for system parameters are maintained. In this section, you will learn: Notification system parameters Maximize throughput system parameters on page 480 Encoding system parameters on page 483 Disk resource system parameters on page 484 Apply process system parameters on page 485

Notification system parameters


Notification system parameters let you control if you should generate InfoSphere CDC messages in the Event Log for specific events. See also: global_shutdown_after_no_heartbeat_response_minutes global_conversion_not_possible_warning on page 480

global_shutdown_after_no_heartbeat_response_minutes
Use this system parameter to specify the duration, in minutes, of communication inactivity before active InfoSphere CDC processes for a subscription are stopped. If a value outside the acceptable range is specified, the default setting is used. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Related concepts
Copyright IBM Corp. 2008

479

System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

global_conversion_not_possible_warning
Use this system parameter to control whether or not InfoSphere CDC generates a warning in the Management Console Event Log in the following situations: v Data conversion is not possible for a specific data value. v Converted data types are encountered that are out of range. Set this parameter to one of the following: truegenerates a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. falsedoes not generate a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. Applies ToTarget Default SettingFalse Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

Maximize throughput system parameters


InfoSphere CDC system parameters allow you to significantly reduce the workload of the target database during mirroring. The InfoSphere CDC apply process groups transactions on the target to reduce the workload. Every commit on the target database will correspond with a commit on the target. However, it may not perform every commit that was done on the source. For example, if the source does three small transactions containing one operation each, the target may commit all three operations as part of a single transaction. You can use this grouping of system parameters to significantly reduce the resources required by the target database. The default settings are appropriate for most databases, but if your target system has limited resources and an increase in latency is acceptable, you can adjust the settings appropriately. See also: mirror_commit_after_max_transactions on page 481 mirror_commit_after_max_seconds on page 481 mirror_commit_after_max_operations on page 481 mirror_commit_on_transaction_boundary on page 482 refresh_commit_after_max_operations on page 482

480

InfoSphere Change Data Capture Management Console: Administration Guide

mirror_commit_after_max_transactions
This system parameter specifies a threshold used to determine when to issue a commit to the target database. Commits are issued to the target database in response to commits issued by applications running on the source, but not all source commits will be issued on the target. The frequency at which source commits are issued to the target database will vary depending on the volume of changes. When data volume is higher, less frequent commits on the target will allow for the higher data throughput required to maintain low latency. This system parameter is used to place a limit on how infrequent these target commits can become. If the source commit being processed has reached this threshold of source commits received since the last target commit was issued, then there will be a target commit issued for this source commit. Applies ToTarget Default Setting10 Minimum Setting1 Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

mirror_commit_after_max_seconds
This system parameter specifies a threshold used to determine when to issue a commit to the target database. Commits are issued to the target database in response to commits issued by applications running on the source, but not all source commits will be issued on the target. The frequency at which source commits are issued to the target database will vary depending on the volume of changes. When data volume is higher, less frequent commits on the target will allow for the higher data throughput required to maintain low latency. This system parameter is used to place a limit on how infrequent these target commits can become. If the specified amount of time, in seconds, has elapsed since the last target commit it issued, then it will issue a target commit either immediately (if it isnt currently in the middle of a source transaction) or as soon as it receives the next source commit. Applies ToTarget Default Setting1 second Minimum Setting1 Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

mirror_commit_after_max_operations
This system parameter specifies a threshold used to determine when to issue a commit to the target database. Commits are issued to the target database in
System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above)

481

response to commits issued by applications running on the source, but not all source commits will be issued on the target. The frequency at which source commits are issued to the target database will vary depending on the volume of changes. When data volume is higher, less frequent commits on the target will allow for the higher data throughput required to maintain low latency. This system parameter is used to place a limit on how infrequent these target commits can become. If the target has applied this number of operations since the last target commit was issued, then it will issue a target commit at the next source commit it receives from the source. Applies ToTarget Default Setting1000 Minimum Setting1 Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

mirror_commit_on_transaction_boundary
This system parameter indicates whether or not the commits that InfoSphere CDC does on the target database will always correspond with a commit that occurred on the source database. If you choose to ignore the commitment control of the source database, InfoSphere CDC allows you to see the partial results of large transactions. Set this parameter to one of the following: v trueDoes not ignore the commitment control of the source database. Only records in a committed transaction are mirrored to the target. This setting provides true transaction consistency by ensuring that only committed transactions are sent to the target. v falseIgnores the commitment control of the source database. This value disables commitment control for transaction processing. No attempt to maintain transaction consistency is performed during mirroring. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

refresh_commit_after_max_operations
This system parameter identifies the number of rows comprising each transaction during refresh. To reduce the workload on the target database during refresh, InfoSphere CDC periodically commits the changes to the target database rather than performing the refresh as a single large transaction. Applies ToTarget

482

InfoSphere Change Data Capture Management Console: Administration Guide

Default Setting1000 Minimum Setting1 Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

Encoding system parameters


For some system parameters, you can set the default method for treating data in defined Unicode columns, and you can set the default character encoding for your database. See also: global_unicode_as_char

global_unicode_as_char
This system parameter indicates the default method of treating data in defined Unicode columns. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Set this parameter to one of the following: v trueInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v falseInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain non-single-byte character data. Setting this system parameter to false ensures that InfoSphere CDC handles non-single-byte character data in the same way as previous InfoSphere CDC releases. Note: Setting this parameter to false does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may have to apply user exit programs or other customization to properly represent data in Unicode columns. For more information about user exit programs, see the InfoSphere CDC End-User Documentation for your platform. Applies ToSource Default Settingfalse Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above)

483

Disk resource system parameters


Some system parameters control memory usage in InfoSphere CDC. For improved performance, if you are able to allocate more than the default value of 512 MB for the InfoSphere CDC Java Virtual Machine, then you can adjust the disk resource system parameters to use the increased memory. See also: mirror_memory_txqueue_total_mb on page 430 mirror_memory_txqueue_each_mb on page 430 global_memory_lob_cache_mb on page 429 mirror_queue_for_buffers_between_cdc_threads_operations on page 485

mirror_memory_txqueue_total_mb
This system parameter controls the amount of memory used to stage data on the source. For optimal performance, this system parameter should be large enough to hold the largest amount of uncommited data that will ever exist in the source database. Applies ToSource Default Setting15 Megabytes Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

mirror_memory_txqueue_each_mb
This system parameter controls the amount of memory used to stage data on the source. For optimal performance, this system parameter should be large enough to hold the data for the largest transactions that occur on the source. Applies ToSource Default Setting3 Megabytes Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

global_memory_lob_cache_mb
This system parameter controls the amount of memory that will be used to stage LOB values on the target. For optimal performance, this value should be large enough to hold the entire data for the largest LOB values that will be replicated. Default Setting2 Megabytes Applies ToTarget Related concepts

484

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

mirror_queue_for_buffers_between_cdc_threads_operations
This system parameter controls the ability of InfoSphere CDCs log scraping to take advantage of multiple processors. The default setting is acceptable for most situations. You can increase this value for highly scalable environments. Applies ToSource Default Setting100 entries Minimum Setting100 entries Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

Apply process system parameters


Some system parameters adjust the way InfoSphere CDC applies rows, column data, and error handling. See also: mirror_end_on_error refresh_end_on_error

mirror_end_on_error
Use this system parameter to indicate if you want to end mirroring after an apply error occurs on the target database. Set this parameter to one of the following: v trueEnd mirroring after an apply error on the target database. v falseDo not end mirroring after an apply error on the target database. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

refresh_end_on_error
Use this system parameter to indicate if you want to end a refresh after an apply error occurs. Set this parameter to one of the following:
System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above)

485

v v

trueEnd a refresh after an apply error occurs. falseDo not end a refresh after an apply error occurs.

Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60

486

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for Teradata (version 6.2 and above)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Notes: v If you make changes to a system parameter during active replication, you must stop and restart InfoSphere CDC for the changes to take effect. v When upgrading to a higher version of InfoSphere CDC, any pre-existing settings for system parameters are maintained. In this section, you will learn: Notification system parameters Apply process system parameters on page 488 Teradata TPump system parameters on page 489 Fastload system parameters on page 492

Notification system parameters


Notification system parameters let you control if you should generate InfoSphere CDC messages in the Event Log for specific events. See also: global_shutdown_after_no_heartbeat_response_minutes global_conversion_not_possible_warning on page 488

global_shutdown_after_no_heartbeat_response_minutes
Use this system parameter to specify the duration, in minutes, of communication inactivity before active InfoSphere CDC processes for a subscription are stopped. If a value outside the acceptable range is specified, the default setting is used. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above)
Copyright IBM Corp. 2008

487

global_conversion_not_possible_warning
Use this system parameter to control whether or not InfoSphere CDC generates a warning in the Management Console Event Log in the following situations: v Data conversion is not possible for a specific data value. v Converted data types are encountered that are out of range. Set this parameter to one of the following: truegenerates a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. falsedoes not generate a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. Applies ToTarget Default SettingFalse Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above) on page 487

Apply process system parameters


Some system parameters adjust the way InfoSphere CDC applies rows, column data, and error handling. See also: mirror_end_on_error refresh_end_on_error

mirror_end_on_error
Use this system parameter to indicate if you want to end mirroring after an apply error occurs on the target database. Set this parameter to one of the following: v trueEnd mirroring after an apply error on the target database. v falseDo not end mirroring after an apply error on the target database. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above) on page 487

refresh_end_on_error
Use this system parameter to indicate if you want to end a refresh after an apply error occurs.

488

InfoSphere Change Data Capture Management Console: Administration Guide

Set this parameter to one of the following: v trueEnd a refresh after an apply error occurs. v falseDo not end a refresh after an apply error occurs. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above) on page 487

Teradata TPump system parameters


Teradata TPump system parameters allow you to configure the Teradata TPump utility. InfoSphere CDC for Teradata uses the TPump utility to load replicated data into Teradata databases. See also: mirror_tpump_files_root_folder_path mirror_tpump_max_file_size_mb on page 490 mirror_tpump_script_val_file_name on page 490 mirror_tpump_timeout_seconds on page 491

mirror_tpump_files_root_folder_path
Identifies the main directory that is created to accommodate all Teradata TPump files. This setting specifies where all Teradata TPump files are located. Subdirectories under the main directory are labeled with the name of the publisher identifier that is used to receive replicated data. This means that for each publisher identifier, Teradata TPump files are maintained in a separate directory. The three subdirectories that are defined are as follows: v <tpump_files_root_folder>\<pubid>\TPump Contains all data (.dat) and script (.script) files that are generated by InfoSphere CDC and used by the Teradata TPump utility to load data into Teradata databases. Data files contain the replicated data that is loaded into Teradata, and script files specify what is contained in the data files and how data is loaded. These files are named DM_<timestamp>.dat and DM_<timestamp>.script, where <timestamp> is the number of milliseconds from midnight on January 1, 1970 to the time when the file was created. v <tpump_files_root_folder>\<pubid>\TPump\archive Contains all archived data (.dat) and script (.script) files. v <tpump_files_root_folder>\<pubid>\TPump\log Contains all Teradata TPump log files. For more information about log files, see tpump_logging below. Log files are named DM_<timestamp>.log, where <timestamp> is the number of milliseconds from midnight on January 1, 1970 to the time when the file was created.
System parameters for InfoSphere CDC for Teradata (version 6.2 and above)

489

where: <tpump_files_root_folder> is the value assigned to this system parameter. <pubid> is the publisher identifier defined in Management Console that is used to receive replicated data. For example, if: <tpump_files_root_folder> is d:\test, and <pubid> is NEWYORK then the following three Teradata TPump subdirectories are created for the NEWYORK publisher identifier: d:\test\NEWYORK\TPump d:\test\NEWYORK\TPump\archive d:\test\NEWYORK\TPump\log

Default SettingThe InfoSphere CDC installation directory. Applies ToTarget Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above) on page 487

mirror_tpump_max_file_size_mb
Identifies the size, in megabytes, that the data file (.dat) must reach before the Teradata TPump utility loads data into a Teradata database. Data files contain the replicated data that is loaded into Teradata. To optimize performance, you should set this system parameter so that the amount of time it takes for the Teradata TPump utility to load data into a Teradata database is approximately equivalent to the time it takes for the data file to reach the specified size. As a result, the next load operation can start shortly after the current load operation has been completed. Therefore, if the amount of time to load data is longer than the amount of time to fill the data file in preparation for the next load, decrease the number of bytes assigned to this system parameter. In addition to working with this system parameter, you must also work with the tpump_ timeout on page 478 system parameter to specify when the Teradata TPump utility loads data into a Teradata database. If the timeout period frequently expires before the data file reaches its specified size, you can increase the timeout period or decrease the data file size to allow loads to also be determined by data file size. However, when a data file contains an insufficient amount of data for a load to be performed, the timeout period must be set to ensure data is loaded within a reasonable period of time. Default Setting50 Mb Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above) on page 487

mirror_tpump_script_val_file_name
Identifies the name of the XML file that InfoSphere CDC uses to generate script (.script) files during replication.

490

InfoSphere Change Data Capture Management Console: Administration Guide

Teradata TPump script files specify what is contained in the data files and how data in these files is loaded into Teradata databases. The file identified by this system parameter contains a set of Teradata TPump command parameter settings. You can modify the settings in this file so that the script files generated by InfoSphere CDC during replication are customized for your working environment. For more information about customizing the generated script files using the XML file identified by this system parameter, see your InfoSphere CDC for Teradata documentation. IBM recommends that you do not change the default setting for this system parameter. Instead, modify the tpumpscripttsdefaults.xml file so that it contains the desired command parameter settings. If you want to specify a different XML, this file must exist in the InfoSphere CDC installation directory and contain the correct XML markup to generate valid script files. Generally, the default values in the tpumpscripttsdefaults.xml file are suitable for most working environments. If you want to modify the settings in tpumpscripttsdefaults.xml, you must be familiar with XML and Teradata TPump. For more information about Teradata TPump commands and command parameters, see your Teradata documentation. Default Settingconf/tpumpscripttsdefaults.xml. This file is located in the conf directory in your InfoSphere CDC installation directory. Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above) on page 487

mirror_tpump_timeout_seconds
Indicates the amount of time, in seconds, between consecutive Teradata TPump data loads into a Teradata database. You can use this system parameter to force data to be loaded when the data file (see tpump_max_file_size on page 477) contains insufficient data for a load to be performed. It can be used to prevent data in a data file from not being loaded for a long period of time. In particular, you can use this system parameter to force loads during periods of slow transaction activity. However, if you set the timeout period so that it frequently expires before a data file can reach the specified size, a smaller amount of data is loaded. In this case, you can increase the timeout period or decrease the data file size to allow loads to also be determined by data file size. Minimum Setting0 seconds (disables the timeout so that a load is only performed when the data file reaches the size specified by the tpump_max_file_size system parameter) Default Setting5 seconds Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above) on page 487

System parameters for InfoSphere CDC for Teradata (version 6.2 and above)

491

Fastload system parameters


Fastload system parameters allow you to configure the Teradata Fastload utility. InfoSphere CDC for Teradata uses the Fastload utility to load replicated data into Teradata databases. See also: refresh_max_fastload_file_size_mb

refresh_max_fastload_file_size_mb
Identifies the size, in megabytes, that the data file must reach before the Teradata FastLoad utility refreshes data in a Teradata database. If the amount of refreshed data is larger than the specified size, InfoSphere CDC closes the data file after it has been filled and passes it to the Teradata FastLoad utility so that data is refreshed in the Teradata database. Additional data files are used to ensure the remaining data is refreshed. Default Setting100 megabytes

492

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC Event Server


System parameters let you control the behavior of InfoSphere CDC Event Server. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC Event Server. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC Event Server. InfoSphere CDC Event Server provides system parameters that control the behavior of your target datastores. If you make changes to a system parameter during active replication, you must stop and restart InfoSphere CDC Event Server for the changes to take effect. When upgrading to a higher version of InfoSphere CDC Event Server, any pre-existing settings for system parameters are maintained. In this section, you will learn: Notification system parameters Apply process system parameters on page 494

Notification system parameters


Notification system parameters let you control if you should generate InfoSphere CDC messages in the Event Log for specific events. See also: global_conversion_not_possible_warning

global_conversion_not_possible_warning
Use this system parameter to control whether or not InfoSphere CDC generates a warning in the Management Console Event Log in the following situations: v Data conversion is not possible for a specific data value. v Converted data types are encountered that are out of range. Set this parameter to one of the following: truegenerates a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. falsedoes not generate a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. Applies ToTarget Default SettingFalse Related concepts System parameters for InfoSphere CDC Event Server
Copyright IBM Corp. 2008

493

Apply process system parameters


Some system parameters adjust the way InfoSphere CDC applies rows, column data, and error handling. See also: mirror_end_on_error refresh_end_on_error userexit_max_lob_size_kb on page 397

mirror_end_on_error
Use this system parameter to indicate if you want to end mirroring after an apply error occurs on the target database. Set this parameter to one of the following: v trueEnd mirroring after an apply error on the target database. v falseDo not end mirroring after an apply error on the target database. Applies ToTarget Default Settingtrue

refresh_end_on_error
Use this system parameter to indicate if you want to end a refresh after an apply error occurs. Set this parameter to one of the following: v trueEnd a refresh after an apply error occurs. v falseDo not end a refresh after an apply error occurs. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC Event Server on page 493 Setting system parameters on source and target datastores on page 60

userexit_max_lob_size_kb
Use this system parameter to set the maximum size of LOB data (in kb) that InfoSphere CDC can pass to a user exit. Applies ToTarget Default Setting128 kb MaximumNone MinimumNone Related concepts

494

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC Event Server on page 493 Setting system parameters on source and target datastores on page 60

System parameters for InfoSphere CDC Event Server

495

496

InfoSphere Change Data Capture Management Console: Administration Guide

System parameters for InfoSphere CDC for WebSphere DataStage


System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Notes: 1. If you make changes to a system parameter during active replication, you must stop and restart InfoSphere CDC for the changes to take effect. 2. When upgrading to a higher version of InfoSphere CDC, any pre-existing settings for system parameters are maintained. In this section, you will learn: Notification system parameters Apply process system parameters on page 498 WebSphere DataStage system parameters on page 499

Notification system parameters


Notification system parameters let you control if you should generate InfoSphere CDC messages in the Event Log for specific events. See also: global_shutdown_after_no_heartbeat_response_minutes global_conversion_not_possible_warning on page 498

global_shutdown_after_no_heartbeat_response_minutes
Use this system parameter to specify the duration (in minutes) of communication inactivity before active InfoSphere CDC processes for a subscription are stopped. If a value outside the acceptable range is specified, the default setting is used. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes. Maximum Setting999 minutes. Related concepts System parameters for InfoSphere CDC for WebSphere DataStage

Copyright IBM Corp. 2008

497

global_conversion_not_possible_warning
Use this system parameter to control whether or not InfoSphere CDC generates a warning in the Management Console Event Log in the following situations: v Data conversion is not possible for a specific data value. v Converted data types are encountered that are out of range. Set this parameter to one of the following: truegenerates a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. falsedoes not generate a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. Applies ToTarget Default SettingFalse Related concepts System parameters for InfoSphere CDC for WebSphere DataStage on page 497

Apply process system parameters


Some system parameters adjust the way InfoSphere CDC applies rows, column data, and error handling. See also: mirror_end_on_error refresh_end_on_error

mirror_end_on_error
Use this system parameter to indicate if you want to end mirroring after an apply error occurs on the target database. Set this parameter to one of the following: v trueEnd mirroring after an apply error on the target database. v falseDo not end mirroring after an apply error on the target database. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for WebSphere DataStage on page 497

refresh_end_on_error
Use this system parameter to indicate if you want to end a refresh after an apply error occurs.

498

InfoSphere Change Data Capture Management Console: Administration Guide

Set this parameter to one of the following: v trueEnd a refresh after an apply error occurs. v falseDo not end a refresh after an apply error occurs. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for WebSphere DataStage on page 497

WebSphere DataStage system parameters


WebSphere DataStage system parameters when your LOB data is truncated. See also: userexit_max_lob_size_kb

userexit_max_lob_size_kb
This system parameter determines when InfoSphere CDC truncates LOB data and is related to the WebSphere DataStage subscription-level properties that you can set for each subscription in Management Console. InfoSphere CDC first truncates your LOB data based on this system parameter and then truncates your data again using the subscription-level properties. For more information on how to set the subscription-level properties, see Setting properties for a subscription that targets IBM WebSphere DataStage on page 89. This system parameter should be set at least as large as the largest subscription-level property while taking into account the units and the type of character data (single-byte or multi-byte). For example, if the largest subscription-level property is set to 8,000 characters and you are using a Japanese system with the possibility of 2 bytes per character (up to 16,000 bytes), you should set this system parameter to at least 16 kB. Default Setting128 kB Applies ToTarget

System parameters for InfoSphere CDC for WebSphere DataStage

499

500

InfoSphere Change Data Capture Management Console: Administration Guide

Functions
Management Console includes several functions. In this section, you will learn: XPath functions Transform extensions on page 506 Database functions on page 514 Using external Java objects in data transformations on page 515 XPath expression operators on page 516

XPath functions
The XPath functions implemented by InfoSphere CDC Event Server follow specific syntax. For details regarding the XPath functions, see W3Cs Web site at http://www.w3.org. In the current release the following XPath functions are implemented: See also: ceiling concat on page 502 contains on page 502 floor on page 502 false on page 502 formatNumber on page 503 normalizeSpace on page 503 not on page 503 number on page 503 position on page 504 round on page 504 startsWith on page 504 string on page 504 stringLength on page 505 substring on page 505 substringAfter on page 505 substringBefore on page 505 sum on page 506 translate on page 506 true on page 506

ceiling
Returns the smallest integer greater than or equal to the numeric value of the argument. Syntaxceiling(value)
Copyright IBM Corp. 2008

501

Input Parametersvalue represents an input value that can be converted to a number. Example<sxt:element name="Price" value="ceiling(12.5)"/>. This function returns a value of 13.

concat
Concatenates two or more values into one string. Syntaxconcat(value1, value2, [, value3, ...]) Input Parametersvalue1, value2, [, value3, ...] represent input values: expressions, literals, or functions. Return Valuestring Example<sxt:element name="Full_Name" value="concat(First_Name, ` `, Last_Name)"/>

contains
Determines whether a string is contained within another string. The function returns true if value 1 contains value 2, otherwise, false. Syntaxcontains(value1, value2) Input Parametersvalue1, value2 represent input values: expressions, literals, or functions. Return Valueboolean Example<sxt:element name="isQualified" value="contains(/employee/ skill,"Java")"/>

floor
Returns the largest integer that is less than or equal to the numeric value of the argument. Syntaxfloor(value) Input Parametersvalue. Represents an input value that can be converted to a number. Return Valuenumber Example<sxt:element name="Price" value="floor(12.5)"/>. This function returns a value of 12.

false
Returns false. Syntaxfalse( )

502

InfoSphere Change Data Capture Management Console: Administration Guide

Input Parametersnone Return Valueboolean Example<sxt:element name="OnSale" value="false()"/>

formatNumber
Formats a numeric value according to a specified pattern. The default pattern implemented follows Java JDK Version 1.1 specification. For more information on number formats, see the Java API documentation. Syntaxformat-number(value, format-pattern) Input Parametersvalue represents an input value that can be converted to a number. format-pattern represents a string value that contains the formatting rules. Return Valuestring Example<sxt:element name="Price" value="format-number(12.5, $#.00)"/>. The preceding declaration formats 12.5 to $12.50 and assigns it as the contents of the Price element.

normalizeSpace
Trims the leading and trailing white spaces (blank spaces, tabs and new line characters), and converts multiple white spaces to a single blank space. Syntaxnormalize-space(value) Input Parametersvalue represents an input string value. Return Valuestring Example<sxt:element name="Test" value="normalize-space (` Hello world! )"/>

not
Returns true if the argument is false, returns false if the argument is true. Syntaxnot(value) Input Parametersvalue represents an input boolean value or expression. Return ValueBoolean Example<sxt:element name="Admit" value="not(/Customers/Customer/ age<18)"/>

number
This function converts a value to a decimal number. Syntaxnumber(value)
Functions

503

Input Parametersvalue represents an input string of numeric values. Return Valuenumber Example<sxt:element name="Cost" value="number(15.6)"/>

position
Returns a number equal to the context position from the expression evaluation context. Syntaxposition( ) Input ParametersNone Return Valuenumber Example<sxt:element name="ColumnNum" value="/root/a[position()=3]"/>

round
Returns the closest integer to the numeric value of the argument. Syntaxround(value) Input Parametersvalue represents an input number, which must be surrounded by single quotes. Return Valuenumber Example<sxt:element name="Cost" value="round(15.6)"/>. For this example, the return value is 16.

startsWith
Returns true if one string begins with another. Syntaxstarts-with(value1, value 2) Input Parametersvalue1 represents an input value: an expression, a literal, or a function. value2 represents the substring to be searched. Return ValueBoolean Example<sxt:element name="isLocal" value="starts-with(Phone, "416")"/>

string
Converts a number or node to a string. Syntaxstring(value) Input Parametersvalue represents an input number. Return Valuestring

504

InfoSphere Change Data Capture Management Console: Administration Guide

Example<sxt:element name="Cost" value="string(15.6)"/>

stringLength
This function returns the length of a string. Syntaxstring-length(value) Input Parametersvalue represents an input value: an expression, a literal, or a function. Return Valuenumber Example<sxt:element name="TestLength" value="string-length(Phone)"/>

substring
This function extracts a substring from a string starting at a specified position, and having a specified length. Syntaxsubstring(value, beginIndex, [length]) Input Parametersvalue represents an input value: an expression, a literal, or a function. beginIndex represents the beginning position, zero-based. length represents the length of substring, zero-based. If omitted, the substring runs to the end of the input string. Return Valuestring Example<sxt:element name="Area_Code" value="substring(Phone, 0, 3)"/>

substringAfter
Extracts a substring from a string. The substring to be extracted appears after the first occurrence of a specified substring. Syntaxsubstring-after(value, searchSubstring) Input Parametersvalue represents an input value: an expression, literal, or a function. searchSubstring represents the substring to be searched. Return Valuestring Example<sxt:element name="LocalNumber" value="substring-after (Phone, ` `)"/>

substringBefore
Syntaxsubstring-before(value, searchSubstring) Descriptionextracts a substring from a string. The substring to be extracted appears before the first occurrence of a specified substring. Input Parametersvalue represents an input value: an expression, a literal, or a function. searchSubstring represents the substring to be searched.
Functions

505

Return Valuestring Example<sxt:element name="AreaCode" value="substring-before(Phone, ` `)"/>

sum
Syntaxsum(node_set) Descriptionreturns the total value of a set of numeric values in a node-set Input Parametersnode_set is an X-Path expression that represents a node-set. Return Valuenumber Example<sxt:element name="TotalPrice" value="sum(//UnitPrice)"/>

translate
Syntaxtranslate(value, from, to) Descriptionsubstitutes characters in a supplied string with specified replacement characters. Input Parametersvalue represents an input value: an expression, a literal, or a function. from represents the characters to be replaced. to represents the characters to be used as the replacement for the from characters. If omitted, the from characters are removed. Return Valuestring Example<sxt:element name="Phone" value="substring(Phone, ` `, `-`)"/>

true
Syntaxtrue( ) Descriptionreturns true. Input ParametersNone Return Valueboolean Example<sxt:element name="OnSale" value="true()"/> Nesting is supported in the current version.

Transform extensions
To meet specific transform requirements, these extensions have been developed to supplement XPath and XSLT recommendations provided by W3C. The first extension is an XPath expression for self-reference. A leading # symbol means self-reference from the target point of view. For example, /root/level1/@attr1 points to an attribute in the source DOM, while #/root/level1/@attr1 points to an

506

InfoSphere Change Data Capture Management Console: Administration Guide

attribute in the target that is the XML document to be generated. InfoSphere CDC Event Server functions are marked with the sxt: prefix, which must be used with the function name. See also: sxt:add sxt:db-lookup sxt:divide on page 508 sxt:filter on page 508 sxt:formatDate on page 509 sxt:getSequentialNum on page 509 sxt:getSubField on page 509 sxt:getSysDate on page 510 sxt:getSysTime on page 510 sxt:groupConcat on page 510 sxt:ifExist on page 510 sxt:ifReturn on page 511 sxt:isEqual on page 511 sxt:multiply on page 511 sxt:nodeConcat on page 511 sxt:padLeft on page 512 sxt:padRight on page 512 sxt:proper on page 512 sxt:setDefault on page 513 sxt:subtract on page 513 sxt:toLowerCase on page 513 sxt:toUpperCase on page 513 sxt:trim on page 514

sxt:add
Syntaxsxt:add (value1, value2, [value3,...]) DescriptionThis function adds two or more values provided. Input Parametersvalue1, value2, [value3, ...] represent two or more values that can be converted to numbers. Return Valuenumber Example<sxt:element name="Total_Quantity" value="sxt:add(QOH, QOO)"/>

sxt:db-lookup
Syntaxsxt:db-lookup (JDBCDriver, URL,UserName, Password, SQLStatement |StoredProcedure[,param1,param2,...]) DescriptionThis function gets a single value from the specified database by performing a query. Do not use this function on tables that are being transformed. Use sxtdb:lookup for tables under current transformation
Functions

507

Input Parameters v JDBCDriverRepresents the name of a valid JDBC driver class. v URLRepresents a unique URL to the database. v UserNameRepresents a valid user name to access the database. v PasswordRepresents a valid password associated with the user name. v SQLStatementRepresents the SQL statement to be applied to the database. Only standard SQL types are supported. v StoredProcedure[,param1,param2,...] Represents the stored procedure. The syntax is: (outputParameter Datatype) call ProcedureName ([inputParameter Datatype, ...]) outputParameterThe stored procedure can have only one output parameter, and the output parameter must be the last parameter. The supported data types are: CHAR, VARCHAR, LONGVARCHAR, INTEGER, DOUBLE, DATE, TIME, TIMESTAMP inputParameterRepresents the value of the input parameter (optional). stringThis function will return the first column in the first row of the result set
sxt:db-lookup("sun.jdbc.odbc.JdbcOdbcDriver","jdbc:odbc:pubs", "sa","sa","SELECT country_name FROM countries WHERE country_id=?", @countryID)

sxt:divide
Syntaxsxt:divide (value1, value2) DescriptionThis function divides two values provided. Input Parametersvalue1, value2 represent two values that can be converted to numbers. value2 cannot be zero. Return Valuenumber Example<sxt:element name="Overtime_Rate" value="sxt:divide(overtime, standard)"/>

sxt:filter
Syntaxsxt:filter (node-set, condition) DescriptionThis function filters the node-set using a conditional expression in the context of each of the node-sets. This is equivalent to the XPath [ ] filtering mechanism. Input Parametersnode-set represents the node-set to be selectively returned if a node meets the condition. condition Represents a filter condition that can be evaluated (true or false). Return Valuenode-set Example<sxt:attribute name="keys" value="sxt:groupConcat(sxt:filter(data_key, sxt:is-equal(data_type,2)), )"/>

508

InfoSphere Change Data Capture Management Console: Administration Guide

sxt:formatDate
Syntaxsxt:formatDate (value, original-format-pattern, to-format-pattern) DescriptionThis function formats the date string using the specified pattern. The patterns must follow the rules in Java. For more information on date formats, see the Java API documentation. Input Parametersvalue represents an input value that can be converted to a date. original-format-pattern represents a string value that contains the original formatting rules. to-format-pattern represents a string value that contains the formatting rules for the converted date. The patterns must follow the rules in Java. v yyyy-MM-dd (for example, 2001-01-25) v MMM dd, yyyy (for example, Jan 25, 2004) v v v v MMMM d, yyyy (for example, January 25, 2004) M/dd/yyyy (for example 1/25/2004) yyyy-MM-dd HH:mm:ss (for example, 2004-01-25 13:25:30) yyyy-MM-dd hh:mm:ss a (for example, 2004-01-25 01:25:30 PM).

Return Valuestring Example<sxt:element name="Birthday" value="sxt:formatDate(@dob, yyyy-MMdd, MMM dd, yyyy)"/>

sxt:getSequentialNum
Syntaxsxt:getSequentialNum (seed, increment) Description This function generates sequential numbers in a session. Input Parametersseed represents the start value of a counter. increment represents the increment for each number. Return Valuenumber Example<sxt:element name="ID" value="sxt:getSequentialNum(1,1)"/>. In this example, when the function is called for the first time, the return value is 1; the second time, the return value is 2, the third time, 3, and so on. The counter does not persist between sessions or processes.

sxt:getSubField
Syntaxsxt:getSubField (value, delimiter, subFieldIndex) DescriptionThis function extracts a sub-field value from a string that contains a list of delimited values. Input Parametersvalue represents an input value: an expression, a literal, or a function. delimiter represents a delimiter used to separate the sub-field values. For example: comma, tab, |, and so on. subFieldIndex represents the ordinal position of the sub-field. For example, the first sub-field is 1, and so on. Return Valuestring
Functions

509

Example<sxt:element name="Area_Code" value="sxt:getSubField(Phone, `-`, 1)"/>

sxt:getSysDate
SyntaxgetSysDate ( ) DescriptionThis function returns the system date at runtime. Input ParametersNone Return Valuestring Example<sxt:element name="UpdateDate" value="sxt:getSysDate()"/> sxt:getSysDateTime

sxt:getSysTime
Syntaxsxt:getSysTime ( ) DescriptionThis function returns the system time at runtime. Input ParametersNone Return Valuestring Example<sxt:element name="UpdateTime" value="sxt:getSysTime()"/>

sxt:groupConcat
Syntaxsxt:groupConcat (nodeToConcat, delimiter) DescriptionThis function converts one level node in a node-set to a string and then concatenates them together into a string Input ParametersnodeToConcat represents the node to be concatenated. It must be a node-set. delimiter represents the delimiter to be used for separating each sub-value. Return Valuestring Example<sxt:element name="AuthorPhones" value="sxt:groupConcat(/authors/ phone, ,)"/>

sxt:ifExist
Syntaxsxt:if-exist (nodeOrExpr1, node OrExpr2) DescriptionThis function verifies whether or not the first value is empty. If it is empty, it returns the second value. Otherwise, it returns the first value. Input ParametersnodeOrExpr1 represents the first node or expression. nodeOrExpr2 represents the second node or expression.

510

InfoSphere Change Data Capture Management Console: Administration Guide

Return ValueString Example<sxt:element name="Phone" value="sxt:if-exist(@WorkPhone, @HomePhone)"/>

sxt:ifReturn
Syntaxsxt:if-return (testCondition, valueForTrue, valueForFalse) DescriptionThis function evaluates a condition and, depending on the evaluation result, returns a specified value. Input ParameterstestCondition represents an expression that can be evaluated to true or false. valueForTrue represents the value to be returned when the condition is true. valueForFalse represents the value to be returned when the condition is false. Return Valuestring Example<sxt:element name="Language" value="sxt:if-return(sxt:isequal(@lang,`fr), `French, `English)"/>

sxt:isEqual
Syntaxsxt:is-equal (nodeOrExpr, valueToTestAgainst) DescriptionThis function tests if a node or expression has a specific value. Input Parameters nodeOrExpr represents a node/expression whose value is compared with the specified value. valueToTestAgainst represents a specific value for testing the node or the expression. Return Valueboolean Example<sxt:element name="no_name" value="sxt:is-equal(@name, ")"/>

sxt:multiply
Syntaxsxt:multiply (value1, value2, [value3, ...]) DescriptionThis function multiplies two or more values provided. Input Parametersvalue1, value2, [value3, ...] represent two or more values that can be converted to numbers. Return Valuenumber Example<sxt:element name="Cost" value="sxt:multiply(Quantity, Price)"/>

sxt:nodeConcat
Syntaxsxt:nodeConcat (flag, nodeToConcat, delimiter) DescriptionThis function converts each node in a node-set to a string and then concatenates them together into a string.
Functions

511

Input Parametersflag represents an expression that can be evaluated to true or false. nodeToConcat represents the node to be concatenated. It must be a node-set. delimiter represents the delimiter to be used for separating each sub-value. Return Valuestring Example<sxt:element name="AuthorPhones" value="sxt:nodeConcat(,/ authors/phone, ,)"/>

sxt:padLeft
Syntaxsxt:pad-left (string_to_pad, value, string_to_fill) DescriptionThis function adds a number of characters to the left of a string. If the length of the string to return is less than the value specified, the return string is truncated. Input Parametersstring_to_pad specifies the string to be modified by adding characters to the left. value specifies the length of the string to be returned. string_to_fill specifies the string that contains the characters to fill. Return Valuestring Example<sxt:element name="Leading_Zeros_Number" value="sxt:padleft(number,8, 0)"/>

sxt:padRight
Syntaxsxt:pad-right (string_to_pad, value, string_to_fill) DescriptionThis function adds a number of characters to the right of a string. If the length of the string to return is less than the value specified, the return string is truncated. Input Parametersstring_to_pad specifies the string to be modified by adding characters to the right. value specifies the length of the string to be returned. string_to_fill specifies the string that contains the characters to fill. Return Valuestring Example<sxt:element name="Trailing_Space" value="sxt:pad-right(fname, 10, )"/>

sxt:proper
Syntaxsxt:proper (string) DescriptionThis function performs a capitalization of all the words provided as input. The first letter of a word is converted to uppercase, while the other ones to lowercase. Input Parametersstring Specifies a string that contains a number of words. Return Valuestring

512

InfoSphere Change Data Capture Management Console: Administration Guide

Example<sxt:element name="FullName" value="sxt:proper(full_name)"/>

sxt:setDefault
Syntaxsxt:setDefault (nodeOrExpr, defaultValue) DescriptionThis function returns a default value if a specified node/expression is evaluated to an empty string. Input ParametersnodeOrExpr represents a node/expression to be tested. defaultValue represents the value to be returned when the node/expression contains an empty string. Return Valuestring Example<sxt:element name="Language" value="sxt:setDefault(@lang,English)"/>

sxt:subtract
Syntaxsxt:subtract (value1, value2, [value3, ...]) DescriptionThis function subtracts one or more values from the first value specified. Input Parametersvalue1, value2, [value3, ...] represent two or more values that can be converted to numbers. Return Valuenumber Example<sxt:element name="Stored_Quantity" value="sxt:subtract(100, 20, 30)"/>. In this example, the return value is 50.

sxt:toLowerCase
Syntaxsxt:toLowerCase (value) DescriptionThis function converts a string to lower case. Input Parametersvalue represents the value to convert to lower case. Return Valuestring Example<sxt:element name="FirstName" value="sxt:toLowerCase(first_name) "/>

sxt:toUpperCase
Syntaxsxt:toUpperCase (value) DescriptionThis function converts a string to upper case. Input Parametersvalue represents the value to convert to upper case. Return Valuestring
Functions

513

Example<sxt:element name="LastName" value="sxt:toUpperCase(last_name)"/>

sxt:trim
Syntaxsxt:trim (value) DescriptionThis function strips off the leading and trailing blank spaces of a string. Input Parametersvalue represents the string value to be trimmed. Return Valuestring Example<sxt:element name="FirstName" value="sxt:trim(first_name)"/>

Database functions
To meet specific transform requirements, these extensions have been developed to supplement XPath and XSLT recommendations provided by W3C. The first extension is an XPath expression for self-reference. A leading # symbol means self-reference from the target point of view. For example, /root/level1/@attr1 points to an attribute in the source DOM, while #/root/level1/@attr1 points to an attribute in the target that is the XML document to be generated. InfoSphere CDC Event Server functions are marked with the sxt: prefix, which must be used with the function name. See also: sxtdb:getPKSeq sxtdb:lookup sxtdb:procCall on page 515

sxtdb:getPKSeq
Syntaxsxtdb:getPKSeq (tableName, colNameSeq, colNameCounter, seqName) DescriptionThis function retrieves the primary key base on a sequence table. Input Parameters v tableNameRepresents the table name where the sequence is stored. v colNameSeqRepresents the column name where the sequence name is stored. v colNameCounterRepresents the column name where the counter is stored. v seqNameRepresents the name of the sequence. Return Valuenumber Examplesxtdb:getPKSeq(SEQUENCES, SEQ_NAME, SEQ_COUNTER, CUST_ID)

sxtdb:lookup
Syntaxsxtdb:lookup (SQLStatement [,param1, param2, ...]) DescriptionThis function retrieves a single value by performing a query.

514

InfoSphere Change Data Capture Management Console: Administration Guide

Input Parameters SQLStatement represents the SQL statement to be performed on the target database. [param1, param2, ...] Represents the values of the input parameters if there are question marks in the statement. This parameter is optional. Only standard SQL types are supported. Return Valuestring Note: This function returns the first column in the first row of the result set. Examplesxtdb:lookup("SELECT country_name FROM countries where country_id=?", countryID).

sxtdb:procCall
Syntaxsxtdb:procCall (SchemaName, ProcName, [param1, param2, ...]) DescriptionThis function retrieves a value by calling a stored procedure. Input Parameters v SchemaNameRepresents the name of the database schema. Note: Only standard SQL types are supported. v ProcNameRepresents the name of the stored procedure. v [param1, param2, ...]Represents the values of the input parameters of the stored procedure. Specifying this parameter is optional. Return Valuestring This function returns the first available OUTPUT parameter. Examplesxtdb:ProcCall("SCOTT", "GET_EMP_ID", @lname)

Using external Java objects in data transformations


You can extend your data transformations using external Java objects. Some of the things you can do include but are not limited to the following: v Implement your own custom data validation v Translate values using look-up tables v Perform complex calculations It is very easy to use your Java classes in your mapping project. The methods must be public but need not be static. Make sure that any external Java classes you want to use can be found in the CLASSPATH environment variable. InfoSphere CDC Event Server will use Java Reflection API to call your programs. InfoSphere CDC Event Server provides three types of calling conventions that can manipulate the following objects: See also: Simple string objects (type I) on page 516 SQL data types (type II) on page 516 XML objects (type III) on page 516

Functions

515

Simple string objects (type I)


For this type of implementation, all the data passed to your Java program are of String type. Your program must also return a string. Syntaxjavas:[package.]className.methodName ([param1, ...]) -> String where: v javasrepresents the identifier for the external Java call simple method. v classNameRepresents the Java class name, which may also reference the package name. v methodNameRepresents the method that performs the processing. Parameters are optional, and they can be XPath expressions, functions, or literal strings. Example<sxt:element name="MyTag" value="javas:com.datamirror.MyClass.someMethod(@cust_id)"/>

SQL data types (type II)


For this type of implementation, all the data passed to your Java program are of Object type. Your program must also return an object. The data types are common SQL data types for databases. They are those defined by the java.sql package. The syntax is the same as for the type I, except that the identifier is java: instead of javas:, as follows:
java:[package.]ClassName.methodName([param1, ...]) -> Object

XML objects (type III)


This type of implementation supports extended XML objects, including XPath node-set and DOM objects (for example, Element and Node). InfoSphere CDC Event Server provides a set of XObjects (for example, XString, XNumber, XBoolean, and Xdate). The syntax is the following:
javax:[package.]ClassName.methodName([param1, ...]) -> XObject

In the current release, only type I (simple string objects) is fully implemented, while type II (SQL data types) and type III (XML objects) will be implemented in a future release.

XPath expression operators


An XPath expression returns either a node-set, a string, a Boolean, or a number. See also: + Operator on page 517 - Operator on page 517 * Operator on page 517 div Operator on page 517 mod Operator on page 517 = Operator on page 517 != Operator on page 517

516

InfoSphere Change Data Capture Management Console: Administration Guide

< Operator on page 518 <= Operator on page 518 > Operator on page 518 >= Operator on page 518 or Operator on page 518 and Operator on page 518 () parentheses Operator on page 518 [ ] Operator on page 519 / Operator on page 519 // Operator on page 519 @ Operator on page 519

+ Operator
DescriptionAdds two numbers. You can also use it to add two expressions that return a numeric result.

- Operator
DescriptionYields the difference between two numbers or indicates the negative value of a numeric expression.

* Operator
DescriptionMultiplies two numbers.

div Operator
DescriptionDivides two numbers and returns a floating decimal.

mod Operator
DescriptionDivides two numbers and returns only the remainder.

= Operator
DescriptionEqual. If the expression is equal to the specified value, the operator returns true. If the expression is not equal to the specified value, the operator returns false. Exampleprice=7.80 ReturnsTrue if price is 7.80; false if price is 7.90

!= Operator
DescriptionNot equal to. If the expression is not equal to the specified value, the operator returns true. If the expression is equal to the specified value, the operator returns false. Exampleprice!=7.80
Functions

517

ReturnsTrue if price is 7.90; false if price is 7.80

< Operator
DescriptionCompares two numeric expressions and determines whether expression1 is less than expression2; if so, the operator returns true. If expression1 is greater than or equal to expression2, the operator returns false. Exampleprice<7.80 ReturnsTrue if price is 7.00; false if price is 7.80

<= Operator
DescriptionCompares two specified numeric expressions and determines whether expression1 is less than or equal to the expression2; if it is, the operator returns true. If the expression1 is greater than expression2, the operator returns false. Exampleprice<=7.80 ReturnsTrue if price is 7.00; false if price is 7.90

> Operator
DescriptionCompares two numeric expressions and determines whether expression1 is greater than expression2; if it is, the operator returns true. If expression1 is less than or equal to expression2, the operator returns false. Exampleprice>7.80 ReturnsTrue if price is 7.90; false if price is 7.80

>= Operator
DescriptionCompares two numeric expressions and determines whether expression1 is greater than or equal to expression2 (true) or expression1 is less than expression2 (false).

or Operator
DescriptionLogical or.

and Operator
DescriptionLogical and.

() parentheses Operator
DescriptionControls the order in which the operators execute in the expression. Parentheses override the normal precedence order and cause the expressions within the parentheses to be evaluated first. When parentheses are nested, the contents of the innermost parentheses are evaluated before the contents of the outer ones.

518

InfoSphere Change Data Capture Management Console: Administration Guide

[ ] Operator
DescriptionA filter is evaluated as a Boolean on every node that is within the current context. If the Boolean evaluates to true, the node is included in the returned set; otherwise, it is excluded. Filters are enclosed in brackets.

/ Operator
DescriptionSelects from the root node.

// Operator
DescriptionSelects nodes in the document that match the selection no matter where they are.

@ Operator
DescriptionIdentifies an attribute of a node.

Functions

519

520

InfoSphere Change Data Capture Management Console: Administration Guide

Dialog boxes
InfoSphere CDC includes several dialog boxes for working with the user interface. In this section, you will learn: Datastore Management User Management on page 525 Connection Management on page 530 Access Server Options on page 531 Preferences on page 534 Datastores on page 536 Notifications on page 541 Source tables on page 543 Target tables on page 546 Subscriptions on page 546 Table mappings on page 551 Column mappings on page 555 XML message mappings on page 559 Data translation on page 560 Table operations on page 560 Promoting changes on page 561 Monitoring on page 562

Datastore Management
Management Console includes several dialog boxes that let you manage datastores in the Access Manager perspective. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: New Datastore dialog box Connection Parameters dialog box on page 522 Copy Datastore dialog box on page 523 Select User dialog box on page 523 Datastore List Report dialog box on page 523 Edit Datastore dialog box on page 524 Datastore tab on page 524 History tab on page 525

New Datastore dialog box


Use this dialog box to add a new datastore in the Access Manager perspective of Management Console.

Copyright IBM Corp. 2008

521

A datastore represents the InfoSphere CDC installation and the database made available for replication. Identification v NameSpecifies the name of the datastore you want to add. v DescriptionSpecifies a brief description for the datastore. v ServerSpecifies the hostname or full IP address of the server where you have installed InfoSphere CDC. v PortSpecifies the port number of the server where you installed InfoSphere CDC. PingPings the server where you have installed InfoSphere CDC. This returns the type of server where you have installed InfoSphere CDC and the version number of the product. Properties v Datastore TypeSpecifies the type of InfoSphere CDC product you have installed on a server. InfoSphere CDC can be of type Source, Target, or Dual. Source InfoSphere CDC captures data from a source server and sends it to a target destination. Target InfoSphere CDC receives captured data sent by a source server and applies it to a target destination. InfoSphere CDC captures data from a source server and then sends it to a target destination. It then receives the data and applies it to the target destination. v Platform TypeSpecifies the type of platform where you have installed InfoSphere CDC. v Database TypeSpecifies the type of database you have installed. InfoSphere CDC will use this database as the source or target of replicated data. v Datastore VersionSpecifies the version of the InfoSphere CDC product you have installed. Dual Connection ParametersOpens the Connection Parameters dialog box. Use this dialog box to set connection parameters for users. These parameters will be used as default connection parameters for all users assigned to this datastore. System administrators can change these parameters for each user in order to override the default parameters when required. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

Connection Parameters dialog box


Use this dialog box to set connection parameters for the datastore in the Access Manager perspective of Management Console. A datastore represents the InfoSphere CDC installation and the database made available for replication. v Database/URLspecifies the name of the database or the Universal Resource Locator (URL) of the database server you want to connect to.

522

InfoSphere Change Data Capture Management Console: Administration Guide

v DB Loginspecifies the database user name to connect to the database. If you want users to connect to the database for replication with WebSphere DataStage, then you must specify the user you created when installingInfoSphere CDC. v DB Passwordspecifies the password to connect to the database. v Confirm Passwordspecifies the confirmed password. Propagate changes to usersenable this option when you want users assigned to this datastore using existing connection parameters to use new connection parameters. The intent of this feature is to ease user account administration so that you only have to specify connection parameters once. You can however choose to override the default connection parameters so that each user has their own connection parameters when required. You can set connection parameters for each user when assigning a user to a datastore in the Connection Management view. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

Copy Datastore dialog box


Use this dialog box to copy a datastore in the Access Manager perspective of Management Console. A datastore represents the InfoSphere CDC installation and the database made available for replication. New NameSpecifies the name for the datastore you want to add. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

Select User dialog box


Use this dialog box to assign a user to datastore you have added in Management Console. A datastore represents the InfoSphere CDC installation and the database made available for replication. Select one or more users to assign to the datastoreLists the users you have assigned to the selected datastore. Note: You can only assign a user to a datastore if you are a System Administrator that can manage datastores and user accounts.

Datastore List Report dialog box


Use this dialog box to specify the type of information you want included in a list report about the datastores you are managing. You can generate a list report in the Access Manager perspective of Management Console. A datastore represents the InfoSphere CDC installation and the database made available for replication. v Descriptionincludes a description you specified when you added the datastore.

Dialog boxes

523

v Datastore Platformincludes the type of database platform on which this datastore resides. v Date Createdincludes the date you had created the datastore. v Date Last Modifiedincludes the date the datastore was last modified. v User Accessincludes the users you have assigned to this datastore. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

Edit Datastore dialog box


Use this dialog box to edit the properties of an existing datastore you have selected in the Access Manager perspective of Management Console. A datastore represents the InfoSphere CDC installation and the database made available for replication. DatastoreUse this tab to view the properties on the datastore. You can make changes to these properties as required. HistoryUse this tab to view the date and time the datastore was created and last modified. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

Datastore tab
Use this tab view the properties of an existing datastore in the Access Manager perspective of Management Console. A datastore represents the InfoSphere CDC installation and the database made available for replication. Identification v NameSpecifies the name of the datastore you want to add. v DescriptionSpecifies a brief description for the datastore. v ServerSpecifies the hostname or full IP address of the server where you have installed InfoSphere CDC. v PortSpecifies the port number of the server where you installed InfoSphere CDC. PingPings the server where you have installed InfoSphere CDC. This returns the type of server where you have installed InfoSphere CDC and the version number of the product. Properties v Datastore TypeSpecifies the type of InfoSphere CDC product you have installed on a server. InfoSphere CDC can be of type Source, Target, or Dual. Source InfoSphere CDC captures data from a source server and sends it to a target destination.

524

InfoSphere Change Data Capture Management Console: Administration Guide

Target InfoSphere CDC receives captured data sent by a source server and applies it to a target destination. InfoSphere CDC captures data from a source server and then sends it to a target destination. It then receives the data and applies it to the target destination. v Platform TypeSpecifies the type of platform where you have installed InfoSphere CDC. v Database TypeSpecifies the type of database you have installed. InfoSphere CDC will use this database as the source or target of replicated data. v Datastore VersionSpecifies the version of the InfoSphere CDC product you have installed. Dual Connection ParametersOpens the Connection Parameters dialog box. Use this dialog box to set connection parameters for users. These parameters will be used as default connection parameters for all users assigned to this datastore. System administrators can change these parameters for each user in order to override the default parameters when required. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

History tab
Use this tab to view information about a datastore in the Access Manager perspective of Management Console. A datastore represents the InfoSphere CDC installation and the database made available for replication. v Createdspecifies the date the datastore was created. v Last Modifiedspecifies the date the datastore was last modified. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

User Management
Access Manager includes several dialog boxes that let you manage user accounts in the Management Console perspective. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: New User dialog box on page 526 Copy User dialog box on page 527 Select Datastore dialog box on page 527 Change Role dialog box on page 527 User List Report dialog box on page 528 User Properties dialog box on page 529
Dialog boxes

525

User tab on page 529 History tab on page 530

New User dialog box


Use this dialog box to add a new user in the Access Manager perspective of Management Console. You must specify login credentials so that the user can log into Management Console and you must set a security role for the user to determine their level of access in Management Console. User Information v Namespecifies the required unique name for the user to login to Management Console. v Full Namespecifies the full name of the user. You may want to provide this information for administration purposes, such as when you generate a list report on the user. v Descriptionspecifies a brief description for the user. You may want to provide this information for administration purposes, such as when you generate a list report on the user. v Passwordspecifies the required password for the user to login to Management Console. As the system administrator, if you have enabled complex passwords, then you must specify a password that meets these requirements. v Confirm Passwordspecifies the confirmed password. Role v System Administratorspecifies that users assigned to this role can perform all available operations in Management Console. Only users that require full operational access to the Monitoring and Configuration perspectives should be assigned to this role. System administrators can also modify system parameters to calibrate their replication environment. v Administratorspecifies that users assigned to this role can perform all available operations in Management Console, but cannot modify system parameters. Users assigned to this role can access both the Monitoring and Configuration perspectives. v Operatorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. v Monitorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. Enable user account and datastore administrationenables a user assigned the System Administrator role access to the Access Manager perspective. If you enable this option for a user, then they can create new users, new datastores, and define Access Server password settings. Status v Account is disableddisables the user account. Users with a disabled account cannot login to Management Console. v Account is lockedlocks the user account. This checkbox is enabled automatically after the number of failed login attempts exceeds the locking policy you may have set in the Access Server Options dialog box in Management Console. v User must change password at next loginforces a user to change their password at next login.

526

InfoSphere Change Data Capture Management Console: Administration Guide

v Password never expiresoverrides the password expiration policy you may have set in the Access Server Options dialog box in Management Console. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. Notes: v Users assigned to the Operator role can start, stop, and monitor replication activities. They can also view the tables selected for refresh and start a refresh on a subscription. Operators also have access to the Replication Diagram view, and can view notifications sent by subscriptions or datastores. However, users assigned to this role cannot configure replication and select or remove tables from a refresh. v Users assigned to the Monitor role can view the event log, view statistics, and view table mappings. Users can view the replication state and status of a subscription and can view latency threshold information. Monitors also have access to the Replication Diagram view. However, users assigned to this role cannot start or stop replication, configure replication, refresh tables, or view notifications sent by subscriptions and datastores.

Copy User dialog box


Use this dialog box to copy a user. You can copy the properties of an existing user in the Access Manager perspective of Management Console. Enter name for the new userSpecifies the name of the user you want to create. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

Select Datastore dialog box


Use this dialog box to assign a datastore to an existing user. Select a datastore to assign to the userLists the available datastores you can assign. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

Change Role dialog box


Use this dialog box to change the role of an existing user in the Access Manager perspective of Management Console. New RoleLists the available security roles you can assign to a user. Role v System Administratorspecifies that users assigned to this role can perform all available operations in Management Console. Only users that require full operational access to the Monitoring and Configuration perspectives should be assigned to this role. System administrators can also modify system parameters to calibrate their replication environment.
Dialog boxes

527

v Administratorspecifies that users assigned to this role can perform all available operations in Management Console, but cannot modify system parameters. Users assigned to this role can access both the Monitoring and Configuration perspectives. v Operatorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. v Monitorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. Enable user account and datastore administrationenables a user assigned the System Administrator role access to the Access Manager perspective. If you enable this option for a user, then they can create new users, new datastores, and define Access Server password settings. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. Notes: v Users assigned to the Operator role can start, stop, and monitor replication activities. They can also view the tables selected for refresh and start a refresh on a subscription. Operators also have access to the Replication Diagram view, and can view notifications sent by subscriptions or datastores. However, users assigned to this role cannot configure replication and select or remove tables from a refresh. v Users assigned to the Monitor role can view the event log, view statistics, and view table mappings. Users can view the replication state and status of a subscription and can view latency threshold information. Monitors also have access to the Replication Diagram view. However, users assigned to this role cannot start or stop replication, configure replication, refresh tables, or view notifications sent by subscriptions and datastores.

User List Report dialog box


Use this dialog box to specify the type of information you want included in a list report about the users you are managing. You can generate a list report in the Access Manager perspective of Management Console. v Full Nameincludes the full name of the user you may have specified when adding the user account. v Roleincludes the role you assigned to this user when adding the user account. v Descriptionincludes the description you may have specified when adding the user account. v Account Statusincludes information if the user account is disabled, locked, if the user must change the password at next login, and if this user account overrides any password expiry you have set in Management Console. v Date Createdincludes the date you created the user account. v Date Last Modifiedincludes the date you last modified the user account. v Datastore Accessincludes a list of the datastores this user account has access to. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

528

InfoSphere Change Data Capture Management Console: Administration Guide

User Properties dialog box


Use this dialog box to edit the properties of an existing user you have selected in the Access Manager perspective of Management Console. UserUse this tab to view the properties on the user account. You can make changes to these properties as required. HistoryUse this tab to view the date and time the user account was created and last modified. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

User tab
Use this tab to edit the properties of an existing user in the Access Manager perspective of Management Console. You can modify login credentials and the security role of the user. User Information v Namespecifies the required unique name for the user to login to Management Console. v Full Namespecifies the full name of the user. You may want to provide this information for administration purposes, such as when you generate a list report on the user. v Descriptionspecifies a brief description for the user. You may want to provide this information for administration purposes, such as when you generate a list report on the user. v Passwordspecifies the required password for the user to login to Management Console. As the system administrator, if you have enabled complex passwords, then you must specify a password that meets these requirements. v Confirm Passwordspecifies the confirmed password. Role v System Administratorspecifies that users assigned to this role can perform all available operations in Management Console. Only users that require full operational access to the Monitoring and Configuration perspectives should be assigned to this role. System administrators can also modify system parameters to calibrate their replication environment. v Administratorspecifies that users assigned to this role can perform all available operations in Management Console, but cannot modify system parameters. Users assigned to this role can access both the Monitoring and Configuration perspectives. v Operatorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. v Monitorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. Enable user account and datastore administrationenables a user assigned the System Administrator role access to the Access Manager perspective. If you enable this option for a user, then they can create new users, new datastores, and define Access Server password settings.

Dialog boxes

529

Status v Account is disableddisables the user account. Users with a disabled account cannot login to Management Console. v Account is lockedlocks the user account. This checkbox is enabled automatically after the number of failed login attempts exceeds the locking policy you may have set in the Access Server Options dialog box in Management Console. v User must change password at next loginforces a user to change their password at next login. v Password never expiresoverrides the password expiration policy you may have set in the Access Server Options dialog box in Management Console. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. Notes: v Users assigned to the Operator role can start, stop, and monitor replication activities. They can also view the tables selected for refresh and start a refresh on a subscription. Operators also have access to the Replication Diagram view, and can view notifications sent by subscriptions or datastores. However, users assigned to this role cannot configure replication and select or remove tables from a refresh. v Users assigned to the Monitor role can view the event log, view statistics, and view table mappings. Users can view the replication state and status of a subscription and can view latency threshold information. Monitors also have access to the Replication Diagram view. However, users assigned to this role cannot start or stop replication, configure replication, refresh tables, or view notifications sent by subscriptions and datastores.

History tab
Use this tab to view information about a user in the Access Manager perspective of Management Console. v Createdspecifies the date the user was created. v Last Modifiedspecifies the date the user was last modified. v Last Password Changespecifies the date of the last password change. v Last Loginspecifies the last login of the user in Management Console. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

Connection Management
Management Console includes several dialog boxes that let you manage your connections to datastores in the Access Manager perspective. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: Connection Parameters dialog box on page 531

530

InfoSphere Change Data Capture Management Console: Administration Guide

Connection Parameters dialog box


Use this dialog box to set connection parameters for a user that is assigned to a datastore in the Access Manager perspective of Management Console. A datastore represents the InfoSphere CDC installation and the database made available for replication. v Database/URLspecifies the name of the database or the Universal Resource Locator (URL) of the database server you want to connect to. v DB Loginspecifies the database user name to connect to the database. If you want users to connect to the database for replication with WebSphere DataStage, then you must specify the user you created when installingInfoSphere CDC. v DB Passwordspecifies the password to connect to the database. v Confirm Passwordspecifies the confirmed password. v Always show connection dialogenables the user to specify the password each time they want to connect to the datastore. v Show parameter valuess (except password)displays the connection parameters to the user (except password) each time the user tries to connect to the datastore. v Write-protect parameters (except password)displays the connection parameters to the user (except password) in read-only format each time the user tries to connect to the datastore. v Allow connection parameters savingenables the user to save the connection parameters when connecting to a datastore. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

Access Server Options


Management Console includes several options that let you set password and user account security policies on all user accounts in the Access Manager perspective. You can also enable audit logging. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: Access Server Options dialog box

Access Server Options dialog box


Use this dialog box to set security policies for passwords, user accounts, and to enable auditing. PasswordsUse this tab to set password policy for all user accounts. Accounts Use this tab to set account policies for all user accounts. AuditUse this tab to enable audit logging on all user accounts.

Dialog boxes

531

Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. Passwords tab Accounts tab Audit tab on page 533 Audit Trail Report dialog box on page 533 Security Log dialog box on page 534 Change Password dialog box on page 534

Passwords tab
Use this tab to set a password policy for all user accounts in the Access Manager perspective of Management Console. Require complex passwords enables Access Server to enforce complex password requirements in order to login to Management Console. v Minimum password lengthspecifies the minimum number of characters required for a password. By default, this setting is defined with a password length of 6 characters. v Minimum alphabetic charactersspecifies the minimum number of alphabetic characters required for a password. By default, this setting is defined with a value of 2 alphabetic characters. v Minimum non-alphabetic charactersspecifies the minimum number of non-alphabetic characters required for a password. By default, this setting is defined with a value of 2 non-alphabetic characters. Enforce password historyenables Access Server to enforce password history. The intent of this policy is to enable administrators to enhance security by ensuring that old passwords are not continually reused. v Passwords rememberedspecifies the number of unique new passwords that have to be associated with a user account before an old password can be reused. The value must be between 1 and 12 passwords. By default, this setting is defined with a value of 5. Enforce password expiryenables Access Server to enforce password expiry policy on user accounts. The intent of this policy is to enable administrators to enhance security by ensuring that new passwords are created and associated with user accounts. v Maximum password age (days)specifies the number of days a password is valid before it expires. By default, this setting is defined with a value of 90 days. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

Accounts tab
Use this tab to set account policies for all user accounts in the Access Manager perspective of Management Console. Lock accounts on failed login attempts enables Access Server to enforce account locking after a number of failed login attempts into Management Console.

532

InfoSphere Change Data Capture Management Console: Administration Guide

v Consecutive failures before lockspecifies the number of allowed attempts before the account is locked. The number of allowed attempts must be between 1 and 100. The default is 3. Enforce new account expiryenables Access Server to enforce an account expiry on new accounts. v Maximum new account agespecifies that if the maximum number of days is exceeded, the user account is automatically locked. A user account is considered new from the moment it is created until the moment it is first accessed. If a new user account has been locked, it can be unlocked only by the System Administrator. The number of days must be between 1 and 999. The default value is 15. Display previous failed login attemptsenables Access Server to display the number of times a user has attempted to log into Management Console. A message that indicates the number of previous failed login attempts appears when the user connects to Access Server in Management Console. Display last successful loginenables Access Server to display a message that indicates the last successful login date and time when the user tries to connect to Access Server in Management Console. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

Audit tab
Use this tab to set enable auditing on user accounts in the Access Manager perspective of Management Console. Enable audit logenable if you want to audit user account management activities, datastore management activities, security policies, or general events. v Audit account managementenable if you want to audit user account management activities such as the creation, modification, and deletion of users. v Audit datastore managementenable if you want to audit datastore management activities such as the creation, modification, and deletion of datastores. v Audit security policy managementenable if you want to audit security policy settings related to passwords and user accounts. v Audit general eventsenable if you want to audit general events generated by Access Server. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.

Audit Trail Report dialog box


Use this dialog box to generate an audit trail report. If you have enabled audit logging on depending on the activities you have set for auditing, the report may include information on the following: v Added, modified, or deleted user accounts. v Added, modified, deleted, or renamed datastores. v New or lost user and datastore assignments. v Enabled, disabled, or modified ability to generate an audit log.
Dialog boxes

533

v Modified security settings on user accounts. Fromspecifies that the report will include audited activities starting from this date. Tospecifies that the report will include audited activities ending at this date.

Security Log dialog box


Use this dialog box to generate a security log report. You can generate security log reports after enabling audit logging and enabled auditing of security policy settings related to passwords and user accounts. The following activities are recorded the report: v Modified user passwords v Disabled or enabled user accounts v Locked or unlocked user accounts v Successful or failed log in attempts by a user v Which users are logged or logged out of Management Console v Which datastores users are connected to or disconnected from v Started or stopped Access Servers v Generated report lists Fromspecifies that the report will include audited security settings starting from this date. Tospecifies that the report will include audited security settings ending at this date.

Change Password dialog box


Use this dialog box to change your login password for Management Console. Current passwordspecifies the current password. New passwordspecifies the new password. Confirm passwordspecifies the new password.

Preferences
Management Console includes several dialog boxes for setting preferences within Management Console. See also: Save Changes dialog box Column Encodings dialog box on page 535 Add Encoding dialog box on page 535 Modify Encoding dialog box on page 536

Save Changes dialog box


Use this dialog box to save changes you made to subscriptions before closing the Mapping Details view. Select the items to saveLists the subscriptions to which you made changes to in the Mapping Details view. Subscriptions are presented in the following format:

534

InfoSphere Change Data Capture Management Console: Administration Guide

<subscription>: <source table> - <target table>

Select AllEnables Management Console to save changes to all subscriptions you made changes to in the Mapping Details view. Select NoneEnables Management Console to save none of the changes you made to the subscriptions in the Mapping Details view.

Column Encodings dialog box


Use this dialog box to add, modify, or delete character encodings in Management Console. Character SetLists the character sets available for encoding conversion. NameLists the name of the character set. IBM CCSIDLists the IBM CCSID of the character set. A Coded Character Set Identifier (CCSID) is a unique 16-bit number identifying a set of encoding scheme identifiers, character set identifiers, code page identifiers, and additional coding-related required information. ISO/IANA NameLists the ISO/IANA Name for the character set. This is dependent on database platform. Refer to the Java Supported Encodings Document for a list of supported ISO/IANA encoding names. LengthLists the character length for a character set. Single-Byte character sets (SBCS) provide 256 character codes. Double-Byte character sets (DBCS) provide encoding (including all control characters) two bytes. Multi-Byte character sets (MBCS) provide encoding using varying numbers of bytes (octets). AddOpens the Add Encoding dialog box. You can use this to add a character set. ModifyOpens the Modify Encoding dialog box. You can use this to modify an existing character set. DeleteDeletes a character set. ImportImports a character set from your local computer. ExportExports a character set to your local computer.

Add Encoding dialog box


Use this dialog box to add a character set. You can then convert between character sets in Management Console. Character SetLists available character sets in your CSV template. Encoding NameSpecifies an encoding name for the character set. IBM CCSIDSpecifies the IBM CCSID. A Coded Character Set Identifier (CCSID) is a unique 16-bit number identifying a set of encoding scheme identifiers, character set identifiers, code page identifiers, and additional coding-related required information.

Dialog boxes

535

ISO/IANA NameSpecifies the ISO/IANA Name for the character set. This is dependent on database platform. Refer to the Java Supported Encodings Document for a list of supported ISO/IANA encoding names. Character LengthLists available character lengths for a character set. Single-Byte character sets (SBCS) provide 256 character codes. Double-Byte character sets (DBCS) provide encoding (including all control characters) two bytes. Multi-Byte character sets (MBCS) provide encoding using varying numbers of bytes (octets).

Modify Encoding dialog box


Use this dialog box to modify an existing character set. Character SetLists available character sets in your CSV template. Encoding NameSpecifies an encoding name for the character set. IBM CCSIDSpecifies the IBM CCSID. A Coded Character Set Identifier (CCSID) is a unique 16-bit number identifying a set of encoding scheme identifiers, character set identifiers, code page identifiers, and additional coding-related required information. ISO/IANA NameSpecifies the ISO/IANA Name for the character set. This is dependent on database platform. Refer to the Java Supported Encodings Document for a list of supported ISO/IANA encoding names. Character LengthLists available character lengths for a character set. Single-Byte character sets (SBCS) provide 256 character codes. Double-Byte character sets (DBCS) provide encoding (including all control characters) two bytes. Multi-Byte character sets (MBCS) provide encoding using varying numbers of bytes (octets).

Datastores
Management Console includes several dialog boxes that work with datastores in Management Console. See also: Datastore Properties dialog box on page 537 Update Access Parameters dialog box on page 537 Add or Modify System Parameter dialog box on page 537 General tab on page 537 System Parameters tab on page 538 Aliases tab on page 538 Retry Datastore Connection dialog box on page 539 Specify Owner and Name page on page 539 Define Columns page on page 539 Review New Table page on page 539 Add Column dialog box on page 540 Modify Column dialog box on page 540

536

InfoSphere Change Data Capture Management Console: Administration Guide

Datastore Properties dialog box


Use this dialog box to view general information about your datastores, to set system parameters, and to create an alias for a target datastore that resides on a private network. GeneralUse this tab to view the general properties of your selected datastore and update your subscriptions if you have updated access parameters for a datastore in Access Manager. System ParametersUse this tab to add, modify, and delete system parameters on your selected datastore. AliasesUse this tab to add, modify, and delete aliases for your target datastore.

Update Access Parameters dialog box


Use this dialog box to end replication for active subscriptions and update access parameters for the datastore. DatastoreDisplays name of the target datastore for which you want to change access parameters. Subscriptions v SubscriptionLists the subscriptions associated with the datastore. v StateDisplays the state of the subscription as active or inactive. An active state indicates that the subscription is replicating data. End ReplicationEnds replication on active subscriptions. UpdateUpdates each subscription that uses that uses this datastore as a target in Management Console.

Add or Modify System Parameter dialog box


Use this dialog box to add a system parameter. Source ParameterIndicates that you want to add a system parameter for a source datastore. Target ParameterIndicates that you want to add a system parameter for a target datastore. Parameter NameSpecifies the name of the system parameter. ValueSpecifies the value of the system parameter.

General tab
Use this tab to view general information about your datastore. Identification v Namedisplays the unique name for the datastore. v Descriptiondisplays the short description assigned to the datastore when it was created in Access Manager. v Host Namedisplays the host name or full IP address of the server where the datastore is running.
Dialog boxes

537

v Portdisplays the port number that the datastore uses to listen for communication from Access Manager. This port number is specified during InfoSphere CDC installation. v Platformdisplays the platform type of the datastore. v Databasedisplays the type of database associated with the datastore. v Versiondisplays the version of InfoSphere CDC installed on the source or target. Access Parameters v Database Typedisplays the type of database associated with the datastore. v Database Namedisplays the name of the database. v Ownerdisplays the name of the database owner. v Passworddisplays the password for the database. Update Related Subscriptionsopens the Update Access Parameters dialog box. Use this dialog box when you have changed the access parameters for a target datastore and you need to update each subscription associated with this datastore.

System Parameters tab


Use this tab to add, modify, and delete a system parameter. Parameterlists the name of each system parameter supported by InfoSphere CDC Management Console. Availability of the system parameters is dependant on the platform and version of InfoSphere CDC that you have installed. Valuelists the default values for system parameters. Addopens the Add System Parameter dialog box. Use this dialog box to add a system parameter. Modifyopens the Modify System Parameter dialog box. Use this dialog box to modify a system parameter. Deletedeletes the selected system parameter from the datastore.

Aliases tab
Use this tab to add, modify, and delete aliases for target datastores that exist on a private network. Host namedisplays the host name you specified for this datastore in Access Manager. Access Manager uses the hostname or the IP address to connect to your target datastore. Portdisplays the port number you specified for this datastore in Access Manager. Aliaseslists any existing aliases created for the datastore. Addopens the Add Aliases dialog box. Use this dialog box to add an alias for the datastore. Modifyopens the Modify Aliases dialog box. Use this dialog box to modify an alias for the datastore.

538

InfoSphere Change Data Capture Management Console: Administration Guide

Deletedeletes an existing alias.

Retry Datastore Connection dialog box


When Access Manager cannot connect to a datastore, you are prompted to retry connection using your user name and/or password. This can also happen if there is a network failure in your environment. The credentials you need to specify in order to reconnect depend on how your user access was set by your system administrator.

Specify Owner and Name page


Use this page to specify an owner and name for the new table you want to create. Table Library/Table OwnerLists the owner or library in which the table belongs. Library/DatabaseLists the library or database in which the table belongs. Table NameSpecifies the name of the table.

Define Columns page


Use this page to add, modify, or delete columns for your table. Keydisplays a green checkmark when the column is the primary key in the table. This is the column you use to sort data. A table can have more than one primary key columns. Column Namedisplays the name of the column. Data Typelists the type data type you specified for the column. Columns can store data, such as date, numeric, or character data. Different data types exist on different platform databases. Scalelists the scale you specified for each numeric column in a table. This is the maximum number of digits to the right of the decimal point. Nullabledisplays a green check mark when you have enabled the column as nullable. Depending on the platform, nullable may also be called a null reference or null object. Addopens the Add Column dialog box. Use this dialog box to add a column for the new table. Modifyopens the Modify Column dialog box. Use this dialog box to modify an existing column in the table. Deletedeletes an existing column. Move Upmoves the selected column to the top of this list. Move Downmoves the selected column to the bottom of the list.

Review New Table page


Use this page to review the CREATE TABLE statement that generates your new table.

Dialog boxes

539

Make this table available for replicationEnables the table for replication. You can view the table in the Source Tables area of Management Console.

Add Column dialog box


Use this dialog box to add a column for the table. Column NameSpecifies the name of the new column. Data TypeLists the type data type you specified for the column. Columns can store data, such as date, numeric, or character data. Different data types exist on different platform databases. Length/PrecisionSpecifies the precision for each numeric column in a table. This is the maximum number of digits used by the data type of the column. When used to describe floating-point numbers, the number of bits used to hold the fractional part. The more precision a system uses, the more exactly it can represent fractional quantities. ScaleSpecifies the scale of each numeric column in a table. This is the maximum number of digits to the right of the decimal point. KeyEnables the column to be a primary key. NullableEnables the column as nullable. AddAdds the column to the table.

Modify Column dialog box


Use this dialog box to modify a column in an existing table. Column Namespecifies the name of the new column. Data Typelists the type data type you specified for the column. Columns can store data, such as date, numeric, or character data. Different data types exist on different platform databases. Length/Precisionspecifies the precision for each numeric column in a table. This is the maximum number of digits used by the data type of the column. When used to describe floating-point numbers, the number of bits used to hold the fractional part. The more precision a system uses, the more exactly it can represent fractional quantities. Scalespecifies the scale of each numeric column in a table. This is the maximum number of digits to the right of the decimal point. Keyenables the column to be a primary key. Nullableenables the column as nullable.

540

InfoSphere Change Data Capture Management Console: Administration Guide

Notifications
Management Console includes several dialog boxes that work with notications within Management Console. See also: Notification dialog box Filter Messages dialog box on page 542 Copy Notification Settings dialog box on page 542 Latency Threshold dialog box on page 543

Notification dialog box


Use this dialog box to set notifications for your source and target datastores. Sourceuse this tab to configure a notification when it is used by a subscription as the source datastore. Targetuse this tab to configure a notification when it is used by a subscription as the target datastore. Notification categories Notification categories represent the events that InfoSphere CDC detects in your source and/or target datastores. v Scrape/Refresh Events (Source)categorizes notifications that are generated for events that occur when InfoSphere CDC scrapes or refreshes data from your source datastore. v Apply Events (Target)InfoSphere CDC generates notifications related to events that occur during the target apply process. For example, InfoSphere CDC can generate a message when there is failure to apply an update on the target table. v Communications Eventscategorizes notifications that are generated for communication events that can occur between source and the target datastores. For example, InfoSphere CDC can generate a message when there is a failure to create TCP/IP socket. v Environment Eventscategorizes notifications that are generated when requirements for a basic replication environment are not met. For example, InfoSphere CDC can generate a message when it cannot connect to a database, or when permissions have not been set. v Journal/Log Maintenance Eventscategorizes notifications that are generated when InfoSphere CDC reads the journal or during log maintenance. Notification messages v Fatal MessagesEnables you to setup a notification for fatal messages. For example, InfoSphere CDC can generate a fatal message in the Event Log view when it cannot open or find a metadata table, or when it encounters a communication error between datastores. v Error MessagesEnables you to setup a notification for error messages. InfoSphere CDC sends a notification when it encounters an error. For example, InfoSphere CDC can generate an error message in the Event Log view when it inserts a row and creates a duplicate key, or when it encounters a runtime verification error on a derived expression.

Dialog boxes

541

v Informational MessagesEnables you to setup a notification for informational messages. InfoSphere CDC sends a notification when it encounters an event that you need to know about. For example, InfoSphere CDC can generate informational messages in the Event Log view when it is ready to mirror tables, or when it encounters instances that require code page conversions. v Status MessagesEnables you to setup a notification for status messages. InfoSphere CDC sends a notification when it encounters a specific event during replication. For example, InfoSphere CDC can generate status messages in the Event Log view when it is going to refresh a table, when it cannot journal changes on a table, or when it has parked a table for replication. v Operational MessagesEnables you to setup a notification for operational messages. InfoSphere CDC sends a notification when it has completed an operation during replication. For example, InfoSphere CDC can generate operational messages in the Event Log view after applying an operation to the target table, or when it has completed a refresh on a table. Filter MessagesOpens the Filter Messages dialog box. Use this dialog box to filter messages to the notification handler you configured. You receive these messages in the Event Log view. Copy SettingsOpens the Copy Settings dialog box. Use this dialog box when you want to copy notification settings from one category to another.

Filter Messages dialog box


Use this dialog box when you want to filter messages to the notification handler you configured for the datastore. Do not send these messagesIndicates that InfoSphere CDC does not send these messages to the notification handler you configured. Send these messages onlyIndicates that InfoSphere CDC only sends these messages to the notification handler you configured.

Copy Notification Settings dialog box


Use this dialog box to copy notification settings. Source v Scrape/Refresh EventsInfoSphere CDC generates notifications related to events that occur when it scrapes or refreshes data on your source datastore. v Communications EventsInfoSphere CDC generates notifications related to communication events that can occur between source and the target datastores. For example, InfoSphere CDC can generate a message when there is a failure to create TCP/IP socket. v Environment EventsInfoSphere CDC generates notifications when requirements for a basic replication environment are not met. For example, InfoSphere CDC can generate a message when it cannot connect to a database, or when permissions have not been set. v Journal/Log Maintenance EventsInfoSphere CDC generates notifications that are related to events that can occur when InfoSphere CDC reads the journal or during log maintenance. Target

542

InfoSphere Change Data Capture Management Console: Administration Guide

v Apply EventsInfoSphere CDC generates notifications related to events that occur during the target apply process. For example, InfoSphere CDC can generate a message when there is failure to apply an update on the target table.

Latency Threshold dialog box


Use this dialog box when you want to set latency thresholds for a subscription in your replication environment. Latency is the amount of time that passes between when data changes on a source table and when it changes on the target table. Notify when latency crosses the threshold valuesEnables latency thresholds for the subscription. Warning threshold (minutes)Specifies the length of time that needs to pass before a subscription is considered latent and begins to cross the warning threshold. The warning threshold is optional, and must be lower than the problem threshold. Problem threshold (minutes)Specifies the length of time that needs to pass before a subscription is considered latent and begins to cross the problem threshold. Set NotificationOpens the Notification dialog box. Use this dialog box to set a latency notification for the subscription. InfoSphere CDC sends a notification when latency reaches the warning threshold and then again when latency reaches the problem threshold. As latency returns to acceptable values, InfoSphere CDC sends another notification when latency falls below the problem and warning thresholds.

Source tables
Management Console includes several dialog boxes for working with tables in Management Console. See also: Replication Tables dialog box Table Properties dialog box on page 544 Structure tab on page 544 Subscriptions tab on page 544 Update Source Table Definition dialog box on page 545 Unique Indexes dialog box on page 545

Replication Tables dialog box


Use this dialog box to update the definition of your table, remove tables, and view table properties. Available TablesDisplays the tables in your database that are available for replication. These tables are selected for replication when you map tables in the Map Tables wizard. UpdateUpdates the definition of the table that has changed in your RDMS. RemoveRemoves the table from Management Console

Dialog boxes

543

PropertiesOpens the Table Properties dialog box which lets you view the structure of the table and the search for subscriptions that use the table in replication.

Table Properties dialog box


Use this dialog box to view the structure of a table and to view the subscriptions that use this table in replication. StructureUse this tab to view the structure of a table. SubscriptionsUse this tab to identify a list of the subscriptions that use the table.

Structure tab
Use this tab to view the structure of the selected table. Column NameLists each column in the selected table. Data TypeLists the type of data each column stores, such as date, numeric, or character data. Different data types exist on different platform databases. LengthLists the length of each column in bytes. PrecisionLists the precision for each numeric column in a table. This is the maximum number of digits used by the data type of the column. When used to describe floating-point numbers, the number of bits used to hold the fractional part. The more precision a system uses, the more exactly it can represent fractional quantities. ScaleLists the scale of each numeric column in a table. This is the maximum number of digits to the right of the decimal point. KeyDisplays a green checkmark when the column is the primary key in the table. This is the column you use to sort data. A table can have more than one primary key columns. NullableDisplays a green checkmark when the column is nullable. Depending on the platform, nullable may also be called a null reference or null object. Unique IndexOpens the Unique Indexes Table dialog box. If you have installed InfoSphere CDC for AS/400, InfoSphere CDC for z/OS, or InfoSphere CDC for DB2 UDB, then you can view unique indexes you have created for the table.

Subscriptions tab
Use this tab to identify the subscriptions that use a table in replication activities. SubscriptionLists the name of the subscriptions that uses the selected table. Used AsLists how the subscriptions is using the selected table. A subscription can use a table as a source or target of replication. Replication MethodLists the replication method chosen for the selected table. Table StatusLists the status of the selected table. A table can be refreshed, mirrored, or parked for replication activities.

544

InfoSphere Change Data Capture Management Console: Administration Guide

SearchSearches for subscriptions that use the selected table in replication. For more information, see Starting and ending replication on subscriptions on page 197.

Update Source Table Definition dialog box


Use this dialog box to update the definition of a source table in Management Console. This is necessary when you have changed the definition of a source table with your RDBMS. Source TableDisplays the name of the selected source table. Subscriptions v SubscriptionLists all the subscriptions that use this source table in replication activities. v StateLists the state of the subscription as active or inactive. If the subscription is active, it is using the table in replication. v Target tableLists the name of the target table to which the selected source table is mapped. If the source table is not mapped to a target table, then Management Console displays Not Mapped. End ReplicationEnds replication on all active subscriptions. UpdateUpdates the definition of the table in Management Console and loads the Source Tables area with the table.

Unique Indexes dialog box


Use this dialog box to identify the indexes created on your tables. A unique index is one in which no two rows are permitted to have the same index key value. Depending on which platform you have installed InfoSphere CDC, you need a unique index when you are mapping your source to target tables and you want to set the replication method to mirroring. IndexLists unique indexes created on the selected table. ColumnLists the name of the columns in the index. Sort OrderLists the sort order on your columns.

Ascending and descending index-column values


You can also view if the sort order on your columns are ascending or descending. Use your RDBMS to assign a sort order to each column in an index. Creating indexes so that columns are in the same order specified in the order by clauses of queries eliminates sorting the columns during query processing. For example, you may have created an index on the Order table. The index has two columns, the first is customer_ID, in ascending order, the second is date, in descending order, so that the most recent orders are listed first.

Dialog boxes

545

Target tables
Management Console includes several dialog boxes for working with target tables in Management Console. See also: Update Target Table Definition dialog box

Update Target Table Definition dialog box


Use this dialog box to update the definition of a target table in Management Console. This is necessary when you have changed the definition of a target table with your RDBMS. Target TableDisplays the name of the selected target table. Subscriptions v SubscriptionLists all the subscriptions replicate to the target table. v StateLists the state of the subscription as active or inactive. If the subscription is active, it is replicating data to the target table. v Source tableLists the name of the source table that is mapped to the target table. If the target table is not mapped to a source table, then Management Console displays Not Mapped. End ReplicationEnds replication on all active subscriptions. UpdateUpdates the definition of the target table in Management Console.

Subscriptions
Management Console includes several dialog boxes for working with subscriptions in Management Console. See also: New Subscription dialog box Subscription Properties dialog box on page 547 Advanced Subscription Settings dialog box on page 547 Specify External Target Datastore dialog box on page 548 Notification dialog box on page 548 Upgrade Subscriptions dialog box on page 549 Naming Options dialog box on page 549 Transfer Bookmark dialog box on page 550 Clear Log Position dialog box on page 550 WebSphere DataStage Properties dialog box on page 550

New Subscription dialog box


Use this dialog box to define a new subscription. Identification v NameSpecifies the name of the subscription you want to define. v DescriptionSpecifies a brief description about the subscription.

546

InfoSphere Change Data Capture Management Console: Administration Guide

v ProjectLists existing projects from which you can select to organize your subscription. Datastores v New ProjectOpens the New Project window. Specify a name for your new project. v SourceSpecifies the source datastores to which you are connected. Select the source datastore from which you want the subscription to replicate data from the list. v TargetLists the target datastore to which the subscription can replicate data. You can select a target datastore associated with the source datastore or select an external datastore from the list. v DetailsOpens the Modify Target Datastore dialog box when you select a target datastore that is associated with the source datastore. If you want to replicate to a target datastore that is not associated with the source datastore (an external target), then the Specify External Target Datastore dialog box opens. Advanced SettingsOpens the Advanced Subscription Settings dialog box. Use this dialog box to specify communication settings for the subscription, or to set propagation control if you have hub-and-spoke replication.

Subscription Properties dialog box


Use this dialog box to modify or view the properties of an existing subscription. Identification v NameSpecifies the name of the subscription you want to define. v DescriptionSpecifies a brief description about the subscription. v ProjectLists existing projects from which you can select to organize your subscription. Datastores v New ProjectOpens the New Project window. Specify a name for your new project. v SourceSpecifies the source datastores to which you are connected. Select the source datastore from which you want the subscription to replicate data from the list. v TargetLists the target datastore to which the subscription can replicate data. You can select a target datastore associated with the source datastore or select an external datastore from the list. v DetailsOpens the Modify Target Datastore dialog box. Use this dialog box when you have changed the access parameters for a target datastore and you need to update each subscription associated with this datastore. Advanced SettingsOpens the Advanced Subscription Settings dialog box. Use this dialog box to specify communication settings for the subscription, or to set propagation control for hub-and-spoke replication.

Advanced Subscription Settings dialog box


Use this dialog box to specify optional communication settings for your subscription. Your subscription uses these settings to communicate with the target datastore.

Dialog boxes

547

Source Settings v Source IDSpecifies the unique ID for the subscription. v Firewall PortSpecifies the firewall port your subscription uses for communication to the target datastore. If the source and target datastores have a limited number of ports for communication through a firewall, then you need to specify a firewall port. v TCP HostSpecifies the TCP host that your source datastore will use to recognize the target datastore when the computer where InfoSphere CDC is installed has multiple network cards. This is useful if you want to specify a host that is different from the host that you specified in InfoSphere CDC Access Manager. The default option is Auto-select which will automatically select the network card that can communicate with the target datastore. The host that you specified in InfoSphere CDC Access Manager also appears by default as well as any alias that you configured in the Datastore Properties dialog box. Propagation ControlYou can use propagation control to prevent the replication of data from a particular source. This is useful if you are using a hub-and-spoke replication configuration and prevents subscriptions from unnecessarily repeating operations like inserting data. v Do not replicate data received from the following subscriptionsClick Add to specify the subscriptions in your replication environment from which you want to prevent replication. v Do not replicate data received from any subscriptionsSpecifies that you want to prevent replication from all subscriptions.

Specify External Target Datastore dialog box


Use this dialog box to specify connection settings to the external target datastore and authentication details to the metadata database. The metadata database maintains information about the external target datastore. This information is provided by the organization or department that owns the datastore. Target System v PlatformSpecifies the operating system for the external target datastore to which you want to connect. v Host NameSpecifies the host name or the IP address of the external target datastore to which you want to connect. v Target PortSpecifies the port number of the external target datastore to which you want to connect. Metadata Database v Database TypeSpecifies the database that maintains the metadata installed with InfoSphere CDC. This is data about your external target datastore. v Database NameSpecifies the name of the metadata database. This database holds information about the external target datastore. v OwnerSpecifies the name of the database user that owns the metadata. This is data about your external target datastore. v PasswordSpecifies the password to access the metadata database.

Notification dialog box


Use this dialog box to set notifications for your subscriptions.

548

InfoSphere Change Data Capture Management Console: Administration Guide

Sourceuse this tab when you want to configure a notification that is sent from this datastore when it is used by a subscription as the source datastore. Targetuse this tab when you want to configure a notification that is sent from this datastore when it is used by a subscription as the target datastore. Datastore Defaultsopens the Notifications dialog box. Use this dialog box to view any default notifications you may have already set for the associated datastore that belongs to this subscription. Depending on how your subscription uses the datastore (as a source or target), the notification is sent from this datastore. Copy Settingsopens the Copy Settings dialog box. Use this dialog box when you want to copy notification settings from one category to another.

Upgrade Subscriptions dialog box


Use this dialog box to upgrade your subscriptions from InfoSphere CDC for Microsoft SQL Server Version 5.3 subscriptions to InfoSphere CDC for Microsoft SQL Server Version 6.x. SubscriptionSpecifies the name of the subscriptions that you are upgrading. New NameSpecifies the new name for the upgraded subscriptions. New Source IDSpecifies the new source ID for the upgraded subscriptions. Source DatastoreSpecifies the source datastore for the upgraded subscriptions. Target DatastoreSpecifies the target datastore for the upgraded subscriptions. Naming OptionsOpens the Naming Options dialog box. Use this dialog box to specify the naming options for one or more subscriptions that are being upgraded.

Naming Options dialog box


Use this dialog box to specify the naming options for one or more subscriptions that are being upgraded. Subscription Name v PrefixSpecifies the prefix that will be added to the name of the upgraded subscriptions. v SuffixSpecifies the suffix that will be added to the name of the upgraded subscriptions. v Use original subscription name, where possibleEnable to use the original subscription name, where possible, during the upgrade process. Source ID v PrefixSpecifies the prefix that will be added to the source ID of the upgraded subscriptions. v SuffixSpecifies the suffix that will be added to the source ID of the upgraded subscriptions. v Use original source ID, where possibleEnable to use the original source ID, where possible, during the upgrade process.

Dialog boxes

549

Transfer Bookmark dialog box


Use this dialog box to transfer the bookmark from the original subscriptions to the upgraded subscriptions. Original SubscriptionSpecifies the name of the original subscriptions. StateSpecifies the current replication state of the original subscriptions. New SubscriptionSpecifies the name of the new upgraded subscriptions. Transfer Bookmark v Transfer to New SubscriptionEnable to transfer the bookmark to the new subscriptions. v Transfer to Original SubscriptionEnable to transfer the bookmark back to the original subscriptions. View Upgrade Report...View the upgrade report for the selected subscriptions. After transferring bookmark, start mirroringEnable to start mirroring for the subscriptions after transferring the bookmarks.

Clear Log Position dialog box


Use this dialog box to set the replication method for the selected subscriptions to refresh. Subscriptions listed on this dialog box do not contain the active bookmark. SubscriptionSpecifies the name of the subscriptions that no longer contain active bookmarks. Source DatastoreSpecifies the source datastore for the subscription that does not contain the active bookmark. Clear LogEnable to set the replication method for the subscription to refresh.

WebSphere DataStage Properties dialog box


Use this dialog box to set WebSphere DataStage properties for a subscription. Batch size threshold v Number of rowsIndicates the number of rows that can be changed before subscription data is sent to WebSphere DataStage. The default setting is 100,000 rows. The value that you specify is used by InfoSphere CDC to determine when a flat file is complete and is made available to WebSphere DataStage for processing. v Time (seconds)Indicates the amount of elapsed time before subscription data is sent to WebSphere DataStage. The default setting is 600 seconds. The value that you specify is used by InfoSphere CDC to determine when a flat file is complete and is made available to WebSphere DataStage for processing. Large object truncation size v Character data (# characters)Indicates the truncation point for large character data. The default setting is 8,000 characters. v Binary data (# characters)Indicates the truncation point for large binary data. The default setting is 8,000 bytes.

550

InfoSphere Change Data Capture Management Console: Administration Guide

Table mappings
Management Console includes several dialog boxes for working with table mappings in Management Console. See also: Filter Columns dialog box Change Example Table dialog box Select Target Table dialog box Select Target Owner or Library dialog box on page 552 Add or Modify Audit Column dialog box on page 552 Message Destinations dialog box on page 553 Message Destination dialog box on page 553 Change Message Destination dialog box on page 553 Delete Table Mappings dialog box on page 554 Filter Tables dialog box on page 554

Filter Columns dialog box


Filter Columns Dialog Box Use this dialog box to filter source columns that you do not want InfoSphere CDC to send to the target. For example, you may have a source column that contains sensitive information. ReplicateEnables columns for replication to the target table. ColumnLists the name of each source column you want to map and replicate to the target table. By default, all source columns are selected, which means that they are available for mapping and replication to the target. If you want to filter a source column, clear the check box.

Change Example Table dialog box


Use this dialog box to change the example table you want Management Console to use when mapping selected source tables to target tables. Management Console basis the mapping on the same (or slightly different) names. For example, you may have a source table called EMPLOYEE and you want to map this table to a target table named EMPLOYEE_HQ. You have also selected two other source tables: JOBS and REGIONS. If your target database contains two tables named JOBS_HQ and REGIONS_HQ, then Management Console automatically maps JOBS to JOBS_HQ and REGIONS to REGIONS_HQ. If the first selected source table is not the table that you want to use as an example table, then you can change it by choosing another source table from the ones you have selected to map.

Select Target Table dialog box


Use this dialog box to select the target table you want to map tables that remain unmapped by the Map Tables wizard. Management Console automatically maps tables if the source and target table names are the same. However, if you are mapping tables that have different names, then source tables can remain unmapped.
Dialog boxes

551

Select Target Owner or Library dialog box


Use this dialog box to specify the database owner (dbo) for your new target table. Subscriptions require this information to send replicated data to the appropriate target database.

Add or Modify Audit Column dialog box


Use this dialog box to add audit columns to your audit table. InfoSphere CDC provides many different kinds of audit columns that can track different kinds of system information. &CCID (Commit Cycle ID)identifies the transaction with the update. &CNTRRN (Source RRN)identifies the relative record number of the source table that recorded the journal entry. &CODE (Entry Type Code)identifies the type of journal entry. Always U for refresh and always R for mirror. &ENTTYPE (Entry Type)identifies the type of change made on the source table (insert, update, or a delete). &JOB (Source Job Name)identifies the name of the job that made the change on the source table. &JOBNO (Source Job Number)identifies the user ID of the operating system that made the change on the source table. &JOBUSER (Source Job User)identifies the user of the operating system user at the time of the change on the source table. &JOURNAL (Journal Name)identifies the name of the journal. &LIBRARY (Source Table Library)identifies the name of the source table schema or its alias. &MEMBER (Source Table Member Name)identifies the name of the member on a source table. &OBJECT (Source Table Name)identifies the name of the source table or its alias. &PROGRAM (Source Program Number)identifies the name of the program on the source table that made the change. &SEQNO (Journal Sequence Number)identifies the sequence number of the change made in the journal. &SYSTEM (Source Server Name)identifies the host name of the source system. &TIMSTAMP (Record Modification Time)identifies the date and time of when the change was made on the source table. &USER (Record Modification User)identifies the user ID that made the change on the source table.

552

InfoSphere Change Data Capture Management Console: Administration Guide

Message Destinations dialog box


Use this page to add, modify, or delete JMS message destinations for an existing connection you created in the InfoSphere CDC Configuration tool. You can also specify the maximum number of retries you want InfoSphere CDC Event Server to post to a message queue and a wait interval in case InfoSphere CDC Event Server fails to post the XML message to a queue or topic. Message Destinations arealist area lists the queues and topics you created connections for in the InfoSphere CDC Configuration Tool. v Add Destinationopens the Message Destination dialog box. Use this dialog box to specify JMS message destination information for an existing JMS connection which can be either a queue or a topic. The JMS connection was created in the InfoSphere CDC configuration tool. v Editopens the Message Destination dialog box. Use this dialog box to edit JMS message destination information. v Deletedeletes the selected JMS message destination of which can be either a queue or a topic. Message Retry area v Retry sending failed messagesenables you to specify the number of times you want InfoSphere CDC Event Server to attempt to post to a message queue or topic and the interval (in seconds) you want InfoSphere CDC Event Server to wait before trying to post again. v Retriesthe number of times InfoSphere CDC Event Server attempts to post to a message queue or topic. If InfoSphere CDC Event Server cannot send the message and to post it to a JMS message destination, then it is regarded as an unsuccessful post. v Interval (seconds)the time InfoSphere CDC Event Server waits before attempting to post a message to a queue or topic again.

Message Destination dialog box


Use this dialog box to edit message destination information for the selected JMS connection. JMS connectionspecifies the name of the JMS connection created in the InfoSphere CDC configuration tool. Namespecifies the name of the JMS message destination (queue or topic) you want to modify. Descriptionspecifies a description for the JMS message destination. Request Destinationspecifies the JNDI name of the JMS queue or topic to which you want to send the XML message. v Use persistent deliveryenable to ensure the message is not lost in transit due to a JMS provider failure. v Use transacted sessionsenables InfoSphere CDC Event Server to open a transacted session and commit every message to the JMS queue or topic.

Change Message Destination dialog box


Use this page to add, modify, or delete JMS message destinations for an existing connection you created in the InfoSphere CDC Configuration tool. You can also
Dialog boxes

553

specify the maximum number of retries you want InfoSphere CDC Event Server to post to a message queue and a wait interval in case InfoSphere CDC Event Server fails to post the XML message to a queue or topic. Queues and Topics arealist area lists the queues and topics you created connections for in the InfoSphere CDC Configuration Tool. v Add Destinationopens the Message Destination dialog box. Use this dialog box to specify JMS message destination information for an existing JMS connection which can be either a queue or a topic. The JMS connection was created in the InfoSphere CDC configuration tool. v Editopens the Message Destination dialog box. Use this dialog box to edit JMS message destination information. v Deletedeletes the selected JMS message destination of which can be either a queue or a topic. Message Retry area v Retry sending failed messagesenables you to specify the number of times you want InfoSphere CDC Event Server to attempt to post to a message queue or topic and the interval (in seconds) you want InfoSphere CDC Event Server to wait before trying to post again. v Retriesthe number of times InfoSphere CDC Event Server attempts to post to a message queue or topic. If InfoSphere CDC Event Server cannot send the message and to post it to a JMS message destination, then it is regarded as an unsuccessful post. v Interval (seconds)the time InfoSphere CDC Event Server waits before attempting to post a message to a queue or topic again.

Delete Table Mappings dialog box


Use this dialog box to delete a mapping to a message destination or to a staging target. You can map a source table to both a message destination (using the message destination mapping type) and a staging target (using the standard mapping type) for a InfoSphere CDC Event Server subscription. Delete message destination mappingenable this check box when you want to delete a mapping to a message destination. Delete staging target mappingenable this check box when you want to delete a mapping to a staging database. Deletedeletes the mapping you enabled.

Filter Tables dialog box


Use this dialog box to filter the specific tables you want to include in your table mapping. Show all tablesDisplays all the tables that are available Show filtered tablesDisplays only the tables that meet the filter criteria you specified. ImportImports a filter you have saved to a text file. ExportExports the filter into a text file so you can save it for future use.

554

InfoSphere Change Data Capture Management Console: Administration Guide

Do no automatically prompt for a filterEnable this check box when you do not want Management Console to display the Filter Tables dialog box.

Column mappings
Management Console includes several dialog boxes for working with column mappings in Management Console. See also: Map Columns Automatically dialog box Set Initial Value dialog box Define Derived Column dialog box on page 556 Copy Column Properties dialog box on page 557 Summarize Column dialog box on page 557 Specify Key dialog box on page 557 Define Expression dialog box on page 558 Replace Expressions Variables dialog box on page 558 Select Column dialog box on page 558 Import Options dialog box on page 558

Map Columns Automatically dialog box


Use this dialog box to enable a custom mapping option to map source and target columns. Original Positionenables the mapping you set on the Column Mapping tab. Ordinal Positionenables the mapping of columns based on the order of columns in the source and target tables. The first column in the target table is mapped to the first column in the source table, the second column in the target table is mapped to the second column in the source table, and so on. If the number of columns in the target table is greater than the number of the columns in the source table, then initial values are used for trailing columns in the target table. If the number of columns in the source table is greater than the number of columns in the target table, then trailing columns in the source table remain unmapped. You can only map by ordinal position provided the data types are compatible. Name to Nameenables the mapping of columns based on matching column names. For example, if a column in the source table is called EMPNAME, then this column is automatically mapped to the column in the target table called EMPNAME. Name to Descriptionenables the mapping of columns based on matching target column names in source column descriptions. This is useful when you are working on an iSeries database platform and you need to map the source table names to target columns.

Set Initial Value dialog box


Use this dialog box to set an initial value for an unmapped target column. ConstantIndicates that InfoSphere CDC populates the target column with a constant. The constant is limited to 25 characters. If you select this option, you need to type a constant in the Constant box.
Dialog boxes

555

NullIndicates that InfoSphere CDC populates the target column that is nullable with a null value. BlankIndicates that InfoSphere CDC populates the target column that has a character or a binary data type with a blank character. ZeroIndicates that InfoSphere CDC populates the target column that has a numeric data type with a value of zero. Database DefaultIndicates that InfoSphere CDC populates the target column with the default specified in your RDBMS. Whenever a row gets inserted into the target table, the value that populates this column is determined from the column defaults defined in your RDBMS. Current DateIndicates that InfoSphere CDC populates the target column that has a data type of datetime with the current date. If your subscription uses InfoSphere CDC for Z/OS as a target datastore, and you have mapped your tables using the LiveAudit mapping type, then both the before image and the after image of an update operation are populated with the same current date.

Define Derived Column dialog box


Use this dialog box to create a derived column. Derived columns use an expression to manipulate data from source columns so that they can populate target columns. Column Properties v NameSpecifies the name of the derived column. v DescriptionSpecifies a brief description about the purpose of the derived column. v Data TypeLists the type of data each column stores, such as date, numeric, or character data. Different data types exist on different platform databases. v LengthLists the length of each column in bytes. v ScaleSpecifies the scale of each numeric column in a table. This is the maximum number of digits to the right of the decimal point. v NullableEnables the column as nullable. Evaluation FrequencyLists the evaluation frequency you want for this derived column. When you want InfoSphere CDC to evaluate the expression in the derived column for the after image of the source table, then select After Image Only. When you want InfoSphere CDC to evaluate the expression in the derived column for both the before and after image of the source table, then select Before and After Image. ExpressionSpecifies an expression for the derived column. Expressions manipulate data in the source column for population in the target column. v Copy ColumnOpens the Copy Column Properties dialog box. Use this to inherit the properties of existing column for your derived column. v VerifyVerifies the syntax of the expression created for the derived column. v EditorOpens the Define Derived Column Expression dialog box. Use this to build an expression for your derived column.

556

InfoSphere Change Data Capture Management Console: Administration Guide

Copy Column Properties dialog box


Use this dialog box to copy properties for your new derived column. When you select a source column from the list, the properties of the column are copied as the properties of the derived column that you want to add. Data Typelists the type of data stored in each column, such as date, numeric, or character data. Significant differences in data types exist between different platform databases. Keywhen marked with a green check mark, this indicates that this column is the primary key that you use to sort data. A table can have more than one primary key. Lengthlists the maximum length for each column in bytes. Scalelists the scale for each numeric column. This refers to the maximum number of digits to the right of the decimal point. Nullablewhen marked with a green check mark, this indicates that the column is allowed to have no valuescalled nullable. Depending on the platform, nullable may also be called a null reference or null object.

Summarize Column dialog box


Use this dialog box to select the source column on which you want to summarize data. You can also select an expression that you have built to summarize data for the target column. Source ColumnsLists the source columns on which you can summarize (accumulate or deduct) data. You can only summarize data on a source column that is of a numeric data type. ExpressionsLists the expressions on which you can summarize data.

Specify Key dialog box


Use this dialog box to indicate how a row in the target table is uniquely identified. InfoSphere CDC requires a key so that data is applied to the correct row on the target during replication. Use an Indexspecifies that InfoSphere CDC uses an index to identify a unique row. Use all Searchable Columnsspecifies that InfoSphere CDC searches through all target columns to determine which columns uniquely identify a row. InfoSphere CDC uses the search results to build a WHERE clause, identify the row, and apply data on the target. If you add more columns to the target table, then InfoSphere CDC performs a search on these columns as well. Specify the Keyspecifies that InfoSphere CDC uses one or more target columns to uniquely identify a row. Notes: v InfoSphere CDC for AS/400 requires that the primary key columns you select match an existing index.

Dialog boxes

557

v InfoSphere CDC for Microsoft SQL Server requires that you select all primary key columns.

Define Expression dialog box


Use this dialog box to build expressions for source and target columns. You can map an expression to a target column so that it populates with the result during replication. Expression Terms v Column Functionslists column functions you can use in an expression. Column functions manipulate data. v Source Columnslists the source columns available in your table mapping. You can select source columns to build an expression. v Target Columnslists the target columns available in your table mapping. v Journal Control Fieldslists journal control fields. Journal control fields provide information about the log entry on the source system. Insert Variableopens the Add Variable dialog box. You can use this to add variables in your expression. Save Expressionsopens the Save Expression dialog box. You can use this to save the expression on the Column Mappings tab. This expression becomes available for all subscriptions. Verifyverifies the syntax of your expression.

Replace Expressions Variables dialog box


Use this dialog box to replace variables in an expression that uses a column function. For example, you may have built an expression with a variable for tax deductions using the %IF column function:
%IF(Salary >=60000 * #taxdeduction#, No tax deductions on Salary)

Each time the salary amount is greater than or equal to $60,000 in the SALARY column, InfoSphere CDC uses the %IF column function to calculate the tax deduction and applies the result in the mapped target column. You can replace a variable by manually typing a value or replace it with data from a source column. VariableLists the variables in the expression. ValueSpecifies the value for the variable. ColumnsOpens the Select Column dialog box. Use this dialog box to select the source column you want to use as a value for your variable.

Select Column dialog box


Use this dialog box to replace variables in a column function with data from a source column.

Import Options dialog box


Use this dialog box to import an XML file. When importing XML files, you can choose to import repeated elements or choose to import attribute values into Management Console.

558

InfoSphere Change Data Capture Management Console: Administration Guide

Import repeated elements with the same parentby default, Management Console imports only one repeated element in a group node with the same parent. Enable this option to import all repeated elements. Import attribute valuesby default, Management Console imports only the structure of your XML. Enable this option to import the attribute values. This may be necessary if attribute values represent the structure of your XML document.

XML message mappings


Management Console includes several dialog boxes for mapping source columns to XML elements and attributes in Management Console. See also: Expression Builder dialog box

Expression Builder dialog box


Use this dialog box to build expressions that reference the source columns in your table. You can map an expression to a target XML message so that it populates an element or an attribute during replication. Functions v XPath Functionsthe XML Path Language (XPath) is an XSL sub-language that uniquely identifies or addresses parts of an XML document. An XPath expression can be used to search through an XML document, and extract information from the nodes (any part of the document, such as an element or attribute) in it. v Transform Functions Columnsthese are customized functions. The first extension is an XPath expression for self-reference. A leading # symbol means self-reference from the target point of view. For example, /root/level1/@attr1 points to an attribute in the source DOM, while #/root/level1/@attr1 points to an attribute in the target that is the XML document to be generated. v Database FunctionsInfoSphere CDC Event Server provides several database-related functions, which can be used for any source to database transformations. These functions are marked with the sxtdb: prefix, which must be used in conjunction with the function name v Java Objectslists external Java objects you can use to perform any specific processes. Operatorslists the operators that are available for use in your expressions. Database v Trigger Tabledisplays the name of the source table. When a row-level event (insert, update, or a delete) occurs on the source table, the before and/or after image of the source column that you have mapped to a target XML element or attribute is populated with data in the target XML document. You can reference the columns from your trigger table in an expression. v Journal Control Fieldslists journal control fields. Journal control fields provide information about the log entry on the source system. You can use these in an expression.

Dialog boxes

559

v Other Tableslists the tables you have added. You can add tables when you want InfoSphere CDC Event Server to retrieve columns from other tables. You can then map these columns to XML elements or attributes or use them in an expression. Target XML Documentlists the elements and attributes in your XML document. You can use these in an expression. Save Expressionsopens the Save Expression dialog box. You can use this to save the expression on the XML Message tab. This expression becomes available for all subscriptions mapped to message destinations or staging target tables.

Data translation
Management Console includes several dialog boxes for setting data translation in Management Console. See also: Define Translation dialog box

Define Translation dialog box


Use this dialog box to add a value translation. From ValueSpecifies the data in the source column before InfoSphere CDC converts it during replication. To ValueSpecifies the translated data that populates the target column after InfoSphere CDC converts it during replication. Translate from NULLEnables InfoSphere CDC to translate from a NULL data type. Translate to NULLEnables InfoSphere CDC to translate to a NULL data type.

Table operations
Management Console includes several dialog boxes when working with setting table operations in Management Console. See also: Additional SQL dialog box Add Member Identifier Dialog Box on page 561 Modify Member Identifier dialog box on page 561 Delete Selected WHERE Clause dialog box on page 561

Additional SQL dialog box


Use this dialog box to specify SQL that you want InfoSphere CDC to execute after it applies a table refresh, or truncate or clear, operation to the target table. SQL Immediately After TruncateSpecifies the SQL you want InfoSphere CDC to execute after it applies a truncate/clear operation to the target table. SQL Immediately After RefreshSpecifies the SQL you want InfoSphere CDC to execute after it applies a refresh to the target table.

560

InfoSphere Change Data Capture Management Console: Administration Guide

Add Member Identifier Dialog Box


Use this dialog box to specify a WHERE clause for a member in a multi-member source table. InfoSphere CDC uses the WHERE clause to identify members in your source table and sends them to the target table. Member NameSpecifies the name of the member for which you want to create an identifier. Expression Terms Target ColumnsLists the target columns that InfoSphere CDC replicates the members to. &MemberSpecifies the name of the member on the source table. VerifyVerifies the syntax WHERE clause for the multi-member source table.

Modify Member Identifier dialog box


Use this dialog box to modify a WHERE clause for a member in a multi-member source table. InfoSphere CDC uses the WHERE clause to identify members in your source table and sends them to the target table. Member NameSpecifies the name of the member for which you want to create an identifier. Expression Terms v Target ColumnsLists the target columns that InfoSphere CDC replicates the members to. v &MemberSpecifies the name of the member on the source table. VerifyVerifies the syntax WHERE clause for the multi-member source table.

Delete Selected WHERE Clause dialog box


Use this dialog box to specify a SQL WHERE clause to control how InfoSphere CDC applies a refresh operation to the target. InfoSphere CDC uses the SQL statement to control which rows in the target table to refresh or truncate. Expression Terms v Target Columnslists the target columns you can specify in your SQL WHERE clause. v &Memberspecifies the name of the member on the source table. If you have installed InfoSphere CDC for AS/400 on your source system, then InfoSphere CDC can replicate members to the target. Verifyverifies the syntax of the WHERE clause.

Promoting changes
Management Console includes several dialog boxes for promoting subscriptions in Management Console. See also: Compare XML dialog box on page 562
Dialog boxes

561

Advanced Target Settings dialog box

Compare XML dialog box


Use this dialog box to compare changes of your promoted subscription against the original subscription. Depending on how you promoted the subscription to the new environment, you should see some or all of the following information highlighted to indicate that you have successfully promoted the subscription: DescriptionIf you provided a new description for the new subscription, then the original and new descriptions are highlighted. ProjectIf you created the new subscription into another project, then the original and new project names are highlighted. New Source DatastoreIf you selected a new source datastore for the new subscription, then the names of the original and new source datastores are highlighted. New Target DatastoreIf you selected a new target datastore for the new subscription, then the names of the original and new target datastores are highlighted. New Source Owner NameIf you selected a new source owner for the new subscription, then the names of the original and new source owners are highlighted. New Target Owner NameIf you selected a new target owner for the new subscription, then the names of the original and new target owners are highlighted. Related tasks To add an alias on page 62

Advanced Target Settings dialog box


Use this dialog box to choose a valid alias for the target datastore you want to promote a subscription to. Host NameChoose a valid alias for this target datastore. You must have already added this alias in Management Console.

Monitoring
Management Console includes several dialog boxes for monitoring subscriptions in Management Console. See also: Start Refresh dialog box on page 563 Change Refresh Order dialog box on page 563 Flag for Refresh dialog box on page 563 Mark Table Capture Point for Mirroring dialog box on page 563 Park (Do not replicate) dialog box on page 564 Replication Method dialog box on page 564 Set Member Replication dialog box on page 565

562

InfoSphere Change Data Capture Management Console: Administration Guide

Start Refresh dialog box


Use this dialog box to start a refresh on the selected table mapping. You can refresh multiple table mappings at a time. Table MappingsThis area lists the table mappings for the selected subscription. v Enter SearchSearches for a table mapping. v Source TableLists the name of the source table in your table mapping. v Target TableLists the name of the target table in your table mapping. v MethodSpecifies the replication method you selected for the table mapping. v RefreshEnables InfoSphere CDC to apply a refresh operation on the target table in the table mapping.

Change Refresh Order dialog box


Use this dialog box when you want you have set referential integrity constraints on a table and you want to preserve these constraints during a refresh. Source Tablelists the source tables in your table mappings. These are source tables on which you have set referential integrity constraints. Refresh Orderlists the numerical order in which InfoSphere CDC refreshes the source tables. Add New Groupadds a group into your Source Table list. You can move source tables into a group. Groups set a refresh order on source tables. Remove Groupungroups source tables from an existing group. Move Upmoves a source table to a group that precedes it. Move Downmoves a source table to a group that comes after it. Move Tomoves a source table into a group.

Flag for Refresh dialog box


Use this dialog box to flag a member for a refresh in a subscription. When you flag a member for a refresh, you are setting the member that you want to refresh at a future point in time. You can also flag a table for a refresh before starting mirroring. This is useful when you know source and target tables are not the same and you want to synchronize them before mirroring. Member Namethe name of the member in the table. Descriptionthe description of the member. Statusdisplays replication status of the member. Last Refreshdisplays the timestamp of the last refresh that was performed by InfoSphere CDC on this subscription.

Mark Table Capture Point for Mirroring dialog box


Use this dialog box to mark the table capture point for a member in a subscription. By marking the table capture point, you establish the point in time from which
Dialog boxes

563

InfoSphere CDC can mirror subsequent source changes to the target. When you start mirroring, InfoSphere CDC captures only those changes that occur after the point in time you set a log position. Member NameThe name of the member in the table. DescriptionThe description of the member. StatusDisplays the replication status of the member. Last RefreshDisplays the timestamp of the last refresh that was performed by InfoSphere CDC on this subscription.

Park (Do not replicate) dialog box


Use this dialog box to park a table from replication. If there is a particular member in the table for which you do not want InfoSphere CDC to capture changes, then you need to park that member from replication. When you park a member, InfoSphere CDC does not journal any subsequent changes you make on the member. Member NameThe name of the member in the table. DescriptionThe description of the member. StatusDisplays the replication status of the member. Last RefreshDisplays the timestamp of the last refresh that was performed by InfoSphere CDC on this subscription.

Replication Method dialog box


Use this dialog box to set a replication method for your table mapping. MirrorIndicates that InfoSphere CDC replicates changes to the target table or accumulates source table changes and replicates at a later time. RefreshIndicates that InfoSphere CDC replicates a snapshot of the source table to the target table. Depending on which InfoSphere CDC product you are using to replicate your source tables, the following options may be available on this dialog box: v Prevent RecursionPrevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM technical support to implement bidirectional replication in your environment. v Use Relative Record NumberEnables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target.

564

InfoSphere Change Data Capture Management Console: Administration Guide

Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS400 source. Journal areaIf you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then you can enable one of the following options: v Use Default JournalEnable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected JournalEnable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC creates this new journal table and uses it to detect and replicate database changes from the source to the target. OwnerLists the database owner of the journal table. NameLists the name of the journal table.

Set Member Replication dialog box


Use this dialog box to select the members you want InfoSphere CDC to replicate. All current and future membersEnables InfoSphere CDC to replicate all members to the target. Selected members onlyEnables InfoSphere CDC to replicate only selected members to the target. ReplicateEnables InfoSphere CDC to replicate the member to the target. Member NameThe name of the member in a subscription. DescriptionThe description of the member.

Dialog boxes

565

566

InfoSphere Change Data Capture Management Console: Administration Guide

Wizards
Management Console includes several wizards. In this section, you will learn: Create Table wizard Promote Subscription wizard on page 568 Import Subscription wizard on page 570 Copy Subscription wizard on page 572 Map Tables wizard on page 574 Other Tables wizard on page 604

Create Table wizard


Use this wizard to create a new table. See also: Specify Owner and Name page Define Columns page Define Primary Key Name and Order page on page 568 Review New Table page on page 568

Specify Owner and Name page


Use this page to specify a database owner and name for the new table. DatabaseDisplays the name of the database you selected. This is the database in which you want your new table to reside. OwnerLists the database owner of the new table. Table nameSpecifies the name of the new table.

Define Columns page


Use this page to define columns for the new table. KeyDisplays a green check mark when the column is the primary key in the table. This is the column you use to sort data. A table can have more than one primary key columns. Column NameLists each column you add to the new table. Data TypeLists the type of data each column stores, such as date, numeric, or character data. Different data types exist on different platform databases. LengthLists the length of each column in bytes. PrecisionLists the precision for each numeric column in a table. This is the maximum number of digits used by the data type of the column. When used to

Copyright IBM Corp. 2008

567

describe floating-point numbers, the number of bits used to hold the fractional part. The more precision a system uses, the more exactly it can represent fractional quantities. ScaleLists the scale of each numeric column in a table. This is the maximum number of digits to the right of the decimal point. NullableDisplays a green check mark when the column is nullable. Depending on the platform, nullable may also be called a null reference or null object. AddAdd a column to the new table ModifyModify an existing column DeleteDelete a column Move upMove a column up the list Move downMove a column down the list

Define Primary Key Name and Order page


Use this page to specify a primary key for the table.

Review New Table page


Use this page to review the CREATE TABLE SQL statement that was generated to create the table. Make this table available for replicationEnable this when you want to add this new table to the Source Tables area of Management Console. Tables in this area are available for replication by subscriptions.

Promote Subscription wizard


Use this wizard to promote a subscription. See also: Promote to a New or Existing Subscription page Specify New Source page (Promote Subscription wizard) on page 569 Specify External Target page (Promote Subscription wizard) on page 569 Specify New Target page (Promote Subscription wizard) on page 570 Review Promotion Settings page on page 570

Promote to a New or Existing Subscription page


Use the Promote Subscription wizard to promote your subscription to a new or an existing environment. For example, you can promote your subscription from a development environment and into a production environment when you are ready to use that subscription in replication activities. Promote to a new subscriptionEnables InfoSphere CDC Management Console to promote a subscription to a new environment. For example, you may have projects that are exclusive for development or testing purposes. You can promote subscriptions into one of these environments.

568

InfoSphere Change Data Capture Management Console: Administration Guide

v NameSpecifies the name of the subscription you want to promote to a new environment. v DescriptionSpecifies a brief description about the subscription you want to promote. v ProjectLists the available projects where you can promote your subscription. v New ProjectLets you create a new project folder where you can promote your subscription Promote changes to an existing subscriptionEnables InfoSphere CDC Management Console to promote changes to a subscription that has already been promoted to another environment. For example, the subscription may already exist in a project that you have reserved for testing subscriptions, but you may have made some minor changes on the subscription. To make sure the subscription in the test environment includes the changes that you made, you need to promote your changes to the into the testing environment. v Promote ToLists the available source and target datastore locations where you can promote the subscription.

Specify New Source page (Promote Subscription wizard)


Use this page to specify the new source datastore you want the promoted subscription to use. Old source datastoredisplays the name of the original source datastore from where your subscription used to replicate data. New source datastorelists the available source datastores from where your promoted subscription can use to replicate data. Specify the names of owners and databases in the new source database area v Old Namedisplays the name of the database where the original source datastore resides. You must select the database where your new source datastore resides. v New Namedisplays the name of the owner of the original source datastore. You must select the owner of the new source datastore. Advanced settingsopens the Advanced Source Settings dialog box. Use this dialog box to specify optional communication settings for your subscription. Your subscription uses these settings to communicate with the target datastore.

Specify External Target page (Promote Subscription wizard)


Use this dialog box to specify connection settings to the external target datastore and authentication details to the metadata database. The metadata database maintains information about the external target datastore. This information is provided by the organization or department that owns the datastore. Target System v Platformspecifies the operating system for the external target datastore to which you want to connect. v Host Namespecifies the host name or the IP address of the external target datastore to which you want to connect. v Target Portspecifies the port number of the external target datastore to which you want to connect.
Wizards

569

Metadata Database v Database Typespecifies the database that maintains the metadata installed with InfoSphere CDC. This is data about your external target datastore. v Database Namespecifies the name of the metadata database. This database holds information about the external target datastore. v Ownerspecifies the name of the database user that owns the metadata. This is data about your external target datastore. v Passwordspecifies the password to access the metadata database.

Specify New Target page (Promote Subscription wizard)


Use this page to specify the new target datastore you want the promoted subscription to use. Old target datastoredisplays the name of the original target datastore from where your subscription uses to replicate data. New target datastorelists the available target datastores to where your promoted subscription can use to replicate. Specify the names of owners and databases in the new target database area v Old Namedisplays the name of the database where the original target datastore resides. You must select the database where your new target datastore resides. v New Namedisplays the name of the owner of the original target datastore. You must select the owner of the new target datastore. Advanced settingsopens the Advanced Target Settings dialog box. Use this dialog box to select an alias that you have added for the target datastore. The source system must be able to recognize this alias on your network.

Review Promotion Settings page


Use this page to review the settings you have created for the subscription. The promoted subscription will use the new source and target datastores you specified and any other items you set in the wizard. View XMLOpens the View XML dialog box. Use this dialog box to view the differences between the original and the new subscription. Save promotion settings for this subscriptionEnable this check box when you want to save promotion settings for another subscription.

Import Subscription wizard


Use this wizard to import a subscription into InfoSphere CDC Management Console. See also: Import to a New or Existing Subscription page on page 571 Specify New Source page (Import Subscription wizard) on page 571 Specify External Target page (Import Subscription wizard) on page 571 Specify New Target page (Import Subscription wizard) on page 572 Review Settings page (Import Subscription wizard) on page 572

570

InfoSphere Change Data Capture Management Console: Administration Guide

Import to a New or Existing Subscription page


Use this wizard to import a subscription you have exported to your computer into Management Console. Import to a new subscriptionEnables the Import Subscription wizard to create a new subscription based on the configuration settings of the imported subscription. You can choose to keep the original source and target datastores or choose new ones for the imported subscription. Import to an existing subscriptionEnables the Import Subscription wizard to import the subscription to an existing subscription. The imported subscription inherits the source and target datastores of the existing subscription and other configuration settings.

Specify New Source page (Import Subscription wizard)


Use this page to specify a new source datastore for the imported subscription. Old source datastoredisplays the name of the original source datastore from where your subscription used to replicate data. New source datastorelists the available source datastores from where your imported subscription can use to replicate data. Specify the names of owners and databases in the new source database area v Old Namedisplays the name of the database where the original source datastore resides. You must select the database where your new source datastore resides. v New Namedisplays the name of the owner of the original source datastore. You must select the owner of the new source datastore. Advanced settingsopens the Advanced Source Settings dialog box. Use this dialog box to specify optional communication settings for your subscription. Your subscription uses these settings to communicate with the target datastore.

Specify External Target page (Import Subscription wizard)


Use this dialog box to specify connection settings to the external target datastore and authentication details to the metadata database. The metadata database maintains information about the external target datastore. This information is provided by the organization or department that owns the datastore. Target System v Platformspecifies the operating system for the external target datastore to which you want to connect. v Host Namespecifies the host name or the IP address of the external target datastore to which you want to connect. v Target Portspecifies the port number of the external target datastore to which you want to connect. Metadata Database v Database Typespecifies the database that maintains the metadata installed with InfoSphere CDC. This is data about your external target datastore. v Database Namespecifies the name of the metadata database. This database holds information about the external target datastore.
Wizards

571

v Ownerspecifies the name of the database user that owns the metadata. This is data about your external target datastore. v Passwordspecifies the password to access the metadata database.

Specify New Target page (Import Subscription wizard)


Use this page to specify a new target datastore for the imported subscription. Old target datastoredisplays the name of the original target datastore from where your subscription uses to replicate data. New target datastorelists the available target datastores to where your imported subscription can use to replicate. Specify the names of owners and databases in the new target database area v Old Namedisplays the name of the database where the original target datastore resides. You must select the database where your new target datastore resides. v New Namedisplays the name of the owner of the original target datastore. You must select the owner of the new target datastore. Advanced settingsopens the Advanced Target Settings dialog box. Use this dialog box to select an alias that you have added for the target datastore. The source system must be able to recognize this alias on your network.

Review Settings page (Import Subscription wizard)


Use this page to review the settings you have created for the subscription. The imported subscription will use the new source and target datastores you specified and any other items you set in the wizard. View XMLOpens the View XML dialog box. Use this dialog box to view the differences between the original and the new subscription.

Copy Subscription wizard


Use this wizard to copy a subscription. See also: Define New Subscription page Specify New Source page (Copy Subscription wizard) on page 573 Specify External Target Page (Copy Subscription wizard) on page 573 Specify New Target page (Copy Subscription wizard) on page 573 Review Settings page (Copy Subscription wizard) on page 574

Define New Subscription page


Use this page to define the subscription you want to create. SubscriptionSpecifies the name of the subscription you want to copy. v NameSpecifies the name of the subscription you want to create. v DescriptionSpecifies a brief description about the subscription. v ProjectLists the available projects where you can organize the subscription.

572

InfoSphere Change Data Capture Management Console: Administration Guide

Specify New Source page (Copy Subscription wizard)


Use this page to specify a new source datastore for the copied subscription. Old source datastoredisplays the name of the original source datastore from where your subscription used to replicate data. New source datastorelists the available source datastores from where your copied subscription can use to replicate data. Specify the names of owners and databases in the new source database area v Old Namedisplays the name of the database where the original source datastore resides. You must select the database where your new source datastore resides. v New Namedisplays the name of the owner of the original source datastore. You must select the owner of the new source datastore. Advanced settingsopens the Advanced Source Settings dialog box. Use this dialog box to specify optional communication settings for your subscription. Your subscription uses these settings to communicate with the target datastore.

Specify External Target Page (Copy Subscription wizard)


Use this dialog box to specify connection settings to the external target datastore and authentication details to the metadata database. The metadata database maintains information about the external target datastore. This information is provided by the organization or department that owns the datastore. Target System v Platformspecifies the operating system for the external target datastore to which you want to connect. v Host Namespecifies the host name or the IP address of the external target datastore to which you want to connect. v Target Portspecifies the port number of the external target datastore to which you want to connect. Metadata Database v Database Typespecifies the database that maintains the metadata installed with InfoSphere CDC. This is data about your external target datastore. v Database Namespecifies the name of the metadata database. This database holds information about the external target datastore. v Ownerspecifies the name of the database user that owns the metadata. This is data about your external target datastore. v Passwordspecifies the password to access the metadata database.

Specify New Target page (Copy Subscription wizard)


Use this page to specify the new target datastore you want the copied subscription to use. Old target datastoredisplays the name of the original target datastore from where your subscription uses to replicate data. New target datastorelists the available target datastores to where your copied subscription can use to replicate.
Wizards

573

Specify the names of owners and databases in the new target database area v Old Namedisplays the name of the database where the original target datastore resides. You must select the database where your new target datastore resides. v New Namedisplays the name of the owner of the original target datastore. You must select the owner of the new target datastore. Advanced settingsopens the Advanced Target Settings dialog box. Use this dialog box to select an alias that you have added for the target datastore. The source system must be able to recognize this alias on your network.

Review Settings page (Copy Subscription wizard)


Use this page to review the settings you have created for the subscription. The copied subscription will use the new source and target datastores you specified and any other items you set in the wizard.

Map Tables wizard


The Map Tables wizard provides the following mapping types: See also: One-to-One mapping type on page 576 Select Mapping Type page (One-to-One) on page 576 Select Source Tables page (One-to-One) on page 577 Select Existing or Create New Target Tables page (One-to-One) on page 577 Map Source Tables to Existing Target Tables page (One-to-One) on page 577 Select Owner for New Target Tables page (One-to-One) on page 577 Name Target Tables page (One-to-One) on page 578 Set Replication Method page (One-to-One) on page 578 Review Mappings page (One-to-One) on page 579 Complete Mappings page (One-to-One) on page 579 Mapping to an external target datastore mapping type on page 579 Select Mapping Type page (Mapping to an external target datastore) on page 579 Select Source Tables page (Mapping to an external target datastore) on page 579 LiveAudit mapping type (Automatic) on page 580 Select Mapping Type page (LiveAudit Automatic) on page 580 Define Audit Columns page (LiveAudit Automatic) on page 580 Select Source Tables page (LiveAudit Automatic) on page 581 Select Existing or Create New Target Tables page (LiveAudit Automatic) on page 581 Map Source Tables to Existing Target Tables page (LiveAudit Automatic) on page 581 Select Owner for New Target Tables page (LiveAudit Automatic) on page 581 Name Target Tables page (LiveAudit Automatic) on page 582 Review Mappings page (LiveAudit Automatic) on page 582 Complete Mappings page (LiveAudit Automatic) on page 582 WebSphere DataStage mapping type (Automatic) on page 582

574

InfoSphere Change Data Capture Management Console: Administration Guide

Select Mapping Type page (WebSphere DataStage Automatic) on page 582 Select WebSphere DataStage Connection Method page (WebSphere DataStage Automatic) on page 582 Select Source Tables page (WebSphere DataStage Automatic) on page 583 WebSphere DataStage Flat File page (WebSphere DataStage Automatic) on page 583 WebSphere DataStage Direct Connect page (WebSphere DataStage Automatic) on page 584 Review Mappings page (WebSphere DataStage Automatic) on page 584 Standard mapping type on page 584 Select Mapping Type page (Standard) on page 585 Select Source Table page (Standard) on page 585 Select Target Table page (Standard) on page 585 Specify Key page (Standard) on page 586 Set Replication Method page (Standard) on page 586 Review Mappings page (Standard) on page 587 LiveAudit mapping type (Custom) on page 587 Select Mapping Type page (LiveAudit Custom) on page 587 Define Audit Columns page (LiveAudit Custom) on page 587 Select Source Tables page (LiveAudit Custom) on page 588 Select Target Table page (LiveAudit Custom) on page 588 Review Mappings page (LiveAudit Custom) on page 588 Adaptive Apply mapping type on page 589 Select Mapping Type page (Adaptive Apply) on page 589 Select Source Tables page (Adaptive Apply) on page 589 Select Target Table page (Adaptive Apply) on page 589 Specify Key page (Adaptive Apply) on page 589 Set Replication Method page (Adaptive Apply) on page 590 Review Mappings page (Adaptive Apply) on page 591 Summarization mapping type on page 591 Select Mapping Type page (Summarization) on page 591 Select Source Tables page (Summarization) on page 591 Select Target Table page (Summarization) on page 591 Specify Key page (Summarization) on page 592 Select Summarization type page on page 592 Set Replication Method page (Summarization) on page 592 Review Mappings page (Summarization) on page 593 Consolidation one-to-one mapping type on page 593 Select Mapping Type page (Consolidation one-to-one) on page 593 Select Source Tables page (Consolidation one-to-one) on page 594 Select Target Table page (Consolidation one-to-one) on page 594 Specify Key page (Consolidation one-to-one) on page 594 Set Replication Method page (Consolidation one-to-one) on page 594 Review Mappings page (Consolidation one-to-one) on page 595 Consolidation one-to-many mapping type on page 596
Wizards

575

Select Mapping Type page (Consolidation one-to-many) on page 596 Select Source Tables page (Consolidation one-to-many) on page 596 Select Target Table page (Consolidation one-to-many) on page 596 Specify Key page (Consolidation one-to-many) on page 596 Set Replication Method page (Consolidation one-to-many) on page 597 Review Mappings page (Consolidation one-to-many) on page 598 WebSphere DataStage mapping type (Custom) on page 598 Select Mapping Type page (WebSphere DataStage Custom) on page 598 Select WebSphere DataStage Connection Method page (WebSphere DataStage Custom) on page 598 Select Source Tables page (WebSphere DataStage Custom) on page 598 WebSphere DataStage Flat File page (WebSphere DataStage Custom) on page 599 WebSphere DataStage Direct Connect page (WebSphere DataStage Custom) on page 599 Review Mappings page (WebSphere DataStage Custom) on page 600 Message Destination mapping type (Automatic) on page 600 Select Mapping Type page (Message Destination) on page 600 Select Source Tables page on page 600 Message Content page on page 600 Message Destination page on page 601 Review Mappings page on page 602 Message Destination mapping type (Custom) on page 602 Select Mapping Type page (Message Destination) on page 600 Select Source Tables page on page 602 Message Content page on page 600 Message Destination page on page 601 Review Mappings page on page 602

One-to-One mapping type


Use this mapping type to map multiple source tables to multiple target tables using one-to-one replication. This means that when there is a row-level operation on the source table, InfoSphere CDC will replicate this to the corresponding target table.

Select Mapping Type page (One-to-One)


Map tables using the one-to-one mapping type. This means that when there is a row-level operation on the source table, InfoSphere CDC will replicate this to the corresponding target table. The One-to-one mapping type lets you map multiple source tables to multiple target tables at a time under the assumption that your source and target tables share the same table structure and similar column names. When these conditions are true, the Map Tables wizard automatically maps tables based on an example mapping you set up.

576

InfoSphere Change Data Capture Management Console: Administration Guide

Select Source Tables page (One-to-One)


Use this page to select the source tables you want to map to target tables. Source Tableslists available databases and tables in your source datastore. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Filter Columnsopens the Filter Columns dialog box. Use this dialog to filter source columns that you do not want InfoSphere CDC to send to the target.

Select Existing or Create New Target Tables page (One-to-One)


Use this page to specify whether you want to map the selected source tables to existing target tables or map these to new target tables. Map to existing target tablesEnables the Map Tables wizard to let you map your source table to an existing target table. Create new target tablesEnables the Map Tables wizard to let you map your source table to a new target table. The new target table is created during the mapping process.

Map Source Tables to Existing Target Tables page (One-to-One)


If you enabled the Map Tables wizard to map your source tables to existing target tables, then you are prompted to select the target tables on this page. Source Tablespecifies one of the source tables you had selected on the Select Source Tables page to map to a target table. The selected source table specified depends on the name. For example, if you had selected to map two source tables, source.dbo.BBB and source.dbo.AAA, then source.dbo.AAA is specified here. When you select a target table to map to this selected source table, the Map Tables wizard uses this relationship as the basis for mapping your other source and target tables. Change Example Tableopens the Change Example Table dialog box. If you have selected to map multiple source tables to multiple target tables, then the Map Tables wizard chooses the first source table in the list and uses its mapping relationship with another target table as the basis for your other table mappings. If you want the Map Tables wizard to use another mapping relationship, then you can select another source table in this dialog box. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping.

Select Owner for New Target Tables page (One-to-One)


Use this page to select a database owner of the new target table. Specify a new target owner for each source owner area v Source ownerlists the database owner of the selected source tables.

Wizards

577

v Target ownerdisplays the database owner you selected for your new target tables. Double-click this area to open the Select Target Owner dialog box and select the database owner you want for your new target tables.

Name Target Tables page (One-to-One)


Use this page to identify the target tables you want the Map Tables wizard to create and map to the selected source tables. Identical to the source table namesenables the Map Tables wizard to create new target tables with the same names as the corresponding source tables. Source table names with prefixes and/or suffixesenables the Map Tables wizard to create new target tables with the same names as the corresponding source tables but with a prefix or a suffix. v Prefixspecifies the prefix you want the Map Tables wizard to append to the name of each of your target tables. v Suffixspecifies the suffix you want the Map Tables wizard to append to the name of each of your target tables. v Use prefix/suffix for index namespecifies that you want to use the prefix or the suffix as the index name.

Set Replication Method page (One-to-One)


Use this page to choose a replication method for the mapped tables. Mirror (Change Data Capture)enables InfoSphere CDC to replicate changes to the target table or accumulate source table changes and replicate these at a later time. v Prevent Recursionprevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM technical support to implement bidirectional replication in your environment Refresh (Snapshot)enables InfoSphere CDC to replicate a copy of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246.

578

InfoSphere Change Data Capture Management Console: Administration Guide

This option is only available when using a InfoSphere CDC for AS/400 source. Journal areaif you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then you can enable one of the following options: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table.

Review Mappings page (One-to-One)


Use this page to review the table mappings you are about to create with the Map Tables wizard. When you click Finish, the table mappings are listed in the Table Mappings view.

Complete Mappings page (One-to-One)


Use this page to map your source tables to existing target tables. The Map Tables wizard automatically maps source tables to target tables that have similar or like names. If your source table does not share the same or similar name as the target table, then you must map remaining source tables to target tables manually. Source Tabledisplays the name of the source tables you selected to include in your table mappings. Target Tabledisplays the name of the target tables that you want to map to corresponding source tables. Double-click this area to open the Select Target Table dialog box and select a target table to map to your source table.

Mapping to an external target datastore mapping type


Use this mapping type when you want to map source tables to target tables that resides in a datastore outside of your organization.

Select Mapping Type page (Mapping to an external target datastore)


Map your source tables to target tables that resides in a datastore outside of your organization. When you start replication on the subscription that contains this table mapping, InfoSphere CDC replicates data to mapped external target tables.

Select Source Tables page (Mapping to an external target datastore)


Use this page to select the source tables you want to map to target tables. Source Tableslists available databases and tables in your source datastore.
Wizards

579

Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Filter Columnsopens the Filter Columns dialog box. Use this dialog to filter source columns that you do not want InfoSphere CDC to send to the target.

LiveAudit mapping type (Automatic)


If you want your target table to keep an audit trail of operations applied to the source table, then map your source and target tables using LiveAudit. When you replicate data using LiveAudit, your target tables contain rows that track insert, update, delete, and clear (truncate) operations applied to the mapped source table. LiveAudit is most useful if your environment must satisfy data auditing and change-tracking requirements. With LiveAudit, you can audit changes to sensitive information, and you can monitor and report on risk in a timely manner. To replicate data using LiveAudit, you must have a LiveAudit-enabled authorization code. To obtain a LiveAudit-enabled authorization code, contact your IBM representative.

Select Mapping Type page (LiveAudit Automatic)


Map your source table to a target table that audits row-level and table-level operations taking place on the source table. When you replicate data using LiveAudit, your target tables contain rows that track insert, update, delete, and clear (truncate) operations applied to the mapped source table. LiveAudit is most useful if your environment must satisfy data auditing and change-tracking requirements. With LiveAudit, you can audit changes to sensitive information, and you can monitor and report on risk in a timely manner. To replicate data using LiveAudit, you must have a LiveAudit-enabled authorization code. To obtain a LiveAudit-enabled authorization code, contact your IBM representative.

Define Audit Columns page (LiveAudit Automatic)


Use this page to choose the audit columns you want to include in your target table. By default, the Map Tables wizard includes the Aud_Type, Aud_Time, Aud_User columns in the target table. Aud_Timestores the &TIMSTAMP journal control field which indicates date and time changes are made to the source. Aud_Typestores the &ENTTYP journal control field which indicates the type of change made to the source. Aud_Userstores the &USER journal control field which indicates the ID of the user who made the change to the source. Addopens theAdd Audit Column dialog box. Use this dialog box to add more audit columns to your target table. Modifyopens the Modify Audit Column dialog box. Use this dialog box to change the audit columns in your target table. Deletedeletes the selected audit column from the table. Move Upmoves the selected audit column up the list. Move Downmoves the selected audit column down the list.

580

InfoSphere Change Data Capture Management Console: Administration Guide

Select Source Tables page (LiveAudit Automatic)


Use this page to select the source tables you want to map to target tables. Source Tableslists available databases and tables in your source datastore. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Filter Columnsopens the Filter Columns dialog box. Use this dialog to filter source columns that you do not want InfoSphere CDC to send to the target.

Select Existing or Create New Target Tables page (LiveAudit Automatic)


Use this page to specify whether you want to map the source table to an existing target tables or map it to a new target tables. Map to existing target tablesEnables the Map Tables wizard to let you map your source table to an existing target table. Create new target tablesEnables the Map Tables wizard to let you map your source table to a new target table. The new target table is created during the mapping process.

Map Source Tables to Existing Target Tables page (LiveAudit Automatic)


If you enabled the Map Tables wizard to map your source tables to existing target tables, then you are prompted to select the target tables on this page. Source Tablespecifies one of the source tables you had selected on the Select Source Tables page to map to a target table. The selected source table specified depends on the name. For example, if you had selected to map two source tables, source.dbo.BBB and source.dbo.AAA, then source.dbo.AAA is specified here. When you select a target table to map to this selected source table, the Map Tables wizard uses this relationship as the basis for mapping your other source and target tables. Change Example Tableopens the Change Example Table dialog box. If you have selected to map multiple source tables to multiple target tables, then the Map Tables wizard chooses the first source table in the list and uses its mapping relationship with another target table as the basis for your other table mappings. If you want the Map Tables wizard to use another mapping relationship, then you can select another source table in this dialog box. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping.

Select Owner for New Target Tables page (LiveAudit Automatic)


Use this page to select a database owner of the new target table. Specify a new target owner for each source owner area v Source ownerlists the database owner of the selected source tables.
Wizards

581

v Target ownerdisplays the database owner you selected for your new target tables. Double-click this area to open the Select Target Owner dialog box and select the database owner you want for your new target tables.

Name Target Tables page (LiveAudit Automatic)


Use this page to identify the target tables you want the Map Tables wizard to create and map to the selected source tables. Identical to the source table namesenables the Map Tables wizard to create new target tables with the same names as the corresponding source tables. Source table names with prefixes and/or suffixesenables the Map Tables wizard to create new target tables with the same names as the corresponding source tables but with a prefix or a suffix. v Prefixspecifies the prefix you want the Map Tables wizard to append to the name of each of your target tables. v Suffixspecifies the suffix you want the Map Tables wizard to append to the name of each of your target tables. v Use prefix/suffix for index namespecifies that you want to use the prefix or the suffix as the index name.

Review Mappings page (LiveAudit Automatic)


Use this page to review the table mappings you are about to create with the Map Tables wizard. When you click Finish, the table mappings are listed in the Table Mappings view.

Complete Mappings page (LiveAudit Automatic)


Use this page to map your source tables to existing target tables. The Map Tables wizard automatically maps source tables to target tables that have similar or like names. If your source table does not share the same or similar name as the target table, then you must map remaining source tables to target tables manually. Source Tabledisplays the name of the source tables you selected to include in your table mappings. Target Tabledisplays the name of the target tables that you want to map to corresponding source tables. Double-click this area to open the Select Target Table dialog box and select a target table to map to your source table.

WebSphere DataStage mapping type (Automatic)


This type of mapping allows you to map one or more source tables for use as inputs to an IBM WebSphere DataStage job.

Select Mapping Type page (WebSphere DataStage Automatic)


Map one or more source tables for use as inputs to an IBM WebSphere DataStage job.

Select WebSphere DataStage Connection Method page (WebSphere DataStage Automatic)


Use this page to select the connection method that InfoSphere CDC will use to connect to WebSphere DataStage.

582

InfoSphere Change Data Capture Management Console: Administration Guide

Flat Fileindicates that InfoSphere CDC will produce a series of flat files that are used to deliver source table changes to WebSphere DataStage. WebSphere DataStage uses the Sequential File stage to read the files. Direct Connectindicates TCP/IP is used to deliver source table changes to WebSphere DataStage. With Direct Connect, InfoSphere CDC and WebSphere DataStage must work together. Changes are not stored, but they are captured from source logs and then processed by WebSphere DataStage. End-to-end transactional consistency requires a more complicated WebSphere DataStage job.

Select Source Tables page (WebSphere DataStage Automatic)


Use this page to select the source tables you want to map to WebSphere DataStage. Source Tableslists available databases and tables in your source datastore. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Filter ColumnsOpens the Filter Columns dialog box. Use this dialog box to filter source columns that you do not want InfoSphere CDC to send to WebSphere DataStage.

WebSphere DataStage Flat File page (WebSphere DataStage Automatic)


Use this page to specify the directory and output record format for the flat files that are utilized by the Sequential File stage in WebSphere DataStage. Location v DirectorySpecifies the directory where you want to store the flat files that are generated by InfoSphere CDC and utilized by WebSphere DataStage. Record Formatthe record format that you choose is dependent on what you are doing in WebSphere DataStage. v Single Recordin this format an update operation is sent as a single row. InfoSphere CDC generates a file that contains the following as part of each record: Four standard journal control fields for each column: DM_TIMESTAMP, DM_TXID, DM_OPERATION_TYPE, DM_USER Before images for columns in the following format: before_mycolumnname After images for columns in the following format: after_mycolumnname The operation types for this format and the Multiple Record format below are as follows: insert or delete before image of update after image of update update v Multiple Recordan update operation is sent as two rows. The first row is the before image and the second row is the after image. InfoSphere CDC generates a file with journal control fields, before images for columns, and after images for columns. Separate records are produced for before and after images, and the format of each record is as follows:

Wizards

583

Four standard journal control fields for each column: DM_TIMESTAMP, DM_TXID, DM_OPERATION_TYPE, DM_USER The columns in the table mapping in the following format: mycolumnname

WebSphere DataStage Direct Connect page (WebSphere DataStage Automatic)


Use this page to specify the WebSphere DataStage Direct Connect host, port, and output record format. Connection v HostSpecifies the host name of the WebSphere DataStage installation. v PortSpecifies a unique port number for the WebSphere DataStage host. For multiple source tables, select the starting port. Record Formatthe record format that you choose is dependent on what you are doing in WebSphere DataStage. v Single Recordin this format an update operation is sent as a single row. InfoSphere CDC generates a file that contains the following as part of each record: Four standard journal control fields for each column: DM_TIMESTAMP, DM_TXID, DM_OPERATION_TYPE, DM_USER Before images for columns in the following format: before_mycolumnname After images for columns in the following format: after_mycolumnname The operation types for this format and the Multiple Record format below are as follows: insert or delete before image of update after image of update update v Multiple Recordan update operation is sent as two rows. The first row is the before image and the second row is the after image. InfoSphere CDC generates a file with journal control fields, before images for columns, and after images for columns. Separate records are produced for before and after images, and the format of each record is as follows: Four standard journal control fields for each column: DM_TIMESTAMP, DM_TXID, DM_OPERATION_TYPE, DM_USER The columns in the table mapping in the following format: mycolumnname

Review Mappings page (WebSphere DataStage Automatic)


Use this page to review the table mappings you are about to create with the Map Tables wizard. When you click Finish, the table mappings are listed in the Table Mappings view.

Standard mapping type


If you want your target table to keep an updated image of the data contained in the source table, then map your source and target tables using the standard mapping type. InfoSphere CDC applies the same operation that occurred on the source table to the target table. A row insert operation on the source table determines a row insert operation on the target table, and so on. You can map tables one at a time using standard replication.

584

InfoSphere Change Data Capture Management Console: Administration Guide

Select Mapping Type page (Standard)


Use this mapping type when you want InfoSphere CDC to replicate the same row-level operation that occurs on a source table to the mapped target table.

Select Source Table page (Standard)


Use this page to select the source table you want to map to a target table. Source Tableslists available databases and tables in your source datastore. v Database/Librarydisplays the name of the database you selected. This database contains the source table you want to map. v Ownerlists the database owner of the source table. v Tablespecifies the name of the source table you selected. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Filter Columnsopens the Filter Columns dialog box. Use this dialog to filter source columns that you do not want InfoSphere CDC to send to the target.

Select Target Table page (Standard)


Use this page to select the target table you want to map to the selected source table. Source TableSpecifies the source table you selected to map to the target table. Target Tableslists available databases and tables in your target datastore. v Database/Librarydisplays the name of the database you selected. This database contains the target table you want to map. v Ownerlists the database owner of the target table. v Tablespecifies the name of the target table you selected. Create TableOpens the Create Table wizard. Use this wizard to create a new target table. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Member Mapping areaIf you have installed InfoSphere CDC for AS/400 on both the source and target and you are mapping a multi-member source table to a selected target table, then you can select a mapping scheme. v Mapping SchemeLists available mapping schemes for multi-member tables. Source and Target Files are Single MemberMerges all members from the source table to a single-member target table. Use Source member Structure on TargetMaintains the same multi-member structure on the target table as the one on the source table. Each source member is mapped to the corresponding target member. Merge Source Members into One Target MemberMerges all members from the source table to a single member in a multi-member. v Target Member NameSpecifies the name of the target member to which you want source members merged.
Wizards

585

Specify Key page (Standard)


Use this page to select an index. Use an Indexenables you to select an index from the Index box. Use if your target table has an index that uniquely identifies a row. Specify the keyenable when you want to select the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. Use all searchable columnsenable when you want to search for all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Note: Availability of the above options is dependent on the platform and version of InfoSphere CDC that you have installed.

Set Replication Method page (Standard)


Mirror (Change Data Capture)enables InfoSphere CDC to replicate changes to the target table or accumulate source table changes and replicate these at a later time. v Prevent Recursionprevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM technical support to implement bidirectional replication in your environment Refresh (Snapshot)enables InfoSphere CDC to replicate a copy of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. Journal areaif you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then you can enable one of the following options:

586

InfoSphere Change Data Capture Management Console: Administration Guide

v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table.

Review Mappings page (Standard)


Use this page to review the table mappings you are about to create with the Map Tables wizard. When you click Finish, the table mappings are listed in the Table Mappings view.

LiveAudit mapping type (Custom)


If you want your target table to keep an audit trail of operations applied to the source table, then map your source and target tables using the LiveAudit mapping type. When you replicate data using LiveAudit, your target tables contain rows that track insert, update, delete, and clear (truncate) operations applied to the mapped source table. LiveAudit is most useful if your environment must satisfy data auditing and change-tracking requirements. With LiveAudit, you can audit changes to sensitive information, and you can monitor and report on risk in a timely manner. To replicate data using LiveAudit, you must have a LiveAudit-enabled authorization code. To obtain a LiveAudit-enabled authorization code, contact your IBM representative.

Select Mapping Type page (LiveAudit Custom)


If you want your target table to keep an audit trail of operations applied to the source table, then map your source and target tables using LiveAudit. When you replicate data using LiveAudit, your target tables contain rows that track insert, update, delete, and clear (truncate) operations applied to the mapped source table. LiveAudit is most useful if your environment must satisfy data auditing and change-tracking requirements. With LiveAudit, you can audit changes to sensitive information, and you can monitor and report on risk in a timely manner. To replicate data using LiveAudit, you must have a LiveAudit-enabled authorization code. To obtain a LiveAudit-enabled authorization code, contact your IBM representative.

Define Audit Columns page (LiveAudit Custom)


Use this page to choose the audit columns you want to include in your target table. By default, the Map Tables wizard includes the Aud_Type, Aud_Time, Aud_User columns in the target table. Aud_Timestores the &TIMSTAMP journal control field which indicates date and time changes are made to the source. Aud_Typestores the &ENTTYP journal control field which indicates the type of change made to the source.

Wizards

587

Aud_Userstores the &USER journal control field which indicates the ID of the user who made the change to the source. Addopens theAdd Audit Column dialog box. Use this dialog box to add more audit columns to your target table. Modifyopens the Modify Audit Column dialog box. Use this dialog box to change the audit columns in your target table. Deletedeletes the selected audit column from the table. Move Upmoves the selected audit column up the list. Move Downmoves the selected audit column down the list.

Select Source Tables page (LiveAudit Custom)


Use this page to select the source tables you want to map to target tables. Source Tableslists available databases and tables in your source datastore. v Database/Librarydisplays the name of the database you selected. This database contains the source table you want to map. v Ownerlists the database owner of the source table. v Tablespecifies the name of the source table you selected. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Filter Columnsopens the Filter Columns dialog box. Use this dialog to filter source columns that you do not want InfoSphere CDC to send to the target.

Select Target Table page (LiveAudit Custom)


Use this page to select the target table you want to map to the selected source table. Source TableSpecifies the source table you selected to map to the target table. Target Tableslists available databases and tables in your target datastore. v Database/Librarydisplays the name of the database you selected. This database contains the target table you want to map. v Ownerlists the database owner of the target table. v Tablespecifies the name of the target table you selected. Create TableOpens the Create Table wizard. Use this wizard to create a new target table. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping.

Review Mappings page (LiveAudit Custom)


Use this page to review the table mappings you are about to create with the Map Tables wizard. When you click Finish, the table mappings are listed in the Table Mappings view.

588

InfoSphere Change Data Capture Management Console: Administration Guide

Adaptive Apply mapping type


Use this mapping type when you know your source and target tables are not synchronized, but you want InfoSphere CDC to replicate data from the source to the target table without error and force both tables into consistency.

Select Mapping Type page (Adaptive Apply)


If you know that your source and target tables are not synchronized, but you want to replicate data from the source to the target without error, then map your source table to your target table using the Adaptive Apply mapping type. For example, if there is an insert on the source table, but that row already exists in your target table, InfoSphere CDC switches the insert to an update operation. Also, if there is an update on your source table, and this row does not exist on your target table, then InfoSphere CDC switches the update into an insert.

Select Source Tables page (Adaptive Apply)


Use this page to select the source tables you want to map to target tables. Source Tableslists available databases and tables in your source datastore. v Database/Librarydisplays the name of the database you selected. This database contains the source table you want to map. v Ownerlists the database owner of the source table. v Tablespecifies the name of the source table you selected. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Filter Columnsopens the Filter Columns dialog box. Use this dialog to filter source columns that you do not want InfoSphere CDC to send to the target.

Select Target Table page (Adaptive Apply)


Use this page to select the target table you want to map to the selected source table. Source TableSpecifies the source table you selected to map to the target table. Target Tableslists available databases and tables in your target datastore. v Database/Librarydisplays the name of the database you selected. This database contains the target table you want to map. v Ownerlists the database owner of the target table. v Tablespecifies the name of the target table you selected. Create TableOpens the Create Table wizard. Use this wizard to create a new target table. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping.

Specify Key page (Adaptive Apply)


Use this page to select an index. Use an Indexenables you to select an index from the Index box. Use if your target table has an index that uniquely identifies a row.
Wizards

589

Specify the keyenable when you want to select the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. Use all searchable columnsenable when you want to search for all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Note: Availability of the above options is dependent on the platform and version of InfoSphere CDC that you have installed.

Set Replication Method page (Adaptive Apply)


Use this page to choose a replication method for the mapped tables. Mirror (Change Data Capture)enables InfoSphere CDC to replicate changes to the target table or accumulate source table changes and replicate these at a later time. v Prevent Recursionprevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM technical support to implement bidirectional replication in your environment Refresh (Snapshot)enables InfoSphere CDC to replicate a copy of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. Journal areaif you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then you can enable one of the following options: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target.

590

InfoSphere Change Data Capture Management Console: Administration Guide

v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table.

Review Mappings page (Adaptive Apply)


Use this page to review the table mappings you are about to create with the Map Tables wizard. When you click Finish, the table mappings are listed in the Table Mappings view.

Summarization mapping type


Use the summarization mapping type when you want InfoSphere CDC to accumulate or deduct numerical values in a row on the target table.

Select Mapping Type page (Summarization)


If you want InfoSphere CDC to accumulate or deduct numerical values on the target table, then map your source and target tables using the Summarization mapping type. There are two types of summarization: Accumulation and Deduction. Accumulation ensures that numeric changes applied to the target column are directly proportional to changes applied to the corresponding source columns. Deduction ensures that numeric changes applied to the target columns are inversely proportional to changes applied to mapped source columns.

Select Source Tables page (Summarization)


Use this page to select the source tables you want to map to target tables. Source Tableslists available databases and tables in your source datastore. v Database/Librarydisplays the name of the database you selected. This database contains the source table you want to map. v Ownerlists the database owner of the source table. v Tablespecifies the name of the source table you selected. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Filter Columnsopens the Filter Columns dialog box. Use this dialog to filter source columns that you do not want InfoSphere CDC to send to the target.

Select Target Table page (Summarization)


Use this page to select the target table you want to map to the selected source table. Source TableSpecifies the source table you selected to map to the target table. Target Tableslists available databases and tables in your target datastore. v Database/Librarydisplays the name of the database you selected. This database contains the target table you want to map. v Ownerlists the database owner of the target table.
Wizards

591

v Tablespecifies the name of the target table you selected. Create TableOpens the Create Table wizard. Use this wizard to create a new target table. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping.

Specify Key page (Summarization)


Use this page to select an index. Use an Indexenables you to select an index from the Index box. Use if your target table has an index that uniquely identifies a row. Specify the keyenable when you want to select the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. Use all searchable columnsenable when you want to search for all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Note: Availability of the above options is dependent on the platform and version of InfoSphere CDC that you have installed.

Select Summarization type page


Use this page to select a summarization type for each numeric target column. Target ColumnLists the target columns that are of a numeric data type. Summarization Type v AccumulationNumeric changes applied to target columns are directly proportional to changes applied to source columns. v DeductionNumeric changes applied to target columns are inversely proportional to changes applied to source columns. Summarized ColumnLists the source columns that you want to map to each numeric target column.

Set Replication Method page (Summarization)


Use this page to choose a replication method for the mapped tables. Mirror (Change Data Capture)enables InfoSphere CDC to replicate changes to the target table or accumulate source table changes and replicate these at a later time. v Prevent Recursionprevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM technical support to implement bidirectional replication in your environment Refresh (Snapshot)enables InfoSphere CDC to replicate a copy of the source table to the target table.

592

InfoSphere Change Data Capture Management Console: Administration Guide

v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. Journal areaif you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then you can enable one of the following options: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table.

Review Mappings page (Summarization)


Use this page to review the table mappings you are about to create with the Map Tables wizard. When you click Finish, the table mappings are listed in the Table Mappings view.

Consolidation one-to-one mapping type


Use the consolidation mapping type when you need merge information from various source tables into a target table.

Select Mapping Type page (Consolidation one-to-one)


Map source and target tables using the consolidation mapping type when your business environment contains information that is scattered across different source tables and you want to consolidate it to facilitate report generation, data management, or data security. To merge different information about a common entity into a single row, such as a person, a customer, or a product part, map your source table to your target table using the Consolidation One-to-one mapping type.
Wizards

593

Select Source Tables page (Consolidation one-to-one)


Use this page to select the source tables you want to map to target tables. Source Tableslists available databases and tables in your source datastore. v Database/Librarydisplays the name of the database you selected. This database contains the source table you want to map. v Ownerlists the database owner of the source table. v Tablespecifies the name of the source table you selected. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Filter Columnsopens the Filter Columns dialog box. Use this dialog to filter source columns that you do not want InfoSphere CDC to send to the target.

Select Target Table page (Consolidation one-to-one)


Use this page to select the target table you want to map to the selected source table. Source TableSpecifies the source table you selected to map to the target table. Target Tableslists available databases and tables in your target datastore. v Database/Librarydisplays the name of the database you selected. This database contains the target table you want to map. v Ownerlists the database owner of the target table. v Tablespecifies the name of the target table you selected. Create TableOpens the Create Table wizard. Use this wizard to create a new target table. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping.

Specify Key page (Consolidation one-to-one)


Use this page to select an index. Use an Indexenables you to select an index from the Index box. Use if your target table has an index that uniquely identifies a row. Specify the keyenable when you want to select the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. Use all searchable columnsenable when you want to search for all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Note: Availability of the above options is dependent on the platform and version of InfoSphere CDC that you have installed.

Set Replication Method page (Consolidation one-to-one)


Use this page to choose a replication method for the mapped tables.

594

InfoSphere Change Data Capture Management Console: Administration Guide

Mirror (Change Data Capture)enables InfoSphere CDC to replicate changes to the target table or accumulate source table changes and replicate these at a later time. v Prevent Recursionprevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM technical support to implement bidirectional replication in your environment Refresh (Snapshot)enables InfoSphere CDC to replicate a copy of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. Journal areaif you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then you can enable one of the following options: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table.

Review Mappings page (Consolidation one-to-one)


Use this page to review the table mappings you are about to create with the Map Tables wizard. When you click Finish, the table mappings are listed in the Table Mappings view.

Wizards

595

Consolidation one-to-many mapping type


If you are using a lookup table to make updates to a target table, then you can map your lookup table using one-to-many row consolidation.

Select Mapping Type page (Consolidation one-to-many)


If you are using a lookup table to make updates to a target table, then map your lookup table to the target table using the Consolidation one-to-many mapping type. When you map a lookup table using one-to-many consolidation, InfoSphere CDC only applies updates to the rows in the target table. v If you insert a row into your lookup table, InfoSphere CDC: Does not apply an operation to the target table (leaves the target table unchanged); or Updates the row that has the same consolidation key value. v If you delete a row from your lookup table, InfoSphere CDC does not apply an operation to target table.

Select Source Tables page (Consolidation one-to-many)


Use this page to select the source tables you want to map to target tables. Source Tableslists available databases and tables in your source datastore. v Database/Librarydisplays the name of the database you selected. This database contains the source table you want to map. v Ownerlists the database owner of the source table. v Tablespecifies the name of the source table you selected. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Filter Columnsopens the Filter Columns dialog box. Use this dialog to filter source columns that you do not want InfoSphere CDC to send to the target.

Select Target Table page (Consolidation one-to-many)


Use this page to select the target table you want to map to the selected source table. Source TableSpecifies the source table you selected to map to the target table. Target Tableslists available databases and tables in your target datastore. v Database/Librarydisplays the name of the database you selected. This database contains the target table you want to map. v Ownerlists the database owner of the target table. v Tablespecifies the name of the target table you selected. Create TableOpens the Create Table wizard. Use this wizard to create a new target table. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping.

Specify Key page (Consolidation one-to-many)


Use this page to select an index.

596

InfoSphere Change Data Capture Management Console: Administration Guide

Use an Indexenables you to select an index from the Index box. Use if your target table has an index that uniquely identifies a row. Specify the keyenable when you want to select the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. Use all searchable columnsenable when you want to search for all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Note: Availability of the above options is dependent on the platform and version of InfoSphere CDC that you have installed.

Set Replication Method page (Consolidation one-to-many)


Use this page to choose a replication method for the mapped tables. Mirror (Change Data Capture)enables InfoSphere CDC to replicate changes to the target table or accumulate source table changes and replicate these at a later time. v Prevent Recursionprevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM technical support to implement bidirectional replication in your environment Refresh (Snapshot)enables InfoSphere CDC to replicate a copy of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. Journal areaif you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then you can enable one of the following options: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS
Wizards

597

SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table.

Review Mappings page (Consolidation one-to-many)


Use this page to review the table mappings you are about to create with the Map Tables wizard. When you click Finish, the table mappings are listed in the Table Mappings view.

WebSphere DataStage mapping type (Custom)


This type of mapping allows you to map a single source table for use as input to an IBM WebSphere DataStage job.

Select Mapping Type page (WebSphere DataStage Custom)


Map a source table for use as an input to an IBM WebSphere DataStage job.

Select WebSphere DataStage Connection Method page (WebSphere DataStage Custom)


Use this page to select the connection method that InfoSphere CDC will use to connect to WebSphere DataStage. Flat Fileindicates that InfoSphere CDC will produce a series of flat files that are used to deliver source table changes to WebSphere DataStage. WebSphere DataStage uses the Sequential File stage to read the files. Direct Connectindicates TCP/IP is used to deliver source table changes to WebSphere DataStage. With Direct Connect, InfoSphere CDC and WebSphere DataStage must work together. Changes are not stored, but they are captured from source logs and then processed by WebSphere DataStage. End-to-end transactional consistency requires a more complicated WebSphere DataStage job.

Select Source Tables page (WebSphere DataStage Custom)


Use this page to select the source tables you want to map to WebSphere DataStage. Source Tableslists available databases and tables in your source datastore. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Filter ColumnsOpens the Filter Columns dialog box. Use this dialog box to filter source columns that you do not want InfoSphere CDC to send to WebSphere DataStage.

598

InfoSphere Change Data Capture Management Console: Administration Guide

WebSphere DataStage Flat File page (WebSphere DataStage Custom)


Use this page to specify the directory and output record format for the flat files that are utilized by the Sequential File stage in WebSphere DataStage. Location v DirectorySpecifies the directory where you want to store the flat files that are generated by InfoSphere CDC and utilized by WebSphere DataStage. Record Formatthe record format that you choose is dependent on what you are doing in WebSphere DataStage. v Single Recordin this format an update operation is sent as a single row. InfoSphere CDC generates a file that contains the following as part of each record: Four standard journal control fields for each column: DM_TIMESTAMP, DM_TXID, DM_OPERATION_TYPE, DM_USER Before images for columns in the following format: before_mycolumnname After images for columns in the following format: after_mycolumnname The operation types for this format and the Multiple Record format below are as follows: insert or delete before image of update after image of update update v Multiple Recordan update operation is sent as two rows. The first row is the before image and the second row is the after image. InfoSphere CDC generates a file with journal control fields, before images for columns, and after images for columns. Separate records are produced for before and after images, and the format of each record is as follows: Four standard journal control fields for each column: DM_TIMESTAMP, DM_TXID, DM_OPERATION_TYPE, DM_USER The columns in the table mapping in the following format: mycolumnname

WebSphere DataStage Direct Connect page (WebSphere DataStage Custom)


Use this page to specify the WebSphere DataStage Direct Connect host, port, and output record format. Connection v HostSpecifies the host name of the WebSphere DataStage installation. v PortSpecifies a unique port number for the WebSphere DataStage host. For multiple source tables, select the starting port. Record Formatthe record format that you choose is dependent on what you are doing in WebSphere DataStage. v Single Recordin this format an update operation is sent as a single row. InfoSphere CDC generates a file that contains the following as part of each record: Four standard journal control fields for each column: DM_TIMESTAMP, DM_TXID, DM_OPERATION_TYPE, DM_USER
Wizards

599

Before images for columns in the following format: before_mycolumnname After images for columns in the following format: after_mycolumnname The operation types for this format and the Multiple Record format below are as follows: insert or delete before image of update after image of update update v Multiple Recordan update operation is sent as two rows. The first row is the before image and the second row is the after image. InfoSphere CDC generates a file with journal control fields, before images for columns, and after images for columns. Separate records are produced for before and after images, and the format of each record is as follows: Four standard journal control fields for each column: DM_TIMESTAMP, DM_TXID, DM_OPERATION_TYPE, DM_USER The columns in the table mapping in the following format: mycolumnname

Review Mappings page (WebSphere DataStage Custom)


Use this page to review the table mappings you are about to create with the Map Tables wizard. When you click Finish, the table mappings are listed in the Table Mappings view.

Message Destination mapping type (Automatic)


Use the Message Destination mapping type when you want your subscription to send source column data to a JMS message destination.

Select Mapping Type page (Message Destination)


Use this mapping type to map one or more source tables to multiple XML messages using standard replication. This means that when there is a row-level operation on the source table, InfoSphere CDC Event Server replicates this row-level operation to the same JMS message destination.

Select Source Tables page


Use this page to select the source tables you want to map to target tables. Source Tableslists available databases and tables in your source datastore. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Filter Columnsopens the Filter Columns dialog box. Use this dialog to filter source columns that you do not want InfoSphere CDC Event Server to send a JMS message destination. Filter Columnsopens the Filter Columns dialog box. Use this dialog to filter source columns that you do not want InfoSphere CDC to send to the target.

Message Content page


Use this page to specify how you want InfoSphere CDC Event Server format the XML message.

600

InfoSphere Change Data Capture Management Console: Administration Guide

You can use the source table structure for your XML and decide if you want to include the before image, the after image, and/or journal control fields in the message. You can also decide not to choose a structure until you are ready to map source columns to XML elements and attributes in the Column Mappings tab. Use the source table structure for the XML messagethe following options are available to you: v Include before-image valuesenable this option when you want the XML message to include the before image of a row-level operation. The before-image represents the data in the source column before an insert, update, or delete operation on the row. v Include after-image valuesenable this option when you want the XML message to include the after image of a row-level operation. The after-image represents the data in the source column after an insert, update, or delete operation on the row. v Include journal control valuesenable this option when you want the XML message to include journal control fields. These provide information about the source table, the source database, or the table-level operations taking place in the database log or journal of the source database. For example, the _ENNTYPE journal control field indicates the type of table-level operation (insert, update, or delete) that took place on the source table. v Value Formatchoose how you want to format source column data in the XML message. You can choose from one of the following: Use attributes for data valuesformats data values of the before image, the after image, and/or journal control fields in your XML message as XML attributes. Use elements for data valuesformats data values of the before image, the after image, and/or journal control fields in your XML message as XML elements.

Do not specify the message format at this timeenable this option when you do not want to decide on a structure at this time. You can create the structure when mapping source columns to XML elements and attributes in the Column Mappings tab. Do not specify the message format at this timeEnable this option when you do not want to decide on a structure at this time. You can create the structure when mapping source columns to XML elements and attributes in the Column Mappings tab.

Message Destination page


Use this page to add, modify, or delete JMS message destinations for an existing connection you created in the InfoSphere CDC Configuration tool. You can also specify the maximum number of retries you want InfoSphere CDC Event Server to post to a message queue and a wait interval in case InfoSphere CDC Event Server fails to post the XML message to a queue or topic. Message Destinations arealist area lists the queues and topics you created connections for in the InfoSphere CDC Configuration Tool. v Add Destinationopens the Message Destination dialog box. Use this dialog box to specify JMS message destination information for an existing JMS connection which can be either a queue or a topic. The JMS connection was created in the InfoSphere CDC configuration tool.
Wizards

601

v Editopens the Message Destination dialog box. Use this dialog box to edit JMS message destination information. v Deletedeletes the selected JMS message destination of which can be either a queue or a topic. Message Retry area v Retry sending failed messagesenables you to specify the number of times you want InfoSphere CDC Event Server to attempt to post to a message queue or topic and the interval (in seconds) you want InfoSphere CDC Event Server to wait before trying to post again. v Retriesthe number of times InfoSphere CDC Event Server attempts to post to a message queue or topic. If InfoSphere CDC Event Server cannot send the message and to post it to a JMS message destination, then it is regarded as an unsuccessful post. v Interval (seconds)the time InfoSphere CDC Event Server waits before attempting to post a message to a queue or topic again.

Review Mappings page


Use this page to review the table mappings you are about to create with the Map Tables wizard. When you click Finish, the table mappings are listed in the Table Mappings view.

Message Destination mapping type (Custom)


Use the Message Destination mapping type when you want your subscription to send source column data to a JMS message destination.

Select Mapping Type page (Message Destination)


Use this mapping type to map one or more source tables to multiple XML messages using standard replication. This means that when there is a row-level operation on the source table, InfoSphere CDC Event Server replicates this row-level operation to the same JMS message destination.

Select Source Tables page


Use this page to select the source table you want to map to a message destination. Source Tableslists available databases and tables in your source datastore. SchemaDisplays the name of the database you selected. This database contains the source table you want to map. TableSpecifies the name of the source table you selected. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Filter Columnsopens the Filter Columns dialog box. Use this dialog to filter source columns that you do not want InfoSphere CDC to send to the target.

Message Content page


Use this page to specify how you want InfoSphere CDC Event Server format the XML message.

602

InfoSphere Change Data Capture Management Console: Administration Guide

You can use the source table structure for your XML and decide if you want to include the before image, the after image, and/or journal control fields in the message. You can also decide not to choose a structure until you are ready to map source columns to XML elements and attributes in the Column Mappings tab. Use the source table structure for the XML messagethe following options are available to you: v Include before-image valuesenable this option when you want the XML message to include the before image of a row-level operation. The before-image represents the data in the source column before an insert, update, or delete operation on the row. v Include after-image valuesenable this option when you want the XML message to include the after image of a row-level operation. The after-image represents the data in the source column after an insert, update, or delete operation on the row. v Include journal control valuesenable this option when you want the XML message to include journal control fields. These provide information about the source table, the source database, or the table-level operations taking place in the database log or journal of the source database. For example, the _ENNTYPE journal control field indicates the type of table-level operation (insert, update, or delete) that took place on the source table. v Value Formatchoose how you want to format source column data in the XML message. You can choose from one of the following: Use attributes for data valuesformats data values of the before image, the after image, and/or journal control fields in your XML message as XML attributes. Use elements for data valuesformats data values of the before image, the after image, and/or journal control fields in your XML message as XML elements.

Do not specify the message format at this timeenable this option when you do not want to decide on a structure at this time. You can create the structure when mapping source columns to XML elements and attributes in the Column Mappings tab. Do not specify the message format at this timeEnable this option when you do not want to decide on a structure at this time. You can create the structure when mapping source columns to XML elements and attributes in the Column Mappings tab.

Message Destination page


Use this page to add, modify, or delete JMS message destinations for an existing connection you created in the InfoSphere CDC Configuration tool. You can also specify the maximum number of retries you want InfoSphere CDC Event Server to post to a message queue and a wait interval in case InfoSphere CDC Event Server fails to post the XML message to a queue or topic. Message Destinations arealist area lists the queues and topics you created connections for in the InfoSphere CDC Configuration Tool. v Add Destinationopens the Message Destination dialog box. Use this dialog box to specify JMS message destination information for an existing JMS connection which can be either a queue or a topic. The JMS connection was created in the InfoSphere CDC configuration tool.
Wizards

603

v Editopens the Message Destination dialog box. Use this dialog box to edit JMS message destination information. v Deletedeletes the selected JMS message destination of which can be either a queue or a topic. Message Retry area v Retry sending failed messagesenables you to specify the number of times you want InfoSphere CDC Event Server to attempt to post to a message queue or topic and the interval (in seconds) you want InfoSphere CDC Event Server to wait before trying to post again. v Retriesthe number of times InfoSphere CDC Event Server attempts to post to a message queue or topic. If InfoSphere CDC Event Server cannot send the message and to post it to a JMS message destination, then it is regarded as an unsuccessful post. v Interval (seconds)the time InfoSphere CDC Event Server waits before attempting to post a message to a queue or topic again.

Review Mappings page


Use this page to review the table mappings you are about to create with the Map Tables wizard. When you click Finish, the table mappings are listed in the Table Mappings view.

Other Tables wizard


Use this wizard when you want to query columns from another table by defining a SQL WHERE clause. You can query columns from tables in the InfoSphere CDC Event Server staging database or from other databases you have configured JDBC connections for. See also: Define Table Location page Select Table page on page 605 SELECT Clause page on page 605 WHERE Clause page on page 605 GROUP BY Clause page on page 606 ORDER BY Clause page on page 606

Define Table Location page


Use this page to identify where you want the other table to reside in the source tree. It can reside as at the node level or as a child of an existing table. Add table as top level nodeEnable when you want the other table to reside at the node level. Add table as a child of another tableEnable when you want the table to reside as the child of another table. You must add a parent table before you can add a child table. Tables areaDisplays the available parent tables. This area is only enabled when you want to add a table as a child of another table.

604

InfoSphere Change Data Capture Management Console: Administration Guide

Select Table page


Use this page to select the other table. You can select it from the InfoSphere CDC Event Server staging database or from another database that you have configured a JDBC connection for. Tables via JDBC areadisplays any databases you have configured JDBC connections for and the InfoSphere CDC Event Server staging database. v JDBC connectiondisplays the name of the JDBC connection. v Schemadisplays the name of the database you selected. This database contains the other table you want InfoSphere CDC Event Server to retrieve columns from. v Tabledisplays the name of the other table. v Parentdisplays the name of the parent table in the source tree. v Aliasdisplays an alias for the other table. You can change the alias to another name. SQL Statement area v Click Next to continue with the wizardenable when you want the wizard to create the SQL statement for you based on the columns in the other table. You can modify the SQL statement in the SQL Expression editor. v Click Finish to add the table and open the SQL editorenable when you want to create your own SQL statement in the SQL Expression editor.

SELECT Clause page


Use this page to build the SELECT clause. The SELECT clause specifies the table columns or expressions that are retrieved. Select Columns area v NameDisplays the name of the column as it exists in the table. You can modify this name to an alias name. With SQL, aliases can be used for column names and table names. The SELECT statement will retrieve the column and return the result with the alias name you specified. v Column/ExpressionDisplays the column or expression you want the SELECT statement to retrieve. You can build an expression using column names.

WHERE Clause page


Use this page to build the WHERE clause. The WHERE clause is optional. When specified, it always follows the FROM clause. The WHERE clause filters rows from the FROM clause tables. Omitting the WHERE clause specifies that all rows are used. Where clause areause this area to build your WHERE clause. It is divided into a select list and includes the following: v Column/Expressionspecifies the columns to be returned. v Operatorspecifies which operation you want the query to perform. v Type Valuespecifies that you want the WHERE clause to return a static value such as name or 123. Triggerspecifies that you want the WHERE clause to return the before image or after image of the column.

Wizards

605

Parent Table Columnspecifies that you want the WHERE clause to return the column of the parent table. This option is only available if you have already added another table and have chosen to add this table as the child table. v Valuedepending on your selection in the Type column, this specifies the static value, the before image or after image of the column, or the column of the parent table that you want the WHERE clause to return. If before/after images does not exist, use other imageenable this check box when you want InfoSphere CDC Event Server to use the other image of the column because of an operation on the source that could not trigger the before image or the after image. For example, if you map the before image of a column to an XML element or attribute and the operation on the source database was an insert, then because there is no before image of that column, InfoSphere CDC Event Server inserts the after image of the column instead. Also, if you map the after image of a column to XML element or attribute and the operation on the source database was a delete because there is no after image, InfoSphere CDC Event Server inserts the before image of that column instead.

GROUP BY Clause page


Use this page to build a GROUP BY clause. The GROUP BY clause is optional. When specified, it can be used in a SELECT statement to collect data across multiple records and group the results by one or more columns. Available columnsLists the columns that you can use in a SELECT statement to group the results in one or more columns. Selected columns Lists the columns you want to include in your SELECT statement and by which you want to group the results. AddAdds the column you want to group by from the Available column list into the Selected column list. RemoveRemoves the column from the Selected column list. Move upMoves the column you want to group by up the list of other selected columns. This lets you group the results by more than one column. Move downMoves the column you want to group by down the list of other selected columns. This lets you group the results by more than one column.

ORDER BY Clause page


Use this page to sort the records in your result set. The ORDER BY clause can only be used in SELECT statements. You can order the result set in either ascending or descending order. Available columnsLists the columns that you can use in a SELECT statement to order the results in one or more columns. Selected columns Lists the columns you want to include in your SELECT statement and by which you want to order the results. AddAdds the column you want to order by from the Available column list into the Selected column list.

606

InfoSphere Change Data Capture Management Console: Administration Guide

RemoveRemoves the column from the Selected column list. Move upMoves the column you want to order by up the list of other selected columns. This lets you order the results by more than one column. Move downMoves the column you want to order by down the list of other selected columns. This lets you order the results by more than one column.

Wizards

607

608

InfoSphere Change Data Capture Management Console: Administration Guide

Notices
This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the users responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo 106-0032, Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.
Copyright IBM Corp. 2008

609

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Canada Limited Office of the Lab Director 8200 Warden Avenue Markham, Ontario L6G 1C7 CANADA Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this information and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. All statements regarding IBMs future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. All IBM prices shown are IBMs suggested retail prices, are current and are subject to change without notice. Dealer prices may vary. This information is for planning purposes only. The information herein is subject to change before the products described become available. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating

610

InfoSphere Change Data Capture Management Console: Administration Guide

platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows: (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. Copyright IBM Corp. _enter the year or years_. All rights reserved. If you are viewing this information softcopy, the photographs and color illustrations may not appear.

Trademarks
The following terms are trademarks of International Business Machines Corporation in the United States, other countries, or both: 400 AIX AS/400 Current DB2 IBM InfoSphere iSeries System i Transformation Server WebSphere z/OS zSeries DataStage is a registered trademark of Ascential Software Corporation in the United States, other countries, or both. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Linux is a trademark of Linus Torvalds in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Other company, product, or service names may be trademarks or service marks of others.

Notices

611

612

InfoSphere Change Data Capture Management Console: Administration Guide

Printed in USA

You might also like