InfoSphere CDC for Sybase databases (Version 10.2) 4About InfoSphere CDC 7Capturing change data with single scrape 10System requirements for InfoSphere CDC for Sybase databases 11Hardware and software requirements 12Running in a virtualization environment 13Disk space requirements 14RAM requirements 16Port requirements 17Before you install InfoSphere CDC for Sybase databases 18Required database, user accounts, and schemas 19Setting the LANG environment variable (UNIX) 20Database and backup restrictions 21Database restrictions 22Backup restrictions 23Direct IO restrictions 24Calculating database connections required by InfoSphere CDC for Sybase databases 25Refresh performance considerations 27Database partition changes 28Enabling the creation of a partition table 29Assessing disk space and memory requirements 30Understanding the importance of an appropriately configured disk subsystem 32Understanding the InfoSphere CDC memory footprint 33Sizing considerations for the staging store 34Creating queues in JMS providers 36Installing or upgrading InfoSphere CDC for Sybase databases 37Installing InfoSphere CDC for Sybase databases using an interactive installation 38To install InfoSphere CDC for Sybase databases (Windows) 39To install InfoSphere CDC for Sybase databases (UNIX and Linux) 40To override the locale for the installation (UNIX and Linux) 41Installing InfoSphere CDC for Sybase databases using a silent installation 42To perform a silent installation of InfoSphere CDC for Sybase databases (UNIX and Linux) 43Upgrading InfoSphere CDC for Sybase databases 44To upgrade InfoSphere CDC for Sybase databases (Windows) 46To upgrade InfoSphere CDC for Sybase databases (UNIX and Linux) 47Configuring InfoSphere CDC for Sybase databases (Windows) 49Configuring InfoSphere CDC for Sybase databases instances (Windows) 50To add a new instance of InfoSphere CDC for Sybase databases (Windows) 51To edit an instance of InfoSphere CDC for Sybase databases (Windows) 57To delete an instance of InfoSphere CDC for Sybase databases (Windows) 58Configuring InfoSphere CDC for Sybase databases (UNIX and Linux) 59Configuring InfoSphere CDC for Sybase databases instances (UNIX and Linux) 60To add a new instance of InfoSphere CDC for Sybase databases (UNIX and Linux) 61To edit an instance of InfoSphere CDC for Sybase databases (UNIX and Linux) 64To delete an instance of InfoSphere CDC for Sybase databases (UNIX and Linux) 65Configuring InfoSphere CDC for Sybase databases for OS (operating system) clustering (UNIXand Linux) 66

Performing a forced or manual failover of InfoSphere CDC for Sybase databases 67Preparing for a failover of InfoSphere CDC for Sybase databases 68After you install and configure InfoSphere CDC for Sybase databases 69Starting InfoSphere CDC for Sybase databases 70To start InfoSphere CDC for Sybase databases (Windows) 71To start InfoSphere CDC for Sybase databases (UNIX and Linux) 72Stopping InfoSphere CDC for Sybase databases 73To stop InfoSphere CDC for Sybase databases (Windows) 74To stop InfoSphere CDC for Sybase databases (UNIX and Linux) 75Maintaining active TCP connections in a network environment 76To maintain active TCP connections 77Enabling SQL statements in Management Console 78To enable SQL statements in Management Console 79InfoSphere CDC for Sybase databases metadata tables 80Data types supported by InfoSphere CDC for Sybase databases 81System parameters for InfoSphere CDC for Sybase databases 82Commands for InfoSphere CDC for Sybase databases 83Using the InfoSphere CDC for Sybase databases commands 84Setting the TSINSTANCE environment variable 85Continuous Capture commands 86dmenablecontinuouscapture - Enable Continuous Capture 87dmdisablecontinuouscapture - Disable Continuous Capture 88Controlling replication commands 89dmendreplication - End replication 90dmrefresh - Refresh subscription 94dmstartmirror - Start mirroring 96Database transaction log commands 99dmdecodebookmark - Display verbose information bookmark 100dmsetbookmark - Set bookmark 101dmshowbookmark - Display bookmark information 103dmshowlogdependency - Show Log Dependency 105Exporting and importing configuration commands 107dmexportconfiguration - Export InfoSphere CDC Configuration 108dmimportconfiguration - Import InfoSphere CDC Configuration 109Managing tables for replication commands 110dmdescribe - Describe source tables 111dmflagforrefresh - Flag for Refresh 112dmmarktablecapturepoint - Mark a table capture point on a source table 113dmpark - Park table 115dmreaddtable - Update source table definition 117dmreassigntable - Update target table definition 118dmsetreplicationmethod - Set replication method 119Monitoring replication commands 121dmclearevents - Clear events 122dmgetsubscriptionstatus - Get subscription status 123dmshowevents - Display InfoSphere CDC events 124Single scrape and staging store commands 126

dmclearstagingstore - Remove cached operations from the staging store 127dmgetstagingstorestatus - Retrieve Staging Store status 128Other commands 129dmbackupmd - Back up metadata 130dmconfigurets - Configure InfoSphere CDC 131dmflusharchivehistory - Flush archive log history 132dmmdconsole 133dmmdcommander 134dmset - Set InfoSphere CDC system parameter 135dmshowversion - Show InfoSphere CDC version 136dmshutdown - Shut down InfoSphere CDC 137dmsupportinfo - Collect IBM Support information 140dmterminate - Terminate InfoSphere CDC processes 142dmts32 - Start InfoSphere CDC 143dmts64 - Start InfoSphere CDC 144User exits for InfoSphere CDC for Sybase databases 145Stored procedure user exits for table and row level operations 146Defining a stored procedure user exit 147Stored procedure user exit database connections 148Retrieving data with a stored procedure user exit 149Retrieving system values using the s$ prefix 150Retrieving journal control fields using the j$ prefix 153Retrieving data values using b$, a$, k$, and d$ prefixes 156Example of a stored procedure user exit 159Sample Java class user exits for InfoSphere CDC for Sybase databases 161To compile the sample Java class user exits (Windows) 162To compile the sample Java class user exits (UNIX and Linux) 163InfoSphere CDC API reference - Javadocs 164Conflict resolution audit table 165Structure of the conflict resolution audit table 166Row image format 169Truncated images 170Unaudited data types 171Uninstalling InfoSphere CDC for Sybase databases 172To uninstall InfoSphere CDC for Sybase databases (Windows) 173To uninstall InfoSphere CDC for Sybase databases (UNIX and Linux) 174Troubleshooting 175Using the IBM Support Assistant (ISA DC) 176To use ISA DC to collect data for a product problem (command line) 177To use ISA DC to collect data for a product problem (GUI) 180To use ISA DC to collect data for a question or an enhancement request (command line) 182To use ISA DC to collect data for a question or an enhancement request (GUI) 184Locating log files 185Troubleshooting and contacting IBM Support 186

-

-

-

-

-

IBM InfoSphere Change Data Capture, Version 10.2 About InfoSphere CDC IBM®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 CDCManagement ConsoleGUI application. InfoSphere CDC provides low impact capture and fast delivery of data changes forkey information management initiatives including dynamic data warehousing, masterdata management, application consolidations or migrations, operational BI, andenabling SOA projects. InfoSphere CDC also helps reduce processing overheadsand network traffic by only sending the data that has changed. Replication can becarried out continuously or periodically. When data is transferred from a sourceserver, it can be remapped or transformed in the target environment. The following diagram illustrates the key components of InfoSphere CDC.

The key components of the InfoSphere CDC architecture are described below:

Access Server—Controls 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.Admin API—Operates as an optional Java™-based programming interface thatyou can use to script operational configurations or interactions.Apply agent—Acts as the agent on the target that processes changes as sent bythe source.Command line interface—Allows you to administer datastores and useraccounts, as well as to perform administration scripting, independent ofManagement Console.Communication Layer (TCP/IP)—Acts as the dedicated network connectionbetween the Source and the Target.

4

-

-

-

-

-

-

-

-

-

-

-

-

Source and Target Datastore—Represents 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. Management Console—Allows you to configure, monitor and manage replicationon various servers, specify replication parameters, and initiate refresh andmirroring operations from a client workstation. Management Console also allowsyou to monitor replication operations, latency, event messages, and other statisticssupported by the source or target datastore. The monitor in Management Consoleis intended for time-critical working environments that require continuous analysisof data movement. After you have set up replication, Management Console can beclosed on the client workstation without affecting active data replication activitiesbetween source and target servers.Metadata—Represents the information about the relevant tables, mappings,subscriptions, notifications, events, and other particulars of a data replicationinstance that you set up.Mirror—Performs the replication of changes to the target table or accumulation ofsource table changes used to replicate changes to the target table at a later time. Ifyou have implemented bidirectional replication in your environment, mirroring canoccur to and from both the source and target tables.Refresh—Performs the initial synchronization of the tables from the sourcedatabase to the target. This is read by the Refresh reader.Replication Engine—Serves 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 asa source capture engine and a target engine simultaneously.Single Scrape—Acts 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. Not all InfoSphere CDC engines use Single Scrape. ForInfoSphere CDC for DB2® for i, there is a Scraper job (that acts as a log reader)and a Mirror job that performs the function of mirroring (see Mirror above). Source transformation engine—Processes row filtering, critical columns, columnfiltering, encoding conversions, and other data to propagate to the target datastoreengine.Source database logs—Maintained by the source database for its own recoverypurposes. The InfoSphere CDC log reader inspects these in the mirroring process,but filters out the tables that are not in scope for replication. Target transformation engine—Processes 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:

JMS Messages—Acts as a JMS message destination (queue or topic) for row-level operations that are created as XML documents.InfoSphere DataStage—Processes changes delivered from InfoSphere CDC thatcan be used by InfoSphere DataStage jobs.

In this section, you will learn:

5

-

Capturing change data with single scrape Related information: Supported sources and targets

6

-

-

-

-

-

IBM InfoSphere Change Data Capture, Version 10.2 About InfoSphere CDC IBM®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 CDCManagement ConsoleGUI application. InfoSphere CDC provides low impact capture and fast delivery of data changes forkey information management initiatives including dynamic data warehousing, masterdata management, application consolidations or migrations, operational BI, andenabling SOA projects. InfoSphere CDC also helps reduce processing overheadsand network traffic by only sending the data that has changed. Replication can becarried out continuously or periodically. When data is transferred from a sourceserver, it can be remapped or transformed in the target environment. The following diagram illustrates the key components of InfoSphere CDC.

The key components of the InfoSphere CDC architecture are described below:

Access Server—Controls 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.Admin API—Operates as an optional Java™-based programming interface thatyou can use to script operational configurations or interactions.Apply agent—Acts as the agent on the target that processes changes as sent bythe source.Command line interface—Allows you to administer datastores and useraccounts, as well as to perform administration scripting, independent ofManagement Console.Communication Layer (TCP/IP)—Acts as the dedicated network connectionbetween the Source and the Target.

7

-

-

-

-

-

-

-

-

-

-

-

-

Source and Target Datastore—Represents 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. Management Console—Allows you to configure, monitor and manage replicationon various servers, specify replication parameters, and initiate refresh andmirroring operations from a client workstation. Management Console also allowsyou to monitor replication operations, latency, event messages, and other statisticssupported by the source or target datastore. The monitor in Management Consoleis intended for time-critical working environments that require continuous analysisof data movement. After you have set up replication, Management Console can beclosed on the client workstation without affecting active data replication activitiesbetween source and target servers.Metadata—Represents the information about the relevant tables, mappings,subscriptions, notifications, events, and other particulars of a data replicationinstance that you set up.Mirror—Performs the replication of changes to the target table or accumulation ofsource table changes used to replicate changes to the target table at a later time. Ifyou have implemented bidirectional replication in your environment, mirroring canoccur to and from both the source and target tables.Refresh—Performs the initial synchronization of the tables from the sourcedatabase to the target. This is read by the Refresh reader.Replication Engine—Serves 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 asa source capture engine and a target engine simultaneously.Single Scrape—Acts 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. Not all InfoSphere CDC engines use Single Scrape. ForInfoSphere CDC for DB2® for i, there is a Scraper job (that acts as a log reader)and a Mirror job that performs the function of mirroring (see Mirror above). Source transformation engine—Processes row filtering, critical columns, columnfiltering, encoding conversions, and other data to propagate to the target datastoreengine.Source database logs—Maintained by the source database for its own recoverypurposes. The InfoSphere CDC log reader inspects these in the mirroring process,but filters out the tables that are not in scope for replication. Target transformation engine—Processes 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:

JMS Messages—Acts as a JMS message destination (queue or topic) for row-level operations that are created as XML documents.InfoSphere DataStage—Processes changes delivered from InfoSphere CDC thatcan be used by InfoSphere DataStage jobs.

In this section, you will learn:

8

-

Capturing change data with single scrape Related information: Supported sources and targets

9

IBM InfoSphere Change Data Capture, Version 10.2 Capturing change data with single scrape Single scrape is a source-only component of InfoSphere® CDC that allows multiplesubscriptions in an instance to share the same log reader and log parser thread.With single scrape, InfoSphere CDC only reads and parses the source databasetransaction log once to capture changes for all tables being mirrored for theinstance. Single scrape improves performance by reducing the footprint on your sourcesystem since it only requires a single log reader thread and a single log parserthread to service multiple subscriptions. This reduces disk I/O and decreases CPUutilization by InfoSphere CDC processes. Change data and the staging store After the InfoSphere CDC log reader captures the change data from the databaselogs and the data is parsed by the InfoSphere CDC log parser, change data isplaced in the staging store. Each subscription retrieves the changes for mirroringtables from the staging store whenever possible. The data in scope for a givensubscription is kept in the staging store until it is sent to the target database. Afterthe data is sent to the target it is removed from the staging store. To improveperformance when subscriptions are mirroring, InfoSphere CDC will keep thestaging store data in memory whenever possible. Related concepts: About InfoSphere CDC

10

-----

IBM InfoSphere Change Data Capture, Version 10.2 System requirements for InfoSphere CDC forSybase databases Before you install InfoSphere® CDC, ensure that the system you choose meets thenecessary operating system, hardware, software, communications, disk, andmemory requirements. In this section, you will learn:

Hardware and software requirements Running in a virtualization environment Disk space requirements RAM requirements Port requirements

11

IBM InfoSphere Change Data Capture, Version 10.2 Hardware and software requirements Click the following links to view hardware and software requirements forInfoSphere® CDC, Management Console, and Access Server: Linux, UNIX, Windows and System i® replication engines: https://ibm.biz/BdxyzE Mainframe replication engine: https://ibm.biz/Bdxyd5 Related concepts: Disk space requirements RAM requirements Port requirements

12

IBM InfoSphere Change Data Capture, Version 10.2 Running in a virtualization environment The InfoSphere® CDC products adhere to the Virtualization Policy for IBM®Software and can be run in any virtualization environment for only the supportedoperating systems and versions listed specifically within IBMInfoSphere DataReplication System Requirements. For more information on the policy, see http://www-01.ibm.com/software/support/virtualization_policy.html

13

--

---

IBM InfoSphere Change Data Capture, Version 10.2 Disk space requirements

InfoSphere CDC may require additional disk space in the following situations:

You are running large batch transactions in the database on your source system.You are configuring multiple subscriptions and one of your subscriptions is latent.In this type of scenario, InfoSphere CDC on your source system may persisttransaction queues to disk if RAM is not available.You are replicating large LOB data types.You are replicating "wide" tables that have hundreds of columns.You are performing regular back ups of your metadata with the dmbackupmdcommand-line utility.

Related concepts: Hardware and software requirements RAM requirements Port requirements Configuring InfoSphere CDC for Sybase databases (Windows)

Disk spaceInfoSphere® CDC source system:100 GB—Default value for theStaging Store Disk Quota for each instance of InfoSphere CDC.The minimum is 1 GB. Although the minimum is 1 GB, prepare formore disk space since there is a staging store on the source. Usethe InfoSphere CDC configuration tool to configure disk space forthis quota.5 GB—For installation files, data queues, and logfiles.Global disk quota—Disk space is required on your sourcesystem for this quota which is used to store in-scope change datathat has not been committed in your database. The amount of diskspace required is determined by your replication environment andthe workload of your source database. Use themirror_global_disk_quota_gb system parameter to configure theamount of disk space used by this quota.InfoSphere CDC target system:1 GB—The minimum amount ofdisk space allowed for the disk quota for each instance ofInfoSphere CDC. The minimum value for this quota is sufficient forall instances created on your target system. Use the InfoSphereCDC configuration tool to configure the disk space for this quota.5GB—For installation files, data queues, and log files.Global diskquota—Disk space is required on your target system for this quotawhich is used to store LOB data received from your InfoSphereCDC source system. The amount of disk space required isdetermined by your replication environment and the amount ofLOB data you are replicating. To improve performance, InfoSphereCDC will only persist LOB data to disk if RAM is not available onyour target system. Use the mirror_global_disk_quota_gb systemparameter to configure the amount of disk space used by thisquota.

14

Configuring InfoSphere CDC for Sybase databases (UNIX and Linux) Assessing disk space and memory requirements Sizing considerations for the staging store

15

-

--

IBM InfoSphere Change Data Capture, Version 10.2 RAM requirements

Although InfoSphere CDC memory requirements will fluctuate, you must work withyour system administrator to ensure the allocated memory for each instance of theproduct is available at all times. This may involve deployment planning since otherapplications with memory requirements may be installed on the same server withInfoSphere CDC. Using values other than the defaults or allocating more RAM thanis physically available on your server should only be undertaken after consideringthe impacts on product performance. InfoSphere CDC source deployments may require additional RAM in the followingscenarios:

You are replicating large LOB data types with your InfoSphere CDC sourcedeployment. These data types are sent to target while being retrieved from thesource database. The target waits until all LOBs (for each record) are receivedbefore applying a row. LOBs are stored in memory as long as there is adequateRAM, otherwise they are written to disk on the target.You are replicating "wide" tables with hundreds of columns.You are performing large batch transactions in your source database rather thanonline transaction processing (OLTP).

Related concepts: Hardware and software requirements Disk space requirements Port requirements Configuring InfoSphere CDC for Sybase databases (Windows) Configuring InfoSphere CDC for Sybase databases (UNIX and Linux)

RAMEach instance of InfoSphere® CDC requires memory for theJava™ Virtual Machine (JVM). The following default values formemory are assigned:1024 MB of RAM —Default value for each 64-bit instance ofInfoSphere CDC. 512 MB of RAM—Default value for each 32-bitinstance of InfoSphere CDC.Use the InfoSphere CDCconfiguration tool to configure the memory for each instance ofInfoSphere CDC.Note:InfoSphere CDC is predominantly a Java-based application.However, some portions of it are written in C. These portions ofInfoSphere CDC are not subject to the memory limits specified forthe JVM

16

IBM InfoSphere Change Data Capture, Version 10.2 Port requirements InfoSphere® CDC requires that you allocate a port for communication with clientworkstations running Management Console and other servers. The port must beaccessible through a firewall, although you do not require access to the Internet.

Related concepts: Maintaining active TCP connections in a network environment Hardware and software requirements Disk space requirements RAM requirements Configuring InfoSphere CDC for Sybase databases (Windows) Configuring InfoSphere CDC for Sybase databases (UNIX and Linux)

Protocol Default port PurposeTCP 10301 Accepts connections

from:ManagementConsoleOtherinstallations ofInfoSphere CDC as asource ofreplicationCommandline utilities

17

-----

--------

IBM InfoSphere Change Data Capture, Version 10.2 Before you install InfoSphere CDC for Sybasedatabases This section contains information on the tasks that you must complete beforeinstalling InfoSphere® CDC. This section assumes that you have met all of thehardware, software, database, and port requirements. You must complete all of thetasks below before installing InfoSphere CDC. In this section, you will learn:

Required database, user accounts, and schemas Setting the LANG environment variable (UNIX) Database and backup restrictions Direct IO restrictions Calculating database connections required by InfoSphere CDC for Sybasedatabases Refresh performance considerations Database partition changes Enabling the creation of a partition table Assessing disk space and memory requirements Understanding the importance of an appropriately configured disk subsystem Understanding the InfoSphere CDC memory footprint Sizing considerations for the staging store Creating queues in JMS providers

18

IBM InfoSphere Change Data Capture, Version 10.2 Required database, user accounts, and schemas Configuring a Sybase database When you configure InfoSphere® CDC for Sybase databases, you are prompted forthe name of the Sybase database you want InfoSphere CDC for Sybase databasesto connect to and replicate data. Before installing InfoSphere CDC for Sybasedatabases, ensure that this Sybase database exists and that you have created andset up a database user that has access to it. Setting up a Windows user account If you are installing InfoSphere CDC for Sybase databases on a Windows system,you must set up a new, or decide on an existing Windows account that you will useto install, configure, or upgrade InfoSphere CDC for Sybase databases. Setting up a UNIX user account When you are installing InfoSphere CDC on a UNIX machine, you must set up anew, or decide on an existing UNIX account that you will use to install, configure, orupgrade InfoSphere CDC. You can install InfoSphere CDC in the directory of yourchoice, however, it must be owned by the UNIX account. Setting up a Sybase account Create and set up a Sybase user and assign database owner (DBO) privileges tothis user. For InfoSphere CDC for Sybase databases to connect to your Sybasedatabase, you need to create a Sybase user account and assign systemadministrator (SA) or DBO privileges to this user. When you configure InfoSphereCDC for Sybase databases, you are prompted for the name of the Sybase databaseyou want InfoSphere CDC for Sybase databases to connect to and the user nameand password of the Sybase user that has access to this database. Configuring a Sybase schema Create a schema or choose an existing schema for your InfoSphere CDC forSybase databases metadata tables. You will have to specify this schema when youconfigure InfoSphere CDC for Sybase databases.

19

IBM InfoSphere Change Data Capture, Version 10.2 Setting the LANG environment variable (UNIX) The UNIX Language environment variable [LANG] needs to be properly set forInfoSphere® CDC to open files with MBCS characters. If your file names will contain a combination of English and Japanese characters, setthe LANG parameter to the following value: LANG=ja_JP.UTF-8

20

--

IBM InfoSphere Change Data Capture, Version 10.2 Database and backup restrictions Before you can start replicating data from a Sybase database, you must followcertain database and backup restrictions on each database you want InfoSphere®CDC for Sybase databases to connect to. These restrictions apply only if theSybase database is used as a replication source. The restrictions arise becauseInfoSphere CDC must read the backup (archive) logs in addition to reading theonline (live) log. See also:

