cdc Admin Guide

IBMInfoSphere Change Data CaptureVersion 6.5.2

InfoSphere Change Data CaptureManagement Console, Version 6.5.2Management Console Administration Guide

NoteBefore using this information and the product it supports, read the information in Notices on page 711.

First edition, fourth revision

This edition applies to version 6, release 5, modification 2 of IBM InfoSphere Change Data Capture (productnumber 5724-U70), version 6, release 5 of IBM InfoSphere Change Data Capture for z/OS (product number5755-U96), version 10, release 1 of IBM InfoSphere Classic Change Data Capture for z/OS (product number5655-W29), and to all subsequent releases and modifications until otherwise indicated in new editions.

Copyright IBM Corporation 2008, 2011.US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

ContentsOverview of InfoSphere CDC. . . . . . 1Understanding the InfoSphere CDC workflow . . . 3

Whats new . . . . . . . . . . . . . 5

Before you start Management Console . 7Configuring firewall settings for outbound (static)ports . . . . . . . . . . . . . . . . . 7

To configure static ports . . . . . . . . . 9Logging in to Management Console by connectingto Access Server . . . . . . . . . . . . . 10

To log in to Management Consoleby connectingto Access Server . . . . . . . . . . . . 10To change your log in password . . . . . . 11

Understanding the ManagementConsole interface . . . . . . . . . . 13

Setting preferences . . . . . . . . . 15Setting advanced preferences . . . . . . . . 15

To set timeout values . . . . . . . . . . 16To allocate memory for Management Console . . 16To add a character encoding . . . . . . . . 16To modify a character encoding . . . . . . 17To delete a character encoding . . . . . . . 17To import the CSV template . . . . . . . . 17To export the CSV template . . . . . . . . 18To show incomplete table mappings beforemirroring . . . . . . . . . . . . . . 18

Setting connection preferences . . . . . . . . 18To specify a default Access Server port number 19To specify firewall settings for outbound (static)ports . . . . . . . . . . . . . . . 19To connect to databases automatically . . . . 19

Setting datastore multiuser preferences . . . . . 19To automatically enable multiuser configurationwhen adding new datastores . . . . . . . 20To prompt users to log comments whenunlocking subscriptions . . . . . . . . . 20

Setting prompt preferences . . . . . . . . . 20To set prompt preferences . . . . . . . . 21To automatically close progress windows . . . 21To show the Show Subscription Active/EditPanel . . . . . . . . . . . . . . . 21To configure filtering for databases, schemas, andtables . . . . . . . . . . . . . . . 21

Setting monitoring preferences . . . . . . . . 21To set the length of time for data retention . . . 22To set the sample rate for data collection . . . 22To show the subscription error indicator. . . . 22To reset the subscription error indicator . . . . 22To automatically retrieve events for selectedsubscription . . . . . . . . . . . . . 23

Setting up user accounts . . . . . . . 25Managing user accounts . . . . . . . . . . 25

To add a user. . . . . . . . . . . . . 26To edit a user. . . . . . . . . . . . . 27To delete a user . . . . . . . . . . . . 28To copy a user . . . . . . . . . . . . 28To change the existing role on a user account . . 29To enable a System Administrator with useraccount and datastore administration privileges . 29To view the history of a user account . . . . . 30

Managing security on user accounts . . . . . . 30To disable a user account . . . . . . . . . 30To require a user to change password at nextlogin . . . . . . . . . . . . . . . 30To override password expiration policy set inManagement Console . . . . . . . . . . 31To unlock a user account . . . . . . . . . 31To unlock a system administrator user account 31

Setting password and account security policies onuser accounts . . . . . . . . . . . . . . 31

To set complex passwords on user accounts . . 32To enforce password history . . . . . . . . 32To enforce password expiry . . . . . . . . 33To enforce password locking on failed loginattempts . . . . . . . . . . . . . . 33To enforce new account expiry . . . . . . . 33To display previous failed login attempts . . . 33To display the last successful login . . . . . 33

Creating user list reports . . . . . . . . . . 34To create a user list report . . . . . . . . 34

Setting up datastores . . . . . . . . 35Managing datastores . . . . . . . . . . . 35

To add a datastore . . . . . . . . . . . 36To edit a datastore . . . . . . . . . . . 36To delete a datastore . . . . . . . . . . 37To copy a datastore . . . . . . . . . . . 37To view the history of a datastore . . . . . . 37To set connection parameters on a datastore . . 37

Managing datastore connections . . . . . . . 38To delete a connection . . . . . . . . . . 39To override default connection parameters on adatastore . . . . . . . . . . . . . . 39

Assigning users to datastores . . . . . . . . 40To assign a datastore to users . . . . . . . 40To assign users to a datastore . . . . . . . 41

Enabling multiple users to work simultaneously onthe same datastore . . . . . . . . . . . . 42

To enable multiple users to work with adatastore . . . . . . . . . . . . . . 43

Creating datastore list reports . . . . . . . . 43To create a datastore list report . . . . . . . 44

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

Copyright IBM Corp. 2008, 2011 iii

Collecting data generated by user activities . . . . 45To enable auditing . . . . . . . . . . . 46To generate an audit trail log . . . . . . . 46To generate a security log report . . . . . . 46To clear the log . . . . . . . . . . . . 47

Setting up and configuringsubscriptions . . . . . . . . . . . . 49Subscriptions view (Configuration perspective) . . 50Setting up subscriptions . . . . . . . . . . 50

To add a subscription . . . . . . . . . . 51To modify a subscription . . . . . . . . . 52To delete a subscription . . . . . . . . . 52

Specifying network settings for subscriptions . . . 52To specify a TCP host for a subscription . . . . 53To specify a firewall port for a subscription. . . 53

Setting propagation control on subscriptions . . . 53To set propagation control on a subscription . . 54

Locking subscriptions within a datastore . . . . 54To view subscription state details . . . . . . 55To view subscription state details in theSubscription Active/Edit Panel. . . . . . . 55To lock a subscription for editing . . . . . . 55To lock a subscription for editing in theSubscription Active/Edit Panel. . . . . . . 55To unlock a subscription . . . . . . . . . 56To unlock a subscription in the SubscriptionActive/Edit Panel . . . . . . . . . . . 56To unlock a subscription (System Administrator) 56To unlock a subscription in the SubscriptionActive/Edit Panel (System Administrator) . . . 57To view the history report for a subscription . . 57

Determining error handling for subscriptions . . . 57To set error handling for a subscription . . . . 57

Making subscriptions persistent . . . . . . . 58To mark a subscription as persistent . . . . . 59

Searching for tables used in replication . . . . . 59To search for subscriptions that use a table inreplication . . . . . . . . . . . . . . 59

Setting up subscriptions for datastores outside ofyour organization . . . . . . . . . . . . 60

To add a subscription for an external targetdatastore . . . . . . . . . . . . . . 60To modify a subscription for an external targetdatastore . . . . . . . . . . . . . . 61

Copying subscriptions . . . . . . . . . . . 61To copy a subscription. . . . . . . . . . 61To copy a subscription for an external targetdatastore . . . . . . . . . . . . . . 63

Upgrading existing Transformation Serversubscriptions to InfoSphere CDC . . . . . . . 64

To upgrade a subscription . . . . . . . . 65To transfer a bookmark from the originalsubscription to the upgraded subscription . . . 66To clear the table capture point on the originalsubscription . . . . . . . . . . . . . 66

Reverting to Transformation Server . . . . . . 67To downgrade a subscription . . . . . . . 67

Using projects to organize your subscriptions . . . 68To add a project . . . . . . . . . . . . 68To rename a project. . . . . . . . . . . 68

To delete a project . . . . . . . . . . . 69Exporting and importing projects . . . . . . . 69

To export projects . . . . . . . . . . . 69To import projects . . . . . . . . . . . 69

Setting up datastores for replication . . 71Understanding the Datastores view . . . . . . 71Connecting to a datastore. . . . . . . . . . 72

To connect to a datastore . . . . . . . . . 72To disconnect from a datastore . . . . . . . 72

Shutting down a datastore . . . . . . . . . 73To shut down a datastore. . . . . . . . . 73

Updating access parameters for a subscription. . . 73To update access parameters for a subscription 73

Setting system parameters on source and targetdatastores . . . . . . . . . . . . . . . 73

To add a system parameter . . . . . . . . 74To modify a system parameter . . . . . . . 74To delete a system parameter . . . . . . . 74

Creating aliases for a target datastore on a privatenetwork connection. . . . . . . . . . . . 74

To add an alias . . . . . . . . . . . . 75To modify an alias . . . . . . . . . . . 75To delete an alias . . . . . . . . . . . 75

Handling a changed host name or port informationfor a datastore . . . . . . . . . . . . . 75

To update host name and port changes for sourcedatastores and associated subscriptions . . . . 76To update host name and port changes for targetdatastores and associated subscriptions . . . . 77

Managing tables available forreplication . . . . . . . . . . . . . 79Updating, removing, and viewing tables forreplication . . . . . . . . . . . . . . . 79

To update the definition of a table . . . . . . 79To remove a table from Management Console . . 80To view the properties of a table . . . . . . 80

Updating the definition of a mapped source andtarget table in a subscription. . . . . . . . . 80

To update the definition of a source table . . . 81To update the definition of a target table . . . 81

Mapping tables . . . . . . . . . . . 83Table Mappings view . . . . . . . . . . . 83Understanding filtering and mapping tables . . . 86

To manually define a filter . . . . . . . . 86Mapping using standard replication . . . . . . 87

To map multiple source tables using standardreplication . . . . . . . . . . . . . . 87To map multi-member tables to existing tables onIBM i using standard replication . . . . . . 89To map multi-member tables to new tables onIBM i using standard replication . . . . . . 90To map multiple source tables for InfoSphereClassic CDC for z/OS using standard replication . 91To map a single source table using standardreplication . . . . . . . . . . . . . . 92To map a single multi-member source table onIBM i using standard replication . . . . . . 94

iv InfoSphere Change Data Capture: Management Console Administration Guide

Mapping using LiveAudit . . . . . . . . . 95To map multiple source tables to existing tablesusing LiveAudit . . . . . . . . . . . . 96To map multiple source tables to new tablesusing LiveAudit . . . . . . . . . . . . 97To map a single source table using LiveAudit . . 98To map a single multi-member source table usingLiveAudit for IBM i . . . . . . . . . . 99

Mapping using Adaptive Apply . . . . . . . 100To map multiple source tables for bulk AdaptiveApply . . . . . . . . . . . . . . . 101To map a single source table using AdaptiveApply . . . . . . . . . . . . . . . 102To map a multi-member source table usingAdaptive Apply on IBM i . . . . . . . . 104

Mapping to summarize data . . . . . . . . 105To map a source table to summarize data . . . 105To map a multi-member source table tosummarize data on IBM i . . . . . . . . 107

Mapping to consolidate data (one-to-one) . . . . 108To map a source table to consolidate data(one-to-one) . . . . . . . . . . . . . 109To map a multi-member source table toconsolidate data on IBM i (one-to-one) . . . . 110

Mapping to consolidate data (one-to-many) . . . 111To map a source table to consolidate data(one-to-many) . . . . . . . . . . . . 113To map a multi-member source table toconsolidate data on IBM i (one-to-many) . . . 114

Mapping to a datastore outside of yourorganization . . . . . . . . . . . . . . 116

To map source tables for a subscription on anexternal datastore . . . . . . . . . . . 116

Mapping using InfoSphere DataStage . . . . . 117To map multiple source tables to InfoSphereDataStage using flat files . . . . . . . . 119To map multiple source tables to InfoSphereDataStage using Direct Connect . . . . . . 119To map a single source table to InfoSphereDataStage using flat files . . . . . . . . 120To map a single source table to InfoSphereDataStage using Direct Connect . . . . . . 121

Generating an InfoSphere DataStage definition filefor a subscription . . . . . . . . . . . . 121

To generate an InfoSphere DataStage definitionfile . . . . . . . . . . . . . . . . 123

Mapping to a JMS Message Destination usingInfoSphere CDC Event Server . . . . . . . . 123

To map multiple source tables to a JMS messagedestination . . . . . . . . . . . . . 126To map a single source table to a JMS messagedestination . . . . . . . . . . . . . 127To stage a source table . . . . . . . . . 129

Remapping a source table . . . . . . . . . 130To remap a source table . . . . . . . . . 130To remap a source table (InfoSphere CDC EventServer) . . . . . . . . . . . . . . 131

Copying selected table mappings . . . . . . . 131To copy selected table mappings . . . . . . 131To copy selected table mappings for an externaltarget datastore. . . . . . . . . . . . 132

Deleting table mappings. . . . . . . . . . 133To delete a table mapping . . . . . . . . 133To delete a table mapping (InfoSphere CDCEvent Server) . . . . . . . . . . . . 133

Exporting and importing subscriptions andselected table mappings . . . . . . . . . . 134

To export a subscription into an XML file . . . 134To export selected table mappings into an XMLfile . . . . . . . . . . . . . . . . 135To import a subscription from an XML file . . 135

Modifying table mappings . . . . . . . . . 135To modify table mappings . . . . . . . . 135

Replicating Data Definition Language(DDL) changes . . . . . . . . . . . 137Prerequisites and considerations for replicatingDDL changes in InfoSphere CDC for Oracledatabases version 6.5.1 . . . . . . . . . . 138Supported DDL operations . . . . . . . . . 139Working with rule sets . . . . . . . . . . 140

To define a rule set for a subscription . . . . 142To delete a rule set . . . . . . . . . . 144

Modifying rule sets . . . . . . . . . . . 144To change the name of a rule set . . . . . . 145To change the schema for a rule set . . . . . 145To add tables to a rule set . . . . . . . . 145To remove tables from a rule set . . . . . . 145To change the structural replication value for arule set . . . . . . . . . . . . . . 146To edit a pattern for a rule set . . . . . . . 146To delete a pattern from a rule set . . . . . 147

Copying rule sets . . . . . . . . . . . . 147To copy selected rule sets . . . . . . . . 147

Exporting rule sets . . . . . . . . . . . 148To export selected rule sets into an XML file . . 148

Promoting rule sets . . . . . . . . . . . 148To promote selected rule sets to a newsubscription . . . . . . . . . . . . . 149To promote selected rule sets to an existingsubscription . . . . . . . . . . . . . 150

Changing the refresh order of tables in aRules-based subscription . . . . . . . . . 151

To change the refresh order of tables . . . . 151Previewing tables in-scope for DDL replication . . 152

To preview tables in a subscription that matchrule sets . . . . . . . . . . . . . . 152

Customizing InfoSphere DataStagetable mappings . . . . . . . . . . 155Setting properties for a subscription that targetsInfoSphere DataStage. . . . . . . . . . . 155

To specify batch size thresholds for anInfoSphere DataStage subscription . . . . . 156To specify large object truncation size for anInfoSphere DataStage subscription . . . . . 156To specify the file name format for anInfoSphere DataStage subscription . . . . . 157To specify Direct Connect settings for anInfoSphere DataStage subscription . . . . . 157

Contents v

Understanding data types supportedby InfoSphere CDC . . . . . . . . . 159Supported data types. . . . . . . . . . . 159Supported column mappings . . . . . . . . 163

Mapping columns . . . . . . . . . 173Mapping source columns to target columns . . . 173

To map a source column to a target column . . 173Mapping journal control fields to target columns 174

To map a journal control field to a targetcolumn . . . . . . . . . . . . . . 174

Mapping expressions to target columns . . . . 175To map an expression to a target column . . . 175To accumulate or deduct numeric data on atarget column . . . . . . . . . . . . 176

Mapping source and target columns automatically 176To map columns automatically . . . . . . 177

Mapping initial values to target columns . . . . 177To define an initial value for a target column 178

Adding and mapping derived columns to targetcolumns . . . . . . . . . . . . . . . 178

To add a derived column . . . . . . . . 179To map a derived column to a target column 180To modify a derived column . . . . . . . 181To delete a derived column. . . . . . . . 181

Setting data translations on columnmappings . . . . . . . . . . . . . 183Setting data translations . . . . . . . . . . 183

To add a data translation . . . . . . . . 184To modify a data translation . . . . . . . 184To delete a data translation . . . . . . . . 185

Importing and exporting data translations . . . . 185To export a data translation . . . . . . . 185To import a data translation . . . . . . . 186

Replicating multibyte (MBCS) anddouble-byte (DBCS) character data . . 187Common encoding conversion scenarios . . . . 188Considerations when replicating MBCS characterdata . . . . . . . . . . . . . . . . 189Upgrading subscriptions to use auto-encodingmode . . . . . . . . . . . . . . . . 190

To upgrade subscriptions to use auto-encodingmode . . . . . . . . . . . . . . . 191

Configuring MBCS encoding conversion betweenyour source and target . . . . . . . . . . 191

To configure MBCS encoding conversion . . . 191Specifying the workload preference . . . . . . 192

To set the workload preference . . . . . . 193Handling Unicode character encoding . . . . . 193

To set handling for Unicode character encoding 194

Setting member identifiers. . . . . . 195Setting member identifiers for multi-membersource tables . . . . . . . . . . . . . 195

To add a member identifier. . . . . . . . 195To modify a member identifier . . . . . . 196To delete a member identifier . . . . . . . 196

Using journal control fields forauditing replication activities . . . . 197About journal control fields . . . . . . . . 197

Commit Cycle ID (&CCID) . . . . . . . . 198Source RRN (&CNTRRN) . . . . . . . . 198Entry Type Code (&CODE) . . . . . . . . 199Entry Type (&ENTTYP) . . . . . . . . . 199Source Job Name (&JOB) . . . . . . . . 200Source Job Number (&JOBNO) . . . . . . 200Source Job User (&JOBUSER) . . . . . . . 201Journal Name (&JOURNAL) . . . . . . . 202Source Table Library (&LIBRARY) . . . . . 203Source Table Member Name (&MEMBER) . . . 203Source Table Name (&OBJECT) . . . . . . 204Source Program Name (&PROGRAM) . . . . 204Journal Sequence Number (&SEQNO) . . . . 205Source Server Name (&SYSTEM) . . . . . . 206Record Modification Time (&TIMSTAMP) . . . 207Record Modification User (&USER) . . . . . 207

About journal codes . . . . . . . . . . . 208Table Clear . . . . . . . . . . . . . 209Delete . . . . . . . . . . . . . . . 210Insert . . . . . . . . . . . . . . . 210Update Before . . . . . . . . . . . . 210Update After . . . . . . . . . . . . 211

Translating journal codes into meaningfulinformation . . . . . . . . . . . . . . 211

Controlling table operations . . . . . 213Controlling the apply of refresh operations . . . 213

To keep all rows on a refresh . . . . . . . 213To delete all rows on a refresh. . . . . . . 214To audit rows on a refresh . . . . . . . . 214

Specifying SQL to control refresh operations . . . 215To specify additional SQL after a refresh . . . 216To delete selected rows on a refresh . . . . . 216

Configuring user exits . . . . . . . 219Configuring table-level user exits . . . . . . . 219

To configure a stored procedure . . . . . . 220To configure a derived column or an expressionthat calls %STPROC, %USER, or %USERFUNC . 221To configure a user exit for a Java class. . . . 222

Configuring table-level user exits for InfoSphereCDC for Microsoft SQL Server. . . . . . . . 223

To configure for IDispatch COM DLL . . . . 224To configure for C or C++ . . . . . . . . 225To configure a stored procedure . . . . . . 226

Configuring table-level user exits for InfoSphereCDC for Oracle databases (version 6.1 and below)or InfoSphere CDC for Sybase databases (version6.1 and below) . . . . . . . . . . . . . 228

To configure a C shared library . . . . . . 229To configure a stored procedure (Oracle andSybase) . . . . . . . . . . . . . . 230To configure a derived column or an expressionthat calls %STPROC (Oracle and Sybase) . . . 231

Configuring table-level user exits for InfoSphereCDC for IBM i (version 6.2 and below) orInfoSphere CDC for z/OS . . . . . . . . . 231

vi InfoSphere Change Data Capture: Management Console Administration Guide

To configure a standard function . . . . . . 231Creating a custom data format for IBM InfoSphereDataStage . . . . . . . . . . . . . . 232

To create a custom data format for InfoSphereDataStage . . . . . . . . . . . . . 233To modify an existing custom data format whenupgrading from InfoSphere DataStage 6.3 to 6.5 . 233

Configuring subscription-level user exits . . . . 234To configure a user exit for a subscription . . . 234

Understanding user exit configuration forInfoSphere CDC Event Server . . . . . . . . 235Overriding JMS message header properties . . . 235