Database restrictions Backup restrictions

21

-

-

-

IBM InfoSphere Change Data Capture, Version 10.2 Database restrictions When you use a Sybase database, consider the following restrictions.

Ensure the truncate log option on checkpoint is disabled—If the truncate logoption is enabled, the database log will be truncated automatically without backupevery time a database checkpoint is performed. Never run truncate_only operations—Running dump transaction with thetruncate_only option deletes inactive transactions from the log without creating abackup.Use only data or log segments, not a combination—If a database has mixedsegments, log backup is not allowed and only full database backups can beperformed.

22

-

-

-

IBM InfoSphere Change Data Capture, Version 10.2 Backup restrictions InfoSphere® CDC uses your existing Sybase backup strategy to maintaintransaction logs and backup archive files. You should consider the following backup restrictions:

All backup archive files must be in one directory—You will have to specify thearchive log directory when you configure InfoSphere CDC. Note: Do not place thearchive logs in the same directory as your online logs and do not place the archivelogs for more than one Sybase database in the same directory. Backup files must be locally accessible—Do not back up with striping tomultiple disks, to tapes, or to remote servers.Use only decompressed backup files—Do no execute compressed backups.Only decompressed backup files can be read.

Related concepts: Configuring InfoSphere CDC for Sybase databases (Windows) Configuring InfoSphere CDC for Sybase databases (UNIX and Linux)

23

IBM InfoSphere Change Data Capture, Version 10.2 Direct IO restrictions InfoSphere® CDC for Sybase databases does not support configurations of Sybaseusing direct I/O on Linux and zLinux. The use of dsync and raw partitions issupported.

24

-

----

-----

-

--

--

IBM InfoSphere Change Data Capture, Version 10.2 Calculating database connections required byInfoSphere CDC for Sybase databases As an administrator, you may find it necessary to calculate how many databaseconnections are needed before installing InfoSphere® CDC on either a source or atarget database. Calculating the upper bound (both permanent and temporary)database connections will help you plan your environment so that it canaccommodate InfoSphere CDC. Calculating connections required by InfoSphere CDC on asource database (22 + G)*I + 4*S + L + CWhere: Note: Enter 0 for any value that does not apply to your deployment of InfoSphereCDC.

G = number of Management Console GUI and CHCCLP scripting applications thatare connected to your instances of InfoSphere CDC.I = number of InfoSphere CDC instances.S = number of subscriptions in all of your InfoSphere CDC instances.L = number of subscriptions that contain LOB columns. C = number of InfoSphere CDC command line utilities that you plan to use.

Example: How to calculate required connections for asource database You want to set up InfoSphere CDC in the source environment as follows:

1 instance of Management Console.2InfoSphere CDC instances.3 subscriptions.1 subscription that uses LOB columns.You do not plan to use any InfoSphere CDC command line utilities.

The number of connections required on the source database will be: (22+1)*2 + 4*3 + 1 = 59 You should plan for a maximum of 59 database connections before installingInfoSphere CDC on a source database. Calculating connections required by InfoSphere CDC on atarget database (4+G)*I + 3*SWhere:

G = number of Management Console GUI and CHCCLP scripting applications thatare connected to your instances of InfoSphere CDC.I = number of InfoSphere CDC instances.S = number of subscriptions in all of your InfoSphere CDC instances.

Example: How to calculate required connections for a targetdatabase You want to set up InfoSphere CDC in the target environment as follows:

1 installed Management Console GUI application.2InfoSphere CDC instances.

25

- 3 subscriptions. The number of connections required on the target database will be: (4 + 1)*2 + 3*3 = 19 You should plan for a maximum of 19 database connectionsbefore installing InfoSphere CDC on the target database.

26

IBM InfoSphere Change Data Capture, Version 10.2 Refresh performance considerations The following considerations only apply if the Sybase database is used as a targetof replication. Enabling the bulkcopy option In order for InfoSphere® CDC for Sybase databases to be able to use the BCPutility for fast loads and allow higher performance copying of data during a refresh tolarge tables, the Sybase database must have the select into/bulkcopy optionenabled. To enable the BCP utility, issue the following statement in Sybase: sp_dboption <db>, "select into/bulkcopy", true You will then need to run a full backup of the Sybase database. For details see yourSybase ASE documentation. Dropping and re-creating indexes To further improve the performance of a refresh using the BCP utility, you can giveInfoSphere CDC for Sybase databases the ability to drop all indexes on the tablesbeing refreshed and then rebuild the indexes after the refresh. In InfoSphere CDC,this action is controlled by the refresh_loader_drop_index system parameter beingset to true. When the refresh_loader_drop_index system parameter is set to true, you mustensure that the ddl in tran option is enabled in the Sybase database. Related information: refresh_loader_drop_index

27

IBM InfoSphere Change Data Capture, Version 10.2 Database partition changes InfoSphere® CDC does not support database partition changes such as adding,removing, or moving except as documented for specific environments.

28

IBM InfoSphere Change Data Capture, Version 10.2 Enabling the creation of a partition table If you want to create a range partition table, the Sybase ASE installation must havethe ASE Partitions License and sp_configure must be used to set enablesemantic partitioning to 1: sp_configure ‘enable semantic partitioning', 1

29

IBM InfoSphere Change Data Capture, Version 10.2 Assessing disk space and memory requirements InfoSphere® CDC requires disk space and memory when it processes change datafrom your source database. In order to process change data efficiently and replicatethese changes to your target system, it is very important that InfoSphere CDC hasadequate disk space and memory for each of the components described in thissection. Disk space requirements for the staging store The InfoSphere CDC staging store is located on your source system and is a cacheof change data read from the database logs. The size of the staging store willincrease as the product accumulates change data, and therefore you must plan yoursource environment accordingly, particularly disk space. The disk space allocated to the staging store is controlled by the Staging Store DiskQuota value that is set when you create an instance with the InfoSphere CDCconfiguration tool. In most cases, the default value is appropriate for InfoSphereCDC source systems. Since the staging store is only used on source systems, youcan reduce this value to the minimum of 1 GB if you are configuring a targetinstance of InfoSphere CDC. Note: You can also allocate disk space to the staging store with thestaging_store_disk_quota_gb system parameter in Management Console. Memory requirements for the JVM (Java Virtual Machine) As a Java-based product, InfoSphere CDC requires you to allocate the maximumamount of memory (RAM) to be used by the Java™ Virtual Machine (JVM). Thisprevents InfoSphere CDC from using all of the available memory on the systemwhere it is installed. The Maximum Memory Allowed value is set on a per-instance basis for eachinstance you create for your source or target database. In most cases the defaultvalues are appropriate for 32-bit and 64-bit instances. However, if your database isprocessing an extremely heavy workload, you may have to adjust the default values.The RAM allocated must be physically available on your system. Disk space requirements for the global disk quota The global disk quota on your source and target systems is used for all capturecomponents including temporary files, transaction queues, and LOBs which arestaged on the target before being applied. InfoSphere CDC will manage disk spaceutilization across all components as required. Most databases have a mechanism that allows you to roll back or undo changes toyour database by storing uncommitted changes. Similarly, InfoSphere CDC usesthis disk quota to store in-scope change data that has not been committed in yourdatabase. Once the database transaction is committed, the disk space used by thetransaction is released. Long running open transactions will contribute to the amountof disk space used. You can configure the amount disk space that is allocated to this quota with themirror_global_disk_quota_gb system parameter. The default setting of this systemparameter is such that InfoSphere CDC will only stop replicating after this disk quota

30

exhausts all available disk space on your system. If you would prefer InfoSphereCDC to stop replicating after it uses a specific amount of disk space, you can specifythe value with this system parameter in Management Console. Related concepts: Sizing considerations for the staging store Configuring InfoSphere CDC for Sybase databases (Windows) Configuring InfoSphere CDC for Sybase databases (UNIX and Linux) Disk space requirements RAM requirements

31

IBM InfoSphere Change Data Capture, Version 10.2 Understanding the importance of an appropriatelyconfigured disk subsystem There are many types of disk subsystems in use to meet either business orperformance needs. Not all of these disk subsystems are suitable for use bydatabases or InfoSphere® Data Replication out of the box. Some may need to betuned to ensure that appropriate input/output semantics are in place for reliablecontinuous operation. Symptoms of an unreliable disk subsystem Without appropriate disk subsystem configuration, both the database itself orInfoSphere Data Replication may exhibit any of a wide variety of input/output relatederrors, usually random in nature. Any one of them can stop replication. If thedatabase transaction logs themselves become corrupted due to this kind ofmisconfiguration, then the database itself may become unrecoverable, putting theentire business at risk. Having an appropriately configured disk subsystem istherefore essential to the operation of both database and InfoSphere DataReplication. What makes a disk subsystem unreliable? Typically, disk mounting options that interfere with or modify the read visibility ofwrite operations are the ones which will cause data to be read inaccurately, therebycausing applications such as databases and InfoSphere Data Replication to reporterrors and fail. The expectations of these semantics between the database andInfoSphere Data Replication must be compatible with those provided by the optionsused to mount the disk subsystem in order to avoid corruption issues. Somedatabases exhibit specific behaviors only with certain disk subsystem types, soproper care and attention is needed to properly configure the disk subsystem. Special notes regarding specific configurations Direct I/O on Linux—Due to the nature of the implementation of direct I/O (directio)on Linux, applications that read from files being written using direct I/O must employexactly the same direct I/O options as the writing application. If this is not done, thereading application may not ever see the data written by the writing application andthe reading application can therefore exhibit a stall. Linux versions of InfoSphereCDC prior to version 6.5.1 Interim Fix 17 for Oracle, version 6.5.2 Interim Fix 20 forOracle, and InfoSphere Data Replication versions prior to 10.2 for Oracle andSybase can exhibit this behaviour under certain conditions. The best resolution is toupgrade to the latest Interim Fix level for InfoSphere CDC or to version 10.2 or laterfor InfoSphere Data Replication.

32

IBM InfoSphere Change Data Capture, Version 10.2 Understanding the InfoSphere CDC memoryfootprint Current® versions of InfoSphere® CDC on Linux, UNIX, and Windows platforms arewritten in the Java™ programming language. The memory specified in theInfoSphere CDC configuration tool refers to the amount of memory that the JavaVirtual Machine (JVM) will allocate to InfoSphere CDC to run. This memory is strictlyenforced by the JVM itself and the JVM will ensure that it is not exceeded. The JVM itself also consumes some memory. The amount of this other memoryvaries considerably by Java version, bit length, and operating system. A simple Javaprogram consumes 13212 KB of overhead when run in a 32-bit Java 1.5 JVM onAIX®, but 173509 KB of overhead when run in a 32-bit Java 1.5 JVM on Linux. Inother words, the overhead on Linux is 13 times larger than the overhead on AIX,when controlling for the other variables. The amount of memory overhead consumed by the JVM itself can also change overtime. This is especially true for Linux and UNIX systems. For those systems, oncethe operating system allocates memory to a process, it is not reclaimed until theprocess ends. Thus, the total amount of memory for any given process never goesdown. Given these factors, you should expect that more memory is used by InfoSphereCDC than is allocated in the configuration tool. InfoSphere CDC has no control overthis memory usage and cannot track or otherwise manage it.

33

IBM InfoSphere Change Data Capture, Version 10.2 Sizing considerations for the staging store This topic outlines scenarios that will increase the disk requirements for the stagingstore on your source system. All of these scenarios should be kept in mind whenyou are planning the disk space requirements for your replication environment. Latent subscriptions The amount of data within the staging store is related to the latency of yoursubscriptions. InfoSphere® CDC measures latency as the amount of time thatpasses between when data changes on a source table and when it changes on thetarget table. For example, if an application inserts and commits a row into the sourcetable at 10:00 and InfoSphere CDC applies that row to the target table at 10:15, thenthe latency for the subscription is 15 minutes. When all of your subscriptions are mirroring and have very little latency, the volumeof data that needs to be kept in the staging store will be relatively small. If all of yoursubscriptions are mirroring but some are latent, the staging store will contain all thedata generated by the logs for the latent subscriptions during the entire time they aremirroring. For example, if the difference in latency between the least latentsubscription and the most latent subscription is 3 hours, and your databasegenerates 100 GB of log data per hour, the staging store will require approximately300 GB of disk storage space. Inactive subscriptions An inactive (not currently replicating) subscription that contains tables with areplication method of Mirror will continue to accumulate change data in the stagingstore from the current point back to the point where mirroring was stopped. For thisreason, you should delete subscriptions that are no longer required, or change thereplication method of all tables in the subscription to Refresh to prevent theaccumulation of change data in the staging store on your source system. Continuous Capture Continuous Capture is a product feature that is designed to accommodate thosereplication environments in which it is necessary to separate the reading of thedatabase logs from the transmission of the logical database operations. This isuseful when you want to continue processing log data even if replication and yoursubscriptions stop due to issues such as network communication failures over afragile network, target server maintenance, or some other issue. You can enable ordisable Continuous Capture without stopping subscriptions. Continuous Capture results in additional disk utilization on the source machine inorder to accumulate change data from the database log file when these are notbeing replicated to the target machine. This change data is stored in the stagingstore. The additional disk utilization due to the accumulation of change data in thestaging store should be evaluated and understood before deciding to use thisfeature in your replication environment. Related concepts: Assessing disk space and memory requirements

34

Continuous Capture commands

35

IBM InfoSphere Change Data Capture, Version 10.2 Creating queues in JMS providers If you choose to use a JMS provider as the communications protocol forInfoSphere® CDC, you will need to define the queues to be used by InfoSphereCDC before you attempt to configure an instance. The queues will need to be named in the format CDC_<port>, where <port> is thefive digit TCP listening port number of the instance. You can left pad the numberwith zeroes if necessary to ensure five digits (example, CDC_00123). Each InfoSphere CDC instance will require its own queue. Instances cannot share aqueue. When you create the queue, you must ensure that they are defined to holdmessages of the type BytesMessage.

36

---

IBM InfoSphere Change Data Capture, Version 10.2 Installing or upgrading InfoSphere CDC for Sybasedatabases Before attempting to install or upgrade InfoSphere® CDC, consult the database,operating system and hardware requirements for the specific version of the softwarethat you want to install, to ensure that it is compatible with your system. If you are upgrading to a later version or installing a fix pack, an installation ofInfoSphere CDC must already be present in order to successfully complete theprocess. In this section, you will learn:

Installing InfoSphere CDC for Sybase databases using an interactive installation Installing InfoSphere CDC for Sybase databases using a silent installation Upgrading InfoSphere CDC for Sybase databases You can upgrade InfoSphere CDC by installing a later version of the software overtop of an existing installation.

Related concepts: Before you install InfoSphere CDC for Sybase databases

37

--

-

---

IBM InfoSphere Change Data Capture, Version 10.2 Installing InfoSphere CDC for Sybase databasesusing an interactive installation Note the following before you install or upgrade InfoSphere® CDC on Linux or UNIX:

Do not install or upgrade InfoSphere CDC as a root user.The installation directory requires file system permissions of 700 if you plan to usethe same user account to install the product, create and configure instances, orupgrade the product.The installation directory requires file system permissions of 770 if you plan to usedifferent user accounts to install the product, create and configure instances, orupgrade the product.

Note: Ensure that the installed version of the Management Console and AccessServer applications are either the same version as the InfoSphere CDC replicationengine or a later version. See also:

To install InfoSphere CDC for Sybase databases (Windows) To install InfoSphere CDC for Sybase databases (UNIX and Linux) To override the locale for the installation (UNIX and Linux)

38

1.

2.3.

4.5.

6.7.8.

9.

IBM InfoSphere Change Data Capture, Version 10.2 To install InfoSphere CDC for Sybase databases(Windows)

Double-click on the installation executable. The IBM®InfoSphere® CDCinstallation wizard opens. Click Next.If you agree to the license terms, select I accept the terms in the licenseagreement and then click Next.Select the folder where you want to install InfoSphere CDC and click Next.If you already have an installation of InfoSphere CDC, the installation program willprompt you to upgrade the installation. Click OK to upgrade the installation.Select the location for the product icons and click Next.Review the installation summary and click Install.Select Launch Configuration Tool to launch the configuration tool after theinstallation. The configuration tool allows you to add an instance of InfoSphereCDC.Click Done to exit the installation.

Related concepts: Configuring InfoSphere CDC for Sybase databases (Windows)

39

1.2.

3.4.

5.

6.7.

8.9.

10.

IBM InfoSphere Change Data Capture, Version 10.2 To install InfoSphere CDC for Sybase databases(UNIX and Linux)

Log on to the account you set up for InfoSphere® CDC.Copy the InfoSphere CDC installation file for your UNIXor Linux platform fromthe InfoSphere CDC DVD or the download file.Make the installation binary file executable.Run the installation program by typing the following command:./<installation_binary_name>.bin If you already have InfoSphere CDC installed, the installation program willprompt you to upgrade. Press Enter on the Introduction screen to display the license agreement. Followthe instructions on the screen to navigate through the license agreement.To accept the license agreement, type 1.Enter the absolute path to your installation directory or press Enter to accept thedefault.Note: The directory that you specify must be owned by the account youare using for the installation. If the installation program cannot create thedirectory, you are prompted to specify a different directory. Review the installation summary. Press Enter to start the installation.After completing the installation, InfoSphere CDC gives you the option oflaunching the configuration tool for InfoSphere CDC.Type 1 to launch the configuration tool.

Note: If you have X-Windows installed, the installation program will launch theconfiguration tool in a graphical environment. Related concepts: Configuring InfoSphere CDC for Sybase databases (UNIX and Linux)

40

1.2.

----

-

IBM InfoSphere Change Data Capture, Version 10.2 To override the locale for the installation (UNIX andLinux) Use the following procedure to override the locale for the installer. English,Japanese and Simplified Chinese are supported.

Navigate to the directory that contains the InfoSphere® CDC installation file.Start the installer with the following flags to override the locale of the installation:

English—<installation_file_name>.bin -l enJapanese—<installation_file_name>.bin -l jaKorean—<installation_file_name>.bin -l koSimplified Chinese—<installation_file_name>.bin -l zh_CN

where: <installation_file_name> is the name of the installation file.

After the installation is complete, you have the option of launching the InfoSphereCDC configuration tool. The configuration tool will use the locale settings for yoursystem.

41

-

IBM InfoSphere Change Data Capture, Version 10.2 Installing InfoSphere CDC for Sybase databasesusing a silent installation A silent installation allows you to automatically install InfoSphere® CDC byspecifying a command with various parameters. You can use this type of installationmethod for large-scale deployments of InfoSphere CDC by embedding the silentinstallation command in a script. See also:

To perform a silent installation of InfoSphere CDC for Sybase databases (UNIXand Linux)

42

1.2.

3.4.

-5.

-

IBM InfoSphere Change Data Capture, Version 10.2 To perform a silent installation of InfoSphere CDCfor Sybase databases (UNIX and Linux)

Log on to the account you set up for InfoSphere® CDC.Copy the InfoSphere CDC installation binary from the InfoSphere CDC CD-ROMor download it from the InfoSphere CDC web site.Make the installation binary executable.Install InfoSphere CDC and generate a response file with the following command:<installation_binary_name> -r <response-file> where: <response-file> is the full path to the installation response file.

On another system, perform the silent installation by running the followingcommand:<installation_binary_name> -i silent -f <response-file> where: <response-file> is the full path to the installation response file.

Related tasks: To install InfoSphere CDC for Sybase databases (UNIX and Linux)

43

-

-

-

-

-

--

--

IBM InfoSphere Change Data Capture, Version 10.2 Upgrading InfoSphere CDC for Sybase databases You can upgrade InfoSphere® CDC by installing a later version of the software overtop of an existing installation. Interim fixes cannot be used to upgrade InfoSphere CDC to later versions. You mustfirst install the general availability (GA) release of the software for the later versionand accept the software license agreement, before applying any interim fixes. Afterthe interim fix has been installed, you can start the InfoSphere CDC instances andcomplete the upgrade. Before attempting to upgrade the software, you should be aware of the followingprerequisites:

All subscriptions in all InfoSphere CDC for Sybase databases instances associatedwith the installation to be upgraded must be stopped.All InfoSphere CDC for Sybase databases instances associated with theinstallation must be stopped.When logging in, you must use the same account that was used during the originalinstallation of InfoSphere CDC for Sybase databases.It is a best practice to backup the installation directory of the current InfoSphereCDC for Sybase databases installation.It is a best practice to backup the InfoSphere CDC metadata tables (TS_AUTH,TS_BOOKMARK, TS_CONFAUD, and TS_DDLAUD) that are stored in theSybase database instance that you are replicating to and from. In the event of afailure during the upgrade, having a backup of the metadata will allow you to revertto the point in time before the upgrade. In addition to the InfoSphere CDCmetadata tables stored in your database, InfoSphere CDC maintains some othermetadata in an internal database. It is a best practice to backup the InfoSphereCDC internal metadata at the same time as the InfoSphere CDC metadata tablesin your database are backed up. The dmbackup command can be used to backupthe internal InfoSphere CDC metadata tables.Do not upgrade InfoSphere CDC as a root user.The installation directory requires file system permissions of 700 to install theproduct, create and configure instances, or upgrade the product.

When upgrading an InfoSphere CDC replication engine, you must also upgradeManagement Console and Access Server to the same version or later to access thefull range of functionality that was introduced in the later version of the engine.Management Console and Access Server are backward-compatible and will supportthe functionality available in earlier versions of the engines. CAUTION: You cannot export and import subscriptions across different versions of InfoSphereCDC. Do not attempt to import a subscription file from a previous version into anupgraded version. Once the upgrade is complete, you should create a new exportedsubscriptions xml file. See also:

To upgrade InfoSphere CDC for Sybase databases (Windows) To upgrade InfoSphere CDC for Sybase databases (UNIX and Linux)

44

45

1.2.3.

4.

5.

6.7.

8.

9.

10.11.12.

IBM InfoSphere Change Data Capture, Version 10.2 To upgrade InfoSphere CDC for Sybase databases(Windows)