To override JMS message header properties . . 235Sending the XML message to a different JMSmessage destination . . . . . . . . . . . 236

To send the XML message to another JMSmessage destination . . . . . . . . . . 237

Creating XML output and applying XSLT to anXML message . . . . . . . . . . . . . 238

To create an XML message and apply XSLT . . 239Sending XML messages to multiple JMS messagedestinations . . . . . . . . . . . . . . 240

To send an XML message to a different JMSmessage destination . . . . . . . . . . 240

Querying a Web service to access content . . . . 241To query a Web service to access content . . . 242

Content based routing . . . . . . . . . . 243To route the content of an XML message toanother JMS message destination . . . . . . 243

Column functions . . . . . . . . . 245Conventions in using column functions . . . . 245String functions . . . . . . . . . . . . 246

Concatenation%CONCAT . . . . . . . 246Lowercase%LOWER . . . . . . . . . 247Left trim%LTRIM . . . . . . . . . . 248Capitalization%PROPER . . . . . . . . 249Character substitution%REPLACE. . . . . 250Right trim%RTRIM. . . . . . . . . . 251Substring%SUBSTRING . . . . . . . . 252Uppercase%UPPER . . . . . . . . . 253

Date and time functions . . . . . . . . . . 254Century%CENTURY . . . . . . . . . 254Current date%CURDATE. . . . . . . . 255Current time%CURTIME . . . . . . . . 256Current timestamp%CURTMSTP . . . . . 258

Conversion functions . . . . . . . . . . . 259Character conversion%TOCHAR . . . . . 259Character format conversion%TOCHARFORMAT . . . . . . . . . . 261Date conversion%TODATE . . . . . . . 262Date and time conversion%TODATETIME 263Number conversion%TONUMBER . . . . 266Time conversion%TOTIME . . . . . . . 267

Conditional and variable functions . . . . . . 269Conditional%IF . . . . . . . . . . . 269Variable%VAR . . . . . . . . . . . 270

Data functions . . . . . . . . . . . . . 271Before value%BEFORE . . . . . . . . 271Current value%CURR . . . . . . . . . 271Retrieve column%GETCOL (DB2 for i) . . . 273

Retrieve column%GETCOL (Dynamic SQL) 276Retrieve column%SELECT . . . . . . . 279

User exit functions . . . . . . . . . . . 283Stored procedure%STPROC . . . . . . . 283User exit%USER . . . . . . . . . . 284User exit%USER (InfoSphere CDC forMicrosoft SQL 5.x). . . . . . . . . . . 288User Exit%USERFUNC . . . . . . . . 289

%GETCOL column function scenarios (DB2 forIBM i) . . . . . . . . . . . . . . . . 291

Retrieving a column from another table usingthe %GETCOL function (DB2 for i) . . . . . 291Performing an outer join using the %GETCOLfunction (DB2 for i) . . . . . . . . . . 292Nesting columns to join data using the%GETCOL function (DB2 for i) . . . . . . 292Combining columns using the %GETCOLfunction (DB2 for i) . . . . . . . . . . 292

%GETCOL column function scenarios (DynamicSQL) . . . . . . . . . . . . . . . . 293

Retrieving a column using the %GETCOLfunction (Dynamic SQL). . . . . . . . . 293Retrieving a column using the %GETCOLfunction without reading the same row from thetable . . . . . . . . . . . . . . . 293Retrieving a column using nested %GETCOLfunctions (Dynamic SQL) . . . . . . . . 294Filtering rows using the %GETCOL function(Dynamic SQL) . . . . . . . . . . . . 295

Publishing multiple derived columns using the%GETCOL function (Dynamic SQL) . . . . . . 295XPath functions . . . . . . . . . . . . 296

ceiling . . . . . . . . . . . . . . . 297concat . . . . . . . . . . . . . . . 297contains . . . . . . . . . . . . . . 297floor . . . . . . . . . . . . . . . 297false . . . . . . . . . . . . . . . 298formatNumber . . . . . . . . . . . . 298normalizeSpace. . . . . . . . . . . . 298not . . . . . . . . . . . . . . . . 298number . . . . . . . . . . . . . . 299position . . . . . . . . . . . . . . 299round . . . . . . . . . . . . . . . 299startsWith . . . . . . . . . . . . . 299string . . . . . . . . . . . . . . . 300stringLength. . . . . . . . . . . . . 300substring . . . . . . . . . . . . . . 300substringAfter . . . . . . . . . . . . 300substringBefore . . . . . . . . . . . . 301sum . . . . . . . . . . . . . . . 301translate . . . . . . . . . . . . . . 301true . . . . . . . . . . . . . . . 302

Transform extensions . . . . . . . . . . . 302sxt:add . . . . . . . . . . . . . . 303sxt:db-lookup . . . . . . . . . . . . 303sxt:divide. . . . . . . . . . . . . . 303sxt:filter . . . . . . . . . . . . . . 304sxt:formatDate . . . . . . . . . . . . 304sxt:getSequentialNum . . . . . . . . . 305sxt:getSubField . . . . . . . . . . . . 305sxt:getSysDateTime . . . . . . . . . . 305

Contents vii

sxt:getSysDate . . . . . . . . . . . . 306sxt:getSysTime . . . . . . . . . . . . 306sxt:groupConcat . . . . . . . . . . . 306sxt:ifExist . . . . . . . . . . . . . . 306sxt:ifReturn . . . . . . . . . . . . . 307sxt:isEqual . . . . . . . . . . . . . 307sxt:multiply . . . . . . . . . . . . . 307sxt:nodeConcat . . . . . . . . . . . . 307sxt:padLeft . . . . . . . . . . . . . 308sxt:padRight. . . . . . . . . . . . . 308sxt:proper . . . . . . . . . . . . . 308sxt:setDefault . . . . . . . . . . . . 309sxt:subtract . . . . . . . . . . . . . 309sxt:toLowerCase . . . . . . . . . . . 309sxt:toUpperCase . . . . . . . . . . . 310sxt:trim . . . . . . . . . . . . . . 310

Using external Java objects in data transformations 310Simple string objects (type I) . . . . . . . 310SQL data types (type II) . . . . . . . . . 311XML objects (type III) . . . . . . . . . 311

XPath expression operators . . . . . . . . . 311+ Operator . . . . . . . . . . . . . 312- Operator . . . . . . . . . . . . . 312* Operator . . . . . . . . . . . . . 312div Operator . . . . . . . . . . . . 312mod Operator . . . . . . . . . . . . 312= Operator . . . . . . . . . . . . . 312!= Operator . . . . . . . . . . . . . 312< Operator . . . . . . . . . . . . . 313 Operator . . . . . . . . . . . . . 313>= Operator . . . . . . . . . . . . . 313or Operator . . . . . . . . . . . . . 313and Operator . . . . . . . . . . . . 313() parentheses Operator . . . . . . . . . 313[ ] Operator . . . . . . . . . . . . . 314/ Operator . . . . . . . . . . . . . 314// Operator . . . . . . . . . . . . . 314@ Operator . . . . . . . . . . . . . 314

Filtering rows and columns . . . . . 315Filtering rows . . . . . . . . . . . . . 315

To filter rows . . . . . . . . . . . . 315Selecting critical columns to filter rows . . . . . 316

To select critical columns . . . . . . . . 316Filtering columns . . . . . . . . . . . . 316

To filter columns . . . . . . . . . . . 317

Setting conflict detection andresolution . . . . . . . . . . . . . 319Resolving conflicts for source or target wins . . . 319

To resolve conflicts for source row wins . . . 321To resolve conflicts for target row wins . . . . 321

Resolving conflicts for largest or smallest valuewins . . . . . . . . . . . . . . . . 321

To resolve conflicts for largest value wins . . . 323To resolve conflicts for smallest value wins . . 323

Resolving conflicts with user exits . . . . . . 323To resolve conflicts with user exit programs . . 324

Controlling row operations . . . . . 327Suppressing the apply of row operations . . . . 327

To suppress an insert, update, or delete . . . 327Preventing the audit of row operations . . . . . 328

To prevent row operations from being audited 328To audit only the after image . . . . . . . 328

Detecting conflicts on row operations . . . . . 329To detect conflicts on row operations . . . . 329

Enabling the apply of soft deletes (InfoSphere CDCfor Oracle databases) . . . . . . . . . . . 330

To enable InfoSphere CDC for Oracle to apply asoft delete . . . . . . . . . . . . . 330

Customizing JMS messagedestination mappings . . . . . . . . 331Creating an XML message . . . . . . . . . 331

To create an XML message . . . . . . . . 331Importing and exporting XML files, schemas, andmapping projects . . . . . . . . . . . . 332

To import an XML, schema, or mappingdefinition file . . . . . . . . . . . . 333To export an XML schema or mappingdefinition file . . . . . . . . . . . . 333

Building an XPath expression . . . . . . . . 334To build an XPath expression . . . . . . . 334

Querying columns from other tables. . . . . . 335To query columns from other tables . . . . . 335

Setting JMS message headerproperties . . . . . . . . . . . . . 339Defining the JMS message header . . . . . . 339

To add a JMS message header property . . . 339To add a custom JMS message header property 340To delete a custom JMS message headerproperty . . . . . . . . . . . . . . 340

Setting general runtime options . . . . . . . 341To enable InfoSphere CDC Event Server to trimtext . . . . . . . . . . . . . . . . 341To disable InfoSphere CDC Event Server fromdifferentiating between an empty string from aNULL value . . . . . . . . . . . . . 342To disable streamed transformation mode . . . 342

Configuring replication . . . . . . . 343Flagging a source table for refresh . . . . . . 343

To flag a source table for a Standard Refresh 345To flag a source table for a Differential Refresh 346Sample: Refreshing subsets of rows . . . . . 346

Marking a table capture point on a source table 348To mark a table capture point on a source tablebefore mirroring . . . . . . . . . . . 349

Parking a table from replication . . . . . . . 349To park a table from replication . . . . . . 349

Changing the refresh order of tables . . . . . . 349To change the refresh order of tables . . . . 350

Changing the replication method of a table . . . 350To change the replication method of a table . . 350

Selecting a new journal table . . . . . . . . 351To select a new journal table . . . . . . . 352

Setting members for replication . . . . . . . 353

viii InfoSphere Change Data Capture: Management Console Administration Guide

To select a member for replication . . . . . 353Changing the message destination . . . . . . 353

To change the message destination of a table 353

Starting and ending replication. . . . 355Starting mirroring . . . . . . . . . . . . 356

To start continuous mirroring . . . . . . . 357To start scheduled end (net-change) mirroring 357

Starting a refresh on a subscription . . . . . . 358To start a refresh . . . . . . . . . . . 360

Ending replication . . . . . . . . . . . . 361To end replication . . . . . . . . . . . 362

Sending XML messages to a JMS messagedestination . . . . . . . . . . . . . . 363

To send an XML message to a JMS messagedestination or a staging target database. . . . 363

Setting notifications . . . . . . . . 365Selecting a notification handler . . . . . . . 366Choosing a notification category and a messagetype . . . . . . . . . . . . . . . . 367Setting notifications for a datastore . . . . . . 368

To set an e-mail (MAPI) notification . . . . . 368To set an email (SMTP) notification . . . . . 369To set an e-mail notification (InfoSphere CDCfor Oracle) . . . . . . . . . . . . . 369To set an e-mail notification . . . . . . . 370To set a notification for the CHCPRINT spoolfile . . . . . . . . . . . . . . . . 370To set a notification for an operator system log 370To set a notification for a UNIX system log . . 371To set a notification using a user exit program 371To set a notification using a user exit program 371To set a notification using a user exit program 372To set a notification for a message queue . . . 372To filter a notification message . . . . . . 373

Setting notifications for a subscription . . . . . 373To set notifications for a subscription . . . . 373To view the datastore default notifications for asubscription . . . . . . . . . . . . . 374

Copying notifications for a subscription . . . . 374To copy notification settings . . . . . . . 374

Setting latency thresholds and notifications . . . 374To set a latency threshold and notification . . . 375

Promoting subscription changes . . . 377Before you promote a subscription or selected tablemappings . . . . . . . . . . . . . . 377Promoting subscriptions . . . . . . . . . . 378

To promote a subscription to a new subscription 379To promote changes to an existing subscription 380

Promoting selected table mappings . . . . . . 382To promote selected table mappings to a newenvironment. . . . . . . . . . . . . 382To promote selected table mappings to anexisting subscription . . . . . . . . . . 384

Monitoring subscriptions . . . . . . 387Subscriptions view (Monitoring perspective) . . 387Understanding subscription states . . . . . . 388

Displaying the replication diagram . . . . . . 389Viewing latency for a subscription . . . . . . 390

To view latency values for a subscription . . . 391Viewing replication activity. . . . . . . . . 391

To view replication activities for a subscription 393Viewing replication events . . . . . . . . . 393

To view events (InfoSphere CDC version 6.5and later). . . . . . . . . . . . . . 395To retrieve events that occurred within a daterange (InfoSphere CDC version 6.5 and later) . 395To view events (InfoSphere CDC version 6.3and earlier) . . . . . . . . . . . . . 396To view event details . . . . . . . . . . 396To copy events . . . . . . . . . . . . 397To clear all events for the selected subscription 397To clear selected events for the selectedsubscription . . . . . . . . . . . . . 397To export events . . . . . . . . . . . 398

Performance view (Monitoring perspective) . . . 398Available metrics . . . . . . . . . . . . 399

Datastore metrics . . . . . . . . . . . 399Database Workload metrics . . . . . . . . 402Log cache metrics . . . . . . . . . . . 403Log reader metrics . . . . . . . . . . 404Log parser metrics. . . . . . . . . . . 407Single Scrape metrics . . . . . . . . . . 408Source Engine metrics . . . . . . . . . 409Communications metrics . . . . . . . . 413Target Engine metrics . . . . . . . . . 415Target Apply metrics . . . . . . . . . . 418

Analyzing subscription performance. . . . . . 422To chart metrics for a subscription . . . . . 423To change the metrics when you are alreadycollecting data . . . . . . . . . . . . 423To chart metrics for tables . . . . . . . . 424To view the busiest tables in a subscription . . 424To stop table-level performance monitoring . . 424

System parameters forTransformation Server for MicrosoftSQL Server (version 5.3 and earlier) . 425General product system parameters . . . . . . 425

AuthCode . . . . . . . . . . . . . 426DBMS . . . . . . . . . . . . . . . 426dbUser . . . . . . . . . . . . . . 426dllname . . . . . . . . . . . . . . 426DSN . . . . . . . . . . . . . . . 426NetServiceName . . . . . . . . . . . 427pwdencrypt . . . . . . . . . . . . . 427Startup Timeout . . . . . . . . . . . 427TSSrcCP . . . . . . . . . . . . . . 428TSTgtCP . . . . . . . . . . . . . . 428TCP_KEEPALIVE_SECS . . . . . . . . . 428WindowsAuthentication . . . . . . . . . 429

Replication system parameters . . . . . . . 429AutoRestart . . . . . . . . . . . . . 429convertNotNullableColumns . . . . . . . 430MirrorError . . . . . . . . . . . . . 430RefreshError. . . . . . . . . . . . . 431RefreshMode . . . . . . . . . . . . 431

Contents ix

Database translation log system parameters . . . 432Cleanup Interval . . . . . . . . . . . 432Cleanup Log Events . . . . . . . . . . 432Cleanup Record Count . . . . . . . . . 433LogCleanupMethod . . . . . . . . . . 434Report Position Interval . . . . . . . . . 434Synchronization Interval. . . . . . . . . 435

Commitment control system parameters . . . . 436CommitmentControl . . . . . . . . . . 436Commit Group Size . . . . . . . . . . 437RefreshBlock . . . . . . . . . . . . 437SeparateCommits . . . . . . . . . . . 438

Event log system parameters . . . . . . . . 438AllowEventLogClear . . . . . . . . . . 438

Multibyte character set system parameters. . . . 439Unicode Handling. . . . . . . . . . . 439

Latency system parameters . . . . . . . . . 440Deadband Percentage . . . . . . . . . 440Monitor Sample Interval. . . . . . . . . 442

Notification system parameters . . . . . . . 442implicit_transformation_warning . . . . . . 442DM_STATUS_INTERVAL . . . . . . . . 443Heartbeat Timeout. . . . . . . . . . . 444InvalidNumericMsg . . . . . . . . . . 444

Tracing system parameters . . . . . . . . . 445CommTrace . . . . . . . . . . . . . 445ProgramTrace . . . . . . . . . . . . 446traceActive . . . . . . . . . . . . . 446TraceLevel . . . . . . . . . . . . . 446trcCleanup . . . . . . . . . . . . . 447trcCOMM . . . . . . . . . . . . . 447trcFiles . . . . . . . . . . . . . . 447trcFncCalls . . . . . . . . . . . . . 448trcJrlSync . . . . . . . . . . . . . . 448trcReplStatus . . . . . . . . . . . . 448trcScan . . . . . . . . . . . . . . 448trcSQL. . . . . . . . . . . . . . . 448trcThread. . . . . . . . . . . . . . 448

Data type system parameters . . . . . . . . 449TrimVarchar . . . . . . . . . . . . . 449

Lock detection system parameters . . . . . . 449DeadlockRetrys. . . . . . . . . . . . 449DM_LOCK_DETECTION . . . . . . . . 449DM_LOCK_TIMEOUT . . . . . . . . . 450

System Parameters for InfoSphereCDC for Microsoft SQL Server(version 6.0 and later). . . . . . . . 451General product system parameters . . . . . . 451

mirror_auto_restart_interval_minutes . . . . 451Notification system parameters . . . . . . . 452

events_max_retain . . . . . . . . . . . 452global_shutdown_after_no_heartbeat_response_minutes452global_conversion_not_possible_warning . . . 452implicit_transformation_warning . . . . . . 453

Maximize throughput system parameters . . . . 454global_max_batch_size . . . . . . . . . 454mirror_interim_commit_threshold . . . . . 454refresh_commit_after_max_operations . . . . 455

Encoding system parameters . . . . . . . . 455

global_unicode_as_char . . . . . . . . . 456Supplemental logging system parameters . . . . 456

mirror_logging_by_empty_triggers . . . . . 457Disk resource system parameters . . . . . . . 457

mirror_global_disk_quota_mb . . . . . . . 457mirror_global_disk_quota_gb . . . . . . . 458staging_store_can_run_independently . . . . 459staging_store_disk_quota_gb . . . . . . . 459

Apply process system parameters . . . . . . 459convert_not_nullable_column . . . . . . . 460global_default_after_database_minimum_timestamp460global_default_before_database_minimum_timestamp461mirror_end_on_error . . . . . . . . . . 461mirror_expected_errors_list . . . . . . . . 461refresh_end_on_error . . . . . . . . . . 462refresh_expected_errors_list . . . . . . . 462refresh_loader_drop_index . . . . . . . . 462refresh_with_referential_integrity . . . . . . 463userexit_max_lob_size_kb . . . . . . . . 463

System parameters for InfoSphereCDC for Oracle databases (version 6.2and earlier) . . . . . . . . . . . . 465General product system parameters . . . . . . 465

CODE_PAGE . . . . . . . . . . . . 466DEFAULT_ORACLE_HOME . . . . . . . 466DEFAULT_ORACLE_SID . . . . . . . . 466DEFAULT_ORACLE_USER. . . . . . . . 467DM_COMMS_HOME . . . . . . . . . 467D_MIRROR_HOME . . . . . . . . . . 467D_MIRROR_LOG . . . . . . . . . . . 467DM_DYNAMIC_PARAMETER_CHECK_INT 468DM_MAX_MONITOR_ENTRIES . . . . . . 468DM_TS_MAX_POOL_SIZE_MB . . . . . . 469DM_TS_POOL_BLOCK_SIZE_MB . . . . . 469_MAX_POOL_SIZE_MB . . . . 470_POOL_BLOCK_SIZE_MB . . . 470LD_LIBRARY_PATH . . . . . . . . . . 471LIBPATH . . . . . . . . . . . . . . 471ORACLE_HOME . . . . . . . . . . . 471ORACLE_SID . . . . . . . . . . . . 472PASSWORD . . . . . . . . . . . . . 472PUBLISH_METADATA . . . . . . . . . 472RLD_SYSTEM_TXQSIZE . . . . . . . . 473_TXQSIZE . . . . . . . . . 473SHLIB_PATH . . . . . . . . . . . . 474STARTUP_TIMEOUT. . . . . . . . . . 474TCP_KEEPALIVE_SECS . . . . . . . . . 474USER . . . . . . . . . . . . . . . 475