Ensure that all subscriptions in all InfoSphere® CDC instances are stopped.Ensure that all InfoSphere CDC instances are stopped.Ensure that you have a backup of the TS_AUTH, TS_BOOKMARK,TS_CONFAUD, and TS_DDLAUD metadata tables that are stored in thedatabase instance that you are replicating to and from. In the event of a failureduring the upgrade, having a backup of the metadata will allow you to revert tothe point in time before the upgrade. In addition to the InfoSphere CDCmetadata tables stored in your database, InfoSphere CDC maintains some othermetadata in an internal database. It is a best practice to backup the InfoSphereCDC internal metadata at the same time as the InfoSphere CDC metadatatables in your database are backed up. The dmbackup command can be used tobackup the internal InfoSphere CDC metadata tables.Ensure that you have backed up your InfoSphere CDC installation directory.Important: The backup of the installation directory and the metadata tablesshould be from the same timeframe, so that they contain an identical snapshotof data. Double-click on the installation executable. The IBM®InfoSphere CDCinstallation wizard opens. Click Next.If you agree to the license terms, select I accept the terms in the licenseagreement and then click Next.Select the folder for the existing installation of InfoSphere CDC to be upgradedand click Next.If you already have an installation of InfoSphere CDC, the installation programwill prompt you to upgrade the installation. Click OK to upgrade the installation.Select the location for the product icons and click Next.Review the pre-upgrade summary and click Install.After upgrading the software, you must start all the configured instances in orderto complete the upgrade process. Depending on the number of tables andsubscriptions configured, as well as the complexity of the mappings, the upgradeprocess can take anywhere from several minutes to hours. Once the upgradeprocess is complete, InfoSphere CDC will be ready for replication and willrestart.

46

1.2.3.

4.

5.6.

7.8.

9.

10.11.

12.13.

14.15.

IBM InfoSphere Change Data Capture, Version 10.2 To upgrade InfoSphere CDC for Sybase databases(UNIX and Linux)

Ensure that all subscriptions in all InfoSphere® CDC instances are stopped.Ensure that all InfoSphere CDC instances are stopped.Ensure that you have a backup of the TS_AUTH, TS_BOOKMARK,TS_CONFAUD, and TS_DDLAUD metadata tables that are stored in thedatabase instance that you are replicating to and from. In the event of a failureduring the upgrade, having a backup of the metadata will allow you to revert tothe point in time before the upgrade. In addition to the InfoSphere CDCmetadata tables stored in your database, InfoSphere CDC maintains some othermetadata in an internal database. It is a best practice to backup the InfoSphereCDC internal metadata at the same time as the InfoSphere CDC metadatatables in your database are backed up. The dmbackup command can be used tobackup the internal InfoSphere CDC metadata tables.Ensure that you have backed up your InfoSphere CDC installation directory.Important: The backup of the installation directory and the metadata tablesshould be from the same timeframe, so that they contain an identical snapshotof data. Log on to the account you set up for InfoSphere CDC.Copy the InfoSphere CDC installation file for the version to which you want toupgrade. This file is available on the InfoSphere CDC DVD or you can downloadthe desired version from the IBM® web site. Ensure that you have copied theinstallation file for the applicable operating system.Make the installation binary file executable.Run the installation program by typing the following command:./<installation_binary_name>.bin If you already have InfoSphere CDC installed, the installation program willprompt you to upgrade. Press Enter on the Introduction screen to display the license agreement. Followthe instructions on the screen to navigate through the license agreement.To accept the license agreement, type 1.Enter the absolute path to your installation directory or press Enter to accept thedefault.Note: The directory that you specify must be owned by the account youare using for the installation. If the installation program cannot create thedirectory, you are prompted to specify a different directory. Confirm the absolute path. If it is correct, type Y and press Enter. Type 1 to confirm that you want to upgrade the existing installation and pressEnter.Review the pre-upgrade summary. Press Enter to start the upgrade.After upgrading the software, you must start all the configured instances in orderto complete the upgrade process. Depending on the number of tables andsubscriptions configured, as well as the complexity of the mappings, the upgradeprocess can take anywhere from several minutes to hours. Once the upgradeprocess is complete, InfoSphere CDC will be ready for replication and willrestart.

47

48

-

IBM InfoSphere Change Data Capture, Version 10.2 Configuring InfoSphere CDC for Sybase databases(Windows) After installing InfoSphere® CDC, the installation program launches a configurationtool. The configuration tool allows you to configure one or more InfoSphere CDCinstances for your environment. You must configure InfoSphere CDC before you canstart replication. In this section, you will learn:

Configuring InfoSphere CDC for Sybase databases instances (Windows)

49

---

IBM InfoSphere Change Data Capture, Version 10.2 Configuring InfoSphere CDC for Sybase databasesinstances (Windows) You can add, edit, or delete an instance of InfoSphere® CDC. Use the InfoSphereCDC configuration tool to work with instances. You do not have to start and stopinstances. Before you add, edit, or delete an instance, ensure logging is turned on for eachdatabase from which you intend to capture data changes. After you complete the configuration, you can start InfoSphere CDC. Note: You can back up the metadata for your instance using the dmbackupmdcommand. See also:

To add a new instance of InfoSphere CDC for Sybase databases (Windows) To edit an instance of InfoSphere CDC for Sybase databases (Windows) To delete an instance of InfoSphere CDC for Sybase databases (Windows)

50

1.

2.

3.4.

IBM InfoSphere Change Data Capture, Version 10.2 To add a new instance of InfoSphere CDC forSybase databases (Windows)

If you are configuring the first instance of InfoSphere® CDC for Sybasedatabases after installation, you can proceed to Step 3 of this procedure.At the command prompt, launch the configuration tool by issuing the followingcommand in the specified directory:\<InfoSphere CDC Installation Directory>\bin\dmconfigurets.exe At the welcome message, click OK to continue.On the IBM®InfoSphere CDC New Instance dialog box, you can configure thefollowing options in the Instance area:

Option DescriptionName Enter a name for your

InfoSphere CDC instance. Thisname must be unique.

Server Port Enter the port number whichInfoSphere CDC uses forcommunication with clientworkstations runningManagement Console andother servers.Note: This portnumber cannot be used byother applications installed onthe same server. You will usethis port number whenspecifying access parametersfor your datastore in theAccess Manager perspective inManagement Console.InfoSphere CDC displays adefault TCP/IP port of 10301.For more information, see yourManagement Consoledocumentation.Note: For more information onthe port requirements forInfoSphere CDC, see Portrequirements.

Auto-Discovery Port Bypass auto-discovery. Thisfeature is disabled by default.Do not select the box or enter aport number.

51

5. In the Windows Service area, you can specify the account that will be used tostart InfoSphere CDC services. Select one of the following options:

Staging Store Disk Quota(GB)

Enter the maximum amount ofdisk space that will be utilizedby the InfoSphere CDC stagingstore on your source system.The default value is 100GB.Specify 1 GB if you arecreating an instance that will beused as a target of replication.This reduces the diskresources that InfoSphere CDCrequires on your target system.

Maximum Memory Allowed(MB)

Enter the amount of physicallyavailable RAM that you want toallocate for this instance ofInfoSphere CDC. By default,the configuration tool allocates512 MB of RAM for each 32-bitinstance and 1024 MB of RAMfor each 64-bit instance.Note:Using values other than thedefaults or allocating moreRAM than is physicallyavailable on your server shouldonly be undertaken afterconsidering the impacts onproduct performance.

Bit Version Select the bit-version of yourdatabase by selecting one ofthe following options:32 bit64bitThese options are notenabled if you are installingInfoSphere CDC on a 32-bitserver.

Option DescriptionLocal System account Start InfoSphere CDC services

through the local systemadministrator account.

52

6. In the Database area, you can configure access to the database that containsthe tables for replication. To complete this step, you will require systemadministrator privileges. You can then add a datastore in the Access Managerperspective in Management Console and provide users access to this database.For more information, see your Management Console documentation.

This account Start InfoSphere CDC servicesthrough the specified useraccount. The account must bespecified in the format<domain>\<user name>, where<domain> is the name of adomain in your environment,and <user name> is a validlogin user name in thespecified domain. If yourcomputer is not part of adomain, you can specify<computer name>\<username>.In the Password and ConfirmPassword boxes, enter thepassword currently associatedwith the selected Windowsuser account. If you change thepassword for the Windows useraccount after installingInfoSphere CDC, you will haveto use the Windows Servicesdialog to change the passwordcurrently set for eachInfoSphere CDC service.

Option DescriptionSybase Directory Enter the fully qualified path to

the Sybase installationdirectory.The configuration tool readsthe SYBASE environmentvariable to provide a defaultvalue. For more information,see your Sybasedocumentation.Click Browse... to specify thepath to the Sybase directory.

SYBASE_OCS Select the SYBASE_OCSenvironment variable.The configuration tool providesdefault values once you specifya valid Sybase installationdirectory. For more informationon the SYBASE_OCSenvironment variable, see yourSybase documentation.

53

7.

-

-

8.

In the Archive Log Directory area, enter the specific path to the Sybase archivelogs in the Archive Path: field, or you click Browse... to specify the path instead.InfoSphere CDC for Sybase databases uses the archive logs to replicate yourdatabase changes.Note the following:

All archive logs must be located in one directory and InfoSphere CDC forSybase databases must have read permissions for this directory.You should not specify the directory that is being used for your online logs.

If you want to use a JMS provider as the method of communication betweendatastores, perform the following steps. Otherwise TCP/IP will be usedexclusively as the communications protocol.A JMS provider should be usedwhen characteristics of your network prevent the existence of a long term, stable

Sybase server Select the name of the SybaseAdaptive Server from the listprovided by the configurationtool.

Database Select the name of thedatabase that you want toreplicate data to or from andcontains all of the tables forreplication. You can set up ordecide on this database beforeyou install InfoSphere CDC forSybase databases.Note: Donot click the Advanced buttonand enter values unlessdirected by an IBMrepresentative.

Port Enter the port number forSybase Adaptive Server. IfInfoSphere CDC for Sybasedatabases can detect the portfrom sql.ini, this text box will beread-only.

Username Enter the user name forSybase Adaptive Server.

Password Enter the password for SybaseAdaptive Server.

Metadata Schema Select the database schemaused by InfoSphere CDC formetadata tables. You canspecify any schema exceptthose in use by other installedinstances of InfoSphere CDCfor the givendatabase.Note:InfoSphereCDC metadata tables containimportant configurationinformation and should bebacked up as part of yourdatabase backup strategy.

54

A.

B.C.D.E.F.G.

H.

I.J.

K.

L.

M.N.

O.9.10.

-

-

-

TCP/IP connection. Ensure that a queue has been created by your system administrator and isnamed correctly. Each InfoSphere CDC instance that is to use a JMSmessage provider must have a queue named in the format CDC_<port>,where <port> is the five digit TCP listening port number of the instance (youcan left pad the number with zeroes if necessary, to ensure five digits). Click the Communications Protocol tab.Select JMS or TCP/IP.Click Add.Select the required JMS Provider .jar files. Click Add Connection.Enter a remote factory name. A connection factory encapsulates a set ofconnection configuration parameters that has been defined by anadministrator. Enter a user name and password for JMS server authentication.This username is defined by your JMS provider. Contact your system administrator formore information. Click the JNDI Server tab.Enter the constant that holds the local or remote connection factory name inthe JNDI Initial Context box. Java™ Naming and Directory Interface (JNDI)is a programming interface from Oracle for connecting Java programs tonaming and directory services.Enter the URL that is relative to the JNDI initial context in the JNDI URL box.In JNDI, all naming and directory operations are performed relative to acontext. Therefore the JNDI defines an initial context that serves as a startingpoint for naming and directory operations. This value should be the fully-qualified class name of the factory class that will create the initial context.If the JNDI server to which you want to connect requires authentication, thenyou need to provide the user name and password to connect to that system.Contact your system administrator for information about the user name thatyou should specify. Click OK to save the connection.Click Test if you want to verify the connection.If the JMS Provider is notconfigured correctly, InfoSphere CDC will use TCP/IP as the communicationprotocol between datastores. Click OK.

Click OK to save your configuration settings for the InfoSphere CDC instance.If InfoSphere CDC has detected an unsupported encoding, a dialog will openasking you to select an alternate encoding from a list.You can filter the list ofalternate encodings by clicking one of the following buttons:

Closest match—Displays the alternated encodings that are the closest matchto the data.Comparable encodings byte length—Displays the alternate encodings inorder of byte length.All–Displays all alternate encodings.

Select an encoding from the list and click OK. If you click Cancel, an error message will be displayed and the instance will notbe created.

55

Related concepts: Disk space requirements RAM requirements Port requirements Assessing disk space and memory requirements Sizing considerations for the staging store Creating queues in JMS providers Related tasks: To start InfoSphere CDC for Sybase databases (Windows) Related reference: dmbackupmd - Back up metadata

56

1.

2.

3.

4.

5.

IBM InfoSphere Change Data Capture, Version 10.2 To edit an instance of InfoSphere CDC for Sybasedatabases (Windows)

In the Instances area, select the instance that you want to modify and click Stop ifthe instance is started.In the Instances area, select an instance and click Edit.The InfoSphere® CDCEdit Instance dialog opens. You can modify any of the values on this dialog box that you specified whenadding an instance.Click OK to save your changes and then click Close.The configuration tool willmodify the instance. In the Instances area, select the instance that you modified and click Start to startthe instance.

57

1.

2.

3.4.

IBM InfoSphere Change Data Capture, Version 10.2 To delete an instance of InfoSphere® CDC forSybase databases (Windows)

At the command prompt, launch the configuration tool by issuing the followingcommand in the specified directory:\<InfoSphere CDC Installation Directory>\bin\dmconfigurets.exe In the Instances area, select the instance that you want to delete and click Stop ifthe instance is started.In the Instances area, select an instance and click Delete.Click Yes to permanently delete the instance.

58

-

IBM InfoSphere Change Data Capture, Version 10.2 Configuring InfoSphere CDC for Sybase databases(UNIX and Linux) After installing InfoSphere® CDC, the installation program launches a configurationtool. The configuration tool allows you to configure one or more InfoSphere CDCinstances for your environment. You must configure InfoSphere CDC before you canstart replication. In this section, you will learn:

Configuring InfoSphere CDC for Sybase databases instances (UNIX and Linux)

59

---

IBM InfoSphere Change Data Capture, Version 10.2 Configuring InfoSphere CDC for Sybase databasesinstances (UNIX and Linux) You can add, edit, or delete an instance of InfoSphere® CDC. Use the InfoSphereCDC configuration tool to work with instances. You do not have to start and stopinstances. Before you add, edit, or delete an instance, ensure logging is turned on for eachdatabase from which you intend to capture data changes. See also:

To add a new instance of InfoSphere CDC for Sybase databases (UNIX and Linux) To edit an instance of InfoSphere CDC for Sybase databases (UNIX and Linux) To delete an instance of InfoSphere CDC for Sybase databases (UNIX and Linux)

60

1.

2.

3.4.5.

6.

7.8.

9.

10.11.

A.

B.C.D.E.F.G.

IBM InfoSphere Change Data Capture, Version 10.2 To add a new instance of InfoSphere CDC forSybase databases (UNIX and Linux)

If you are configuring the first instance of InfoSphere® CDC after installation,you can proceed to Step 3 of this procedure.At the command prompt, launch the configuration tool by issuing the followingcommand in the specified directory:/<InfoSphere CDC Installation Directory>/bin/dmconfigurets At the welcome message, press Enter to continue.Enter 2 and press Enter to add a new instance of InfoSphere CDC.Enter a name for your InfoSphere CDC instance and press Enter. The instancename must be unique.Enter the port number which InfoSphere CDC uses for communication with clientworkstations running Management Console and other servers. InfoSphere CDCdisplays a default port of 10301. Press Enter.This port number cannot be usedby other applications installed on the same server. You will use this port numberwhen specifying access parameters for your datastore in the Access Managerperspective in Management Console. Press Enter to bypass auto-discovery. This feature is disabled by default.Enter the maximum amount of disk space that will be utilized by the InfoSphereCDC staging store on your source system. The default value is 100 GB.Specify1 GB if you are creating an instance that will be used as a target of replication.This reduces the disk resources that InfoSphere CDC requires on your targetsystem. Enter the amount of physically available RAM that you want to allocate for thisinstance of InfoSphere CDC and press Enter. By default, the configuration toolallocates 512 MB of RAM for each 32-bit instance and 1024 MB of RAM for each64-bit instance.Using values other than the defaults or allocating more RAM thanis physically available on your server should only be undertaken afterconsidering the impacts on product performance. Depending on the bit version of your server, enter 32 or 64 and press Enter.If you want to use TCP/IP as the exclusive method of communication betweendatastores, enter n and press Enter. If you want to have the option to use eithera JMS provider or TCP/IP as the communications protocol, perform the followingsteps:A JMS provider should be used when characteristics of your networkprevent the existence of a long term, stable TCP/IP connection.

Ensure that a queue has been created by your system administrator and isnamed correctly. Each InfoSphere CDC instance that is to use a JMSmessage provider must have a queue named in the format CDC_<port>,where <port> is the five digit TCP listening port number of the instance. Youcan left pad the number with zeroes if necessary to ensure five digits(example, CDC_00123).Enter y and press Enter.Enter 2 to add a JMS provider. Enter the fully qualified path to your JMS provider .jar file and press Enter.Enter 4 and press Enter to complete the configuration of the JMS providers.Enter 1 to add a JMS connection.Enter a JMS remote connection factory name and press Enter. For example,jms/ConnectionFactory. A connection factory encapsulates a set of

61

H.I.J.K.L.M.N.O.P.Q.

R.

12.

13.

14.15.

16.17.

18.

19.

20.

connection configuration parameters that has been defined by anadministrator. InfoSphere CDC uses this to create a connection with yourJMS provider.Enter the user name and press Enter.Enter the password to authenticate to the JMS server and press Enter.Enter the password a second time to confirm and press Enter.Enter the JNDI initial context and press Enter.Enter the URL that is relative to the JNDI Initial Context and press Enter.Enter the user name for the JNDI Principal and press Enter.Enter the JNDI credentials password and press Enter.Enter the password a second time to confirm and press Enter.Press Enter again to return to the Engine Communication Connection menu.Press 5 if you want to verify the connection and then press Enter to return tothe Engine Communication Connection menu.If the JMS Provider is notconfigured correctly, InfoSphere CDC will use TCP/IP as the communicationprotocol between datastores. Enter 7 to complete the configuration of the engine communicationconnection.

Enter the fully qualified path to your Sybase installation directory and pressEnter.The configuration tool reads the SYBASE environment variable to provide adefault value. For more information, see your Sybase documentation. Enter the number of the SYBASE_OCS environment variable and press Enter.The configuration tool lists the server names.If the number of detected servernames is large, you will be offered the option of entering the schema namedirectly or you can press Enter to view the pages of schema names. Enter the number of the Sybase Adaptive Server and press Enter.For advanced parameters, enter n and press EnterNote: Do not configure theadvanced parameters unless directed by an IBM® representative. Enter the user name for the Sybase Adaptive Server and press Enter.Enter the password for the Sybase Adaptive Server and press Enter. Theconfiguration tool will now search the database for schemas.Enter the number of the database that you want to replicate data to or from andcontains all of the tables for replication. Press Enter. You can set up or decideon this database before you install InfoSphere CDC.Note: You cannot select aSybase system database. Enter the number that corresponds to the database schema used by InfoSphereCDC for metadata tables and press Enter. You can specify any schema exceptthose in use by other installed instances of InfoSphere CDC for the givendatabase.If the number of detected schemas is large, you will be offered theoption of entering the schema name directly or you can press Enter to view thepages of schema names. You will not be asked for this information if you choose a read-only database. Note:InfoSphere CDC metadata tables contain important configurationinformation and should be backed up as part of your database backup strategy. Enter the path to the directory that will be used for your Sybase archive logs.InfoSphere CDC uses the archive logs to replicate your database changes.Notethe following:

62

-

-

21.

A.

B.-

--

C.22.

All archive logs must be located in one directory and InfoSphere CDC musthave read permissions for this directory.You should not specify the directory that is being used for your online logs.

Press Enter. If InfoSphere CDC detects an unsupported encoding, an error message will bedisplayed and you will be asked to choose an alternate encoding.

Enter y to proceed. If you enter n and press Enter to cancel, the instance willnot be created. Enter a value to choose how the alternate encodings will be displayed:

1—Displays the available alternate encodings that are the closest match tothe database.2—Displays the available alternate encodings in order of byte length.3—Displays all available alternate encodings.

Enter the number for the encoding to be used and press Enter.The configuration tool creates the InfoSphere CDC instance and prompts you tostart the instance. Enter y to start the instance.The configuration tool will promptyou if your configuration is about to overwrite the metadata for an existinginstance.

Related concepts: Disk space requirements RAM requirements Port requirements Assessing disk space and memory requirements Sizing considerations for the staging store Creating queues in JMS providers Related tasks: To start InfoSphere CDC for Sybase databases (UNIX and Linux) Related reference: dmbackupmd - Back up metadata

63

1.

2.

3.

4.5.

6.

IBM InfoSphere Change Data Capture, Version 10.2 To edit an instance of InfoSphere CDC for Sybasedatabases (UNIX and Linux)

Stop InfoSphere® CDC by using the dmshutdown command. You cannot edit aninstance that is running.At the command prompt, launch the configuration tool by issuing the followingcommand from the <InfoSphere CDC Installation Directory>/bin directory:./dmconfigurets Enter 1 and press Enter to list the installed instances of InfoSphere CDC. Recordthe name of the instance you want to modify.Enter 3 and press Enter to modify an instance of InfoSphere CDC. Enter the number of the instance that you want to modify and press Enter.Theconfiguration tool allows you to edit a number of values that you specified whenadding an instance. After making your changes, enter 5 and press Enter to apply your changes andreturn to the main menu. Enter 6 and press Enter to discard your changes.

64

1.2.

3.

4.5.

IBM InfoSphere Change Data Capture, Version 10.2 To delete an instance of InfoSphere CDC for Sybasedatabases (UNIX and Linux)

Stop InfoSphere® CDC by using the dmshutdown command.At the command prompt, launch the configuration tool by issuing the followingcommand from the <InfoSphere CDC installation directory>/bin directory:./dmconfigurets Enter 1 and press Enter to list the installed instances of InfoSphere CDC. Recordthe name of the instance you want to delete.Enter 4 and press Enter to delete an instance of InfoSphere CDC.Enter the instance name that you want to delete and press Enter.