Apply process system parameters . . . . . . 475convertNotNullableColumns . . . . . . . 476D_MIRROR_MIRROR_ERROR_LIST. . . . . 476D_MIRROR_MIRROR_ERROR_STOP . . . . 477D_MIRROR_REFRESH_ERROR_LIST . . . . 477D_MIRROR_REFRESH_ERROR_STOP . . . . 478DM_ADAPTIVE_APPLY_SOFT_DELETES . . . 478DM_ADAPTIVE_APPLY_.479DM_ADAPTIVE_APPLY_MIMIC_SOURCE_OPERATION479DM_ARRAY_BIND_MAX . . . . . . . . 480FILTER_NOCHANGE_UPDATES_FOR_AUDIT 480

x InfoSphere Change Data Capture: Management Console Administration Guide

NLS_LANG . . . . . . . . . . . . . 481NLS_NCHAR . . . . . . . . . . . . 481NOT_NULL_DATE_DEFAULT . . . . . . 481TRIM_CHAR_TO_VARCHAR . . . . . . . 481TRIM_VARCHAR_TO_VARCHAR . . . . . 482TRIM_TO_NULL . . . . . . . . . . . 482UNICODE_HANDLING. . . . . . . . . 483

Cascading replication system parameters . . . . 484CASCADE_OMIT_TARGETS . . . . . . . 484PREVENT_RECURSION. . . . . . . . . 485

Database journal (trigger) system parameters . . . 485REPORT_POSITION_INTERVAL . . . . . . 485MONITOR_PURGE_INTERVAL . . . . . . 486MONITOR_REFRESH_PERIOD . . . . . . 486

Maximize throughput system parameters . . . . 487COMMIT_GROUP_SIZE. . . . . . . . . 487COMMIT_LEVEL . . . . . . . . . . . 488COMMIT_INTERVAL . . . . . . . . . 488MAINTAIN_TRANSACTION_CONSISTENCY 489SYNCHRONIZATION_COMMIT_GROUP_SIZE . . . . . . . . . . . . 489SYNCHRONIZATION_INTERVAL . . . . . 490TRANSACTION_GROUP_SIZE . . . . . . 490TRANSACTION_INTERVAL . . . . . . . 491TRANSACTION_RECORDS_THRESHOLD . . 491

Tracing system parameters . . . . . . . . . 492D_MIRROR_SP_TRACE . . . . . . . . . 492D_MIRROR_TRACE . . . . . . . . . . 492D_MIRROR_TRACE_FILE_SIZE . . . . . . 493D_MIRROR_TRACE_ON_ERROR . . . . . 493DM_PRINT_DIAGNOSTICS . . . . . . . 494D_MIRROR_ALARM_TRACE . . . . . . . 494

Refresh loader system parameters . . . . . . 495DIRPATH_BUF_ROWS . . . . . . . . . 495DIRPATH_BUF_SIZE . . . . . . . . . . 496DIRPATH_CACHE_DATE_SIZE . . . . . . 497DIRPATH_LOAD . . . . . . . . . . . 497DIRPATH_LOGGING . . . . . . . . . 498DIRPATH_DO_RECOVERY. . . . . . . . 498

User exit system parameters . . . . . . . . 499D_MIRROR_SP_CONNECTION . . . . . . 499DM_FROM_CODEPAGE_V4USEREXIT. . . . 499DM_TO_CODEPAGE_V4USEREXIT . . . . . 500

Table mapping system parameters . . . . . . 500TS_DELETE_ASSIGNED_OBJECTS_DURING_DESCRIBE500

Notification system parameters . . . . . . . 501implicit_transformation_warning . . . . . . 501DEADBAND_PERCENTAGE . . . . . . . 502DM_STATUS_INTERVAL . . . . . . . . 503HEARTBEAT_TIMEOUT . . . . . . . . 504LOG_EMAIL_USERNAME . . . . . . . . 504MONITOR_SAMPLE_INTERVAL. . . . . . 505STATISTICS_INTERVAL . . . . . . . . . 505

Disk resource system parameters . . . . . . . 506LOG_MAX_SIZE . . . . . . . . . . . 506

System parameters for InfoSphereCDC for Oracle databases (version 6.3and later) . . . . . . . . . . . . . 507General product system parameters . . . . . . 507

mirror_auto_restart_interval_minutes . . . . 507mirror_set_table_data_capture_timeout . . . . 508

Transaction log location system parameters . . . 508mirror_archive_log_directory . . . . . . . 508mirror_asm_oracle_path . . . . . . . . . 508mirror_online_log_directory . . . . . . . 509oracle_archive_dir . . . . . . . . . . . 509oracle_archive_destination_id . . . . . . . 509oracle_archive_logs_only . . . . . . . . 510oracle_log_path_userexit. . . . . . . . . 510oracle_log_shipping . . . . . . . . . . 510oracle_using_log_transport_services . . . . . 511

Notification system parameters . . . . . . . 512events_max_retain . . . . . . . . . . . 512global_conversion_not_possible_warning . . . 513global_shutdown_after_no_heartbeat_response_minutes513implicit_transformation_warning . . . . . . 513

Maximize throughput system parameters . . . . 514mirror_interim_commit_threshold . . . . . 514mirror_sess_hist_age_threshold . . . . . . 515mirror_src_ora_version . . . . . . . . . 515refresh_commit_after_max_operations . . . . 515userexit_max_lob_size_kb . . . . . . . . 516

Encoding system parameters . . . . . . . . 516global_unicode_as_char . . . . . . . . . 516

Disk resource system parameters . . . . . . . 517mirror_global_disk_quota_mb . . . . . . . 517mirror_global_disk_quota_gb . . . . . . . 518staging_store_can_run_independently . . . . 518staging_store_disk_quota_gb . . . . . . . 519staging_store_disk_quota_mb . . . . . . . 519

Apply process system parameters . . . . . . 520convert_not_nullable_column . . . . . . . 520global_max_batch_size . . . . . . . . . 520mirror_end_on_error . . . . . . . . . . 521mirror_expected_errors_list . . . . . . . . 521refresh_end_on_error . . . . . . . . . . 522refresh_expected_errors_list . . . . . . . 522refresh_in_unicode . . . . . . . . . . 523refresh_with_referential_integrity . . . . . . 523trim_char_to_varchar . . . . . . . . . . 523trim_varchar_to_varchar. . . . . . . . . 524userexit_max_lob_size_kb . . . . . . . . 524

System parameters for InfoSphereCDC for Oracle databases (trigger)(version 6.3 and later). . . . . . . . 525General product system parameters . . . . . . 525


events_max_retain . . . . . . . . . . . 526global_conversion_not_possible_warning . . . 526global_shutdown_after_no_heartbeat_response_minutes526implicit_transformation_warning . . . . . . 527

Maximize throughput system parameters . . . . 527mirror_interim_commit_threshold . . . . . 528refresh_commit_after_max_operations . . . . 528

Database journal (trigger) system parameters . . . 528mirror_journal_schema . . . . . . . . . 529

Encoding system parameters . . . . . . . . 529

Contents xi

global_unicode_as_char . . . . . . . . . 529Disk resource system parameters . . . . . . . 530

mirror_global_disk_quota_mb . . . . . . . 530mirror_global_disk_quota_gb . . . . . . . 531

Apply process system parameters . . . . . . 531convert_not_nullable_column . . . . . . . 531global_max_batch_size . . . . . . . . . 532mirror_end_on_error . . . . . . . . . . 532mirror_expected_errors_list . . . . . . . . 533refresh_end_on_error . . . . . . . . . . 533refresh_expected_errors_list . . . . . . . 533refresh_in_unicode . . . . . . . . . . 534refresh_with_referential_integrity . . . . . . 534trim_char_to_varchar . . . . . . . . . . 535trim_varchar_to_varchar. . . . . . . . . 535userexit_max_lob_size_queue_kb . . . . . . 535

System parameters for InfoSphereCDC for Sybase databases (version6.0 and earlier) . . . . . . . . . . . 537General product system parameters . . . . . . 537

CODE_PAGE . . . . . . . . . . . . 538D_MIRROR_HOME . . . . . . . . . . 538D_MIRROR_LOG . . . . . . . . . . . 538DM_DYNAMIC_PARAMETER_CHECK_INT 538DM_MAX_MONITOR_ENTRIES . . . . . . 539DSQUERY . . . . . . . . . . . . . 539LD_LIBRARY_PATH . . . . . . . . . . 540LIBPATH . . . . . . . . . . . . . . 540PUBLISH_METADATA . . . . . . . . . 540SYBASE . . . . . . . . . . . . . . 541SYBASE_OCS . . . . . . . . . . . . 541SHLIB_PATH . . . . . . . . . . . . 541STARTUP_TIMEOUT. . . . . . . . . . 541USER . . . . . . . . . . . . . . . 542

Apply process system parameters . . . . . . 542convertNotNullableColumns . . . . . . . 542D_MIRROR_MIRROR_ERROR_STOP . . . . 543D_MIRROR_REFRESH_ERROR_STOP . . . . 543FILTER_NOCHANGE_UPDATES_FOR_AUDIT 544NLS_LANG . . . . . . . . . . . . . 544TRANSACTION_GROUP_SIZE . . . . . . 544TRANSACTION_INTERVAL . . . . . . . 545TRANSACTION_RECORDS_THRESHOLD . . 546TRIM_CHAR_TO_VARCHAR . . . . . . . 546TRIM_VARCHAR_TO_VARCHAR . . . . . 546TRIM_TO_NULL . . . . . . . . . . . 547

Cascading replication system parameters . . . . 548PREVENT_RECURSION. . . . . . . . . 548

Database journal (trigger) system parameters . . . 548REPORT_POSITION_INTERVAL . . . . . . 548

Maximize throughput system parameters . . . . 549COMMIT_GROUP_SIZE. . . . . . . . . 549COMMIT_INTERVAL . . . . . . . . . 550SYNCHRONIZATION_COMMIT_GROUP_SIZE . . . . . . . . . . . . 551SYNCHRONIZATION_INTERVAL . . . . . 552

Tracing system parameters . . . . . . . . . 552D_MIRROR_ALARM_TRACE . . . . . . . 552D_MIRROR_TRACE . . . . . . . . . . 553

D_MIRROR_TRACE_FILE_SIZE . . . . . . 553D_MIRROR_TRACE_ON_ERROR . . . . . 554

Notification system parameters . . . . . . . 554implicit_transformation_warning . . . . . . 555DEADBAND_PERCENTAGE . . . . . . . 555DM_STATUS_INTERVAL . . . . . . . . 557HEARTBEAT_TIMEOUT . . . . . . . . 557LOG_EMAIL_USERNAME . . . . . . . . 558MONITOR_SAMPLE_INTERVAL. . . . . . 558STATISTICS_INTERVAL . . . . . . . . . 559

Disk resource system parameters . . . . . . . 559LOG_MAX_SIZE . . . . . . . . . . . 559

Refresh loader system parameters . . . . . . 560D_HOME_BCP . . . . . . . . . . . . 560D_MIRROR_BCP . . . . . . . . . . . 560D_MIRROR_BCP_ROWS . . . . . . . . 561D_MIRROR_FASTBCP . . . . . . . . . 561DM_BCP_PACKET_SIZE . . . . . . . . 561

System parameters for InfoSphereCDC for Sybase databases (version6.3 and later) . . . . . . . . . . . 563General product system parameters . . . . . . 563



Maximize throughput system parameters . . . . 566global_max_batch_size . . . . . . . . . 566mirror_interim_commit_threshold . . . . . 566refresh_commit_after_max_operations . . . . 567


Disk resource system parameters . . . . . . . 568mirror_global_disk_quota_mb . . . . . . . 568mirror_global_disk_quota_gb . . . . . . . 569staging_store_can_run_independently . . . . 570staging_store_disk_quota_gb . . . . . . . 570

Apply process system parameters . . . . . . 570global_default_after_database_minimum_timestamp571global_default_before_database_minimum_timestamp571convert_not_nullable_column . . . . . . . 572mirror_end_on_error . . . . . . . . . . 572mirror_expected_errors_list . . . . . . . . 572refresh_end_on_error . . . . . . . . . . 573refresh_expected_errors_list . . . . . . . 573refresh_loader_drop_index . . . . . . . . 574refresh_with_referential_integrity . . . . . . 574trim_char_to_varchar . . . . . . . . . . 574trim_varchar_to_varchar. . . . . . . . . 575userexit_max_lob_size_kb . . . . . . . . 575

Supplemental logging system parameters . . . . 576auto_configure_supplemental_logging . . . . 576mirror_logging_by_empty_triggers . . . . . 576

System parameters for InfoSphereCDC for DB2 for i (version 6.2 andearlier) . . . . . . . . . . . . . . 577

xii InfoSphere Change Data Capture: Management Console Administration Guide

General product system parameters . . . . . . 577Authorization Code . . . . . . . . . . 578Enable *MAXOPT3 Option . . . . . . . . 578Record Format Check . . . . . . . . . 578Startup Timeout . . . . . . . . . . . 579TCP_KEEPALIVE_SECS . . . . . . . . . 579

Replication system parameters . . . . . . . 580Allow Refresh While Active . . . . . . . 580End on Error During Mirroring . . . . . . 580End on Error During Refresh . . . . . . . 581Refresh After Restore . . . . . . . . . . 581

Cascading replication system parameters . . . . 582Enable Cascading Replicates . . . . . . . 582

Database journal (trigger) system parameters . . . 582Default Journal Library . . . . . . . . . 582Default Journal Name . . . . . . . . . 583Replicate User Defined Journal Entries . . . . 583Report Position Interval . . . . . . . . . 584Synchronization Interval. . . . . . . . . 584

Remote journal system parameters . . . . . . 585Data Origin TCP/IP Name . . . . . . . . 585Data Origin Port . . . . . . . . . . . 585Relational Database Directory Entry . . . . . 586

Commitment control system parameters . . . . 586Commitment Control . . . . . . . . . . 586

Multibyte character set system parameters. . . . 587Unicode Handling. . . . . . . . . . . 587

Latency system parameters . . . . . . . . . 588Deadband Percentage . . . . . . . . . 588Monitor Sample Interval. . . . . . . . . 590

Notification system parameters . . . . . . . 590Heartbeat Timeout. . . . . . . . . . . 590Messages on Column Not Null Capable . . . 591Messages on Invalid Numerics . . . . . . 591Progress Status Interval . . . . . . . . . 592

Data type system parameters . . . . . . . . 593Numeric Column Validation . . . . . . . 593

Date and time column function system parameters 593Default Date On Error . . . . . . . . . 593

Row and column filtering system parameters. . . 594Audit Filtered Transactions . . . . . . . . 594Critical Column Filtering . . . . . . . . 595

Event log system parameters . . . . . . . . 595Notify Message Queue . . . . . . . . . 595Notify Message Queue Library . . . . . . 596Notify Message Threshold . . . . . . . . 596

Lock detection system parameters . . . . . . 597Lock Timeout Value . . . . . . . . . . 597

System parameters for InfoSphereCDC for DB2 UDB and InfoSphereCDC for Teradata (version 6.0 andearlier) . . . . . . . . . . . . . . 599General product system parameters . . . . . . 599

audit_auth_ code . . . . . . . . . . . 600auth_ code . . . . . . . . . . . . . 600db_password . . . . . . . . . . . . 600db_user . . . . . . . . . . . . . . 601debug . . . . . . . . . . . . . . . 601engine_ port. . . . . . . . . . . . . 601

log_file_quota . . . . . . . . . . . . 601log_total_quota . . . . . . . . . . . . 601md_db_url . . . . . . . . . . . . . 602md_schema . . . . . . . . . . . . . 602scrape_timeout . . . . . . . . . . . . 602startup_timeout . . . . . . . . . . . 602target_debug . . . . . . . . . . . . 602target_initial_codepage . . . . . . . . . 603ts_password . . . . . . . . . . . . . 603ts_product . . . . . . . . . . . . . 603

Access Server system parameters . . . . . . . 603accessserver_udp_ listenport . . . . . . . 603agent_assert . . . . . . . . . . . . . 604agent_debug. . . . . . . . . . . . . 604agent_jdbcdb2_driver. . . . . . . . . . 604agent_jdbcdb2_driver_net . . . . . . . . 604agent_jdbcpb_driver . . . . . . . . . . 604agent_jdbcpb_driver_net. . . . . . . . . 604agent_max_connections_num . . . . . . . 605agent_message_version . . . . . . . . . 605agent_msg_resources_file . . . . . . . . 605agent_src_engine_address . . . . . . . . 605agent_src_engine_port . . . . . . . . . 605agent_src_engine_socket_tmout . . . . . . 605agent_trace_in_message . . . . . . . . . 605agent_trace_out_message . . . . . . . . 606agent_udp_ listenport . . . . . . . . . 606

Cascading replication system parameters . . . . 606cascade_replication . . . . . . . . . . 606

Commitment control system parameters . . . . 607commit_group_size . . . . . . . . . . 607commit_ interval . . . . . . . . . . . 608refresh_commit_ block_size. . . . . . . . 609scraper_trans_ num_limit . . . . . . . . 609source_default_ commit_level . . . . . . . 609target_default_commit_level . . . . . . . 610

Database translation log system parameters . . . 610report_position_interval . . . . . . . . . 611

Fastload system parameters . . . . . . . . 611refresh_del_fastload_file . . . . . . . . . 611dofastload . . . . . . . . . . . . . 612fastload_backup_path . . . . . . . . . 613fastload_in_whole . . . . . . . . . . . 613fastload_path . . . . . . . . . . . . 613make_fastload_log_file . . . . . . . . . 614max_fastload_ file_size . . . . . . . . . 614

Latency system parameters . . . . . . . . . 615monitor_sample_interval . . . . . . . . 615

Lock detection system parameters . . . . . . 615dm_lock_detection. . . . . . . . . . . 616dm_lock_timeout . . . . . . . . . . . 616

Multibyte character set system parameters. . . . 617unicode_handling . . . . . . . . . . . 617

Notification system parameters . . . . . . . 618dm_status_interval . . . . . . . . . . 618heartbeat_timeout . . . . . . . . . . . 619

Replication system parameters . . . . . . . 619dobatch . . . . . . . . . . . . . . 619source_default_active_refresh . . . . . . . 620target_mirror_number_of_errors_before_abort 620target_print_refresh_details . . . . . . . . 620

Contents xiii

target_refresh_number_of_errors_before_abort 621Tracing system parameters . . . . . . . . . 621

message_handler_trace_level . . . . . . . 621message_trace_level . . . . . . . . . . 621target_trace_logical_messages . . . . . . . 621target_trace_physical_messages . . . . . . 622trace_level . . . . . . . . . . . . . 622trace_on . . . . . . . . . . . . . . 622

Teradata TPump system parameters . . . . . . 622tpump_arc_data_files . . . . . . . . . . 622tpump_files_root_folder . . . . . . . . . 623tpump_logging . . . . . . . . . . . . 624tpump_max_file_size . . . . . . . . . . 624tpump_script_params_file . . . . . . . . 625tpump_script_val_file. . . . . . . . . . 625tpump_ timeout . . . . . . . . . . . 626

System parameters for InfoSphereCDC for DB2 for LUW (version 6.1 andlater) . . . . . . . . . . . . . . . 627General product system parameters . . . . . . 627





Disk resource system parameters . . . . . . . 632mirror_global_disk_quota_mb . . . . . . . 632mirror_global_disk_quota_gb . . . . . . . 632staging_store_can_run_independently . . . . 633staging_store_disk_quota_gb . . . . . . . 633staging_store_disk_quota_mb . . . . . . . 634

Apply process system parameters . . . . . . 634convert_not_nullable_column . . . . . . . 634global_max_batch_size . . . . . . . . . 635mirror_end_on_error . . . . . . . . . . 635mirror_expected_errors_list . . . . . . . . 636refresh_end_on_error . . . . . . . . . . 636refresh_expected_errors_list . . . . . . . 637refresh_loader_drop_index . . . . . . . . 637refresh_with_referential_integrity . . . . . . 637userexit_max_lob_size_kb . . . . . . . . 638

System parameters for InfoSphereCDC for Teradata (version 6.2 andlater) . . . . . . . . . . . . . . . 639Notification system parameters . . . . . . . 639


Maximize throughput system parameters . . . . 641global_max_batch_size . . . . . . . . . 641mirror_interim_commit_threshold . . . . . 642

Encoding system parameters . . . . . . . . 642mbcs_support_is_on . . . . . . . . . . 642tpump_utf16_support_workaround_is_on . . . 643

Disk resource system parameters . . . . . . . 643mirror_global_disk_quota_mb . . . . . . . 643mirror_global_disk_quota_gb . . . . . . . 644