65

---

-

-

-

--

IBM InfoSphere Change Data Capture, Version 10.2 Configuring InfoSphere CDC for Sybase databasesfor OS (operating system) clustering (UNIX andLinux) InfoSphere® CDC supports Active/Passive two-node clusters on the UNIX andLinux platforms. Clustering provides continuous access to resources in the event ofa hardware failure, software failure, or some other interruption. To implement InfoSphere CDC clustering support in your environment, you mustcomplete all of the following prerequisite tasks. Note: Prerequisites that only apply to InfoSphere CDC as a clustered source or aclustered target are specified.

Install InfoSphere CDC on the shared drive of the cluster.Add a new instance of InfoSphere CDC.Ensure that the server port you specify during configuration of the instance isavailable and persistent on both nodes of the cluster. InfoSphere CDC listens onthis port.Ensure that all of the database logs required for replication are available. Thisprerequisite only applies to InfoSphere CDC as a clustered source.Ensure that every InfoSphere CDC source that connects to the target sees thetarget in the same way. The target must have a clustered IP address or use thesame host name for both nodes of the cluster. This prerequisite only applies toInfoSphere CDC as a clustered target.Optionally, schedule a regular backup of your InfoSphere CDC metadata andevent log messages. Note that metadata will only change when you add or modifysubscriptions. You can find more information about this prerequisite in the failoverprocedure for InfoSphere CDC in this section.

Note: You can run the dmshowlogdependency command with the –i flag to list thedatabase logs required for replication. In this section, you will learn:

Performing a forced or manual failover of InfoSphere CDC for Sybase databases Preparing for a failover of InfoSphere CDC for Sybase databases

Related concepts: Configuring InfoSphere CDC for Sybase databases instances (UNIX and Linux) Related tasks: To install InfoSphere CDC for Sybase databases (UNIX and Linux)

66

1.

2.

3.

4.

IBM InfoSphere Change Data Capture, Version 10.2 Performing a forced or manual failover ofInfoSphere CDC for Sybase databases A forced or manual failover is often necessary in a clustered environment forsoftware upgrades, maintenance, or other reasons. The tasks in the following stepsmust be included in your manual failover script.

Stop all instances of InfoSphere® CDC on the current active node with thefollowing command:dmshutdown -I <instance_name> Manually failover your clustered environment with the scripts or procedures thatare specific to your environment.Restart all instances on the new active node with the following commands for 32-bit and 64-bit operating systems:dmts32 - I <instance_name> or dmts64- I <instance_name> Start all subscriptions on the new active node with the dmstartmirror command.

Related concepts: Starting InfoSphere CDC for Sybase databases Stopping InfoSphere CDC for Sybase databases Related tasks: Preparing for a failover of InfoSphere CDC for Sybase databases Related reference: dmstartmirror - Start mirroring

67

1.

2.

3.

4.

5.6.

IBM InfoSphere Change Data Capture, Version 10.2 Preparing for a failover of InfoSphere CDC forSybase databases To prepare for a failover such as a hardware or software failure, your clusteringenvironment will require a script that performs InfoSphere® CDC tasks on the newactive node. The tasks in the following steps must be included in your failover script.

Clean the transaction queues for each instance by removing all files that beginwith txqueue* in the <InfoSphere CDC installation directory>/instance/<instancename>/txnstore directory.Back up your metadata for each instance by archiving all files that begin with md*in the <InfoSphere CDC installation directory>/instance/<instance name>/confdirectory. If the metadata database does not recover after a failover, restore thesefiles to the same directory on the new active node. This task is optional.Back up your Event Log messages for each instance by archiving all files in the<InfoSphere CDC installation directory>/instance/<instance name>/eventsdirectory. If the events database does not recover after a failover, restore thesefiles to the same directory on the new active node. This task is optional.Start each instance on the new active node with the following commands for 32-bit and 64-bit operating systems:dmts32 - I <instance_name> or dmts64- I <instance_name> Run the dmclearstagingstore command on the new active node for all instances.Start all subscriptions on the new active node with the dmstartmirror command.

Related concepts: Starting InfoSphere CDC for Sybase databases Related tasks: Performing a forced or manual failover of InfoSphere CDC for Sybase databases Related reference: dmstartmirror - Start mirroring

68

----

IBM InfoSphere Change Data Capture, Version 10.2 After you install and configure InfoSphere CDC forSybase databases Once you have installed and configured InfoSphere® CDC, you can start usingInfoSphere CDC. In this section, you will learn:

Starting InfoSphere CDC for Sybase databases Stopping InfoSphere CDC for Sybase databases Maintaining active TCP connections in a network environment Enabling SQL statements in Management Console

69

--

IBM InfoSphere Change Data Capture, Version 10.2 Starting InfoSphere CDC for Sybase databases When you install InfoSphere® CDC on a supported Windows server, you can start itmanually after the initial configuration. Starting InfoSphere CDC starts the servicesin Windows. The services will automatically start after a reboot. When you install InfoSphere CDC on a supported UNIX server, you can issue acommand to start it. After installing InfoSphere CDC, start it so that you can create adatastore for this instance in Management Console. See also:

To start InfoSphere CDC for Sybase databases (Windows) To start InfoSphere CDC for Sybase databases (UNIX and Linux)

70

1.

2.

IBM InfoSphere Change Data Capture, Version 10.2 To start InfoSphere CDC for Sybase databases(Windows)

At the command prompt, launch the configuration tool by issuing the followingcommand in the specified directory:\<InfoSphere CDC Installation Directory>\bin\dmconfigurets.exe In the Instances area, select the instance that you want to start and click Start.The configuration tool starts the instance of InfoSphere® CDC.

You can also use the Windows Services dialog to start and stop InfoSphere CDCservices.

71

--

IBM InfoSphere Change Data Capture, Version 10.2 To start InfoSphere® CDC for Sybase databases(UNIX and Linux) Depending on the operating system you are running, issue one of the following startcommands:

dmts32 - I <instance_name>dmts64 - I <instance_name>

Related tasks: To add a new instance of InfoSphere CDC for Sybase databases (UNIX and Linux)

72

--

IBM InfoSphere Change Data Capture, Version 10.2 Stopping InfoSphere CDC for Sybase databases It may be necessary to stop InfoSphere® CDC when you want to change theconfiguration settings, take a server or database offline for maintenance purposes,or if you want to upgrade InfoSphere CDC. You can use the configuration tool orcommands to stop InfoSphere CDC. See also:

To stop InfoSphere CDC for Sybase databases (Windows) To stop InfoSphere CDC for Sybase databases (UNIX and Linux)

73

1.

2.

3.

IBM InfoSphere Change Data Capture, Version 10.2 To stop InfoSphere CDC for Sybase databases(Windows)

End replication on all subscriptions in Management Console. For moreinformation on how to end replication on subscriptions, see your ManagementConsole documentation.Launch the configuration tool by issuing the following command in the specifieddirectory:\<InfoSphere CDC Installation Directory>\bin\dmconfigurets In the Instances area, select the instance that you want to stop and click Stop.The configuration tool stops the InfoSphere® CDC instance and services. Theservices will automatically start again after a reboot.

You can also use the Windows Services dialog to start and stop InfoSphere CDCservices.

74

1.

2.

IBM InfoSphere Change Data Capture, Version 10.2 To stop InfoSphere CDC for Sybase databases(UNIX and Linux)

End replication on all subscriptions in Management Console. For moreinformation on how to end replication on subscriptions, see your ManagementConsole documentation.Depending on how you want to stop InfoSphere® CDC, issue one of the followingstop commands in the bin directory in your InfoSphere CDC installation directory:

Option Descriptiondmshutdown [-I<instance_name>]

Use this command to gracefullyshut down InfoSphere CDC. Ifyou have multiple activeInfoSphere CDC installationson the same UNIX or Linuxserver, and you want to shutthem all down, run thiscommand from the installationdirectory for each InfoSphereCDC instance.

dmterminate [-L <locale>] Use this command to terminateall processes for all instancesrunning on a UNIXor Linuxserver. Use this command when youcannot completely shut downInfoSphere CDC using thedmshutdown command.

75

-

IBM InfoSphere Change Data Capture, Version 10.2 Maintaining active TCP connections in a networkenvironment If your deployment of InfoSphere® CDC is in a network environment that uses afirewall, VPN gateway, or local system tools to detect idle TCP connections, it maybe necessary to configure the product to prevent these connections from beingclosed during periods of application inactivity between the source and target. By default, InfoSphere CDC sends a message over TCP connections every 20seconds to ensure these connections remain active during periods of inactivity. Ifyour network policies close TCP connections for idle periods of less than 20seconds, you must change the configuration of each instance of InfoSphere CDC toensure the TCP connections remain open. See also:

To maintain active TCP connections

76

1.

2.3.

4.5.

IBM InfoSphere Change Data Capture, Version 10.2 To maintain active TCP connections

For each instance of InfoSphere® CDC, navigate to one of the followingdirectories depending on your operating system:UNIX or Linux: <CDC_installation_directory>/instance/<instance_name>/conf Windows:<CDC_installation_directory>\instance\<instance_name>\conf Open the comms.ini file in a text editor.Change the KEEP_ALIVE_TIMEOUT parameter to a value that is lower than thetime used to detect idle connections in your network. For example, if yournetwork disables idle TCP connections after 15 seconds, you can change theKEEP_ALIVE_TIMEOUT parameter to a value of 10 seconds:KEEP_ALIVE_TIMEOUT=10 Save the comms.ini file.For the changes to take effect, use the configuration tool to restart all instances ofInfoSphere CDC.

InfoSphere CDC will now send messages over the TCP connection every 10seconds.

77

-

IBM InfoSphere Change Data Capture, Version 10.2 Enabling SQL statements in Management Console InfoSphere® CDC lets you execute SQL statements after it applies a table-levelclear or refresh operation to a target table. You can specify SQL statements in theAdditional SQL dialog box in Management Console. By default, this feature isdisabled in InfoSphere CDC for security reasons. You can enable this feature bycreating a table called TS_SQL_EXECAUTH in the database where you installedInfoSphere CDC. The structure of the table is unimportant, and you must create thetable using the same schema as the metadata tables during the configuration ofInfoSphere CDC. For more information about specifying SQL statements inManagement Console, see Specifying SQL to control refresh operations in yourManagement Console documentation. See also:

To enable SQL statements in Management Console

78

1.

2.

IBM InfoSphere Change Data Capture, Version 10.2 To enable SQL statements in Management Console

Locate the database on the target server that you created for InfoSphere® CDC.Depending on how you are using InfoSphere CDC, this is the database you wantInfoSphere CDC to replicate to or from.Note: During installation, InfoSphere CDCplaces metadata tables in the database necessary for InfoSphere CDCprocesses. If you want to enable the specification of SQL statements, create a table namedTS_SQL_EXECAUTH in the database.Note: The table can have any structureand must be created in the schema you specified when you configuredInfoSphere CDC.

Related concepts: InfoSphere CDC for Sybase databases metadata tables

79

-

--

IBM InfoSphere Change Data Capture, Version 10.2 InfoSphere CDC for Sybase databases metadatatables InfoSphere® CDC maintains a set of metadata tables that represent data about yourcurrent replication configuration. These tables are created in the schema anddatabase that you specify in the configuration tool and should be part of the backupstrategy for your database. InfoSphere CDC will not replicate these tables. Do notmodify the contents of these tables unless requested to do so by your IBM®representative. The names of the metadata tables created by InfoSphere CDC are as follows:

TS_AUTHNote: For all users you added in the Access Manager perspective inManagement Console, make sure you give GRANT SELECT privileges to theTS_AUTH metadata table. TS_BOOKMARKTS_CONFAUD—The conflict resolution audit table records information aboutconflicts that were resolved using conflict detection and resolution.

Related concepts: Configuring InfoSphere CDC for Sybase databases (Windows) Configuring InfoSphere CDC for Sybase databases (UNIX and Linux)

80

IBM InfoSphere Change Data Capture, Version 10.2 Data types supported by InfoSphere CDC forSybase databases For information about data types supported by InfoSphere® CDC for Sybasedatabases, see Supported data types.

81

IBM InfoSphere Change Data Capture, Version 10.2 System parameters for InfoSphere CDC for Sybasedatabases For information about system parameters for InfoSphere® CDC for Sybasedatabases, see System parameters for InfoSphere CDC for Sybase databases.

82

----------

IBM InfoSphere Change Data Capture, Version 10.2 Commands for InfoSphere CDC for Sybasedatabases This section discusses the commands available with InfoSphere® CDC. Using thesecommands you can control replication, manage your tables for replication, monitorreplication, and perform various other tasks. In this section, you will learn:

Using the InfoSphere CDC for Sybase databases commands Setting the TSINSTANCE environment variable Continuous Capture commands Controlling replication commands Database transaction log commands Exporting and importing configuration commands Managing tables for replication commands Monitoring replication commands Single scrape and staging store commands Other commands

83

--

-

-

--

-

--

IBM InfoSphere Change Data Capture, Version 10.2 Using the InfoSphere CDC for Sybase databasescommands You can issue InfoSphere® CDC commands at a command line prompt or as part ofa batch file or shell script. Commands are case-sensitive in UNIX environments andare located in the bin directory of your InfoSphere CDC installation directory. Youmust run the commands from this directory. Note: Use the -? flag to list the available parameters for a command and a shortdescription of each parameter. For example, dmstartmirror -?. Command formats For each command, the following items of information are provided:

Syntax—Identifies the name of the command and lists the command parameters.Parameters—Describes each parameter in the command and identifies the valuesthat can be specified.Result—Indicates the values that are returned by the command if it is successful.These values can be useful for scripting. This section also specifies the informationthat is displayed on the screen, if any, as a result of executing the command.Examples—Provides one or more examples of invoking the command.

Parameter formats Note the following conventions in the definition of the command parameters:

Angle brackets ( < > ) indicate a mandatory parameter.Square brackets ( [ ] ) indicate an optional parameter. If you omit the parameter,InfoSphere CDC uses a default value.A vertical bar ( | ) separating one or more parameters indicate that only one of theparameters in the list can be used. When one or more vertical bars appear in a listof parameters that is enclosed by square brackets [ ], the choices are limited to theparameters in the list, but you have the option to not specify any of the parameters.Ellipsis ( ... ) means that a parameter or option can be repeated more than once.You can issue the commands in UNIX or Linuxor Windows.

84

-

-

IBM InfoSphere Change Data Capture, Version 10.2 Setting the TSINSTANCE environment variable Before using InfoSphere® CDC commands, you can set the TSINSTANCEenvironment variable to the name of your InfoSphere CDC instance. After you set the TSINSTANCE environment variable, you no longer have to specifythe instance name when issuing commands. Windows Issue the following command at the command prompt: SET TSINSTANCE=<instance_name> where:

<instance_name> is the name of your InfoSphere CDC instance. UNIX or Linux The following command is for kshell. You can run similar commands in other shells: export TSINSTANCE=<instance_name> where:

<instance_name> is the name of your InfoSphere CDC instance.

85

--

IBM InfoSphere Change Data Capture, Version 10.2 Continuous Capture commands Continuous Capture is a product feature that is designed to accommodate thosereplication environments in which it is necessary to separate the reading of thedatabase logs from the transmission of the logical database operations. This isuseful when you want to continue processing log data even if replication and yoursubscriptions stop due to issues such as network communication failures over afragile network, target server maintenance, or some other issue. You can enable ordisable Continuous Capture without stopping subscriptions. Continuous Capture allows you to avoid spikes in your source system CPU resourceutilization by continuing to process log data (and write to disk as necessary) evenwhen subscriptions are stopped. This feature allows you to avoid situations wherethe product uses no CPU when subscriptions are stopped and high CPU when youstart subscriptions after a prolonged target system outage. This functionality comes with the trade-off of additional disk utilization on the sourcemachine in order to accumulate changes from the database log file when these arenot being replicated to the target machine. These trade-offs should be evaluatedand understood before deciding to use this feature in your replication environment. To use the commands in this section that are applicable to Continuous Capture, youmust set the staging_store_can_run_independently system parameter to false.The default value for this parameter is true. See also:

dmenablecontinuouscapture - Enable Continuous Capture dmdisablecontinuouscapture - Disable Continuous Capture