Apply process system parameters . . . . . . 644convert_not_nullable_column . . . . . . . 644mirror_end_on_error . . . . . . . . . . 645mirror_expected_errors_list . . . . . . . . 645mirror_td_apply_method . . . . . . . . 646refresh_end_on_error . . . . . . . . . . 646refresh_expected_errors_list . . . . . . . 647trim_char_to_varchar . . . . . . . . . . 647trim_varchar_to_varchar. . . . . . . . . 648userexit_max_lob_size_kb . . . . . . . . 648

Teradata TPump system parameters . . . . . . 648mirror_tpump_files_root_folder_path . . . . 648mirror_tpump_max_file_size_mb . . . . . . 649mirror_tpump_script_val_file_name . . . . . 650mirror_tpump_timeout_seconds . . . . . . 650mirror_tpump_update_on_key_column . . . . 651

Fastload system parameters . . . . . . . . 651refresh_allow_fast_loader . . . . . . . . 651refresh_max_fastload_file_size_mb . . . . . 652use_jdbc_for_refresh . . . . . . . . . . 652

System parameters for InfoSphereCDC Event Server . . . . . . . . . 653Notification system parameters . . . . . . . 653

events_max_retain . . . . . . . . . . . 653global_conversion_not_possible_warning . . . 653implicit_transformation_warning . . . . . . 654

Apply process system parameters . . . . . . 654convert_not_nullable_column . . . . . . . 655mirror_commit_on_transaction_boundary . . . 655mirror_end_on_error . . . . . . . . . . 656mirror_expected_errors_list . . . . . . . . 656mirror_interim_commit_threshold . . . . . 656refresh_end_on_error . . . . . . . . . . 657refresh_expected_errors_list . . . . . . . 657userexit_max_lob_size_kb . . . . . . . . 657


System parameters for InfoSphereCDC for InfoSphere DataStage . . . . 661Notification system parameters . . . . . . . 661

ds_output_timestamp_utc . . . . . . . . 661events_max_retain . . . . . . . . . . . 662global_conversion_not_possible_warning . . . 662global_shutdown_after_no_heartbeat_response_minutes662implicit_transformation_warning . . . . . . 663


Apply process system parameters . . . . . . 665convert_not_nullable_column . . . . . . . 665mirror_end_on_error . . . . . . . . . . 665

xiv InfoSphere Change Data Capture: Management Console Administration Guide

mirror_expected_errors_list . . . . . . . . 666mirror_interim_commit_threshold . . . . . 666refresh_end_on_error . . . . . . . . . . 666refresh_expected_errors_list . . . . . . . 667refresh_with_referential_integrity . . . . . . 667trim_char_to_varchar . . . . . . . . . . 667trim_varchar_to_varchar. . . . . . . . . 668

InfoSphere DataStage system parameters . . . . 668userexit_max_lob_size_kb . . . . . . . . 668

System parameters for InfoSphereCDC for Informix . . . . . . . . . . 669General product system parameters . . . . . . 669





Disk resource system parameters . . . . . . . 673mirror_global_disk_quota_mb . . . . . . . 673mirror_global_disk_quota_gb . . . . . . . 674staging_store_can_run_independently . . . . 675staging_store_disk_quota_gb . . . . . . . 675

Apply process system parameters . . . . . . 675convert_not_nullable_column . . . . . . . 676global_max_batch_size . . . . . . . . . 676mirror_end_on_error . . . . . . . . . . 677mirror_expected_errors_list . . . . . . . . 677refresh_end_on_error . . . . . . . . . . 677refresh_expected_errors_list . . . . . . . 678refresh_with_referential_integrity . . . . . . 678trim_char_to_varchar . . . . . . . . . . 678trim_varchar_to_varchar. . . . . . . . . 678userexit_max_lob_size_kb . . . . . . . . 679

System parameters for InfoSphereCDC for Netezza databases . . . . . 681Notification system parameters . . . . . . . 681


Maximize throughput system parameters . . . . 683acceptable_latency_in_minutes . . . . . . 683

Disk resource system parameters . . . . . . . 683mirror_global_disk_quota_gb . . . . . . . 684

Apply process system parameters . . . . . . 684convert_not_nullable_column . . . . . . . 684userexit_max_lob_size_kb . . . . . . . . 685

Commands for Access Server . . . . 687Datastore commands . . . . . . . . . . . 687

dmchangeconnectionpasswordChanging theconnection parameters to a datastore . . . . 687dmcreatedatastoreAdding a datastore . . . 688dmdeleteconnectionDeleting a datastoreconnection . . . . . . . . . . . . . 689dmdeletedatastoreDeleting a datastore . . . 690dmlistuserdatastoresGenerating a report list ofdatastores assigned to a user . . . . . . . 690

User account commands. . . . . . . . . . 691dmchangeuserpasswordChanging thepassword on a user account . . . . . . . 691dmcreateuserAdding a user account . . . . 692dmdeleteuserDeleting a user . . . . . . 694dmdisableuserDisabling a user account . . . 694dmenableuserEnabling a user . . . . . . 695dmlistusersListing user accounts . . . . . 695dmresetuserResetting a user account . . . . 697dmunlockuserUnlocking a user account . . . 698

Other commands . . . . . . . . . . . . 698dmaccessserverStart Access Server . . . . 698dmaddconnectionAdding a datastoreconnection to a user . . . . . . . . . . 699dmlistdatastoreusersGenerating a report list ofusers assigned to a datastore . . . . . . . 700dmshowversionShow InfoSphere CDC AccessServer version . . . . . . . . . . . . 700onlineOpen command environment . . . . 701

Using Support Assistant andcontacting IBM Support . . . . . . . 703Preparing to collect diagnostic data and tracinginformation . . . . . . . . . . . . . . 703

To enable tracing for Management Console andAccess Server . . . . . . . . . . . . 704To enable tracing for datastores for InfoSphereCDC version 6.3 and above (optional) . . . . 704To start the collection of diagnostic data andtracing information with Support Assistant . . 705

Contacting IBM Support. . . . . . . . . . 706

Glossary . . . . . . . . . . . . . 707

Notices . . . . . . . . . . . . . . 711Trademarks . . . . . . . . . . . . . . 713

Contents xv

xvi InfoSphere Change Data Capture: Management Console Administration Guide

Overview of InfoSphere CDCIBM InfoSphere Change Data Capture (InfoSphere CDC) is a replication solutionthat captures database changes as they happen and delivers them to targetdatabases, message queues, or an ETL solution such as InfoSphere DataStage

based on table mappings configured in the InfoSphere CDC Management ConsoleGUI application.

InfoSphere CDC provides low impact capture and fast delivery of data changes forkey information management initiatives including dynamic data warehousing,master data management, application consolidations or migrations, operational BI,and enabling SOA projects. InfoSphere CDC also helps reduce processingoverheads and network traffic by only sending the data that has changed.Replication can be carried out continuously or periodically. When data istransferred from a source server, it can be remapped or transformed in the targetenvironment.

The following diagram illustrates the key components of InfoSphere CDC.

The key components of the InfoSphere CDC architecture are described below:v Access ServerControls all of the non-command line access to the replicationenvironment. When you log in to Management Console, you are connecting toAccess Server. Access Server can be closed on the client workstation withoutaffecting active data replication activities between source and target servers.

v Admin APIOperates as an optional Java-based programming interface thatyou can use to script operational configurations or interactions.

v Apply agentActs as the agent on the target that processes changes as sent bythe source.

v Command line interfaceAllows you to administer datastores and useraccounts, as well as to perform administration scripting, independent ofManagement Console.

v Communication Layer (TCP/IP)Acts as the dedicated network connectionbetween the Source and the Target.

Copyright IBM Corp. 2008, 2011 1

v Source and Target DatastoreRepresents the data files and InfoSphere CDCinstances required for data replication. Each datastore represents a database towhich you want to connect and acts as a container for your tables. Tables madeavailable for replication are contained in a datastore.

v Management ConsoleAllows you to configure, monitor and managereplication on various servers, specify replication parameters, and initiate refreshand mirroring operations from a client workstation. Management Console alsoallows you to monitor replication operations, latency, event messages, and otherstatistics supported by the source or target datastore. The monitor inManagement Console is intended for time-critical working environments thatrequire continuous analysis of data movement. After you have set up replication,Management Console can be closed on the client workstation without affectingactive data replication activities between source and target servers.

v MetadataRepresents the information about the relevant tables, mappings,subscriptions, notifications, events, and other particulars of a data replicationinstance that you set up.

v MirrorPerforms the replication of changes to the target table or accumulationof source table changes used to replicate changes to the target table at a latertime. If you have implemented bidirectional replication in your environment,mirroring can occur to and from both the source and target tables.

v RefreshPerforms the initial synchronization of the tables from the sourcedatabase to the target. This is read by the Refresh reader.

v Replication EngineServes to send and receive data. The process that sendsreplicated data is the Source Capture Engine and the process that receivesreplicated data is the Target Engine. An InfoSphere CDC instance can operate as asource capture engine and a target engine simultaneously.

v Single ScrapeActs as a source-only log reader and a log parser component. Itchecks and analyzes the source database logs for all of the subscriptions on theselected datastore.

v Source transformation engineProcesses row filtering, critical columns, columnfiltering, encoding conversions, and other data to propagate to the targetdatastore engine.

v Source database logsMaintained by the source database for its own recoverypurposes. The InfoSphere CDC log reader inspects these in the mirroringprocess, but filters out the tables that are not in scope for replication.

v Target transformation engineProcesses data and value translations, encodingconversions, user exits, conflict detections, and other data on the target datastoreengine.

There are two types of target-only destinations for replication that are notdatabases:v JMS MessagesActs as a JMS message destination (queue or topic) forrow-level operations that are created as XML documents.

v InfoSphere DataStageProcesses changes delivered from InfoSphere CDC thatcan be used by InfoSphere DataStage jobs.

For more information on how to install Management Console and Access Server,see Access Server and Management Console - Installation Guide. For information onhow to install your source and target replication engines, see the end-userdocumentation for your replication engine platform.

See also:Understanding the InfoSphere CDC workflow on page 3

2 InfoSphere Change Data Capture: Management Console Administration Guide

Understanding the InfoSphere CDC workflowThis list and the following sections detail the workflow for setting up andconfiguring replication in InfoSphere CDC:v Installing Access Serverv Installing Management Consolev Adding and configuring datastoresv Adding and configuring subscriptionsv Mapping and customizing tables If you are using InfoSphere CDC Event Server, creating and customizing XML

messages for table mappings. If you are using InfoSphere DataStage, generating .dsx definition files and

custom Java classes for InfoSphere DataStage jobs.v Starting and ending replication

Overview of InfoSphere CDC 3

Whats newThe following table lists the major feature changes to Management Console version6.5.2:

Item Description For more information, see:

Support forNetezza databases

Management Console enables youto connect to a configured targetNetezza datastore and replicatedata from a supported InfoSphereCDC source datastore.

A large number of features and enhancements have been added to ManagementConsole version 6.5.1. The following table lists the major feature changes:

Item Description For more information, see:

Ending replication Four choices for stoppingreplication

Starting and ending replicationon page 355

Replicatingmultibytecharacter set(MBCS) data

v Auto-encoding modev Translation and Encoding tabsin the Table Mappings view

Replicating multibyte (MBCS)and double-byte (DBCS) characterdata on page 187

Table mappingsfor InfoSphereCDC forInfoSphereDataStage

Two options: Flat File or DirectConnect

Mapping using InfoSphereDataStage on page 117

Row subsets onrefresh

Filter a refresh through the use ofan SQL WHERE clause to onlyinclude rows within a specifiedrange.

Flagging a source table forrefresh on page 343

Monitoring Changes to the Monitoringperspective, including a new view:Performance.

Subscriptions view (Monitoringperspective) on page 387

Performance view (Monitoringperspective) on page 398

UpgradingInfoSphere CDC

Upgrade Transformation Server

for Microsoft SQL Server orTransformation Server for Oracleto InfoSphere CDC version 6.5

Upgrading existingTransformation Serversubscriptions to InfoSphere CDCon page 64

Reverting to TransformationServer on page 67

DDL Replication Replicate the structural changes totables

Replicating Data DefinitionLanguage (DDL) changes onpage 137


Before you start Management ConsoleBefore you can start and log in to Management Console, make sure that you haveAccess Server installed and running.

For more information, see the Management Console and Access Server - InstallationGuide.

Important: As of version 6.3.1 fix pack 1, both Management Console and AccessServer must be at the same level. Management Console can only connect to asimilar version of Access Server.

InfoSphere CDC version 6.5 introduces a number of enhancements and changes.While InfoSphere CDC version 6.5 is backward-compatible, you must upgradeyour existing InfoSphere CDC agent datastores for their appropriate databaseplatforms to version 6.5 to access the full range of functionality introduced withversion 6.5.

In this section, you will learn:Configuring firewall settings for outbound (static) portsLogging in to Management Console by connecting to Access Server on page10

Related concepts

Setting up user accounts on page 25Commands for Access Server on page 687

Configuring firewall settings for outbound (static) portsIf your network uses a firewall or other security mechanism that requires staticports for communication, then you must specify the ports that other computers canuse to communicate with Access Server services.

Note: In addition to a network firewall, you might have personal firewall softwareinstalled and enabled on client machines. This firewall may cause a problem whenconnecting to Management Console from Access Server.

To calculate the number of Access Server ports to open, use this formula: numberof ports to open = 2 * (number of users + (number of users * number ofdatastores) + number of datastores) where a datastore refers to an InfoSphereCDC installation.


The following figure highlights the ports you can configure for ManagementConsole and Access Server components. You can configure static port numbers forall or some of these ports, depending on your network requirements.

The labels in the figure above correspond to the following groups of ports:v 1Communication from Management Console to the Access Server service. Youspecify this port when you install Access Server and when you log in toManagement Console. The default port is 10101 and you can set this value inManagement Console.

v 2Communication from Access Server back to Management Console formonitor updates.

v 3Communication from Management Console to the Access Server service, perdatastore (that is, per InfoSphere CDC installation). This requires two ports foreach InfoSphere CDC installation.

v 4Communication from the Access Server service to the datastore, listenprocess. This is established for each Management Console connection.

v 5Communication from the Access Server service to the datastore, monitorprocess. This is a shared connection between all Management Consoleconnections on the same datastore. This requires two ports for each datastore.

You must also configure your routers and firewalls to allow communicationthrough the configured ports. For more information, contact your networkadministrator.

Management Console requires:v One input and output port to the Access Server.v One input port from the Access Serverv One input and output port per datastore (regardless of whether you connect tothe datastore)

The Access Server requires:v One input and output port per datastore, per installation of ManagementConsole

v Two input and output ports, per datastore

Additionally, you can have more than one datastore, or more than one installationof Management Console; for example:


v One installation of Management Console and one datastorev One installation of Management Console and two datastoresv Two installations of Management Console and one datastorev Two installations of Management Console and two datastores

Example: calculating ports required

To help determine the number of ports required, take a scenario where there areten concurrent users and three datastores.

To calculate the number of Access Server ports to open, use this formula: numberof ports to open = 2 * (number of users + (number of users * number ofdatastores) + number of datastores) where a datastore refers to an InfoSphereCDC installation.

Using the above scenario of ten concurrent users and three datastores, the numberof Access Server ports required is 86. Here is the breakdown of the calculation,following the order in the figure above illustrating the ports you can configure forManagement Console and Access Server components:v Number of concurrent users that will log into Access Server = 10v One port per user to connect to and deliver unsolicited message = 10v Number of possible concurrent connections from Management Console toconnect to datastores); that is, 10 users * 3 datastores = 10 * 3

v Number of possible concurrent connections to datastore, listen process; that is,10 users * 3 datastores)

v Two ports required to connect to each datastore, monitor process = 2 * 3Therefore, 10 + 10 + (10 *3) + (10 *3) + (2 *3) = 86

To calculate the number of ports to open Management Console, use this formula:number of ports to open = 2 + number of datastores

Using the above scenario of ten concurrent users and three datastores, the numberof ports required is 5 for each Management Console. This is the breakdown of thecalculation for each Management Console:v Connection to Access Server = 1v Connection for unsolicited updates from Access Server = 1v One port for each connection to a datastore, listen process = 1 * 3Therefore, 1 + 1 + (1 *3) = 5

See also:To configure static ports

To configure static ports1. Open the dmaccessserver.vmargs file in a text editor. This file is located in the

conf directory in your Access Server installation directory.2. Replace the entry in this file with the following text:

-jar lib/server.jar local_port:local_port_count:

where:

Before you start Management Console 9

v is the first port in the range that you want the Access Serverservice to use when sending messages or establishing connections.

v is the number of ports you want to reserve forthis use.To calculate the number of Access Server ports to open, use this formula:number of ports to open = 2 * (number of users + (number of users *number of datastores) + number of datastores) where a datastore refers toan InfoSphere CDC installation.

v is the port number that Access Server listenson and is set during the Access Server installation. You do not have tospecify a value here if you are using the default port number of 10101.

For example, if the number of available ports for communication is 500 andyou want Access Server to listen for connections on port 10101, then the entrywould be as follows:-jar lib/server.jar local_port:10102 local_port_count:500 10101

This enables Access Server to listen for connections on port 10101 and restrictsit to using ports in the range of 10102 to 10601.These changes will take effect after you restart the Access Server service.

Logging in to Management Console by connecting to Access ServerAfter you start Management Console, you will be prompted to log in to AccessServer. Access Server is the server application that controls access to yourreplication environment.

System Administrators with user and datastore account management rights cancreate additional user accounts in the Access Manager perspective.

You can have multiple instances of Access Server in your working environment,but you can only connect to one server at a time.

See also:To log in to Management Consoleby connecting to Access ServerTo change your log in password on page 11

To log in to Management Consoleby connecting to AccessServer

1. Ensure that your InfoSphere CDC system administrator has added you as auser to an existing datastore in Management Console. Your systemadministrator can set your user name and password in the Access Managerperspective.

2. Navigate to the programs menu and start Management Console.3. Enter your user name in the User Name box.4. Enter your password in the Password box. The password is case-sensitive.5. ,Enter or select the host name (system name) or full IP address of the

workstation running Access Server in the Server Name list.6. Enter the TCP/IP port number in the Port Number box.

The port number that appears by default is specified in the Edit > Preferencesmenu.


Related tasks

To add a user on page 26

To change your log in password1. Click File > Access Server > Change Password.2. Enter the current password in the Current Password box.3. Enter and confirm the new password in the New Password and Confirm

Password boxes.Your password must conform to the password policy defined by the AccessServer system administrator.

Before you start Management Console 11

Understanding the Management Console interfaceManagement Console is composed of a number of windows or tabs that arereferred to as perspectives and views. After logging in to Management Console youwill see three perspectives: the Configuration perspective, the Monitoringperspective, and the Access Manager perspective, from which you can access anumber of different views depending on your role and access level:v Configuration perspectiveContains the Subscriptions view, the Datastoresview, and the Table Mappings view. These views enable you to configure yourreplication environment by connecting to your datastores, creating subscriptions,mapping your tables, and configuring how to transform your data. Within thestatus bar for the perspective, you can view a summary of your configuration: The user name used to log onto Management Console. The number of datastores connected and warning information for any

datastores that could not be connected. The number of subscriptions loaded. The number of tables loaded for the selected subscription.

v Monitoring perspectiveContains the Subscriptions view and the Performanceview. These views that allow you to initiate replication and monitor yourreplication activity. At the bottom of this perspective, you can view a summaryof your monitoring environment: The user name used to log onto Management Console. The number of datastores connected and warning information for any

datastores that could not be connected. The number of subscriptions loaded.

v Access Manager perspectiveContains the Datastore Management view, theUser Management view, and the Connection Management view. These viewsenable you to create and manage datastores, user accounts, and accessconnections. At the bottom of this perspective, you can view a summary of yourAccess Manager environment: The user name used to log onto Management Console. The number of datastores connected and warning information for any

datastores that could not be connected.

Preferences allow you to control the behavior of Management Console. Forexample, you can choose whether you want to connect to datastores automaticallyafter logging in to Management Console.

The information, features and options displayed in the Management Consoleinterface is determined by several factors:v your role as a userv the datastores to which you have accessv the type of the datastorev the version of the datastore

Only the relevant information will be displayed in the interface and only theeligible features and options will be available for use.


Related concepts

Managing user accounts on page 25Setting up datastores on page 35Setting up and configuring subscriptions on page 49Monitoring subscriptions on page 387

14 InfoSphere Change Data Capture: Management

cdc Admin Guide

Documents

Transcript of cdc Admin Guide