86

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmenablecontinuouscapture - Enable ContinuousCapture Use this command to enable Continuous Capture for your staging store. Continuous Capture allows the InfoSphere® CDC log reader to continue operatingwhen communication with the target datastore is interrupted due to networkdifficulties or other issues. Upon resumption of communication with the target,Continuous Capture will reduce the latency between the source and targetdatastores. Syntax dmenablecontinuouscapture [-I <INSTANCE_NAME>] [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Related reference: dmdisablecontinuouscapture - Disable Continuous Capture dmgetstagingstorestatus - Retrieve Staging Store status

87

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmdisablecontinuouscapture - Disable ContinuousCapture Use this command to disable Continuous Capture for your staging store. Syntax dmdisablecontinuouscapture [-I <INSTANCE_NAME>] [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere® CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Related reference: dmenablecontinuouscapture - Enable Continuous Capture dmgetstagingstorestatus - Retrieve Staging Store status

88

---

IBM InfoSphere Change Data Capture, Version 10.2 Controlling replication commands This section contains commands that control replication in InfoSphere® CDC. See also:

dmendreplication - End replication dmrefresh - Refresh subscription dmstartmirror - Start mirroring

89

-----

-

-

-

--

IBM InfoSphere Change Data Capture, Version 10.2 dmendreplication - End replication Use this command to end refresh or mirroring on the specified subscriptions. Ending replication allows you to prepare for transitional activities in your businessenvironment and allows you to move to the next step in your business processes.Here are some examples of transitional activities in your business environment thatmay require an end to replication:

Initiating a database backup.Performing a regularly scheduled reboot of your source database server.Quiescing your database in preparation for an upgrade.Weekly batch processing has just completed.Preparing for off-line maintenance activities.

If you are replicating data continuously with Continuous mirroring and businessreasons arise that require an end to replication, InfoSphere® CDC provides multipleoptions that suit most business needs. If your business requirements dictate thatreplication must end at a particular point in your source database log because thetarget database must be in a known state when replication ends, you can choosefrom the following Scheduled End to replication options:

-se parameter—When specified without –t or –p, this parameter ends replication atthe current time in the source database log.-t parameter—When specified with –se, this parameter ends replication at a user-specified date and time.-p parameter—When specified with –se, this parameter ends replication at a user-specified log position.

An example of a scenario that might require these options is that you are populatinga reporting instance and you need stable (non-changing) data in your reportinginstance during the day. At the end of the day when you shut down your application,you can choose one of the Scheduled End (Net Change) options to update thereporting instance with data from the current day as well. If business requirements do not require a specific end point but do require a timeframe for ending replication, InfoSphere CDC provides escalating options (Normal,Immediate, and Abort) that end replication more rapidly at the expense of a slowerstart when resuming replication. For example, a routine end to replication with noparticular urgency may require the Normal option, whereas a sudden business needto end replication rapidly may require the Abort option. A routine reboot of a SANmight be appropriate for the Normal option, whereas a sudden and unexpectedhardware or application failure may require the Abort option. If you initiate an end to replication and business reasons warrant a change in thetime frame, you can reschedule the end of replication by specifying a new date andtime, a new position in the database log, or choose another option for endingreplication. Ending replication is also necessary if you want to update and make changes toyour subscription by:

Adding a table mapping to the subscription.Deleting a table mapping from the subscription.

90

--

-

--

--

--

Temporarily removing a table mapping from the subscription (parking a table).Modifying mapping details such as source and target column mappings, derivedcolumns, data translations, row and column selections, user exits, and so on.Updating the properties of a subscription when the structure of your source ortarget tables change.

This command also includes an asynchronous option for scripting (-nw parameter)that can be used with -se to allow your script to continue executing without waitingfor the Scheduled End to replication. You can also start and end replication in Management Console. For moreinformation, see Starting and ending replication. To stop an instance after ending replication on all subscriptions, use thedmshutdown command. Syntax dmendreplication [-I <INSTANCE_NAME>] [-c|-i|-a|-se [-t <date and time>|-p

<log position>] [-w|-nw]] <-A|-s <SUBSCRIPTION NAME ...>> [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the InfoSphere CDC instance for which you want to end replication.Alternatively, you can specify the TSINSTANCE environment variable in placeof this value.

-cSpecifies that InfoSphere CDC ends replication on the specified subscriptionswith the Normal option. InfoSphere CDC will use this option by default if you donot specify –se, -i, or –a.This option completes in progress work and then endsreplication. If a refresh is in progress, Normal will complete the refresh for thecurrent table before replication ends. Normal is the most appropriate option for most business requirements and isthe preferred method for ending replication in most situations.

-iSpecifies that InfoSphere CDC ends replication on the specified subscriptionswith the Immediate option.This option stops all in progress work and then endsreplication. Starting replication after using this option can be slower than using -c. If a refresh is in progress, the refresh for the current table will be interruptedand then replication will end. You should ensure that all dependent source database logs are availablebefore ending replication using the Immediate option. InfoSphere CDC mayneed to reprocess all the dependent source logs when you restart thesubscription. If InfoSphere CDC is currently processing a long runningtransaction when you end replication with Immediate, InfoSphere CDC mayhave to resume replication from the earliest open transaction in the databaselogs. Use the dmshowlogdependency command to determine which logs arerequired. Attention: Use this option if business reasons require replication to end fasterthan -c at the expense of a slower start when you resume replication on thespecified subscriptions.

91

--

--

--

--

--

--

--

-aSpecifies that InfoSphere CDC ends replication on the specified subscriptionswith the Abort option.This option stops all in progress work and then endsreplication rapidly. Starting replication after using this option can be muchslower than using -c. A refresh in progress will be interrupted and the target willstop processing any data that has not been committed before replication ends. You should ensure that all dependent source database logs are availablebefore ending replication using the Abort option. InfoSphere CDC may need toreprocess all the dependent source logs when you restart the subscription. IfInfoSphere CDC is currently processing a long running transaction when youend replication with Abort, InfoSphere CDC may have to resume replicationfrom the earliest open transaction in the database logs. Use thedmshowlogdependency command to determine which logs are required. Attention: Use this option if your business reasons require a rapid end toreplication and you are willing to tolerate a much slower start when you resumereplication on the specified subscriptions. A sudden business requirement for an unplanned shutdown of your sourcesystem may require this option for ending replication.

-seSpecifies that InfoSphere CDC will end replication normally at the currentsource system time in the source database log with the Scheduled End option.The source system time when replication will end is set when you issue thiscommand.If you specify the following parameters with -se, replication will end ata specific date and time or log position:

–t—End replication at a specific date and time in your source database log.–p—End replication at a specific log position in your source database log.

Note: As latency between the source and target increases, the amount of timerequired to end replication will also increase.

-t <date and time>Indicates the date and time in the source database log when replication will endwhen using –se. When specifying a value for this parameter, use the followingformat:“yyyy-MM-dd HH:mm” This parameter is optional when you specify –se.

-p <log position>Indicates that InfoSphere CDC will end replication at the specified Sybase logposition in your source database log when using -se.This parameter is optionalwhen you specify –se.

-wIndicates that this command will wait for replication to end when you use –se. –w is the default setting for a Scheduled End to replication.If you are scriptingthe command with this parameter, your script must wait for -se processing tocomplete before it continues to execute. Note: This parameter does not apply if you specify –c, -i, or –a. InfoSphereCDC will always wait if you specify –c, -i, or –a when ending replication.

-nwIndicates that this command will not wait for replication to end if you specify -se. If you are scripting this command, this parameter allows your script to

92

--

--

--

continue executing (asynchronous) if -se processing is not complete.-A

Indicates that InfoSphere CDC ends replication on all subscriptions.Use –s toend replication on one or more subscriptions.

-s <SUBSCRIPTION NAME>Indicates the subscriptions where InfoSphere CDC will end replication.Tospecify multiple subscriptions, list the subscriptions separated by a space. Forexample: Subscription1 Subscription2 Subscription3 You must specify a value for this parameter or use –A for all subscriptions.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isthe locale of the machine where InfoSphere CDC is installed.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmendreplication -I MYINSTANCE -c -s FINANCEInfoSphere CDC ends replicationwith the Normal option for the FINANCE subscription in the specified instance. dmendreplication -I MYINSTANCE –se –t “2010-02-05-00-00” FINANCE -nwInfoSphere CDC ends replication with the Scheduled End option for the FINANCEsubscription at the specified time in the source database log. The command exitsbefore Scheduled End processing is complete. dmendreplication -I MYINSTANCE –a –s SUBSCRIPTION1 SUBSCRIPTION2InfoSphere CDC ends replication with the Abort option for SUBSCRIPTION1 andSUBSCRIPTION2 in the specified instance.

93

--

--

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmrefresh - Refresh subscription Use this command to refresh the specified subscriptions. When you refresh asubscription, InfoSphere® CDC ensures that the target tables are synchronized withthe source tables. Typically, you would refresh target tables when you have set thereplication method to Refresh on your tables. However, you can also refresh target tables that have a replication method set toMirror and a status of Active or Refresh. When you refresh a table configured formirroring, InfoSphere CDC refreshes the target table so that it is synchronized withthe source table and then marks a table capture point as the starting point formirroring. This command exits after it has successfully refreshed the specified subscriptions. Ifyou terminate this program while it is still running, InfoSphere CDC ends replicationimmediately for the specified subscriptions. Syntax dmrefresh [-I <INSTANCE_NAME>] [-a|-f] <-A|-s <SUBSCRIPTION_NAME ...> [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the InfoSphere CDC instance for which you want to refresh one ormore subscriptions. Alternatively, you can specify the TSINSTANCEenvironment variable in place of this value.

-aSpecifies that InfoSphere CDC refreshes all target tables in the subscription.

-fSpecifies that InfoSphere CDC refreshes only target tables that are flagged forrefresh. If you omit both the -a and -f options, InfoSphere CDC assumes -f bydefault.

-ASpecifies that InfoSphere CDC refreshes all subscriptions.

-s <SUBSCRIPTION_NAME>Specifies that InfoSphere CDC refreshes the indicated subscription. To specifymultiple subscriptions, list the subscriptions separated by a space.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmrefresh -I NEWINSTANCE -a -s FINANCEInfoSphere CDC refreshes all targettables in the Finance subscription.

94

95

-

-

-

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmstartmirror - Start mirroring Issue this command from your InfoSphere® CDC source to start mirroring on thespecified subscriptions. This command starts mirroring for any table with areplication method of Mirror and a status of Refresh or Active. Tables with areplication method of Mirror and a status of Refresh are refreshed before mirroringbegins. InfoSphere CDC provides two types of mirroring for source tables that are mappedto target tables: Continuous (-c parameter) and Scheduled End (Net Change) (-nparameter). The type of mirroring you select depends on your business needs. As its name implies, Continuous mirroring replicates changes to the target on acontinuous basis. Use this type of mirroring when business requirements dictate thatyou need replication to be running continuously and you do not have a clearlydefined reason to end replication at the present time. Scheduled End (Net Change) mirroring replicates changes (to the target) up to auser-specified point in the source database log and then ends replication. Use thistype of mirroring when business requirements dictate that you only replicate yourdata periodically and you have a clearly defined end point for the state of your targetdatabase when replication ends. Scheduled End (Net Change) mirroring allows youto end replication at the following points in your source database log:

-n parameter—When specified without –tor –p, this parameter ends replication atthe current time in the source database log.-t parameter—When specified with –n, this parameter ends replication at a user-specified date and time.-p parameter—When specified with –n, this parameter ends replication at a user-specified log position.

These user specified end points ensure that your target database is in a known statewhen replication ends. You can also start and end replication in Management Console. For moreinformation, see Starting and ending replication. Syntax dmstartmirror [-I <INSTANCE_NAME>] [-c|-n [-t <date and time>|-p

<log position>] [-w|-nw]] <-A|-s <SUBSCRIPTION NAME ...> [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the InfoSphere CDC instance for which you want to start mirroring.Alternatively, you can specify the TSINSTANCE environment variable in placeof this value.

-cSpecifies that InfoSphere CDC will start Continuous mirroring on the specifiedsubscriptions.If you do not specify –c or -n, InfoSphere CDC will startContinuous mirroring by default on the specified subscriptions.

-nSpecifies that InfoSphere CDC mirrors all committed database changes in thesource database and then ends replication normally at the current source

96

--

--

--

--

--

--

--

--

system time in the database log with the Scheduled End option. The sourcesystem time when replication will end is set when you issue this command.Ifyou specify the following parameters with –n, replication will end at a specificdate and time or log position:

–t—End replication at a specific date and time in your source database log.–p—End replication at a specific log position in your source database log.

Note: As latency between the source and target increases, the amount of timerequired to end replication will also increase.

-t <date and time>Indicates the date and time in the source database log when replication will endwhen using –n. When specifying a value for this parameter, use the followingformat:“yyyy-MM-dd HH:mm” This parameter is optional when you specify –n.

-p <log position>Indicates that InfoSphere CDC will end replication at the specified Sybase logposition in your source database log when using -se.This parameter is optionalwhen you specify –n.

-wIndicates that this command will wait for replication to end when you use –n. –wis the default setting for a Scheduled End to replication.If you are scripting thecommand with this parameter, your script must wait for -n processing tocomplete before it continues to execute. This parameter does not apply if you specify –c for Continuous mirroring.

-nwIndicates that this command will not wait for replication to end if you specify -n.If you are scripting this command, this parameter allows your script to continueexecuting (asynchronous) if -n processing is not complete.This parameter doesnot apply if you specify –c for Continuous mirroring.

-AIndicates that InfoSphere CDC starts mirroring for all subscriptions.Use –s tostart mirroring for one or more subscriptions.

-s <SUBSCRIPTION_NAME>Indicates the subscriptions where InfoSphere CDC will start mirroring. Tospecify multiple subscriptions, list the subscriptions separated by a space. Forexample:Subscription1 Subscription2 Subscription3 You must specify a value for this parameter or use –A for all subscriptions.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isthe locale of the machine where InfoSphere CDC is installed.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmstartmirror -I MYINSTANCE -c -s FINANCEInfoSphere CDC starts continuousmirroring for the FINANCE subscription.

97

dmstartmirror -I MYINSTANCE –n –p “000000FB:000001A4:0001” –nw –AInfoSphere CDC starts mirroring with the Scheduled End option for all subscriptionsin the specified instance. Replication will end at the specified Microsoft SQL ServerLSN in the source database log. The command will not wait for Scheduled Endprocessing to complete. dmstartmirror -I MYINSTANCE –n –t “2010-02-05-00-00” FINANCE -nwInfoSphereCDC starts mirroring with the Scheduled End option for the FINANCE subscription inthe MYINSTANCE instance. Replication will end at the specified time in the sourcedatabase log. The command will exit before Scheduled End processing is complete.

98

----

IBM InfoSphere Change Data Capture, Version 10.2 Database transaction log commands This section contains commands that help you manage your database transactionlog or bookmarks. See also:

dmdecodebookmark - Display verbose information bookmark dmsetbookmark - Set bookmark dmshowbookmark - Display bookmark information dmshowlogdependency - Show Log Dependency

99

--

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmdecodebookmark - Display verbose informationbookmark Use this command to display verbose information about a bookmark. Syntax dmdecodebookmark [-I <INSTANCE_NAME>] (-b <bookmark> | -f <bookmark_file>)

[-d <database_version>] [-L <locale>] Parameters

-I <INSTANCE_NAME>The name of the InfoSphere® CDC instance. You can set the TSINSTANCEenvironment variable to the name of your InfoSphere CDC instance. After this iscomplete, you no longer have to specify the instance when issuing commands.

-b <bookmark>The bookmark as a hexadecimal-encoded string.

-f <bookmark_file>The bookmark file as a binary file.

-d<database_version>The database and version that generated the bookmark specified, if thebookmark was generated by InfoSphere CDC version 6.2 or earlier.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmdecodebookmark -f bookmark.txtInfoSphere CDC displays information about thebookmark stored in the bookmark.txt file.

100

--

--

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmsetbookmark - Set bookmark CAUTION: Improper use of this command can result in data loss or data duplication. Youshould only execute this command when directed by IBM Technical Support. Use this command on your InfoSphere® CDC source system to set the replicationposition (bookmark) in the stream of change data for a subscription. You can obtainthe replication position for a subscription with the dmshowbookmark command,which is executed on your InfoSphere CDC target system. Syntax dmsetbookmark [-I <INSTANCE_NAME>] -s <SUBSCRIPTION_NAME ...> (-b <bookmark> | -f

<bookmark_file_name>) [-a] [-L <locale>] Parameters

-I <INSTANCE_NAME>The name of the InfoSphere CDC instance. You can set the TSINSTANCEenvironment variable to the name of your InfoSphere CDC instance. After this iscomplete, you no longer have to specify the instance when issuing commands.

-s <SUBSCRIPTION_NAME>The name of the subscription for which InfoSphere CDC sets a replicationposition (bookmark).

-b <bookmark>Indicates the replication position (bookmark) which determines the point in thedatabase log where you want InfoSphere CDC to resume mirroring. Whenmirroring resumes, InfoSphere CDC will start capturing change data at theindicated replication position. The replication position is a hexadecimal-encodedstring that is obtained from the dmshowbookmark command.

-f <bookmark_file_name>Indicates the name of the binary or XML file that contains all replication position(bookmark) information which determines the point in the database log whereyou want InfoSphere CDC to resume mirroring. When mirroring resumes,InfoSphere CDC will start capturing change data at the replication positionindicated in the file.You can specify an absolute path for the location of the file.If you do not specify an absolute path, you must place the file in the InfoSphereCDC installation directory. InfoSphere CDC will auto-detect the binary or XMLformat of the file.Note: If your source database is DB2® for LUW and isconfigured for DPF, you can generate the XML file used by this parameter byusing the dmshowbookmark command on your InfoSphere CDC target with the-x parameter.

-aSets all tables in the subscriptions (except for parked tables) as active as of thenew replication position (bookmark). If you do not specify this value,InfoSphere CDC will use -a by default.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

101

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails Examples dmsetbookmark -I MYINSTANCE -b 6578616d706c65 -s FINANCEInfoSphere CDCsets a replication position (bookmark) for the Finance subscription for the specifiedinstance. This command specifies that mirroring will resume at the indicatedreplication position in the database log. dmsetbookmark -I MYINSTANCE -f bookmark -s FINANCEInfoSphere CDC sets areplication position (bookmark) for the Finance subscription for the specifiedinstance. This command specifies that mirroring will resume at the replicationposition (bookmark) contained in the bookmark file. InfoSphere CDC will auto-detectthe XML or binary format of the file. The file is located in InfoSphere CDC installationdirectory since no absolute path is specified.

102

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmshowbookmark - Display bookmark information CAUTION: Improper use of this command in conjunction with the dmsetbookmark commandcan result in data loss or data duplication. You should only execute thedmsetbookmark command when directed by IBM Technical Support. Use this command on your InfoSphere® CDC target system to obtain the replicationposition (bookmark) in the stream of change data for a subscription. After generatingthe replication position information with this command, you can use thedmsetbookmark command on the source system to set the replication position for asubscription. Syntax dmshowbookmark [-I <INSTANCE_NAME>] -s <SOURCE_ID>

[-f <bookmark_file_name>] [-x <bookmark_file_name>] [-v] [-L <locale>] Parameters

-I <INSTANCE_NAME>The name of the InfoSphere CDC instance. You can set the TSINSTANCEenvironment variable to the name of your InfoSphere CDC instance. After this iscomplete, you no longer have to specify the instance when issuing commands.

-s <SOURCE_ID>Specifies the source ID of the subscription for which you want to obtain thereplication position (bookmark).Source IDs are automatically generated basedon truncating the subscription name to 8 characters during subscriptioncreation. Source IDs must be unique.

-f <bookmark_file_name>Specifies the name of the binary file that will be generated by this command.The generated file contains information about the replication position(bookmark) for the specified subscription. You can specify an absolute path for the location where you want to create thefile. If you do not specify an absolute path, the file is created in the InfoSphereCDC installation directory. Use the -f parameter in the dmsetbookmark command to read the binary filegenerated by this parameter. Note: Use the -x parameter if you are issuing this command from the target of aDB2® for LUW DPF source environment.

-x <bookmark_file_name>Specifies the name of the XML file that will be generated by this command. Thegenerated file contains information about the replication position (bookmark) forthe specified subscription. Use this parameter if you are replicating from a DB2for LUW DPF source environment. The XML file contains replication positions(bookmarks) for all partitions.You can specify an absolute path for the locationwhere you want to create the file. If you do not specify an absolute path, the fileis created in the InfoSphere CDC installation directory. Use the -f parameter in the dmsetbookmark command to read the XML filegenerated by this parameter.

103

--

--

-vDisplays verbose information about the replication position (bookmark),including a hexadecimal-encoded string. The amount of information displayeddepends on the type and version of the source engine. The hexadecimal-encoded string is always displayed. This parameter displays a subset of whatthe dmdecodebookmark command displays. If not specified, only ahexadecimal-encoded string is displayed.Note: Use the -x parameter if you areissuing this command from the target of a DB2 LUW DPF source environment.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmshowbookmark -I MYINSTANCE -s MASTER -f bookmarkInfoSphere CDCobtains the replication position (bookmark) information for the specified instance andthe MASTER source ID. Replication position (bookmark) information is contained inthe bookmark binary file which will be placed in the InfoSphere CDC installationdirectory since no absolute path has been specified. dmshowbookmark -I MYINSTANCE -s FINANCE -x mybookmarksInfoSphere CDCobtains the replication position (bookmark) information for the specified instance andthe FINANCE source ID. Replication position (bookmark) information is contained inthe mybookmarks XML file which will be placed in the InfoSphere CDC installationdirectory since no absolute path has been specified.

104

---

-

--

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmshowlogdependency - Show Log Dependency Use this command to display information about source database logs in order toimplement a log retention policy. For a specified instance of InfoSphere® CDC, youcan display:

A list of all the logs that are required for the specified instance.The earliest open transaction in the log for the specified instance.The logs which contain the position confirmed by the target database for thespecified instance.The logs which contain the position the specified instance is reading from.

You must issue this command on your InfoSphere CDC source system. Syntax dmshowlogdependency [-I <INSTANCE_NAME>] ( -i | -t | -l)[-c]

(-s <SUBSCRIPTION_NAME> | -A | -a) [-v] [-L <locale>] Parameters

-I <INSTANCE_NAME>The name of the InfoSphere CDC instance. You can set the TSINSTANCEenvironment variable to the name of your InfoSphere CDC instance. After this iscomplete, you no longer have to specify the instance when issuing commands.

-cConsiders the current position instead of the restart position.

-iDisplays the complete list of required source database logs for the specifiedinstance. These logs are required to start replication and contain data that hasnot been applied to the target. If you specify -A, the command considers allsubscriptions and displays a list of logs required to start replication on allsubscriptions. If you specify -s, the command displays a list of logs required tostart replication on the specified subscription. If you decide to use -a, then thecommand displays a list of logs required to start replication for each individualsubscription. Each list contains logs required for the correspondingsubscription.

-tDisplays the source database log which contains the position confirmed by thetarget database. If you specify -A, the command considers all subscriptions anddisplays the oldest log. If you specify -s, the command displays the log for thespecified subscription. If you decide to use -a, then the command displays onelog for each subscription. Each log contains the position confirmed by the targetdatabase for the corresponding subscription.

-lDisplays the source database log which contains the position InfoSphere CDCis reading from. If you specify -A, the command considers all subscriptions anddisplays the oldest log. If you specify -s, the command displays the log for thespecified subscription. If you decide to use-a, then the command displays onelog for each subscription. Each log contains the position for the correspondingsubscription.

105

-

--

--

--

--

--

Accurate information about where in the log InfoSphere CDC is reading will onlybe provided if there is a steady stream of in scope data being applied andcommitted on the source database

-s <SUBSCRIPTION_NAME>Displays a source database log or a list of logs for the specified subscription.

-ADisplays a source database log or a list of logs for all subscriptions.

-aDisplays a source database log or a list of logs for each individual subscription.

-vSpecifies verbose output (otherwise, the output is formatted for scripting).

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. The command can also print as NULL if there are notables defined in the subscription. Examples dmshowlogdependency -I MYINSTANCE -i -s MYSUBSCRIPTIONNAMEDisplaysthe complete list of required source database logs for the specified instance andsubscription. dmshowlogdependency -I MYINSTANCE -ADisplays the complete list of requiredsource database logs for all subscriptions in the specified instance.

106

--

IBM InfoSphere Change Data Capture, Version 10.2 Exporting and importing configuration commands This section contains commands that allow you to export and/or import yourInfoSphere® CDC global configuration. See also:

dmexportconfiguration - Export InfoSphere CDC Configuration dmimportconfiguration - Import InfoSphere CDC Configuration

107

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmexportconfiguration - Export InfoSphere CDCConfiguration Use this command to export the configuration details of an installed instance ofInfoSphere® CDC. Configuration details are sent to an XML configuration file. Youcan use the dmimportconfiguration command to import the XML file that you createwith this command into another instance of InfoSphere CDC. Note: This command does not export subscription-specific settings that areconfigured in Management Console. Subscription-specific settings can be exportedto an XML file in Management Console. Note: This command is interactive and will prompt you for your password. Youcannot script this command. Syntax dmexportconfiguration <absolute_path_to_configuration_file> [-L <locale>] Parameters

<absolute_path_to_configuration_file>The absolute path to the XML configuration file that you want to export.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmexportconfiguration c:\configuration.xmlInfoSphere CDC exports the XML file tothe specified absolute path. Related reference: dmimportconfiguration - Import InfoSphere CDC Configuration

108

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmimportconfiguration - Import InfoSphere CDCConfiguration Use this command to import the InfoSphere® CDC configuration settings from anXML file which you created with the dmexportconfiguration command. Note: You can script this command and use an InfoSphere CDC silent installation todeploy InfoSphere CDC on multiple systems. Syntax dmimportconfiguration <absolute_path_to_configuration_file> [-L <locale>] Parameters

<absolute_path_to_configuration_file>The absolute path to the XML configuration file that you are importing.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmimportconfiguration c:\configuration.xml InfoSphere CDC imports the XML configuration file from the specified absolute path. Related reference: dmexportconfiguration - Export InfoSphere CDC Configuration

109

-------

IBM InfoSphere Change Data Capture, Version 10.2 Managing tables for replication commands This section contains commands that help you manage the tables that you want toreplicate with InfoSphere® CDC. See also:

dmdescribe - Describe source tables dmflagforrefresh - Flag for Refresh dmmarktablecapturepoint - Mark a table capture point on a source table dmpark - Park table dmreaddtable - Update source table definition dmreassigntable - Update target table definition dmsetreplicationmethod - Set replication method

110

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmdescribe - Describe source tables Use this command to send source table metadata changes over to the target. This command exits after it has successfully described the specified subscriptions. Syntax dmdescribe [-I <INSTANCE_NAME>] <-A|-s <SUBSCRIPTION_NAME ...> [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the InfoSphere® CDC instance for which you want to send sourcemetadata changes over to the target. Alternatively, you can specify theTSINSTANCE environment variable in place of this value.

-ASpecifies that InfoSphere CDC will send source metadata changes made to allsubscriptions over to the target.

-s <SUBSCRIPTION_NAME>Specifies that InfoSphere CDC sends source metadata changes for theindicated subscriptions over to the target. To specify multiple subscriptions, listthe subscriptions separated by a space.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmdescribe -I NEWINSTANCE -s FINANCEInfoSphere CDC sends sourcemetadata changes in the Finance subscription over to the target for the specifiedinstance.

111

--

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmflagforrefresh - Flag for Refresh Use this command to flag a source table for refresh. When you flag a table forrefresh, you are selecting the tables that you want to refresh at a future point in time. Syntax dmflagforrefresh [-I <INSTANCE_NAME>] -s <SUBSCRIPTION_NAME ...>

<-A|-t <schema>.<table> ...> [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere® CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-s <SUBSCRIPTION_NAME>Specifies the name of the subscription. To specify multiple subscriptions, list thesubscriptions separated by a space.

-ASpecifies that InfoSphere CDC flags all source tables for refresh in thesubscription.

-t <schema>.<table>Specifies the name of a source table in the subscription that InfoSphere CDCflags for refresh. You must specify the table name in the format schema.table.To specify multiple tables, list the tables separated by a space.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmflagforrefresh -I MYINSTANCE -s FINANCE -AInfoSphere CDC flags for refreshall source tables in the Finance subscription for the specified instance.

112

--

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmmarktablecapturepoint - Mark a table capturepoint on a source table Use this command to mark a table capture point on a source table and change thestatus of the table to Active. If you changed the table before executing thiscommand, those changes will not be replicated. Mark a table capture point on a source table when you want to override an existingposition in the stream of changed data. This is possible when you have alreadysynchronized (refreshed) your source and target tables using an application otherthan InfoSphere® CDC (for example, using the import or export capabilities of yourdatabase platform) and you know the point in time your source and target aresynchronized with each other. InfoSphere CDC mirrors changes to the target tablefrom the current position in the stream of changed data. This position is set byInfoSphere CDC when you select Mirror (Change Data Capture) after mapping yourtables in the Map Tables wizard. If you want to override the position set byInfoSphere CDC, then you can manually mark a table capture point in ManagementConsole. When you decide to start mirroring on the subscription, InfoSphere CDCidentifies the position you have set as the point in time from which to capture andreplicate database changes to the target. Syntax dmmarktablecapturepoint [-I <INSTANCE_NAME>] -s <SUBSCRIPTION_NAME ...>

-A|-t <<schema>.<table>...> [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-s <SUBSCRIPTION_NAME>Specifies the subscription name. To specify multiple subscriptions, list thesubscriptions separated by a space.

-ASpecifies that InfoSphere CDC overrides an existing position in the stream ofchanged data on all source tables in the subscription.

-t <schema>.<table>Specifies the name of a source table in the subscription on which InfoSphereCDC marks a table capture point. You must specify the table name in theformat schema.table. To specify multiple tables, list the tables separated by aspace.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples

113

dmmarktablecapturepoint -I MYINSTANCE -s FINANCE -AInfoSphere CDC sets thestatus of all tables in the Finance subscription to Active. dmmarktablecapturepoint -I MYINSTANCE -s ACCOUNTING -t myschema.mytableInfoSphere CDC sets the status of the specified table in the Accounting subscriptionto Active.

114

--

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmpark - Park table Use this command to park a source table. By parking a source table, you tellInfoSphere® CDC that you do not want to capture changes for that particular tablein a subscription. When you park a table, InfoSphere CDC does not replicate anysubsequent changes you make on the source table, which may result in inconsistentsource and target tables. Note: Before you can park a source table, if you are mirroring the table to the target,then you need to end replication on the subscription. For more information, see thedmendreplication command. Syntax dmpark [-I <INSTANCE_NAME>] -s <SUBSCRIPTION_NAME ...> <-A|-t <schema>.<table> ...>

[-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-s <SUBSCRIPTION_NAME>Specifies the subscription name. To specify multiple subscriptions, list thesubscriptions separated by a space.

-ASpecifies that InfoSphere CDC parks all source tables in the subscription.

-t <schema>.<table>Specifies the name of a source table in the subscription that InfoSphere CDCparks. You must specify the table name in the format schema.table. To specifymultiple tables, list the tables separated by a space.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmpark -I MYINSTANCE -s FINANCE -AInfoSphere CDC parks all source tables inthe Finance subscription. Related reference: dmendreplication - End replication

115

116

-

-

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmreaddtable - Update source table definition Use this command to update the definition of one or more source tables in theInfoSphere® CDC metadata. Run this command after you have changed thedefinition of a source table using your relational database. Notes:

This command will set the table status to Parked after updating the source tabledefinition in the InfoSphere CDC metadata. This command is not the equivalent of the Management Console Update SourceTable Definition dialog, which you access by selecting Configuration >Subscriptions > <subscription_name>, then right-clicking the table mapping nameunder Table Mappings, and then selecting Update Table Definition > Source Table.

Note: Syntax dmreaddtable [-I <INSTANCE_NAME>] <-A|-t <schema>.<table> ...> [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-ASpecifies that InfoSphere CDC updates definitions for all source tables that areavailable for replication.

-t <schema>.<table>Specifies the name of a source table in the subscription for which InfoSphereCDC updates the definition. You must specify the table name in the formatschema.table. To specify multiple tables, list the tables separated by a space.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmreaddtable -I NEWINSTANCE -AInfoSphere CDC updates definitions for allsource tables that are available for replication. The status for all tables will be set toParked.

117

--

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmreassigntable - Update target table definition Use this command to update the definition of a target table in InfoSphere® CDCmetadata after you change the definition of the target table in your database. Syntax dmreassigntable [-I <INSTANCE_NAME>] -s <SUBSCRIPTION_NAME ...>

<-A|-t <schema>.<table> ...> [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-s <SUBSCRIPTION_NAME>Specifies the subscription that contains the source table that is mapped to thetarget table which was updated in your database. To specify multiplesubscriptions, list the subscriptions separated by a space.

-ASpecifies that InfoSphere CDC updates definitions for all target tables in thesubscription.

-t <schema>.<table>Specifies the name of a source table in the subscription that is mapped to thetarget table for which InfoSphere CDC updates the table definition in themetadata. You must specify the table name in the format schema.table. Tospecify multiple tables, list the tables separated by a space.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the operation was successful. If it fails, thiscommand returns a non-zero value. Example dmreassigntable -I NEWINSTANCE -s FINANCE -AInfoSphere CDC updatesdefinitions for all target tables in the Finance subscription. dmreassigntable -I CDCINSTANCE -s FINANCE -t SCHEMA1.SRCTBL1InfoSphere CDC updates the definition for the target table that is mapped to theSCHEMA1.SRCTBL1 source table in the Finance subscription.

118

--

--

--

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmsetreplicationmethod - Set replication method Use this command to change the replication method for tables in a subscription.When running this command, InfoSphere® CDC changes the status of any Activetables to Refresh. Note: Before you run this command, you must end replication on the subscription. Syntax dmsetreplicationmethod [-I <INSTANCE_NAME>] <-r|-m> -s <SUBSCRIPTION_NAME ...>

<-A|-t <schema>.<table> ...> [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-mSpecifies that tables will use Mirror (Change Data Capture) as the replicationmethod.

-rSpecifies that tables will use Refresh (Snapshot) as the replication method.

-s <SUBSCRIPTION_NAME>Specifies the name of the subscriptions. To specify multiple subscriptions, listthe subscriptions separated by a space.

-ASpecifies that all tables in the subscription will use the indicated replicationmethod.

-t <schema>.<table>Specifies the name of a source table in the subscription that will use theindicated replication method. You must specify the table name in the formatschema.table. To specify multiple tables, list the tables separated by a space.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmsetreplicationmethod -I MYINSTANCE -r -s FINANCE -AAll tables in the Financesubscription will use Refresh as the replication method in the specified InfoSphereCDC instance. dmsetreplicationmethod -I NEWINSTANCE -m -s FINANCE -t acct.taxcodesThesource table acct.taxcodes in the Finance subscription will use Mirror as thereplication method in the specified InfoSphere CDC instance.

119

120

---

IBM InfoSphere Change Data Capture, Version 10.2 Monitoring replication commands This section contains commands that help you monitor replication in InfoSphere®CDC. See also:

dmclearevents - Clear events dmgetsubscriptionstatus - Get subscription status dmshowevents - Display InfoSphere CDC events

121

--

--

--

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmclearevents - Clear events Use this command to delete events from the Event Log view in ManagementConsole. Syntax dmclearevents [-I <INSTANCE_NAME>] [-S|-T-|-B] <-A|-s <SUBSCRIPTION_NAME ...>

[-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere® CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-SSpecifies that InfoSphere CDC clears events from the source.

-TSpecifies that InfoSphere CDC clears events from the target.

-BSpecifies that InfoSphere CDC clears events from both the source and target. Ifnone of the S, T, and B options are specified, InfoSphere CDC assumes B bydefault.

-ASpecifies that InfoSphere CDC clears events for all subscriptions.

-s <SUBSCRIPTION_NAME>Specifies that InfoSphere CDC clears events for the indicated subscription. Tospecify multiple subscriptions, list the subscriptions separated by a space.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmclearevents -I MYINSTANCE -S -AInfoSphere CDC clears events from thesource for all subscriptions for the specified instance. dmclearevents -I MYINSTANCE -B -s FINANCE MARKETINGInfoSphere CDCclears events from both the source and target for the Finance and Marketingsubscriptions for the specified instance.

122

--

--

--

--

--

----

IBM InfoSphere Change Data Capture, Version 10.2 dmgetsubscriptionstatus - Get subscription status Issue this command on the InfoSphere® CDC source engine to retrieve statusinformation for one or more subscriptions and send the results to standard output. Please note that this command can be issued on Linux, UNIX and Windows sourcereplication engines only, not on target replication engines. Syntax dmgetsubscriptionstatus [-I <INSTANCE_NAME>] [-p] <-A|-s <SUBSCRIPTION_NAME ...>

[-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-pSpecifies that InfoSphere CDC sends status information to standard output.

-ASpecifies that InfoSphere CDC retrieves status information for all subscriptions.

-s <SUBSCRIPTION_NAME>Specifies the name of the subscription for which status information is retrieved.To specify multiple subscriptions, list the subscriptions separated by a space.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns one of the following statuses for each subscription:

Recovering—The subscription is in an undetermined state.Idle—The subscription is not running.Starting—The subscription is in start up mode and is not currently replicating data.Running—The subscription is running and replicating data.

Examples dmgetsubscriptionstatus -I MYINSTANCE -p -AInfoSphere CDC retrieves statusinformation for all subscriptions and sends the results to standard output for thespecified instance.

123

--

--

--

--

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmshowevents - Display InfoSphere CDC events Use this command to display InfoSphere® CDC events to standard output. You canuse this command as an alternative to showing InfoSphere CDC events in theEvent Log view in Management Console. The output of this command shows events in chronological order with the mostrecent event shown first in the list. Syntax dmshowevents [-I <INSTANCE_NAME>] <-a|-s <SUBSCRIPTION_NAME> ...

|-t <SOURCE_ID> ...|-s <SUBSCRIPTION_NAME> ... -t <SOURCE_ID> ...> [-h] [-c max_msg]

[-L <locale>] or dmshowevents -I <INSTANCE_NAME> <-a|-s <SUBSCRIPTION_NAME>|-t

<SOURCE_ID>> ...> [-h] [-c <max_msg>] [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-aSpecifies that InfoSphere CDC shows events for all subscriptions.

-s <SUBSCRIPTION_NAME>Specifies the name of the subscription for which InfoSphere CDC displayssource events. To specify multiple subscriptions, list the subscriptionsseparated by a space.

-t <SOURCE_ID>Specifies the source ID of the subscription for which InfoSphere CDC displaystarget events. List the source IDs if you specify more than one.Source IDs areautomatically generated based on truncating the subscription name to 8characters during subscription creation. Source IDs must be unique.

-hSpecifies that InfoSphere CDC displays a header before the list of events. Thisoption helps you identify each item of information that is displayed for eachevent.

-c <max_msg>Specifies the maximum number of events that InfoSphere CDC displays. If youomit this parameter or you specify a value greater than the total number ofevents, InfoSphere CDC displays all events for the specified subscriptions andsource IDs.

Minimum Setting—0. No events are shown.Maximum Setting—2147483647

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the operation was successful. If it fails, this

124

command returns a non-zero value. Examples dmshowevents -I NEWINSTANCE -s FINANCEInfoSphere CDC displays all eventsfor the Finance subscription for the specified instance. dmshowevents -I MYINSTANCE –a –hInfoSphere CDC displays all events for allsubscriptions. A header is displayed before the list of events for the specifiedinstance. dmshowevents -I NEWINSTANCE –s FINANCE MARKETING –t ATLANTA –h –c20InfoSphere CDC displays the most recent 20 events for the Finance andMarketing subscriptions and for the Atlanta source ID. A header is displayed beforethe list of events for the specified instance. Sample output TIME|AGENTTYPE|SUBSCRIPTION|EVENTID|SEVERITY|EVENTPROGRAM|EVENTTEXT

2006-04-21 17:23:08.817|T|ATLANTA|95|Information|class com.datamirror.ts.target.

publication.c|IBM InfoSphere Change Data Capture Communications ending.

2006-04-21 17:23:08.614|T|ATLANTA|1538|Information|class com.datamirror.ts.target.

publication.c|---IBM InfoSphere Change Data Capture for ATLANTA terminating

normally.

2006-04-21 17:23:08.333|T|ATLANTA|1537|Information|class com.datamirror.ts.target.

publication.c|Describe conversation with ATLANTA completed successfully.

2006-04-21 17:23:07.911|T|ATLANTA|1536|Information|class com.datamirror.ts.target.

publication.c|Describe conversation started by ATLANTA.

2006-04-21 17:23:07.333|T|ATLANTA|1531|Information|class com.datamirror.ts.target.

publication.c|Communication with ATLANTA successfully started on Data channel.

2006-04-21 17:23:06.973|T|ATLANTA|1534|Information|class com.datamirror.ts.engine.a

|Code page conversation from the source database's code page 1252 to the target

database's code page Cp1252 for ATLANTA will be performed by the Remote system Fields in each record are separated by vertical bars ( | ). These fields are identifiedin the first line of the output. In the AGENTTYPE field, S indicates source and Tindicates target.

125

--

IBM InfoSphere Change Data Capture, Version 10.2 Single scrape and staging store commands The InfoSphere® CDC staging store is located on your source server and is a cacheof change data read from the database logs. The size of the staging store willincrease as the product accumulates change data, and therefore you must plan yoursource environment accordingly, particularly disk space. See also:

dmclearstagingstore - Remove cached operations from the staging store dmgetstagingstorestatus - Retrieve Staging Store status

126

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmclearstagingstore - Remove cached operationsfrom the staging store Use this command to remove all the contents from the InfoSphere® CDC stagingstore on your source system. The staging store is used to provide a cache ofchange data that is read from the database logs. There may be times when thecontents of the staging store are no longer valid and InfoSphere CDC will giveinstructions to clear the staging store with this command. Syntax dmclearstagingstore [-I <INSTANCE_NAME>] [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the operation was successful. If it fails, thiscommand returns a non-zero value.

127

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmgetstagingstorestatus - Retrieve Staging Storestatus Use this command to retrieve status information for the InfoSphere® CDC stagingstore on your source system and the Continuous Capture feature. Syntax dmgetstagingstorestatus [-I <INSTANCE_NAME>] [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Related reference: dmenablecontinuouscapture - Enable Continuous Capture dmdisablecontinuouscapture - Disable Continuous Capture

128

------------

IBM InfoSphere Change Data Capture, Version 10.2 Other commands This section contains miscellaneous commands that allow you to determine theversion of InfoSphere® CDC, verify communications, stop InfoSphere CDC, setsystem parameters, and back up your metadata. See also:

dmbackupmd - Back up metadata dmconfigurets - Configure InfoSphere CDC dmflusharchivehistory - Flush archive log history dmmdconsole dmmdcommander dmset - Set InfoSphere CDC system parameter dmshowversion - Show InfoSphere CDC version dmshutdown - Shut down InfoSphere CDC dmsupportinfo - Collect IBM Support information dmterminate - Terminate InfoSphere CDC processes dmts32 - Start InfoSphere CDC dmts64 - Start InfoSphere CDC

129

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmbackupmd - Back up metadata Use this command to create a backup of the InfoSphere® CDC metadata databasewhich contains information about your current replication configuration. You shouldalways back up your metadata when there are changes to your subscriptionconfiguration and table status. You can only back up your metadata whileInfoSphere CDC is running. The backup of the metadata database is created in <Installation_directory>/instance/<instance_name>/conf/backup for UNIX and Linux and in<Installation_directory>\instance\<instance_name>\conf\backup for Windows. Thefiles in the backup directory should be stored on separate media for possiblerecovery. Syntax dmbackupmd [-I <INSTANCE_NAME>] [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails.

130

--

IBM InfoSphere Change Data Capture, Version 10.2 dmconfigurets - Configure InfoSphere CDC Use this command to launch the InfoSphere® CDC configuration tool. You can usethis tool to create instances and configure your installation of InfoSphere CDC. If the DISPLAY environment variable has been set, the configuration tool willattempt to launch the graphical user interface (GUI) version of the configuration toolwhen this command is issued. If you do not have the graphical libraries installed toview the GUI, you will need to ensure that the DISPLAY environment variable hasbeen cleared in order to launch the command line version. Syntax dmconfigurets [-L <locale>] Parameters

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails.

131

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmflusharchivehistory - Flush archive log history Use this command to remove the archive log history from InfoSphere® CDCmemory. Run this command in situations where the archive logs are placed in the archive logdirectory by mistake and then deleted. The names of the deleted archive logs arestored in InfoSphere CDC memory and must be removed from memory since theyare no longer part of the archive log chain. Note: You must end replication on all subscriptions before executing this command. Syntax dmflusharchivehistory [-I <INSTANCE_NAME>] [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmflusharchivehistory -I FINANCE Removes the archive log history from InfoSphere CDC memory for the FINANCEinstance.

132

IBM InfoSphere Change Data Capture, Version 10.2 dmmdconsole This command is for internal use only.

133

IBM InfoSphere Change Data Capture, Version 10.2 dmmdcommander This command is for internal use only.

134

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmset - Set InfoSphere CDC system parameter Use this command to view or change InfoSphere® CDC system parameters. Youcan also change system parameters in Management Console. Note: You can set any system parameter using this command. However, it will onlydisplay system parameters that are set to non-default values. Syntax dmset [-I <INSTANCE_NAME>] [<parameter_name>[=[<parameter_value>]]] [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

<parameter_name>Specifies the name of the InfoSphere CDC system parameter.

<parameter_value>Specifies the value that you want to assign to the system parameter.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmset -I MYINSTANCEDisplays all of the system parameters that are set to non-default values. dmset -I MYINSTANCE events_max_retain=20000Sets the events_max_retainsystem parameter to 20000. dmset -I MYINSTANCE events_max_retainDisplays the current value of thespecified parameter. dmset -I MYINSTANCE stop_replication=Deletes the stop_replication systemparameter.

135

--

IBM InfoSphere Change Data Capture, Version 10.2 dmshowversion - Show InfoSphere CDC version Use this command to display the InfoSphere® CDC version and build number. Runthis command before you contact your IBM® representative. Syntax dmshowversion [-L <locale>] Parameters

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the operation was successful. If it fails, thiscommand returns a non-zero value.

136

--

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmshutdown - Shut down InfoSphere CDC Use this command to stop an instance of InfoSphere® CDC and end replication onall subscriptions that use the instance as a source. This command is often usedprior to taking a server or database offline for maintenance purposes or upgradingInfoSphere CDC. Note: As a best practice before you run this command and to ensure that itcompletes successfully, use the dmendreplication command to end replication on allsubscriptions that use the specified instance as a source and as a target. Thiscommand will not complete successfully if target subscriptions are still running. To end replication on subscriptions that use the specified instance as a target, youcan use the –a parameter which will generate an error when forcefully endingreplication on subscriptions that use the specified instance as the target. If this command does not end InfoSphere CDC processes and stop the specifiedinstance, use the dmterminate command on the UNIX and Linux platforms to force acomplete shut down and on Windows, to stop the service. Syntax dmshutdown [-I <INSTANCE_NAME>] [-c|-i|-a|-se [-t <date and time>|-p <log position>]

[-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.

-cSpecifies that InfoSphere CDC stops the specified instance and endsreplication on all subscriptions that use the instance as a source with theNormal option. InfoSphere CDC will use this option by default if you do notspecify –se, -i, or –a.This option completes in progress work and then endsreplication. If a refresh is in progress, Normal will complete the refresh for thecurrent table before replication ends. Normal is the most appropriate option for most business requirements and isthe preferred method for ending replication in most situations.

-iSpecifies that InfoSphere CDC stops the specified instance and endsreplication on all subscriptions that use the instance as a source with theImmediate option.This option stops all in progress work and then endsreplication. Starting replication after using this option can be slower than using -c. If a refresh is in progress, the refresh for the current table will be interruptedand then replication will end. Attention: Use this option if business reasons require replication to end fasterthan -c at the expense of a slower start when you resume replication on thespecified subscriptions.

-aSpecifies that InfoSphere CDC stops the specified instance and endsreplication on all subscriptions that use the instance as a source or target withthe Abort option. Subscriptions that use the specified instance as a target will

137

--

-

-

--

--

--

end replication with an error.This option stops all in progress work and thenends replication rapidly. Starting replication after using this option can be muchslower than using -c. A refresh in progress will be interrupted and the target willstop processing any data that has not been committed before replication ends. Attention: Use this option if your business reasons require a rapid end toreplication and you are willing to tolerate a much slower start when you resumereplication on the specified subscriptions. A sudden business requirement for an unplanned shutdown of your sourcesystem may require this option for ending replication. Note: As a best practice, use the dmendreplication command to end replicationon all subscriptions that use the instance specified in this command as a sourceor target.

-seSpecifies that InfoSphere CDC will stop the specified instance and endreplication normally at the current source system time in the source databaselog with the Scheduled End option. Replication will end on subscriptions thatuse the specified instance as a source. The source system time whenreplication will end is set when you issue this command.You can use thefollowing parameters with this option to end replication at a specific date andtime or log position:

–t—Stop the instance and end replication at a specific date and time in yoursource database log.–p—Stop the instance and end replication at a specific log position in yoursource database log.

Note: As latency between the source and target increases, the amount of timerequired to end replication will also increase.

-t <date and time>Indicates the date and time in the source database log when replication will endwhen using –se. When specifying a value for this parameter, use the followingformat:“yyyy-MM-dd HH:mm” This parameter is optional when you specify –se.

-p <log position>Indicates that InfoSphere CDC will end replication at the specified Sybase logposition in your source database log when using -se.This parameter is optionalwhen you specify –se.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isthe locale of the machine where InfoSphere CDC is installed.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Related reference: dmterminate - Terminate InfoSphere CDC processes

138

139

--

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmsupportinfo - Collect IBM Support information Note: You should only run this command when the Management ConsoleSupportAssistant cannot connect to your InfoSphere® CDC datastore because it is notrunning or it will not run. Use this command (when requested by IBM® Technical Support) to collectInfoSphere CDC environment information in a generated .zip file that is used todiagnose and troubleshoot your support issue. Once the command has completed collecting information and generating the .zipfile, the output will display the full path and name of the .zip file. If you run thiscommand multiple times, the generated .zip files are numbered randomly. Note thatyou are responsible for deleting the generated .zip files when they are no longerrequired. Syntax dmsupportinfo [-I <INSTANCE_NAME>] [-t <"yyyy-MM-dd hh:mm:ss to yyyy-MM-dd hh:mm:ss">] [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the name of the InfoSphere CDC instance. Alternatively, you canspecify the TSINSTANCE environment variable in place of this value.If you donot specify an instance (possibly because you could not create an instance),this command will only collect non-instance specific information.

-t <"yyyy-MM-dd hh:mm:ss to yyyy-MM-dd hh:mm:ss">Specifies the date and time range (relative to the time zone of the operatingsystem where you issue this command) used by InfoSphere CDC to retrieveenvironment information.Note: As a best practice, specify a date and time rangethat only captures the time period when you experienced problems. This allowsfor easier problem diagnosis and reduces the size of the files retrieved.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Example dmsupportinfo -I PRODUCTION -t "2009-12-03 08:00:00 to 2009-12-03 12:00:00"Retrieves support information for the Production instance from 8:00 AM to 12:00 PMon December 3, 2009. This is the time range when you experienced support issueswith this instance of InfoSphere CDC. Related concepts: Troubleshooting and contacting IBM Support

140

141

--

IBM InfoSphere Change Data Capture, Version 10.2 dmterminate - Terminate InfoSphere CDC processes Note: This command is only supported on the UNIX and Linux platforms. Use this command to terminate all InfoSphere® CDC processes for all instancesrunning on a UNIX or Linux server that you cannot completely shut down with thedmshutdown command. InfoSphere CDC terminates only processes that are startedby the UNIX account used to run this command. You can use this command prior to taking a server or database offline formaintenance purposes or upgrading InfoSphere CDC to the latest version. Use the dmshutdown command to gracefully shut down InfoSphere CDC. Ifdmshutdown is unable to completely shut down InfoSphere CDC, then usedmterminate to terminate any active InfoSphere CDC processes that still remainafter issuing dmshutdown. Syntax dmterminate [-L <locale>] Parameters

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails.

142

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmts32 - Start InfoSphere CDC Use this command to start a 32-bit instance of InfoSphere® CDC. Syntax dmts32 [-I <INSTANCE_NAME>] [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the InfoSphere CDC instance for which you want to start.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmts32 -I -MYINSTANCEInfoSphere CDC starts for the specified instance.

143

--

--

IBM InfoSphere Change Data Capture, Version 10.2 dmts64 - Start InfoSphere CDC Use this command to start a 64-bit instance of InfoSphere® CDC. Syntax dmts64 [-I <INSTANCE_NAME>] [-L <locale>] Parameters

-I <INSTANCE_NAME>Specifies the InfoSphere CDC instance for which you want to start.

-L <locale>The name of the locale used for the InfoSphere CDC instance. The default isyour machine's locale.

Result This command returns a value of 0 if the command was successful and a non-zerovalue if the command fails. Examples dmts64 -I MYINSTANCEInfoSphere CDC starts for the specified instance.

144

-

-

---

IBM InfoSphere Change Data Capture, Version 10.2 User exits for InfoSphere CDC for Sybase databases A user exit lets you define a set of actions that InfoSphere® CDC can run before orafter a database event occurs on a specified table. User exits allow you tocustomize your environment to meet your business requirements. After compilingthe user exit, you can specify the user exit in Management Console. InfoSphere CDC provides two types of user exits:

Stored procedure—This type of user exit is run directly by the database engine andis generally faster at processing database requests.Java class—This type of user exit utilizes the InfoSphere CDC API. For moreinformation, see the API reference Javadocs.

Sample Java™ class user exits are also provided with InfoSphere CDC. You canextend or modify these samples to suit your environment. In this section, you will learn:

Stored procedure user exits for table and row level operations Sample Java class user exits for InfoSphere CDC for Sybase databases InfoSphere CDC API reference – Javadocs

145

----

IBM InfoSphere Change Data Capture, Version 10.2 Stored procedure user exits for table and row leveloperations A stored procedure is a program (or procedure) which is physically stored within adatabase. The advantage of a stored procedure is that when it is run, in response toa user request, it is run directly by the database engine, which usually runs on aseparate database server and is generally faster at processing database requests. After writing and compiling user exit programs, you can specify at which user exitpoint you want to invoke the user exit (either before or after a row-level or before orafter a table-level operation) on the User Exits tab of InfoSphere® CDC. See also:

Defining a stored procedure user exit Stored procedure user exit database connections Retrieving data with a stored procedure user exit Example of a stored procedure user exit

146

--

-

-

IBM InfoSphere Change Data Capture, Version 10.2 Defining a stored procedure user exit When defining a stored procedure user exit in InfoSphere® CDC, consider thefollowing:

Overloaded stored procedures are not supported.Stored procedure user exits must have at least two parameters, which must be thefirst two defined in the following order:

result—An integer output parameter that returns '0' if the stored procedure userexit is successful or a non-zero value if the stored procedure user exit is notsuccessful.returnMsg—A character output parameter that returns error messages to theEvent Log if the stored procedure user exit is not successful.

Related reference: Example of a stored procedure user exit

147

IBM InfoSphere Change Data Capture, Version 10.2 Stored procedure user exit database connections The stored procedure user exit program and InfoSphere® CDC use the sameshared connection as the default method to connect to the database. This settingensures that, by default, changes to tables made by InfoSphere CDC are visible tothe stored procedure user exit program.

148

-

-

-

-

---

IBM InfoSphere Change Data Capture, Version 10.2 Retrieving data with a stored procedure user exit You can retrieve data from your source table by passing system parameters to yourstored procedure. You can retrieve the following type of data:

Retrieve system values (s$)—when passed to a stored procedure, the s$ prefixmakes system values available from the source database to your storedprocedure. For example, s$entry identifies the entry point at which InfoSphere®CDC had run the user exit. Retrieve journal control fields (j$)—when passed to a stored procedure, the j$prefix makes journal control fields available from the source database to yourstored procedure. For example, j$USER identifies the operating system user nameof the person that made the update on the source table. This is useful if you areusing the stored procedure to audit table or row-level operations that haveoccurred on the source table.Retrieve data values—depending on the prefix you pass to the stored procedure,you can retrieve data from the source database and make it available to yourstored procedure. For example, you can use b$ to retrieve the before image of thesource column, or you can use k$ to access the target table to find the rows thatneed to be modified.

Each of these values can be used as input parameters for the stored procedure userexit that you write. The format used to retrieve data is slightly different depending onthe product that you are using:

For InfoSphere CDC, the format is <x>$<value>where <x> represents the prefix and <value> represents the name of the value to beretrieved. See also:

Retrieving system values using the s$ prefix Retrieving journal control fields using the j$ prefix Retrieving data values using b$, a$, k$, and d$ prefixes

149

IBM InfoSphere Change Data Capture, Version 10.2 Retrieving system values using the s$ prefix This prefix is used to retrieve system values. The table below presents and brieflydescribes these values.

Prefix and Value Data Type Description

150

s$entry NUMBER Represents the entrypoint from where thestored procedure wasinvoked. You caninvoke a storedprocedure from thefollowing entry points:1—indicates thatInfoSphere® CDChas invoked thestored procedurebefore a table clear(truncate)operation2—indicatesthat InfoSphere CDChas invoked thestored procedureafter a table clear(truncate)operation3—indicatesthat InfoSphere CDChas invoked thestored procedurebefore a row insertoperation4—indicatesthat InfoSphere CDChas invoked thestored procedureafter a row insertoperation5—indicatesthat InfoSphere CDChas invoked thestored procedurebefore a row updateoperation6—indicatesthat InfoSphere CDChas invoked thestored procedureafter a row updateoperation7—indicatesthat InfoSphere CDChas invoked thestored procedurebefore a row deleteoperation8—indicatesthat InfoSphere CDChas invoked thestored procedureafter a row deleteoperation9—indicatesthat InfoSphere CDChas invoked thestored procedurebefore a table refresh

151

operation10—indicates that InfoSphereCDC has invoked thestored procedureafter a table refreshoperation

s$srcSysId VARCHAR Identifies uniquely thelocation of the sourcedata.

s$srcTabId VARCHAR Represents the nameof the source table inthe source databasethat sends replicateddata to the target.

s$tgtTabId VARCHAR Represents the nameof the target table inthe target databasethat receivesreplicated data fromthe source.

152

IBM InfoSphere Change Data Capture, Version 10.2 Retrieving journal control fields using the j$ prefix This prefix is used to retrieve information about the operation that occurred on thesource system. You can use jb$ with InfoSphere® CDC to retrieve the sameinformation. Note: If you are replicating data using InfoSphere Change Data Capture for DB2®for i on the source system, then the value for j$ and jb$ with ENTT and SEQNjournal control fields will be different. jb$ENTT generates 'UB' to indicate that thebefore image of a row has been updated on the source table, and generates 'UP' toindicate that the after image of a row has been updated on the source table. Also, ifyou are using InfoSphere Change Data Capture for DB2 for i on the source system,then jb$SEQN generates an internal ID for the row within a transaction. The available values are listed:

Prefix and Value Data Type Descriptionj$CCID VARCHAR Identifies the

transaction with theinsert, update, ordelete operation.

j$CODE VARCHAR Identifies the type ofjournal or log entry,either “U” for arefresh operation or“R” for mirroring. TheIBM® i platform willsend “F” for file ortable-level entries.

j$CTRR orj$CNTRRN

VARCHAR Identifies the relativerecord number of thesource table thatrecorded thejournal/logentry.Note: CTRR orCNTRRN containsmeaningfulinformation when youinvoke your storedprocedure on theinsert entries thatmake up the refresh.The IBM i platformwill also fill this in onany insert, update, ordelete operation.

j$ENTT or j$ENTTYP VARCHAR Generates journal orlog codes that identifythe operation type onthe source system.

153

j$JRN or j$JOURNAL VARCHAR The name of thejournal/log whereInfoSphere CDC isreading insert,update, or deleteoperations from.

j$JOB VARCHAR Identifies the name ofthe job that made theinsert, update, ordelete on the sourcesystem.

j$MBR or j$MEMBER VARCHAR Identifies the name ofthe source table or itsalias.

j$NBR or j$JOBNO VARCHAR Identifies the processID of the program onthe source table thatis making the insert,update, or deleteoperation.

j$PGM orj$PROGRAM

VARCHAR Identifies the name ofthe program on thesource system thatmade the insert,update or deleteoperation.

j$SEQN or j$SEQNO VARCHAR Identifies thesequence number ofthe insert, update, ordelete operation inthe journal or log.

j$SYNM orj$SYSTEM

VARCHAR Identifies the hostname of the sourcesystem.

j$USER VARCHAR Identifies theoperating systemuser name that madethe insert, update, ordelete operation onthe source.

j$USPF VARCHAR Identifies thedatabase user namethat made the insert,update, or deleteoperation on thesource.

154

j$TSTP orj$TIMSTAMP

VARCHAR Identifies the dateand time of when theinsert, update, ordelete operation orrefresh was made onthe source. Inenvironments thatsupport microsecondprecision, the dateand time format ofthis journal controlfield is YYYY-MM-DD-HH:MM:SS.UUUUUU. Otherwise,InfoSphere CDC setsthe microsecondcomponent UUUUUUto zeroes or does notinclude it at all.

155

IBM InfoSphere Change Data Capture, Version 10.2 Retrieving data values using b$, a$, k$, and d$prefixes Four prefixes are used to retrieve data:

Prefix Mode Descriptionb$<source columnname>

Input Used to retrieve thebefore image of thedata in a sourcecolumn. The beforeimage is the originalimage from thesource table columnbefore anytransformation isapplied to it.For example, youmay have made thefollowing UPDATE toyour source table:UPDATE source_tableset MYCOLUMN = 2where MYCOLUMN = 1;

This will set 2 on allrows whereMYCOLUMN was 1before the executionof this SQLstatement.When you define astored procedure anddecide that you wantthe stored procedureto retrieve the beforeimage ofMYCOLUMN, youwould specify thefollowing:b$MYCOLUMN;

This returns a valueof 1.

156

a$<source columnname>

Input Used to retrieve theafter image of thedata in a sourcecolumn. The afterimage is thetranslated data fromthe source tablecolumn. For example,the data that wastranslated by aderived expression.For example, youmay have made thefollowing UPDATE toyour source table:UPDATE source_tableset MYCOLUMN = 2where MYCOLUMN = 1;

This will set 2 on allrows whereMYCOLUMN was 1before the executionof this SQLstatement.When you define astored procedure anddecide that you wantthe stored procedureto retrieve the afterimage ofMYCOLUMN, youwould specify thefollowing:a$MYCOLUMN;

This returns a valueof 2.

k$<target key columnname>

Input Used to access thetarget table to find therows that need to bemodified.Note: Keycolumns are notavailable for auditing.

d$<target columnname>

Input/Output Used to retrieve datavalues aftertransformation, whichwill be used to updatethe table in the targetdatabase. Only thesevalues may bemodified by thestored procedure.

157

158

IBM InfoSphere Change Data Capture, Version 10.2 Example of a stored procedure user exit The following code snippet is an example of a stored procedure user exit.

Code Commentscreate or replace procedurePROD.AUDIT_STPROC ( result OUT INT, returnMsg OUT CHAR, s$entry IN NUMBER, s$srcSysId IN CHAR, s$srcTabId IN CHAR, s$tgtTabId IN CHAR, j$ENTT IN CHAR, a$IDNO IN NUMBER, a$PRICE IN NUMBER, a$DESC IN CHAR, a$LONGDESC IN CHAR, a$TRANSDATE IN DATE, d$IDNO IN NUMBER, d$PRICE IN NUMBER, d$DESC IN CHAR, d$LONGDESC IN CHAR, d$TRANSDATE IN DATE )

The parameters you declare and want topass to your stored procedure must bevalid data types.The following parameters are mandatoryand must be declared in your storedprocedure:result—Returns a value of '0' if thestored procedure user exit is successful.If the stored procedure user exit is notsuccessful it will return a non-zero valueand a message will be sent to the EventLog.returnMsg—Returns an errormessage to the Event Log if the storedprocedure is not successful.The followingparameters have been declared in thisstored procedure:s$entry—Retrieves the entry point atwhich the stored procedure was called.In this example, InfoSphere® CDC callsthe user exit at every entrypoint.s$srcSysId—Retrieves the locationof source data.s$srcTabId—Retrievesthe name of the sourcetable.s$tgtTabId—Retrieves the name ofthe target table.j$ENTT—Retrieves thejournal code that indicates the type ofoperation on the sourcetable.a$—Retrieves the after image ofthe IDNO, PRICE, DESC, LONGDESC,and TRANSDATE sourcecolumns.d$—Retrieves the transformeddata of the IDNO, PRICE, DESC,LONGDESC, and TRANSDATA targetcolumns.

IS ENTRYPOINT VARCHAR(50); BEGIN CASE s$entryWHEN 16 THEN ENTRYPOINT :='User Exit program called Before Insert';WHEN 1048576 THEN ENTRYPOINT :='User Exit program called After Insert';WHEN 64 THEN ENTRYPOINT :='User Exit program called Before Update';WHEN 4194304 THEN ENTRYPOINT :='User Exit program called After Update';END CASE;

This stored procedure user exit can beinvoked from these entry points.

insert into PROD.AUDIT_TABLE1values (s$entry, s$srcSysId,s$srcTabId, s$tgtTabId,j$ENTT, a$IDNO, a$PRICE, a$DESC,a$LONGDESC, a$TRANSDATE, d$IDNO,d$PRICE, d$DESC, d$LONGDESC, d$TRANSDATE,ENTRYPOINT);

This stored procedure user exit willINSERT these values intoPROD.AUDIT_TABLE1.

159

result := 0; returnMsg := 'OK';END AUDIT_STPROC;

This stored procedure user exit issuccessful and returns a '0' value.Note: If your stored procedure returns anon-zero value because the storedprocedure is not successful, then anerror message is sent to the Event Log.

160

-

-

-

-

-

-

-

-

-

--

IBM InfoSphere Change Data Capture, Version 10.2 Sample Java class user exits for InfoSphere CDCfor Sybase databases InfoSphere® CDC provides sample user exits that you can extend or modify to suityour environment. The samples are found in samples.jar, which is located in thesamples directory in your InfoSphere CDC installation directory. The Java™ filecontains the following samples:

CRUserExitSample.java—A conflict resolution user exit that can be used withtables having a primary key column of any data type or a numeric column with anydata type. This sample is located incom.datamirror.ts.target.publication.userexit.cdr.DEUserExitSample.java—Used in expressions using the %USERFUNC columnfunction. It calculates the sum of the user-supplied parameters (in the expression)and returns the sum incremented by 1. This sample is located incom.datamirror.ts.derivedexpressionmanager.SPUserExitSample.java—Calls a stored procedure with the image coming fromthe source. This sample is located incom.datamirror.ts.target.publication.userexit.sample.UserExitSample.java—Subscribes to replication events to retrieve the details ofthe events which took place. This sample is located incom.datamirror.ts.target.publication.userexit.sample.UserExitSample1.java—Records new rows inserted into a table on the target andstores them in a text file. The user specifies the name of the text file as aparameter. This sample is located incom.datamirror.ts.target.publication.userexit.sample.

Note the following: To run the sample user exits without modifying them, you must specify the fullyqualified path to the compiled user exit in Management Console. For example,com.datamirror.ts.target.publication.userexit.sample.UserExitSample.Compiled sample user exits are located in the ts.jar file which is found in the libdirectory in your InfoSphere CDC installation directory. Note that the compiled userexits in the ts.jar file have a *.class extension.If you want to modify the sample user exits, you must compile the user exit afteryou make changes to the source code.The user exit class must also be in the InfoSphere CDC runtime classpath.

For more information on how to specify Java class or Stored Procedure user exits inManagement Console, see your Management Console documentation. See also:

To compile the sample Java class user exits (Windows) To compile the sample Java class user exits (UNIX and Linux)

161

1.2.

3.4.

5.

6.7.

IBM InfoSphere Change Data Capture, Version 10.2 To compile the sample Java class user exits(Windows)

Stop InfoSphere® CDC.Unzip the samples.jar file into the lib folder in your InfoSphere CDC installationfolder. Make sure you maintain the folder structure when unzipping the jar file.After unzipping the jar file, you will have a folder structure like the following:<installation_folder>\lib\com\datamirror\ts\target\publication\userexit\sample Make your changes to the sample user exit.Compile the modified user exit. For example, if you want to compileUserExitSample.java, open a command window, navigate to the lib folder andissue the following command:javac -classpath ts.jar;.com\datamirror\ts\target\publication\userexit\sample

\UserExitSample.java If this command runs successfully, there will be no output on your screen. Note: Your system must have the Java™ JDK to run this command. After running the command successfully, navigate to the following directory andconfirm that you have created a UserExitSample.class file:<installation_directory>\lib\com\datamirror\ts\target

\publication\userexit\sample Start InfoSphere CDC.The final step to configure the user exit is to specify the fully qualified path toUserExitSample in Management Console. For example:com.datamirror.ts.target.publication.userexit.sample.UserExitSample Note: Do not specify the .class extension.

For more information on how to specify Java class user exits in ManagementConsole, see your Management Console documentation. Note: If you plan to use the sample user exits in production environments, you willhave to test the samples before they are deployed. IBM® does not assumeresponsibility for adverse results caused by modified or customized user exitclasses.

162

1.2.

3.4.

5.

6.7.

IBM InfoSphere Change Data Capture, Version 10.2 To compile the sample Java class user exits (UNIXand Linux)

Stop InfoSphere® CDC.Unzip the samples.jar file into the lib directory in your InfoSphere CDC installationdirectory. Make sure you maintain the directory structure when unzipping the jarfile.After unzipping the jar file, you will have a directory structure like the following:<installation_directory>/lib/com/datamirror/ts/target

/publication/userexit/sample Make your changes to the sample user exit.Compile the modified user exit. For example, if you want to compileUserExitSample.java, open a command window, navigate to the lib directory andissue the following command:javac -classpath ts.jar:.com/datamirror/ts/target/publication/userexit/sample

/UserExitSample.java If this command runs successfully, there will be no output on your screen. Note: Your system must have the Java™ JDK to run this command. After running the command successfully, navigate to the following directory andconfirm that you have created a UserExitSample.class file:<installation_directory>/lib/com/datamirror/ts/target

/publication/userexit/sample Start InfoSphere CDC.The final step to configure the user exit is to specify the fully qualified path toUserExitSample in Management Console. For example:com.datamirror.ts.target.publication.userexit.sample.UserExitSample Note: Do not specify the .class extension.

For more information on how to specify Java class user exits in ManagementConsole, see your Management Console documentation. Note: If you plan to use the sample user exits in production environments, you willhave to test the samples before they are deployed. IBM® does not assumeresponsibility for adverse results caused by modified or customized user exitclasses.

163

--

IBM InfoSphere Change Data Capture, Version 10.2 InfoSphere CDC API reference – Javadocs The API reference is available in Javadoc format in your InfoSphere® CDCinstallation directory. To view the API reference, navigate to the api directory belowand click the index.html file to open the Javadoc documentation in your browser:

Windows—<InfoSphere CDC installation directory>\docs\apiUNIX and Linux—<InfoSphere CDC installation directory>/docs/api

164

----

IBM InfoSphere Change Data Capture, Version 10.2 Conflict resolution audit table When InfoSphere® CDC resolves a conflict between the source and target tables, itrecords information about the resolution in the TS_CONFAUD table. InfoSphereCDC creates this table in the target metadata location that is specified during theconfiguration of InfoSphere CDC. Note:InfoSphere CDC will add data continuously to the audit table as conflicts occur,but will never purge data from the table. Depending on the number of conflicts, theaudit table will to grow in size over time. It is the user's responsibility to schedulemaintenance (such as using a DELETE FROM statement) on the conflict resolutionaudit table regularly. A good practice would be to remove the applicable informationfrom the audit table after you have resolved each conflict. In this section, you will learn:

Structure of the conflict resolution audit table Row image format Truncated images Unaudited data types

165

IBM InfoSphere Change Data Capture, Version 10.2 Structure of the conflict resolution audit table You can use the TS_CONFAUD table to track how conflict resolution affects yourtarget table. For example, you can query the AFTERIMG column to see when achange was made to the target table. Then you can review the contents of theBEFOREIMG and AFTERIMG columns to see the change on the source table thatresulted in the data on the target table. This can help in identifying issues in yourconflict resolution strategy. Conflict detection and resolution is configured in Management Console. The structure of the TS_CONFAUD table is as follows:

Column DescriptionCNFTIME The date and time on the target when the

conflict was detected.SRCTIME The time the conflicting data was applied

to the source table.SRCSYSID The source ID of the subscription.SRCSCHEMA The schema or library name for the

source table.SRCNAME The name of the source table.SRCMEMBER This field is blank.TGTSCHEMA The schema or library for the target table.TGTNAME The name of the target table.TGTMEMBER This column is only used for the IBM® i

platform.OPTYPE The row-level operation on the source

that caused the conflict. The value is oneof: 1—Inserted into the sourcetable.2—Updated on the sourcetable.3—Deleted from the source table.

CNFTYPE The type of conflict that was detected.The value is one of: 1—Inserted into thesource table. The key for that rowalready exists in the targettable.2—Updated or deleted on thesource table. The key for that row doesnot exist in the target table.3—Updatedor deleted on the source table. Theimages of the source and target tablesdo not match.4—Unexpected conflictwas detected.

166

RESMTD The conflict resolution method that wasused. The value is one of: 1—Sourcewins2—Target wins3—Largest valuewins4—Smallest value wins5—UserexitIf the resolution method was None,then a row will not be entered into thistable. See your InfoSphere® CDCdocumentation for more information onthese methods.

CNFRES Indicates if the conflict was resolved. Thevalue is one of: Y—Conflict wasresolved.N—Conflict was not resolved.

BEFORETRNC Indicates if the before image stored inBEFOREIMG was truncated. The valueis one of:Y—Value was truncated.N—Value wasnot truncated.

BEFOREIMG A representation of the row in the sourcetable after it was changed. See RowImage Format for more information onthe format of this column.

AFTERTRNC Indicates if the after image stored inAFTERIMG was truncated. The value isone of:Y—Value was truncated.N—Value wasnot truncated.

AFTERIMG A representation of the row in the sourcetable after it was changed. See RowImage Format for more information onthe format of this column.

TGTIMG A representation of the row in the targettable before replication occurred. SeeRow Image Format for more informationon the format of this column.

TGTTRNC Indicates if the after image stored inTGTIMG was truncated. The value is oneof: Y—Value was truncated.N—Valuewas not truncated.

WINIMG A representation of the final row in thetarget table after conflict resolution hasoccurred. See Row Image Format formore information on the format of thiscolumn.

WINTRNC Indicates if the image stored in WINIMGwas truncated. The value is one of:Y—Value was truncated.N—Value wasnot truncated.

167

Related concepts: Row image format

168

IBM InfoSphere Change Data Capture, Version 10.2 Row image format The BEFOREIMG, AFTERIMG, TGTIMG, and WINIMG columns in the audit tableshow representations of a row in either the source or target table. The images in these columns are limited by the maximum length of VARCHAR dataon your target metadata database. The images contain all of the values in the row,except for data in raw, binary, or LOB columns. The data from each column ispresented in the following format:(length:value) In the format above, value is the data in the column and length is the number ofcharacters used to represent the data. The images display numeric data ascharacter strings and NULL values as (null). The row images match the column order in the source table and the conflictresolution audit table. These images may be truncated if the image is longer thanthe maximum length of VARCHAR data in the target metadata database. If a table'skey column is not the first column in the table, then it may be truncated.

169

IBM InfoSphere Change Data Capture, Version 10.2 Truncated images If a row image is longer than the maximum length of a VARCHAR column, then theywill be truncated. There is a column in the audit table that indicates if each imagecolumn has been truncated. For example, if WINTRNC is Y, then the value ofWINIMG was truncated. The format of the truncated column is:(-length:value) In the format above, value is the truncated value and length is the number ofcharacters in the truncated string.

170

---

IBM InfoSphere Change Data Capture, Version 10.2 Unaudited data types The audit table does not include columns of the following data types in its images:

IMAGENTEXTTEXT

If the source or target table contains rows with these data types, then the imagesimply overlooks them. Binary data will appear in the images as hex-encodedcharacters. The image does not store any information from unsupported columns.

171

--

IBM InfoSphere Change Data Capture, Version 10.2 Uninstalling InfoSphere CDC for Sybase databases This section provides step-by-step instructions on how to uninstall InfoSphere®CDC. In this section, you will learn:

To uninstall InfoSphere CDC for Sybase databases (Windows) To uninstall InfoSphere CDC for Sybase databases (UNIX and Linux)

172

1.2.3.

4.

IBM InfoSphere Change Data Capture, Version 10.2 To uninstall InfoSphere CDC for Sybase databases(Windows)

Go to Windows Control Panel > Add or Remove Programs.Locate IBM®InfoSphere® Change Data Capture and click Change/Remove.Click Uninstall on the uninstall wizard. This deletes your all your InfoSphere CDCinstances under this installation.Click Done after the uninstallation has completed.

173

1.2.

3.

4.5.6.

7.

IBM InfoSphere Change Data Capture, Version 10.2 To uninstall InfoSphere CDC for Sybase databases(UNIX and Linux)

Stop InfoSphere® CDC by using the dmshutdown command.At the command prompt, launch the configuration tool by issuing the followingcommand from the <InfoSphere CDC installation directory>/bin directory:./dmconfigurets Enter 1 and press Enter to list the installed instances of InfoSphere CDC. Recordthe names of all these instances. Uninstalling InfoSphere CDC is simply deletingthe InfoSphere CDC instances.Enter 4 and press Enter to delete the first instance of InfoSphere CDC.Enter the instance name that you want to delete and press Enter.Repeat the above steps to delete all the InfoSphere CDC instances you recordedpreviously.Delete the InfoSphere CDC installation directory.

174

---

--

-

IBM InfoSphere Change Data Capture, Version 10.2 Troubleshooting If you encounter issues while running InfoSphere® CDC, you have a number ofoptions for tracking and troubleshooting issues to help with problem resolution. There are three methods that you can use in InfoSphere CDC for tracking andtroubleshooting issues:

Data Collection with the IBM® Support Assistant (ISA DC)Management Console Support AssistantThe dmsupportinfo command, which is executed on the replication engine

If you are trying to troubleshoot issues with InfoSphere CDC version 10.2 or later onLinux, UNIX and Windows operating systems, you should use the ISA DC toolunless otherwise instructed by IBM Technical Support. In this section, you will learn:

Using the IBM Support Assistant (ISA DC) Locating log files In addition to the Management Console event log, InfoSphere CDC producesother logs to help troubleshoot installation and replication errors.Troubleshooting and contacting IBM Support

175

-

-

--

---

-

IBM InfoSphere Change Data Capture, Version 10.2 Using the IBM Support Assistant (ISA DC) You can use the IBM® Support Assistant Data Collection tool (ISA DC) to collectInfoSphere® CDC data to provide to IBM Technical Support to assist you introubleshooting issues with InfoSphere CDC, to request a product enhancement orto ask a question about InfoSphere CDC. ISA DC can be used with InfoSphere CDC replication engines that are version 10.2or later, except InfoSphere CDC for z/OS®. The ISA DC tool is included in the InfoSphere CDC installation process, and doesnot require configuration. The executable files are located in the isa folder in theInfoSphere CDC directory. Simply run the isadc.bat, isadc.sh or index.html file, asappropriate, to launch the tool. Prerequisites and considerations for using ISA DC Prerequisites: The following prerequisite must be satisfied on the machine on which ISA DC will berun, in order to successfully use the tool:

IBM JRE/JDK version 1.6 or laterConsiderations: The following issues should be taken into consideration before you attempt to useISA DC:

ISA DC cannot be run remotely. It must be run on the machine where the instanceis configured.ISA DC cannot be used to collect data from InfoSphere CDC for z/OS.If InfoSphere CDC is installed but you have not configured an instance or areunable to configure an instance, ISA DC can still be used to collect minimal data toassist IBM Technical Support in resolving the issue.

See also:

To use ISA DC to collect data for a product problem (command line) To use ISA DC to collect data for a product problem (GUI) To use ISA DC to collect data for a question or an enhancement request(command line) To use ISA DC to collect data for a question or an enhancement request (GUI)

176

1.

2.

3.

4.5.

6.7.8.

9.

10.

11.

12.

13.

A.

IBM InfoSphere Change Data Capture, Version 10.2 To use ISA DC to collect data for a product problem(command line)

Launch the IBM® Support Assistant.Run the isadc.bat or isadc.sh file, located inthe isa\isadc folder in the root directory of the InfoSphere® CDC instance. Enter 1 to accept the license agreement and press Enter.After the licenseagreement has been accepted, it will not be shown again. Provide a file name and press Enter.The name provided will be given to the .zipfile containing the data collection results. If you do not want to assign a name to the data collection results, press Enterand a default name will be used. Enter 1 to confirm your chosen file name and press Enter to continue.Enter 1 to run the InfoSphere Change Data CaptureSupport Assistant DataCollector and press Enter.The Welcome page is displayed. Read the Welcome page information and enter 1 to proceed. Press Enter.Enter 1 to collect data for a product problem and press Enter.Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3 andpress Enter. Select the name of the InfoSphere CDC instance for which data will be collected.If you have multiple instances of InfoSphere CDC configured, you will be askedto select which instance for which you want to collect. Enter the correspondingnumber for the instance name and press Enter. If you have a single InfoSphere CDC instance configured, it will be selectedautomatically and this step will be skipped. Even if you do not have an instance configured, ISA DC will still collect whatdata is available. If no instance is configured, you can skip to Step 14. Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3 andpress Enter. If your selected instance is not running, you will be alerted by ISA DC. As onlyminimal data is available if the instance is stopped, it is preferable that theinstance be running during data collection.Try to start your instance. When theinstance is running, enter 1 and press Enter. If you cannot start your instance and want to continue the data collectionprocess, enter 2 and press Enter. Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3 andpress Enter. If the instance is running, you will be asked for information regarding when theproblem occurred.

Enter the date and time when you think the problem began and press Enter.This information must be entered in the following format: yyyy-mm-ddhh:mm:ss

177

B.

C.

D.

14.

-

-

-

-

15.

16.

17.A.

B.

C.

D.

Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3and press Enter. Determine the period of time for which the data will be collected and pressEnter.The amount specified will be applied as a before value and an aftervalue to the date and time specified previously. For example, if you select 1Day as the time period, data will be collect for 24 hours before the specifieddate and time and for the 24 hours after the specified date and time. Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3and press Enter.

Select the method to transfer the data collection archive file and press Enter.Choose one of the following options:

Send using secure transfer to IBM Support (HTTPS)—Sends the .zip file toIBM Support using a secure protocol.Send using FTP to IBM Support (unencrypted)—Sends the .zip file to IBMSupport using an unencrypted protocol.Send using FTP to another location (unencrypted)—Sends the .zip file to arecipient of your choice, using an unencrypted protocol.End the collection without sending—Ends the data collection and createsthe .zip file, but does not transfer it.

Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3 andpress Enter. If you chose to end the collection without sending the output, ISA DC will notifyyour when the .zip file has been successfully created. Enter 1 and press Enter toexit the application.If you chose to transfer the file using HTTPS, follow these steps:

If you want to receive a confirmation email when the upload was successful,enter an email address and press Enter. If you do not want to receiveconfirmation, press Enter to continue. Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3and press Enter. Enter the PMR number that was given to you by IBM Technical Support andpress Enter. Ensure that the PMR number follows the required namingconvention of PMRNumber.BranchNumber.CountryCode. If an unknownPMR number is entered, you will be asked to correct the PMR number andre-send the data. Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3and press Enter.

178

18.

A.

B.

19.A.B.C.D.E.

20.

If you chose to transfer the file to IBM Technical Support using unencryptedFTP, follow these steps:

Enter the PMR number that was given to you by IBM Technical Support andpress Enter. Ensure that the PMR number follows the required namingconvention of PMRNumber.BranchNumber.CountryCode. If an unknown PMRnumber is entered, you will be asked to correct the PMR number and re-sendthe data. Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3and press Enter.

If you chose to transfer the file using unencrypted FTP, follow these steps:Enter the FTP host name and press Enter.Enter the user name and press Enter.Enter the password for the user name and press Enter.Enter the path for the directory on the FTP server and press Enter.Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3and press Enter.

When you receive notice that the operation has completed successfully, enter 1and press Enter to exit the application.

179

1.

2.

3.4.5.6.7.

8.

9.

10.

-----

11.

12.

A.B.

IBM InfoSphere Change Data Capture, Version 10.2 To use ISA DC to collect data for a product problem(GUI)

Launch the IBM® Support Assistant.Run the index.html file, located in theisa\isadc folder in the root directory of the InfoSphere® CDC instance. Read the license agreement and click OK to accept it.After the licenseagreement has been accepted, it will not be shown again. Click Start.The Welcome screen opens. Click OK.Select A product problem from the drop down box.Click OK.Select the name of an InfoSphere CDC instance from the drop down list andclick OK.If you have multiple instances of InfoSphere CDC configured, you willbe asked to select which instance for which you want to collect. If you have a single InfoSphere CDC instance configured, it will be selectedautomatically and this step will be skipped. If your selected instance is not running, you will be alerted by ISA DC. As onlyminimal data is available if the instance is stopped, it is preferable that theinstance be running during data collection.Try to start your instance. When theinstance is running, select Yes, I have started the instance from the drop downbox and click OK. If you cannot start your instance and want to continue the data collectionprocess, select No, continue with minimal data collection from the drop downbox and click OK. If the instance is running, you will be asked for information regarding when theproblem occurred. Enter the date and time when you think the problem beganand click OK.This information must be entered in the following format: yyyy-mm-dd hh:mm:ss. Determine the period of time for which the data will be collected and click OK.Choose one of the following values:

6 hours12 hours1 Day2 Days7 Days

The amount specified will be applied as a before value and an after value to thedate and time specified previously. For example, if you select 1 Day as the timeperiod, data will be collect for 24 hours before the specified date and time andfor the 24 hours after the specified date and time. If you chose to end the collection without sending the output, select Do nottransfer data to IBM. ISA DC will notify your when the .zip file has beensuccessfully created.If you want to transfer the data to IBM using a secure transfer (HTTPS), selectthe Transfer to IBM option.

Choose the HTTPS transfer type option.Enter the PMR number that was given to you by IBM Technical Support.Ensure that the PMR number follows the required naming convention ofPMRNumber.BranchNumber.CountryCode. If an unknown PMR number is

180

C.D.

13.

A.B.

C.14.

A.

B.C.D.E.

15.

entered, you will be asked to correct the PMR number and re-send the data. Enter your email address.Click Transfer.

If you want to transfer the data to IBM using unencrypted FTP, select theTransfer to IBM option.

Choose the FTP transfer type option.Enter the PMR number that was given to you by IBM Technical Support.Ensure that the PMR number follows the required naming convention ofPMRNumber.BranchNumber.CountryCode. If an unknown PMR number isentered, you will be asked to correct the PMR number and re-send the data. Click Transfer.

If you choose to send the data to a location other than IBM using unencryptedFTP, click Transfer to another server via FTP

Enter the email address or IP address of the recipient in the Hotmail/IPAddress field.Enter the user name.Enter the password.Enter the path for the directory on the FTP server.Click Transfer.

When you receive notice that the operation has completed successfully, clickBrowse directory if you want to see the file you created or click Start NewCollection to collect more data.To exit the application, close your browser tab orwindow.

181

1.

2.

3.

4.5.

6.7.

8.

9.

-

-

-

-

10.

11.

12.A.

B.

C.

IBM InfoSphere Change Data Capture, Version 10.2 To use ISA DC to collect data for a question or anenhancement request (command line)

Launch the IBM® Support Assistant.Run the isadc.bat or isadc.sh file, located inthe isa\isadc folder in the root directory of the InfoSphere® CDC instance. Enter 1 to accept the license agreement and press Enter.After the licenseagreement has been accepted, it will not be shown again. Provide a file name and press Enter.The name provided will be given to the .zipfile containing the data collection results. If you do not want to assign a name to the data collection results, press Enterand a default name will be used. Enter 1 to confirm your chosen file name and press Enter to continue.Enter 1 to run the InfoSphere Change Data CaptureSupport Assistant DataCollector and press Enter.The Welcome page is displayed. Read the Welcome page information and enter 1 to proceed. Press Enter.Enter 2 to collect data for a question or an enhancement request and pressEnter.Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3 andpress Enter. Select the method to transfer the data collection archive file and press Enter.Choose one of the following options:

Send using secure transfer to IBM Support (HTTPS)—Sends the .zip file toIBM Support using a secure protocol.Send using FTP to IBM Support (unencrypted)—Sends the .zip file to IBMSupport using an unencrypted protocol.Send using FTP to another location (unencrypted)—Sends the .zip file to arecipient of your choice, using an unencrypted protocol.End the collection without sending—Ends the data collection and createsthe .zip file, but does not transfer it.

Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3 andpress Enter. If you chose to end the collection without sending the output, ISA DC will notifyyour when the .zip file has been successfully created. Enter 1 and press Enter toexit the application.If you chose to transfer the file using HTTPS, follow these steps:

If you want to receive a confirmation email when the upload was successful,enter an email address and press Enter. If you do not want to receiveconfirmation, press Enter to continue. Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3and press Enter. Enter the PMR number that was given to you by IBM Technical Support andpress Enter. Ensure that the PMR number follows the required naming

182

D.

13.

A.

B.

14.A.B.C.D.E.

15.

convention of PMRNumber.BranchNumber.CountryCode. If an unknownPMR number is entered, you will be asked to correct the PMR number andre-send the data. Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3and press Enter.

If you chose to transfer the file to IBM Technical Support using unencryptedFTP, follow these steps:

Enter the PMR number that was given to you by IBM Technical Support andpress Enter. Ensure that the PMR number follows the required namingconvention of PMRNumber.BranchNumber.CountryCode. If an unknown PMRnumber is entered, you will be asked to correct the PMR number and re-sendthe data. Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3and press Enter.

If you chose to transfer the file using unencrypted FTP, follow these steps:Enter the FTP host name and press Enter.Enter the user name and press Enter.Enter the password for the user name and press Enter.Enter the path for the directory on the FTP server and press Enter.Enter 1 to process your input and continue collecting data. Press Enter.If youwant to cancel the collection, enter 2 and press Enter. If you want to go back and change your input for the previous step, enter 3and press Enter.

When you receive notice that the operation has completed successfully, enter 1and press Enter to exit the application.

183

1.

2.

3.4.5.6.7.

8.

A.B.

C.D.

9.

A.B.

C.10.

A.

B.C.D.E.

11.

IBM InfoSphere Change Data Capture, Version 10.2 To use ISA DC to collect data for a question or anenhancement request (GUI)

Launch the IBM® Support Assistant.Run the index.html file, located in theisa\isadc folder in the root directory of the InfoSphere® CDC instance. Read the license agreement and click OK to accept it.After the licenseagreement has been accepted, it will not be shown again. Click Start.The Welcome screen opens. Click OK.Select A question or enhancement request from the drop down box.Click OK.If you chose to end the collection without sending the output, select Do nottransfer data to IBM. ISA DC will notify your when the .zip file has beensuccessfully created.If you want to transfer the data to IBM using a secure transfer (HTTPS), selectthe Transfer to IBM option.

Choose the HTTPS transfer type option.Enter the PMR number that was given to you by IBM Technical Support.Ensure that the PMR number follows the required naming convention ofPMRNumber.BranchNumber.CountryCode. If an unknown PMR number isentered, you will be asked to correct the PMR number and re-send the data. Enter your email address.Click Transfer.

If you want to transfer the data to IBM using unencrypted FTP, select theTransfer to IBM option.

Choose the FTP transfer type option.Enter the PMR number that was given to you by IBM Technical Support.Ensure that the PMR number follows the required naming convention ofPMRNumber.BranchNumber.CountryCode. If an unknown PMR number isentered, you will be asked to correct the PMR number and re-send the data. Click Transfer.

If you choose to send the data to a location other than IBM using unencryptedFTP, click Transfer to another server via FTP

Enter the email address or IP address of the recipient in the Hotmail/IPAddress field.Enter the user name.Enter the password for the user name.Enter the path for the directory on the FTP server.Click Transfer.

When you receive notice that the operation has completed successfully, clickBrowse directory if you want to see the file you created or click Start NewCollection to collect more data.To exit the application, close your browser tab orwindow.

184

-

-

-

-

IBM InfoSphere Change Data Capture, Version 10.2 Locating log files In addition to the Management Console event log, InfoSphere® CDC producesother logs to help troubleshoot installation and replication errors. Review the log files in the <CDC_installation directory>\Uninstall\Logs directoryif you encounter any errors during the installation of InfoSphere CDC. If you encounter replication errors or replication stops, review any of these tracelogs:

<CDC_installation_directory>/log—This directory contains information for anInfoSphere CDC problem. Refer to this directory if the problem is related toconfiguring an InfoSphere CDC instance. However, it is always useful to refer thisdirectory as well as the <CDC_installation_directory>/instance/<instance_name>/log directory to troubleshoot any problem.<CDC_installation_directory>/instance/<instance_name>/log—This directorystores trace files for a specific InfoSphere CDC instance. It is also useful to refer tothe <CDC_installation_directory>/instance/<instance_name>/log directory totroubleshoot your problem. When tracing has been enabled, the trace files will beenabled under <CDC_installation_directory>/instance/<instance_name>/log/on.<CDC_installation_directory>/instance/<instance_name>/tmp—This directorytemporarily stores data such as incomplete large transactions and large LOB datavalues.<CDC_installation_directory>/instance/<instance_name>/stagingstore—Thisdirectory stores sincle scrape staging store data that does not fit in memory. Whenan InfoSphere CDC instance is stopped normally, the contents of this staging storeare written to files that are stored in this directory.

185

-

-

IBM InfoSphere Change Data Capture, Version 10.2 Troubleshooting and contacting IBM Support The following support page contains the latest troubleshooting information anddetails on how to open a service request with IBM® Support:

http://www.ibm.com/software/data/infosphere/support/change-data-capture/ For contact information in your region:

http://www.ibm.com/planetwide/ Related reference: dmsupportinfo - Collect IBM Support information

186