Professional Documents
Culture Documents
Version 6.3
IBM InfoSphere Change Data Capture Management Console, Version 6.3 Administration Guide
IBM InfoSphere Change Data Capture Management Console, Version 6.3 Administration Guide
Note Before using this information and the product it supports, read the information in Notices on page 609.
First edition This edition applies to version 6, release 3 of IBM InfoSphere CDC (product number 5724-U70) and version 6, release 2 of IBM InfoSphere CDC for z/OS (product number 5755-U96), and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright International Business Machines Corporation 2008. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Contents
InfoSphere CDC architectural overview 1 Introducing the InfoSphere CDC Management Console interface . . . . . 3
About InfoSphere CDC Management Console . . Terminology changes . . . . . . . . . . Command changes . . . . . . . . . . . Functionality changes . . . . . . . . . . Connecting to datastores and working with subscriptions . . . . . . . . . . . . . Datastores view . . . . . . . . . . . Source Tables area . . . . . . . . . . Subscriptions view . . . . . . . . . . Mapping source and target tables . . . . . . Map Tables wizard . . . . . . . . . . Table Mappings view . . . . . . . . . Setting mapping details on a subscription . . . Edit Mapping Details view . . . . . . . Column Mappings tab . . . . . . . . . Filtering tab . . . . . . . . . . . . Translation tab . . . . . . . . . . . . Conflicts tab . . . . . . . . . . . . Operation tab . . . . . . . . . . . . User Exits tab . . . . . . . . . . . . Promoting subscriptions . . . . . . . . . Monitoring the performance of a subscription . . Subscriptions view (Monitoring perspective) . Table Mappings view (Monitoring perspective) Statistics view . . . . . . . . . . . Event Log view . . . . . . . . . . . Replication Diagram view . . . . . . . . . . . 3 3 4 4 Table Mappings view . . . . . . . . Mapping Details view . . . . . . . . Subscriptions view (Monitoring perspective) Replication Diagram view . . . . . . Setting Preferences . . . . . . . . . . . . . . . . . . . . . . . . 18 19 19 20 20
. 4 . 4 . 5 . 5 . 5 . 6 . 6 . 6 . 7 . 7 . 7 . 7 . 8 . 8 . 8 . 9 . 10 . 10 10 . 11 . 11 . 11
Introducing InfoSphere CDC Management Console with InfoSphere CDC Event Server . . . . . . . . . . 13
About InfoSphere CDC Event Server . . . . . . InfoSphere CDC Event Server as a target-only datastore . . . . . . . . . . . . . . . Mapping source tables on a subscription that targets a JMS message destination . . . . . . . . . Setting mapping details on a subscription that targets a JMS Message destination . . . . . . . XML Message tab . . . . . . . . . . . XML Settings tab . . . . . . . . . . . Column Mapping tab . . . . . . . . . . Filtering tab . . . . . . . . . . . . . Translation tab . . . . . . . . . . . . Operation tab . . . . . . . . . . . . . User Exits tab . . . . . . . . . . . . 13 13 14 14 15 15 15 16 16 16 16
. 33 . 34 . 34 . 34 . 34 . 35 . . . . . . . . 35 36 36 36 36 36 37 37
. .
. 17 . 18
iii
Auditing user accounts, datastores, security policies, and general events . . . . . . . . . . . . To enable auditing . . . . . . . . . . . To generate an audit trail log . . . . . . . To generate a security log report . . . . . . To clear the log . . . . . . . . . . . . Creating list reports . . . . . . . . . . . To create a user list report . . . . . . . . To create a datastore list report . . . . . . . Commands for Access Server . . . . . . . . dmaddconnectionAdding a datastore connection to a user . . . . . . . . . . dmchangeconnectionChanging the connection parameters to a datastore . . . . . . . . . dmchangepasswordChanging the password on a user account . . . . . . . . . . . . dmcreatedatastoreAdding a datastore . . . . dmcreateuserAdding a user . . . . . . . dmdeleteconnectionDeleting a datastore connection . . . . . . . . . . . . . . dmdeletedatastoreDeleting a datastore . . . dmdeleteuserDeleting a user . . . . . . . dmdisableuserDisabling a user account . . . dmenableuserEnabling a user . . . . . . dmlistdatastoreusersGenerating a report list of users assigned to a datastore . . . . . . . dmlistuserdatastoresGenerating a report list of datastores assigned to a user . . . . . . . dmlistusersListing user accounts . . . . . dmresetuserResetting a user account . . . . dmunlockuserUnlocking a user account . . .
37 38 39 39 39 39 40 40 40 41 42 43 43 44 45 45 46 46 46 47 47 48 49 49
To delete a character encoding . To import the CSV template . . To export the CSV template . .
. . .
. . .
. . .
. . .
. . .
. 57 . 57 . 57
Upgrading subscriptions . . . . . . . 63
Upgrading Transformation Server subscriptions from version 5.3.4 to 6.2 . . . . . . . . To upgrade a subscription to Transformation Server for Microsoft SQL Server version 6.2 To transfer a bookmark to a new subscription To clear the log position for a subscription . . . . . . 63 . 63 . 64 . 64
Setting notifications . . . . . . . . . 69
Selecting a notification handler . . . . . . . . Choosing a notification category and a message type Setting notifications for a datastore . . . . . . To set an email (MAPI) notification . . . . . To set an email (SMTP) notification . . . . . To set an email notification . . . . . . . . To set an email notification . . . . . . . . To set a notification for the TSDPRINT spool file To set a notification for an operator system log To set a notification for a UNIX system log . . . To set a notification using a user exit program . . To set a notification using a user exit program . . To set a notification using a user exit program . . To set a notification for a message queue . . . To filter a notification message . . . . . . . To copy notification settings . . . . . . . . Setting notifications for a subscription . . . . . To set notifications for a subscription . . . . . To view the datastore default notifications for a subscription . . . . . . . . . . . . . 70 71 72 72 73 73 74 74 74 75 75 75 76 76 77 77 77 77 78
. 53 . . . . . . . . . . . . . . . . . 53 53 54 54 54 54 55 55 55 55 55 55 56 56 56 56 57
iv
Copying notifications for a subscription . . To copy notification settings . . . . . Setting latency thresholds and notifications . To set a latency threshold and notification
. . . .
. . . .
. . . .
78 78 78 79
To map a multi-member table using LiveAudit for AS/400 . . . . . . . . . . . . . To map multiple source tables to existing tables using LiveAudit . . . . . . . . . . . To map multiple source tables to new tables using LiveAudit . . . . . . . . . . . Mapping using WebSphere DataStage . . . . . To map a single source table to WebSphere DataStage using flat files . . . . . . . . To map a single source table to WebSphere DataStage using Direct Connect . . . . . . To map multiple source tables to WebSphere DataStage using flat files . . . . . . . . To map multiple source tables to WebSphere DataStage using Direct Connect . . . . . . Mapping using Adaptive Apply . . . . . . . To map a source table using Adaptive Apply To map multi-member source tables using Adaptive Apply on AS/400 . . . . . . . . Mapping to summarize data . . . . . . . . To map a source table to summarize data . . . To map multi-member source tables using Summarization on AS/400 . . . . . . . . Mapping to consolidate data (one-to-one) . . . . To map a source table to consolidate data (one-to-one) . . . . . . . . . . . . . To map multi-member source tables using Consolidation One-to-One on AS/400 . . . . Mapping to consolidate data (one-to-many) . . . To map a source table to consolidate data (one-to-many) . . . . . . . . . . . . To map multi-member source tables using Consolidation one-to-many on AS/400 . . . . Mapping to a datastore outside of your organization . . . . . . . . . . . . . . To map tables for a subscription on an external datastore . . . . . . . . . . . . . . Mapping to a JMS message destination using InfoSphere CDC Event Server . . . . . . . . To map multiple source tables to a JMS message destination . . . . . . . . . . . . . To map a single source table to a JMS message destination . . . . . . . . . . . . . To stage a source table . . . . . . . . .
102 104 105 106 106 107 108 109 110 110 112 113 114 115 117 117 119 121 122 124 126 126 127 127 129 131
Mapping tables . . . . . . . . . . . 91
Mapping using standard replication . . . . . . 91 To map similar source tables to similar target tables (One-to-One) . . . . . . . . . . . 92 To map a custom source table to a custom target table (standard) . . . . . . . . . . . . 93 To map multi-member source tables on AS/400 (standard) . . . . . . . . . . . . . . 95 To map multi-member source tables to existing target tables on AS/400 (one-to-one) . . . . . 97 To map multi-member source tables to new tables on AS/400 (one-to-one) . . . . . . . 99 Mapping using LiveAudit . . . . . . . . . 100 To map a single source table using LiveAudit 101
133 133 133 134 134 135 135 135 136 136 136
Changing the refresh order on a table mapping . . To change the refresh order on a table mapping Changing the replication method of a table mapping . . . . . . . . . . . . . . . To change the replication method of a table mapping . . . . . . . . . . . . . . Selecting a new journal table . . . . . . . . To select a new journal table . . . . . . . Setting members for replication . . . . . . . To select a member for replication . . . . . Deleting table mappings . . . . . . . . . . To delete a table mapping . . . . . . . . To delete a table mapping (InfoSphere CDC Event Server) . . . . . . . . . . . . Updating the definition of mapped source and target table in a subscription . . . . . . . . To update the definition of a source table . . . To update the definition of a target table . . .
137 137 137 138 139 139 140 140 140 140 141 141 142 142
To accumulate or deduct numeric data on a target column . . . . . . . . . . . Mapping source and target columns automatically To map columns automatically . . . . . Mapping initial values to target columns . . . To define an initial value for a target column Adding and mapping derived columns to target columns . . . . . . . . . . . . . . To add a derived column . . . . . . . To map a derived column to a target column To modify a derived column . . . . . . To delete a derived column . . . . . . .
. 159 160 . 160 . 161 161 . 162 . 163 164 . 164 . 165
vi
. 186
To configure a user exit for a Java class . . . . Configuring user exits for InfoSphere CDC for Oracle or InfoSphere CDC for Sybase . . . . . To configure a C shared library . . . . . . To configure a stored procedure (Oracle and Sybase) . . . . . . . . . . . . . . To configure a derived column or an expression that calls %STPROC (Oracle and Sybase) . . . Configuring user exits for InfoSphere CDC for AS/400 (version 6.2 and below) or InfoSphere CDC for z/OS . . . . . . . . . . . . . . . To configure a standard function . . . . . . Creating a custom data format for IBM WebSphere DataStage . . . . . . . . . . . . . . To create a custom data format for WebSphere DataStage . . . . . . . . . . . . .
. 199 . 199
201
. 201 . 202 . 202 204 . 205 . 205 . 205
. 229
213
214
vii
Before configuring InfoSphere CDC for WebSphere DataStage . . . . . . . . . . . . . . Configuring InfoSphere CDC to send data to WebSphere DataStage . . . . . . . . . . Adding a subscription for WebSphere DataStage Mapping tables to WebSphere DataStage . . . Customizing your WebSphere DataStage table mappings . . . . . . . . . . . . . Generating a WebSphere DataStage Definition File . . . . . . . . . . . . . . . . Creating a custom data format for WebSphere DataStage . . . . . . . . . . . . . Starting replication in Management Console . . .
. 259
Date conversion%TODATE . . . . . . . Date and time conversion%TODATETIME Number conversion%TONUMBER . . . . Time conversion%TOTIME . . . . . . . Conditional and variable functions . . . . . . Conditional%IF . . . . . . . . . . . Variable%VAR . . . . . . . . . . . Data functions . . . . . . . . . . . . . Before value%BEFORE . . . . . . . . Current value%CURR . . . . . . . . . Retrieve column%GETCOL (DB2 UDB for iSeries) . . . . . . . . . . . . . . Retrieve column%GETCOL (Dynamic SQL) Retrieve column%SELECT . . . . . . . User exit functions . . . . . . . . . . . Stored procedure%STPROC . . . . . . . User exit%USER . . . . . . . . . . User exit%USER (InfoSphere CDC for Microsoft SQL 5.x) . . . . . . . . . . . User Exit%USERFUNC . . . . . . . . %GETCOL column function scenarios (DB2 UDB for iSeries) . . . . . . . . . . . . . . Retrieving a column from another table using the %GETCOL function (DB2 UDB for iSeries) . Performing an outer join using the %GETCOL function (DB2 UDB for iSeries) . . . . . . Nesting columns to join data using the %GETCOL function (DB2 UDB for iSeries) . . Combining columns using the %GETCOL function (DB2 UDB for iSeries) . . . . . . %GETCOL column function scenarios (Dynamic SQL) . . . . . . . . . . . . . . . . Retrieving a column using the %GETCOL function (Dynamic SQL) . . . . . . . . . Retrieving a column using the %GETCOL function without reading the same row from the table . . . . . . . . . . . . . . . Retrieving a column using nested %GETCOL functions (Dynamic SQL) . . . . . . . . Filtering rows using the %GETCOL function (Dynamic SQL) . . . . . . . . . . . . Publishing multiple derived columns using the %GETCOL function (Dynamic SQL) . . . . . .
275 277 279 280 282 282 283 284 284 284 285 288 293 297 297 298 302 303 305 305 306 306 306 307 307
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) . . . . . . . 313
General product system parameters AuthCode . . . . . . . DBMS . . . . . . . . . dbUser . . . . . . . . dllname . . . . . . . . DSN . . . . . . . . . NetServiceName . . . . . pwdencrypt . . . . . . . Startup Timeout . . . . . TSSrcCP . . . . . . . . TSTgtCP . . . . . . . . TCP_KEEPALIVE_SECS . . . WindowsAuthentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313 314 314 314 314 314 315 315 315 315 316 316 316
viii
Replication system parameters . . . . AutoRestart . . . . . . . . . . convertNotNullableColumns . . . . MirrorError . . . . . . . . . . RefreshError . . . . . . . . . . RefreshMode . . . . . . . . . Database translation log system parameters Cleanup Interval . . . . . . . . Cleanup Log Events . . . . . . . Cleanup Record Count . . . . . . LogCleanupMethod . . . . . . . Report Position Interval . . . . . . Synchronization Interval . . . . . . Commitment control system parameters . CommitmentControl . . . . . . . Commitment Group Size . . . . . RefreshBlock . . . . . . . . . SeparateCommits . . . . . . . . Event log system parameters . . . . . AllowEventLogClear . . . . . . . Multibyte character set system parameters. Unicode Handling . . . . . . . . Latency system parameters . . . . . . Deadband Percentage . . . . . . Monitor Sample Interval . . . . . . Notification system parameters . . . . convertNotNullableMsg . . . . . . DM_STATUS_INTERVAL . . . . . Heartbeat Timeout. . . . . . . . InvalidNumericMsg . . . . . . . Tracing system parameters . . . . . . CommTrace . . . . . . . . . . ProgramTrace . . . . . . . . . traceActive . . . . . . . . . . TraceLevel . . . . . . . . . . trcCleanup . . . . . . . . . . trcCOMM . . . . . . . . . . trcFiles . . . . . . . . . . . trcFncCalls . . . . . . . . . . trcJrlSync . . . . . . . . . . . trcReplStatus . . . . . . . . . trcScan . . . . . . . . . . . trcSQL. . . . . . . . . . . . trcThread . . . . . . . . . . . Data type system parameters . . . . . TrimVarchar . . . . . . . . . . Lock detection system parameters . . . DeadlockRetrys . . . . . . . . . DM_LOCK_DETECTION . . . . . DM_LOCK_TIMEOUT . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
317 317 317 318 318 319 319 319 320 320 321 322 322 323 323 324 324 325 325 325 325 325 326 326 329 329 329 330 331 331 332 332 332 333 333 333 333 334 334 334 334 334 334 335 335 335 335 335 335 336
mirror_commit_after_max_operations . . . . 339 mirror_commit_on_transaction_boundary . . . 340 refresh_commit_after_max_operations . . . . 340 Encoding system parameters . . . . . . . . 341 global_unicode_as_char . . . . . . . . . 341 Supplemental logging system parameters . . . . 342 mirror_logging_by_empty_triggers . . . . . 342 Disk resource system parameters . . . . . . . 343 mirror_memory_txqueue_total_mb . . . . . 343 mirror_memory_txqueue_each_mb . . . . . 343 global_memory_lob_cache_mb. . . . . . . 343 mirror_queue_for_buffers_between_cdc_threads_operations 344 Apply process system parameters . . . . . . 344 mirror_end_on_error . . . . . . . . . . 344 refresh_end_on_error . . . . . . . . . . 344 Authentication system parameters . . . . . . 345 global_ts_user_authentication_method . . . . 345
System parameters for InfoSphere CDC for Oracle (version 6.2 and below) . . . . . . . . . . . . . . 347
General product system parameters . . . . . . 347 CODE_PAGE . . . . . . . . . . . . 348 DEFAULT_ORACLE_HOME . . . . . . . 348 DEFAULT_ORACLE_SID . . . . . . . . 348 DEFAULT_ORACLE_USER . . . . . . . . 349 DM_COMMS_HOME . . . . . . . . . 349 D_MIRROR_HOME . . . . . . . . . . 349 D_MIRROR_LOG . . . . . . . . . . . 349 DM_DYNAMIC_PARAMETER_CHECK_INT 350 DM_MAX_MONITOR_ENTRIES . . . . . . 350 DM_TS_MAX_POOL_SIZE_MB . . . . . . 350 DM_TS_POOL_BLOCK_SIZE_MB . . . . . 351 <subscription>_MAX_POOL_SIZE_MB . . . . 351 <subscription>_POOL_BLOCK_SIZE_MB . . . 352 LD_LIBRARY_PATH . . . . . . . . . . 353 LIBPATH . . . . . . . . . . . . . . 353 ORACLE_HOME . . . . . . . . . . . 353 ORACLE_SID . . . . . . . . . . . . 353 PASSWORD . . . . . . . . . . . . . 354 PUBLISH_METADATA . . . . . . . . . 354 RLD_SYSTEM_TXQSIZE . . . . . . . . 354 <subscription>_TXQSIZE . . . . . . . . 355 SHLIB_PATH . . . . . . . . . . . . 355 STARTUP_TIMEOUT . . . . . . . . . . 355 TCP_KEEPALIVE_SECS . . . . . . . . . 356 USER . . . . . . . . . . . . . . . 356 Apply process system parameters . . . . . . 357 convertNotNullableColumns . . . . . . . 357 D_MIRROR_MIRROR_ERROR_LIST. . . . . 358 D_MIRROR_MIRROR_ERROR_STOP . . . . 358 D_MIRROR_REFRESH_ERROR_LIST . . . . 359 D_MIRROR_REFRESH_ERROR_STOP . . . . 359 DM_ADAPTIVE_APPLY_SOFT_DELETES . . . 359 DM_ADAPTIVE_APPLY_<SCHEMA>.<TABLENAME> 360 DM_ADAPTIVE_APPLY_MIMIC_SOURCE_OPERATION 360 DM_ARRAY_BIND_MAX . . . . . . . . 361 FILTER_NOCHANGE_UPDATES_FOR_AUDIT 361 NLS_LANG . . . . . . . . . . . . . 362 NLS_NCHAR . . . . . . . . . . . . 362
Contents
System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) . . . . . . . 337
Notification system parameters . . . . . . . 337 global_shutdown_after_no_heartbeat_response_minutes 337 global_conversion_not_possible_warning . . . 338 Maximize throughput system parameters . . . . 338 mirror_commit_after_max_transactions . . . . 339 mirror_commit_after_max_seconds . . . . . 339
ix
NOT_NULL_DATE_DEFAULT . . . . . . 362 TRIM_CHAR_TO_VARCHAR . . . . . . . 362 TRIM_VARCHAR_TO_VARCHAR . . . . . 363 TRIM_TO_NULL . . . . . . . . . . . 363 UNICODE_HANDLING. . . . . . . . . 364 Cascading replication system parameters . . . . 365 CASCADE_OMIT_TARGETS . . . . . . . 365 PREVENT_RECURSION. . . . . . . . . 365 Database journal (trigger) system parameters . . . 366 REPORT_POSITION_INTERVAL . . . . . . 366 MONITOR_PURGE_INTERVAL . . . . . . 367 MONITOR_REFRESH_PERIOD . . . . . . 367 Maximize throughput system parameters . . . . 367 COMMIT_GROUP_SIZE. . . . . . . . . 368 COMMIT_LEVEL . . . . . . . . . . . 368 COMMIT_INTERVAL . . . . . . . . . 369 MAINTAIN_TRANSACTION_CONSISTENCY 370 SYNCHRONIZATION_COMMIT_ GROUP_SIZE . . . . . . . . . . . . 370 SYNCHRONIZATION_INTERVAL . . . . . 371 TRANSACTION_GROUP_SIZE . . . . . . 371 TRANSACTION_INTERVAL . . . . . . . 372 TRANSACTION_RECORDS_THRESHOLD . . 372 Tracing system parameters . . . . . . . . . 372 D_MIRROR_SP_TRACE . . . . . . . . . 373 D_MIRROR_TRACE . . . . . . . . . . 373 D_MIRROR_TRACE_FILE_SIZE . . . . . . 373 D_MIRROR_TRACE_ON_ERROR . . . . . 374 DM_PRINT_DIAGNOSTICS . . . . . . . 374 D_MIRROR_ALARM_TRACE . . . . . . . 375 Refresh loader system parameters . . . . . . 375 DIRPATH_BUF_ROWS . . . . . . . . . 375 DIRPATH_BUF_SIZE . . . . . . . . . . 376 DIRPATH_CACHE_DATE_SIZE . . . . . . 377 DIRPATH_LOAD . . . . . . . . . . . 377 DIRPATH_LOGGING . . . . . . . . . 378 DIRPATH_DO_RECOVERY. . . . . . . . 378 User exit system parameters . . . . . . . . 379 D_MIRROR_SP_CONNECTION . . . . . . 379 DM_FROM_CODEPAGE_V4USEREXIT. . . . 379 DM_TO_CODEPAGE_V4USEREXIT . . . . . 380 Table mapping system parameters . . . . . . 380 TS_DELETE_ASSIGNED_OBJECTS_DURING_DESCRIBE 380 Notification system parameters . . . . . . . 381 convertNotNullableMsg . . . . . . . . . 381 DEADBAND_PERCENTAGE . . . . . . . 381 DM_STATUS_INTERVAL . . . . . . . . 384 HEARTBEAT_TIMEOUT . . . . . . . . 384 LOG_EMAIL_USERNAME . . . . . . . . 385 MONITOR_SAMPLE_INTERVAL . . . . . . 385 STATISTICS_INTERVAL . . . . . . . . . 386 Disk resource system parameters . . . . . . . 386 LOG_MAX_SIZE . . . . . . . . . . . 386
Notification system parameters . . . . . . . 388 events_max_retain . . . . . . . . . . . 388 global_shutdown_after_no_heartbeat_response_minutes 388 global_conversion_not_possible_warning . . . 389 Maximize throughput system parameters . . . . 389 mirror_commit_on_transaction_boundary . . . 389 mirror_sess_hist_age_threshold . . . . . . 390 mirror_src_ora_version . . . . . . . . . 390 refresh_commit_after_max_operations . . . . 390 userexit_max_lob_size_queue . . . . . . . 391 Database journal (trigger) system parameters . . . 391 mirror_journal_schema . . . . . . . . . 391 Encoding system parameters . . . . . . . . 391 global_unicode_as_char . . . . . . . . . 392 Disk resource system parameters . . . . . . . 392 mirror_queue_for_buffers_between_cdc_threads_operations 392 mirror_global_disk_quota_mb . . . . . . . 393 Apply process system parameters . . . . . . 393 convert_not_nullable_column . . . . . . . 393 global_max_batch_size . . . . . . . . . 394 mirror_end_on_error . . . . . . . . . . 394 refresh_end_on_error . . . . . . . . . . 394 refresh_allow_fast_loader . . . . . . . . 395 refresh_allow_jdbc_batch . . . . . . . . 395 mirror_expected_errors_list . . . . . . . . 395 refresh_in_unicode . . . . . . . . . . 396 trim_char_to_varchar . . . . . . . . . . 396 trim_varchar_to_varchar . . . . . . . . . 396 User exit system parameters . . . . . . . . 397 userexit_max_lob_size_kb . . . . . . . . 397
System parameters for InfoSphere CDC for Sybase (version 6.0 and below) . . . . . . . . . . . . . . 399
General product system parameters . . . . . CODE_PAGE . . . . . . . . . . . D_MIRROR_HOME . . . . . . . . . D_MIRROR_LOG . . . . . . . . . . DM_DYNAMIC_PARAMETER_CHECK_INT DM_MAX_MONITOR_ENTRIES . . . . . DSQUERY . . . . . . . . . . . . LD_LIBRARY_PATH . . . . . . . . . LIBPATH . . . . . . . . . . . . . PUBLISH_METADATA . . . . . . . . SYBASE . . . . . . . . . . . . . SYBASE_OCS . . . . . . . . . . . SHLIB_PATH . . . . . . . . . . . STARTUP_TIMEOUT . . . . . . . . . USER . . . . . . . . . . . . . . Apply process system parameters . . . . . convertNotNullableColumns . . . . . . D_MIRROR_MIRROR_ERROR_STOP . . . D_MIRROR_REFRESH_ERROR_STOP . . . FILTER_NOCHANGE_UPDATES_FOR_AUDIT NLS_LANG . . . . . . . . . . . . TRANSACTION_GROUP_SIZE . . . . . TRANSACTION_INTERVAL . . . . . . TRANSACTION_RECORDS_THRESHOLD . TRIM_CHAR_TO_VARCHAR . . . . . . TRIM_VARCHAR_TO_VARCHAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399 400 400 400 400 401 401 401 402 402 402 402 403 403 403 404 404 405 405 405 406 406 407 407 407 408
System parameters for InfoSphere CDC for Oracle (version 6.3 and above) . . . . . . . . . . . . . . 387
General product system parameters . . . mirror_set_table_data_capture_timeout . mirror_asm_oracle_path . . . . . . . . . . . . . 387 . 387 . 388
TRIM_TO_NULL . . . . . . . . . Cascading replication system parameters . . PREVENT_RECURSION. . . . . . . Database journal (trigger) system parameters . REPORT_POSITION_INTERVAL . . . . Maximize throughput system parameters . . COMMIT_GROUP_SIZE . . . . . . . COMMIT_INTERVAL . . . . . . . SYNCHRONIZATION_COMMIT_ GROUP_SIZE . . . . . . . . . . SYNCHRONIZATION_INTERVAL . . . Tracing system parameters . . . . . . . D_MIRROR_TRACE . . . . . . . . D_MIRROR_TRACE_FILE_SIZE . . . . D_MIRROR_TRACE_ON_ERROR . . . Notification system parameters . . . . . convertNotNullableMsg . . . . . . . DEADBAND_PERCENTAGE . . . . . DM_STATUS_INTERVAL . . . . . . HEARTBEAT_TIMEOUT . . . . . . LOG_EMAIL_USERNAME . . . . . . MONITOR_SAMPLE_INTERVAL . . . . STATISTICS_INTERVAL . . . . . . . Disk resource system parameters . . . . . LOG_MAX_SIZE . . . . . . . . . Refresh loader system parameters . . . . D_HOME_BCP . . . . . . . . . . D_MIRROR_BCP . . . . . . . . . D_MIRROR_BCP_ROWS . . . . . . D_MIRROR_FASTBCP . . . . . . . DM_BCP_PACKET_SIZE . . . . . .
General product system parameters . . . . . . 435 Authorization Code . . . . . . . . . . 436 . . 412 Enable *MAXOPT3 Option . . . . . . . . 436 . . 413 Record Format Check . . . . . . . . . 436 . . 413 Startup Timeout . . . . . . . . . . . 436 . . 414 TCP_KEEPALIVE_SECS . . . . . . . . . 437 . . 414 Replication system parameters . . . . . . . 437 . . 414 Allow Refresh While Active . . . . . . . 438 . . 415 End on Error During Mirroring . . . . . . 438 . . 415 End on Error During Refresh . . . . . . . 438 . . 416 Refresh After Restore . . . . . . . . . . 439 . . 418 Cascading replication system parameters . . . . 439 . . 418 Enable Cascading Replicates . . . . . . . 439 . . 419 Database journal (trigger) system parameters . . . 440 . . 419 Default Journal Library . . . . . . . . . 440 . . 420 Default Journal Name . . . . . . . . . 440 . . 420 Report Position Interval . . . . . . . . . 441 . . 420 Synchronization Interval . . . . . . . . . 441 . . 421 Remote journal system parameters . . . . . . 442 . . 421 Data Origin TCP/IP Name . . . . . . . . 442 . . 421 Data Origin Port . . . . . . . . . . . 442 . . 421 Relational Database Directory Entry . . . . . 443 . . 422 Commitment control system parameters . . . . 443 . . 422 Commitment Control . . . . . . . . . . 443 Multibyte character set system parameters. . . . 444 System parameters for InfoSphere Unicode Handling . . . . . . . . . . . 444 CDC for Sybase (version 6.3 and Latency system parameters . . . . . . . . . 445 above) . . . . . . . . . . . . . . 425 Deadband Percentage . . . . . . . . . 445 Notification system parameters . . . . . . . 425 Monitor Sample Interval . . . . . . . . . 447 events_max_retain . . . . . . . . . . . 425 Notification system parameters . . . . . . . 447 global_shutdown_after_no_heartbeat_response_minutes 426 Heartbeat Timeout. . . . . . . . . . . 448 global_conversion_not_possible_warning . . . 426 Messages on Column Not Null Capable . . . 448 Maximize throughput system parameters . . . . 426 Messages on Invalid Numerics . . . . . . 449 global_max_batch_size . . . . . . . . . 427 Progress Status Interval . . . . . . . . . 449 mirror_commit_on_transaction_boundary . . . 427 Data type system parameters . . . . . . . . 450 refresh_commit_after_max_operations . . . . 428 Numeric Column Validation . . . . . . . 450 Encoding system parameters . . . . . . . . 428 Date and time column function system parameters 450 global_unicode_as_char . . . . . . . . . 428 Default Date On Error . . . . . . . . . 450 Disk resource system parameters . . . . . . . 429 Row and column filtering system parameters . . . 451 global_memory_lob_cache_mb. . . . . . . 429 Audit Filtered Transactions . . . . . . . . 451 mirror_global_disk_quota_mb . . . . . . . 429 Critical Column Filtering . . . . . . . . 452 mirror_memory_txqueue_each_mb . . . . . 430 Event log system parameters . . . . . . . . 452 mirror_memory_txqueue_total_mb . . . . . 430 Notify Message Queue . . . . . . . . . 452 mirror_queue_for_buffers_between_cdc_threads_operations Notify Message Queue Library . . . . . . 453 430 Apply process system parameters . . . . . . 431 Notify Message Threshold . . . . . . . . 453 convert_not_nullable_column . . . . . . . 431 Lock detection system parameters . . . . . . 453 mirror_end_on_error . . . . . . . . . . 431 Lock Timeout Value . . . . . . . . . . 453 refresh_end_on_error . . . . . . . . . . 431 userexit_max_lob_size_kb . . . . . . . . 432 System parameters for InfoSphere mirror_expected_errors_list . . . . . . . . 432 CDC for DB2 UDB, PointBase, and refresh_expected_errors_list . . . . . . . 432 Teradata (version 6.0 and below) . . . 455 trim_char_to_varchar . . . . . . . . . . 433 General product system parameters . . . . . . 455 trim_varchar_to_varchar . . . . . . . . . 433 audit_auth_ code . . . . . . . . . . . 456
Contents
. . . . . . . .
. . . . . . . .
. . .
. . .
System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) . . . . . . . . . . . . . . 435
xi
auth_ code . . . . . . . . . . db_password . . . . . . . . . db_user . . . . . . . . . . . debug . . . . . . . . . . . . engine_ port . . . . . . . . . . log_file_quota . . . . . . . . . log_total_quota . . . . . . . . . md_db_url . . . . . . . . . . md_schema . . . . . . . . . . scrape_timeout . . . . . . . . . startup_timeout . . . . . . . . target_assert . . . . . . . . . . target_debug . . . . . . . . . target_initial_codepage . . . . . . ts_password . . . . . . . . . . ts_product . . . . . . . . . . use_uni_listener . . . . . . . . Access Server system parameters . . . . accessserver_udp_ listenport . . . . agent_assert . . . . . . . . . . agent_debug. . . . . . . . . . agent_jdbcdb2_driver . . . . . . . agent_jdbcdb2_driver_net . . . . . agent_jdbcpb_driver . . . . . . . agent_jdbcpb_driver_net. . . . . . agent_max_connections_num . . . . agent_message_version . . . . . . agent_msg_resources_file . . . . . agent_src_engine_address . . . . . agent_src_engine_port . . . . . . agent_src_engine_socket_tmout . . . agent_trace_in_message . . . . . . agent_trace_out_message . . . . . agent_udp_ listenport . . . . . . Cascading replication system parameters . cascade_replication . . . . . . . Commitment control system parameters . commit_group_size . . . . . . . commit_ interval . . . . . . . . refresh_commit_ block_size . . . . . scraper_trans_ num_limit . . . . . target_default_commit_level . . . . Database translation log system parameters report_position_interval . . . . . . Fastload system parameters . . . . . del_fastload_file . . . . . . . . dofastload . . . . . . . . . . fastload_backup_path . . . . . . fastload_in_whole . . . . . . . . fastload_path . . . . . . . . . make_fastload_log_file . . . . . . max_fastload_ file_size . . . . . . Latency system parameters . . . . . . monitor_sample_interval . . . . . Lock detection system parameters . . . dm_lock_detection. . . . . . . . dm_lock_timeout . . . . . . . . Multibyte character set system parameters. unicode_handling . . . . . . . . Notification system parameters . . . . dm_status_interval . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
456 456 456 457 457 457 457 457 457 457 457 458 458 458 458 458 458 458 459 459 459 459 459 459 459 460 460 460 460 460 460 460 460 460 461 461 461 461 462 463 463 464 464 464 465 465 466 466 467 467 467 468 468 468 469 469 469 470 470 471 471
heartbeat_timeout . . . . . . . . . . Replication system parameters . . . . . . dobatch . . . . . . . . . . . . . source_default_active_refresh . . . . . . source_default_replication_type . . . . . target_mirror_number_of_errors_before_abort target_print_refresh_details . . . . . . . target_refresh_number_of_errors_before_abort Tracing system parameters . . . . . . . . message_handler_trace_level . . . . . . message_trace_level . . . . . . . . . target_trace_logical_messages . . . . . . target_trace_physical_messages . . . . . trace_level . . . . . . . . . . . . trace_on . . . . . . . . . . . . . Teradata TPump system parameters . . . . . tpump_arc_data_files . . . . . . . . . tpump_files_root_folder . . . . . . . . tpump_logging . . . . . . . . . . . tpump_max_file_size . . . . . . . . . tpump_script_params_file . . . . . . . tpump_script_val_file. . . . . . . . . tpump_ timeout . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . .
472 472 472 473 473 473 473 474 474 474 474 474 474 474 474 475 475 475 476 477 477 477 478
System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) . . . . . . . . . . . . . . 479
Notification system parameters . . . . . . . 479 global_shutdown_after_no_heartbeat_response_minutes 479 global_conversion_not_possible_warning . . . 480 Maximize throughput system parameters . . . . 480 mirror_commit_after_max_transactions . . . . 481 mirror_commit_after_max_seconds . . . . . 481 mirror_commit_after_max_operations . . . . 481 mirror_commit_on_transaction_boundary . . . 482 refresh_commit_after_max_operations . . . . 482 Encoding system parameters . . . . . . . . 483 global_unicode_as_char . . . . . . . . . 483 Disk resource system parameters . . . . . . . 484 mirror_memory_txqueue_total_mb . . . . . 484 mirror_memory_txqueue_each_mb . . . . . 484 global_memory_lob_cache_mb. . . . . . . 484 mirror_queue_for_buffers_between_cdc_threads_operations 485 Apply process system parameters . . . . . . 485 mirror_end_on_error . . . . . . . . . . 485 refresh_end_on_error . . . . . . . . . . 485
System parameters for InfoSphere CDC for Teradata (version 6.2 and above) . . . . . . . . . . . . . . 487
Notification system parameters . . . . . . . 487 global_shutdown_after_no_heartbeat_response_minutes 487 global_conversion_not_possible_warning . . . 488 Apply process system parameters . . . . . . 488 mirror_end_on_error . . . . . . . . . . 488 refresh_end_on_error . . . . . . . . . . 488 Teradata TPump system parameters . . . . . . 489 mirror_tpump_files_root_folder_path . . . . 489 mirror_tpump_max_file_size_mb . . . . . . 490 mirror_tpump_script_val_file_name . . . . . 490
xii
. . .
. . .
. . .
Functions . . . . . . . . . . . . . 501
XPath functions . . . ceiling . . . . . . concat . . . . . . contains . . . . . floor . . . . . . false . . . . . . formatNumber . . . normalizeSpace . . . not . . . . . . . number . . . . . position . . . . . round . . . . . . startsWith . . . . string . . . . . . stringLength . . . . substring . . . . . substringAfter . . . substringBefore . . . sum . . . . . . translate . . . . . true . . . . . . Transform extensions . . sxt:add . . . . . sxt:db-lookup . . . sxt:divide . . . . . sxt:filter . . . . . sxt:formatDate . . . sxt:getSequentialNum sxt:getSubField . . . sxt:getSysDate . . . sxt:getSysTime . . . sxt:groupConcat . . sxt:ifExist . . . . . sxt:ifReturn . . . . sxt:isEqual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501 501 502 502 502 502 503 503 503 503 504 504 504 504 505 505 505 505 506 506 506 506 507 507 508 508 509 509 509 510 510 510 510 511 511
sxt:multiply . . . . . sxt:nodeConcat . . . . sxt:padLeft . . . . . sxt:padRight . . . . . sxt:proper . . . . . sxt:setDefault . . . . sxt:subtract . . . . . sxt:toLowerCase . . . sxt:toUpperCase . . . sxt:trim . . . . . . Database functions . . . sxtdb:getPKSeq . . . . sxtdb:lookup . . . . sxtdb:procCall . . . . Using external Java objects in Simple string objects (type SQL data types (type II) . XML objects (type III) . XPath expression operators . + Operator . . . . . - Operator . . . . . * Operator . . . . . div Operator . . . . mod Operator . . . . = Operator . . . . . != Operator . . . . . < Operator . . . . . <= Operator . . . . . > Operator . . . . . >= Operator . . . . . or Operator . . . . . and Operator . . . . () parentheses Operator . [ ] Operator . . . . . / Operator . . . . . // Operator . . . . . @ Operator . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . data I) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . transformations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
511 511 512 512 512 513 513 513 513 514 514 514 514 515 515 516 516 516 516 517 517 517 517 517 517 517 518 518 518 518 518 518 518 519 519 519 519
Dialog boxes
. . . . . . . . . . . 521
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521 521 522 523 523 523 524 524 525 525 526 527 527 527 528 529 529 530 530 531 531 531
Datastore Management . . . . . New Datastore dialog box . . . Connection Parameters dialog box Copy Datastore dialog box . . . Select User dialog box . . . . Datastore List Report dialog box . Edit Datastore dialog box . . . Datastore tab . . . . . . . History tab . . . . . . . . User Management . . . . . . . New User dialog box . . . . . Copy User dialog box . . . . Select Datastore dialog box . . . Change Role dialog box . . . . User List Report dialog box . . User Properties dialog box . . . User tab . . . . . . . . . History tab . . . . . . . . Connection Management . . . . Connection Parameters dialog box Access Server Options . . . . . Access Server Options dialog box
Contents
xiii
Preferences . . . . . . . . . . . . . Save Changes dialog box . . . . . . . Column Encodings dialog box . . . . . . Add Encoding dialog box . . . . . . . Modify Encoding dialog box . . . . . . Datastores . . . . . . . . . . . . . Datastore Properties dialog box . . . . . Update Access Parameters dialog box . . . Add or Modify System Parameter dialog box General tab . . . . . . . . . . . . System Parameters tab . . . . . . . . Aliases tab . . . . . . . . . . . . Retry Datastore Connection dialog box . . . Specify Owner and Name page . . . . . Define Columns page . . . . . . . . Review New Table page . . . . . . . . Add Column dialog box . . . . . . . . Modify Column dialog box . . . . . . . Notifications. . . . . . . . . . . . . Notification dialog box . . . . . . . . Filter Messages dialog box . . . . . . . Copy Notification Settings dialog box . . . Latency Threshold dialog box . . . . . . Source tables . . . . . . . . . . . . Replication Tables dialog box . . . . . . Table Properties dialog box . . . . . . . Structure tab . . . . . . . . . . . Subscriptions tab . . . . . . . . . . Update Source Table Definition dialog box . Unique Indexes dialog box . . . . . . . Target tables . . . . . . . . . . . . . Update Target Table Definition dialog box . . Subscriptions . . . . . . . . . . . . New Subscription dialog box . . . . . . Subscription Properties dialog box . . . . Advanced Subscription Settings dialog box . Specify External Target Datastore dialog box Notification dialog box . . . . . . . . Upgrade Subscriptions dialog box . . . . Naming Options dialog box . . . . . . Transfer Bookmark dialog box . . . . . . Clear Log Position dialog box . . . . . . WebSphere DataStage Properties dialog box . Table mappings . . . . . . . . . . . Filter Columns dialog box . . . . . . . Change Example Table dialog box . . . . Select Target Table dialog box . . . . . . Select Target Owner or Library dialog box . . Add or Modify Audit Column dialog box . . Message Destinations dialog box . . . . . Message Destination dialog box . . . . . Change Message Destination dialog box . . Delete Table Mappings dialog box . . . . Filter Tables dialog box . . . . . . . . Column mappings . . . . . . . . . . . Map Columns Automatically dialog box . . Set Initial Value dialog box . . . . . . . Define Derived Column dialog box . . . . Copy Column Properties dialog box . . . . Summarize Column dialog box . . . . . Specify Key dialog box . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
534 534 535 535 536 536 537 537 537 537 538 538 539 539 539 539 540 540 541 541 542 542 543 543 543 544 544 544 545 545 546 546 546 546 547 547 548 548 549 549 550 550 550 551 551 551 551 552 552 553 553 553 554 554 555 555 555 556 557 557 557
Define Expression dialog box . . . . . . Replace Expressions Variables dialog box . . Select Column dialog box . . . . . . . Import Options dialog box . . . . . . . XML message mappings . . . . . . . . . Expression Builder dialog box . . . . . . Data translation . . . . . . . . . . . Define Translation dialog box . . . . . . Table operations . . . . . . . . . . . Additional SQL dialog box . . . . . . . Add Member Identifier Dialog Box . . . . Modify Member Identifier dialog box . . . Delete Selected WHERE Clause dialog box . Promoting changes . . . . . . . . . . Compare XML dialog box . . . . . . . Advanced Target Settings dialog box . . . Monitoring . . . . . . . . . . . . . Start Refresh dialog box . . . . . . . . Change Refresh Order dialog box . . . . Flag for Refresh dialog box . . . . . . . Mark Table Capture Point for Mirroring dialog box . . . . . . . . . . . . . . . Park (Do not replicate) dialog box . . . . Replication Method dialog box . . . . . Set Member Replication dialog box . . . .
. . . . . . . . . . . . . . . . . . . . . . . .
558 558 558 558 559 559 560 560 560 560 561 561 561 561 562 562 562 563 563 563 563 564 564 565
Wizards . . . . . . . . . . . . . . 567
Create Table wizard . . . . . . . . . . . Specify Owner and Name page . . . . . . Define Columns page . . . . . . . . . Define Primary Key Name and Order page . . Review New Table page . . . . . . . . . Promote Subscription wizard . . . . . . . . Promote to a New or Existing Subscription page Specify New Source page (Promote Subscription wizard) . . . . . . . . . . . . . . Specify External Target page (Promote Subscription wizard) . . . . . . . . . . Specify New Target page (Promote Subscription wizard) . . . . . . . . . . . . . . Review Promotion Settings page . . . . . . Import Subscription wizard . . . . . . . . Import to a New or Existing Subscription page Specify New Source page (Import Subscription wizard) . . . . . . . . . . . . . . Specify External Target page (Import Subscription wizard) . . . . . . . . . . Specify New Target page (Import Subscription wizard) . . . . . . . . . . . . . . Review Settings page (Import Subscription wizard) . . . . . . . . . . . . . . Copy Subscription wizard . . . . . . . . . Define New Subscription page . . . . . . Specify New Source page (Copy Subscription wizard) . . . . . . . . . . . . . . Specify External Target Page (Copy Subscription wizard) . . . . . . . . . . . . . . Specify New Target page (Copy Subscription wizard) . . . . . . . . . . . . . . Review Settings page (Copy Subscription wizard) . . . . . . . . . . . . . . 567 567 567 568 568 568 568 569 569 570 570 570 571 571 571 572 572 572 572 573 573 573 574
xiv
Map Tables wizard . . . . . . . . . . . One-to-One mapping type . . . . . . . . Select Mapping Type page (One-to-One) . . . Select Source Tables page (One-to-One) . . . . Select Existing or Create New Target Tables page (One-to-One) . . . . . . . . . . . Map Source Tables to Existing Target Tables page (One-to-One) . . . . . . . . . . . Select Owner for New Target Tables page (One-to-One) . . . . . . . . . . . . Name Target Tables page (One-to-One) . . . . Set Replication Method page (One-to-One) . . Review Mappings page (One-to-One) . . . . Complete Mappings page (One-to-One) . . . Mapping to an external target datastore mapping type . . . . . . . . . . . . Select Mapping Type page (Mapping to an external target datastore) . . . . . . . . Select Source Tables page (Mapping to an external target datastore) . . . . . . . . LiveAudit mapping type (Automatic) . . . . Select Mapping Type page (LiveAudit Automatic) . . . . . . . . . . . . . Define Audit Columns page (LiveAudit Automatic) . . . . . . . . . . . . . Select Source Tables page (LiveAudit Automatic) Select Existing or Create New Target Tables page (LiveAudit Automatic) . . . . . . . Map Source Tables to Existing Target Tables page (LiveAudit Automatic) . . . . . . . Select Owner for New Target Tables page (LiveAudit Automatic) . . . . . . . . . Name Target Tables page (LiveAudit Automatic) Review Mappings page (LiveAudit Automatic) Complete Mappings page (LiveAudit Automatic) . . . . . . . . . . . . . WebSphere DataStage mapping type (Automatic) . . . . . . . . . . . . . Select Mapping Type page (WebSphere DataStage Automatic) . . . . . . . . . Select WebSphere DataStage Connection Method page (WebSphere DataStage Automatic) . . . Select Source Tables page (WebSphere DataStage Automatic) . . . . . . . . . . . . . WebSphere DataStage Flat File page (WebSphere DataStage Automatic) . . . . . . . . . WebSphere DataStage Direct Connect page (WebSphere DataStage Automatic) . . . . . Review Mappings page (WebSphere DataStage Automatic) . . . . . . . . . . . . . Standard mapping type . . . . . . . . . Select Mapping Type page (Standard) . . . . Select Source Table page (Standard) . . . . . Select Target Table page (Standard) . . . . . Specify Key page (Standard) . . . . . . . Set Replication Method page (Standard) . . . Review Mappings page (Standard) . . . . . LiveAudit mapping type (Custom) . . . . . Select Mapping Type page (LiveAudit Custom) Define Audit Columns page (LiveAudit Custom) . . . . . . . . . . . . . .
574 576 576 577 577 577 577 578 578 579 579 579 579 579 580 580 580 581 581 581 581 582 582 582 582 582 582 583 583 584 584 584 585 585 585 586 586 587 587 587 587
Select Source Tables page (LiveAudit Custom) Select Target Table page (LiveAudit Custom) Review Mappings page (LiveAudit Custom) . . Adaptive Apply mapping type . . . . . . Select Mapping Type page (Adaptive Apply) Select Source Tables page (Adaptive Apply) . . Select Target Table page (Adaptive Apply) . . . Specify Key page (Adaptive Apply) . . . . . Set Replication Method page (Adaptive Apply) Review Mappings page (Adaptive Apply) . . . Summarization mapping type . . . . . . . Select Mapping Type page (Summarization) . . Select Source Tables page (Summarization) . . Select Target Table page (Summarization) . . . Specify Key page (Summarization) . . . . . Select Summarization type page . . . . . . Set Replication Method page (Summarization) Review Mappings page (Summarization) . . . Consolidation one-to-one mapping type . . . Select Mapping Type page (Consolidation one-to-one) . . . . . . . . . . . . . Select Source Tables page (Consolidation one-to-one) . . . . . . . . . . . . . Select Target Table page (Consolidation one-to-one) . . . . . . . . . . . . . Specify Key page (Consolidation one-to-one) Set Replication Method page (Consolidation one-to-one) . . . . . . . . . . . . . Review Mappings page (Consolidation one-to-one) . . . . . . . . . . . . . Consolidation one-to-many mapping type . . . Select Mapping Type page (Consolidation one-to-many) . . . . . . . . . . . . Select Source Tables page (Consolidation one-to-many) . . . . . . . . . . . . Select Target Table page (Consolidation one-to-many) . . . . . . . . . . . . Specify Key page (Consolidation one-to-many) Set Replication Method page (Consolidation one-to-many) . . . . . . . . . . . . Review Mappings page (Consolidation one-to-many) . . . . . . . . . . . . WebSphere DataStage mapping type (Custom) Select Mapping Type page (WebSphere DataStage Custom) . . . . . . . . . . Select WebSphere DataStage Connection Method page (WebSphere DataStage Custom) . . . . Select Source Tables page (WebSphere DataStage Custom) . . . . . . . . . . . . . . WebSphere DataStage Flat File page (WebSphere DataStage Custom) . . . . . . . . . . WebSphere DataStage Direct Connect page (WebSphere DataStage Custom) . . . . . . Review Mappings page (WebSphere DataStage Custom) . . . . . . . . . . . . . . Message Destination mapping type (Automatic) Select Mapping Type page (Message Destination) . . . . . . . . . . . . . Select Source Tables page . . . . . . . . Message Content page . . . . . . . . . Message Destination page . . . . . . . .
Contents
588 588 588 589 589 589 589 589 590 591 591 591 591 591 592 592 592 593 593 593 594 594 594 594 595 596 596 596 596 596 597 598 598 598 598 598 599 599 600 600 600 600 600 601
xv
Review Mappings page . . . . . . . . Message Destination mapping type (Custom) Select Mapping Type page (Message Destination) . . . . . . . . . . . . Select Source Tables page . . . . . . . Message Content page . . . . . . . . Message Destination page . . . . . . . Review Mappings page . . . . . . . . Other Tables wizard . . . . . . . . . . Define Table Location page . . . . . . .
Select Table page . . . SELECT Clause page . . WHERE Clause page . . GROUP BY Clause page . ORDER BY Clause page .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
Notices . . . . . . . . . . . . . . 609
Trademarks . . . . . . . . . . . . . . 611
xvi
The key components of the InfoSphere CDC architecture are described below: Datastore Replication Enginean InfoSphere CDC process that sends or receives replicated data. Datastore replication engine processes on source and target servers are created when you install InfoSphere CDC. DBMS the source or target database. You can work only with those databases that InfoSphere CDC supports as a source or target of replicated data. Datastorean InfoSphere CDC process on a source or target server that accepts requests from an instance of Access Server and communicates with the datastore replication engine to initiate and manage replication activity. Datastore processes on source and target servers are created when you install InfoSphere CDC. These processes are also defined in Access Manager perspective so that you can connect to the same datastores in InfoSphere CDC Management Console. InfoSphere CDC Management Console Userthe name specified in an InfoSphere CDC Management Console log in process on a client workstation (for example, gsmith). As a InfoSphere CDC administrator, you can define InfoSphere CDC users in Access Manager and assign one of four roles to each InfoSphere CDC user. Each role determines the InfoSphere CDC Management Console operations that can be applied by a InfoSphere CDC user to a replication configuration. Access Servera client workstation where a set of background processes direct requests received from InfoSphere CDC Management Console on other client
Copyright IBM Corp. 2008
workstations to the appropriate datastores. These processes also return information back to the applications. Processes running on Access Server accept requests only from known InfoSphere CDC users, and communicate only with known datastores. You can create datastores and other InfoSphere CDC users in the Access Manager perspective in Management Console and these are associated with Access Server. Auto-discovery provides a way for Access Manager to recognize, upon startup, all available datastores on the local subnetwork. The processes running on Access Server are created during InfoSphere CDC Management Console installation. You can have multiple instances of Access Server in your working environment. In this case, you may be able to connect to one of several Access Servers from InfoSphere CDC Management Console. To establish a connection, you must know the name of the workstations where Access Server processes are running and provide appropriate security information. InfoSphere CDC Management Consolean interactive application that you can use to configure and monitor replication. It allows you to manage replication on various servers, specify replication parameters, and initiate refresh and mirroring operations from a client workstation. Use Management Console after creating datastores in the Access Manager perspective . After you have setup replication, Management Console can be closed on the client workstation without affecting active data replication activities between source and target servers. Management Console also includes an event log and a monitor. The event log allows you to examine generated InfoSphere CDC event messages. The monitor provides the necessary support to continuously monitor replication operations and latency. Diagrams depicting components of your replication configuration are constructed through direct manipulation of graphical objects. The monitor in Management Console is intended for time-critical working environments that require continuous analysis of data movement.
Terminology changes
InfoSphere CDC now uses the term v datastore in place of replication agent v source and target in place of publisher and subscriber v notifications in place of alerts and alarms v source tables and target tables in place of publication tables and subscription tables v table mappings in place of table assignments v mapping types in place of assignment types v row filtering expression in place of row selection expression v expression in place of derived expression v translation in place of value translation However, you may still encounter the old terms in some InfoSphere CDC products and documentation.
Command changes
Management Console uses the command v Add or Remove Tables in place of Manage Publications v Update Source Table Definition in place of the Re-Add Table, Describe, and Re-assign process for updating metadata of source tables v Update Target Table Definition in place of Re-assign to update the metadata of target tables v Map Tables in place of Assign
Functionality changes
To eliminate the publisher-subscriber model in the user interface and align the product to a subscription-centric experience, Management Console automatically. v adds tables to a subscription when you map tables v performs a describe from the source datastore to the target datastore when you have mapped source and target tables, update the definition of a source table, or change the properties of a subscription
Datastores view
Use the Datastores view to identify the datastores you can connect to and make source tables available for replication.
Subscriptions view
Use the Subscriptions view to create new subscriptions or view existing subscriptions. You must be connected to both a source and target datastore to view existing table mappings in a subscription, map tables between them, and edit mapping details.
Unknown datastores
Management Console displays Unknown source datastores when you do not have permissions to them or you are disconnected from it. Access parameters for datastores are set in Access Manager. Management Console also displays Unknown target datastores when you do not have permissions to them in Access Manager, or because the target datastore resides outside of your organization or department. Management Console displays the hostname and IP address of unknown target datastores. Management Console also displays any disconnected target datastores. Related concepts Using projects to organize your subscriptions on page 81 Setting up subscriptions on page 83 Setting up subscriptions for datastores outside of your organization on page 86
Translation tab Conflicts tab on page 8 Operation tab on page 8 User Exits tab on page 8
Filtering tab
Use the Filtering tab to v define a row-filtering expression to include or exclude rows from replication (row selection expression in Enterprise Administrator) v filter columns v enable critical column selection Related concepts Filtering rows on page 167 Selecting critical columns to filter rows on page 168 Filtering columns on page 168
Translation tab
Use the Translation tab to v set translations (value translations in Enterprise Administrator) v set encoding conversions (character handling in Enterprise Administrator) v set multibyte character encoding conversions (this is a new feature and only available in specific platforms and versions of InfoSphere CDC) Related concepts Setting data translations on page 171 Converting multibyte character sets on page 175 Handling Unicode character encodings on page 176
Introducing the InfoSphere CDC Management Console interface
Conflicts tab
Use the Conflicts tab when you want InfoSphere CDC to detect conflicts on target columns and resolve them. v source row wins v target row wins v largest value wins v smallest value wins v user exits If you do not want InfoSphere CDC to detect conflicts on target columns, then you can select None. Related concepts Resolving conflicts for source or target wins on page 189 Resolving conflicts for largest or smallest value wins on page 191 Resolving conflicts with user exits on page 194
Operation tab
Use the Operation tab to specify the row-level or table-level operations you want InfoSphere CDC to apply on a target table when there is a corresponding row-level or table-level operation on the source table. In Enterprise Administrator, you had to specify row-level or table-level options on separate tabs of the Subscription Table Properties dialog boxthe Table tab and the Row tab. These options are now consolidated in the Operation tab of Management Console. If you do not want InfoSphere CDC to detect conflicts on target columns, then you can select None. Related concepts Suppressing the apply of row operations on page 179 Preventing the audit of row operations on page 180 Detecting conflicts on row operations on page 181 Controlling the apply of refresh operations on page 183 Specifying SQL to control refresh operations on page 184
Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207 Configuring user exits for InfoSphere CDC for Oracle or InfoSphere CDC for Sybase on page 216 Configuring user exits for InfoSphere CDC for AS/400 (version 6.2 and below) or InfoSphere CDC for z/OS on page 219
Promoting subscriptions
The manual subscription promotion process available in Enterprise Administrator has been replaced with a Promote Subscription wizard in Management Console. In Enterprise Administrator, you had to promote the publisher-side and subscriber-side of the subscription. This wizard provides an integrated view of your subscription and automates the process of promoting subscription changes from development to test to production. The promotion wizard can also create copies and backups of InfoSphere CDC replication configurations. Also, if you have configured items on your source tables or target tables then you can promote these to datastores in the new environment. As an alternative to promoting subscriptions, you can also use export and import subscriptions. Use the Import Subscription wizard when you have exported the subscription as an XML file on your local computer and made changes to this file. When you are ready to import the XML file into Management Console, the wizard lets you either import the changes into a new subscription or overwrite an existing one. Both the commands Export Subscription and Import Subscription are available on the Subscription menu. You can also make copies of a subscription to a new subscription using Copy Subscription wizard.
10
Flagging a source table for a refresh on page 135 Marking a table capture point on a source table on page 135 Parking a table mapping from replication on page 136 Changing the refresh order on a table mapping on page 137 Changing the replication method of a table mapping on page 137 Setting members for replication on page 140 Deleting table mappings on page 140
Statistics view
The Statistics view monitor latency and throughput on a subscription. You can monitor the following statistics v latency, the amount of a time a subscription takes to replicate data to the target table. v throughput, the number of operations applied to the target table (measured in bytes and number of operations) Related concepts Profiling the latency and throughput performance of your subscription on page 235
11
12
Introducing InfoSphere CDC Management Console with InfoSphere CDC Event Server
This section is intended for users of Management Console that want to transform data to XML and send data to a JMS message destination with InfoSphere CDC Event Server In this section, you will learn: About InfoSphere CDC Event Server InfoSphere CDC Event Server as a target-only datastore Mapping source tables on a subscription that targets a JMS message destination on page 14 Setting mapping details on a subscription that targets a JMS Message destination on page 14
13
Related concepts Connecting to a datastore on page 59 Updating, removing, and viewing tables for replication on page 67 Setting up subscriptions on page 83
14
XML Message tab XML Settings tab Column Mapping tab Filtering tab on page 16 Translation tab on page 16 Operation tab on page 16 User Exits tab on page 16
15
Mapping columns on page 157 Related tasks To stage a source table on page 131
Filtering tab
Use this tab to include or exclude rows or columns for replication. Related concepts Filtering rows and columns on page 167
Translation tab
Depending on how you have mapped your source table, you can use this tab to add a data translation between your source and target staging columns and/or set encoding conversions. You can only set a data translation on a subscription for source columns that are mapped to target staging columns. If you have only mapped your source table to a JMS message destination, then you can only set encoding conversions for any multibyte character sets in your source table. When you add a data translation and start replication, the supported InfoSphere CDC source product translates values from the source column into the new value you specified for the mapped target column. InfoSphere CDC Event Server then inserts the translated value into an XML document. Related concepts Setting data translations on column mappings on page 171 Setting multibyte and Unicode character set conversions on page 175
Operation tab
Use this tab to control how InfoSphere CDC Event Server applies row-level operations (insert, update, and deletes) and table-level operations (truncate/clear) to the target staging table. This tab is only available if you have you have mapped your source table to a target staging table using the Standard mapping type in the Map Tables wizard. Related concepts Creating an XML message on page 143 Controlling row operations on page 179 Controlling table operations on page 183
16
Datastores view
Datastores are logical entities that represent the data files and processes required to accomplish data replication. Each datastore represents the database to which you want to connect and acts as a container for your tables. Tables made available for replication are contained in a datastore. To access this view, log in toInfoSphere CDC Management Console and click Configuration > Datastores. In this view, you can do the following: v Connect to datastores. v Configure properties on your datastores such as system parameters. v Configure notifications on your source or target datastores. Related concepts Logging in to Management Console (Connecting to Access Server) on page 21 Setting up datastores for replication on page 59
17
18
19
v v v v
Refresh a Subscription Connect to a datastore Show table mappings for a subscription Display subscription properties Related concepts Monitoring your subscriptions on page 231 Starting and ending replication on subscriptions on page 197 Connecting to a datastore on page 59
Setting Preferences
Preferences allow you to control certain aspects of the behavior ofInfoSphere CDC Management Console. Preferences allow you to do the following: v Specify port preferences for Access Server and connection preferences for datastores. v Set timeout values, allocate memory, and set prompts for filtering large numbers of tables. v Set prompt preferences. v Control the behavior of progress windows. v Control how statistics are collected for your replication environment. v Control the behavior or views. To access Preferences, click Edit, Preferences. Related concepts Setting preferences in Management Console on page 51
20
21
22
Managing datastores
A datastore represents the InfoSphere CDC installation and the database made available for replication. As a System Administrator, you can add, modify, and delete datastores in the Access Manager perspective of Management Console. Use the Datastore Management view to: v Add, modify, copy, and delete datastoresadding a datastore in Management Console means that you are in the process of making an installation of InfoSphere CDC and the database you want users to replicate to or from available for connection by other users. When adding a new datastore, you must specify information about the database and provide database connection parameters so that users can connect to the datastore. Only users you have assigned to a datastore can connect to the datastore. v Assign users to a datastoreassigning users to a datastore gives them access to an installation of InfoSphere CDC and the ability to connect to the database that you have made available for replication on the server.
23
v Propagate connection parameterspropagating new connection parameters for users that use the existing connection parameters eases system administration in that you only have to specify connection parameters once. v Generate reports on the activities related to a set of datastoresgenerating a report on a specific datastore can help you keep track of which users you have assigned datastore access to and what databases users can access, the date of creation, and the last time it was modified. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: To add a new datastore To edit a datastore To delete a datastore on page 25 To copy a datastore on page 25 To view the history of a datastore on page 25 To set connection parameters on a datastore on page 25 Related concepts Setting up datastores for replication on page 59 Related tasks To assign users to a datastore on page 31
To edit a datastore
1. Click Access Manager > Datastore Management. 2. Select an existing datastore. 3. Click File > Access Server > Properties. 4. If you want to change the Name of the datastore, type it in the Name box. 5. If you want to change the description, type it in the Description box. 6. If the name of the server or IP address where InfoSphere CDC is installed has changed, type it in the Server box.
24
7. If the port number of the server has changed, type it in the Port box. Note: You can only edit a datastore if you are a System Administrator and have the privilege to manage datastores and user accounts. Related concepts Setting up datastores for replication on page 59
To delete a datastore
1. Click Access Manager > Datastore Management. 2. Select an existing datastore or hold CTRL and select multiple datastores. 3. Click File > Access Server > Delete. Note: You can only delete a datastore if you are a System Administrator and have the privilege to manage datastores and user accounts. Related concepts Setting up datastores for replication on page 59
To copy a datastore
1. Click Access Manager > Datastore Management. 2. Select an existing datastore. 3. Click File > Access Server > Copy. 4. Type the name of the new datastore in the New Name box. Note: You can only copy a datastore if you are a System Administrator and have the privilege to manage datastores and user accounts. Related concepts Setting up datastores for replication on page 59
25
8. If you want users assigned to this datastore that use the existing connection parameters to connect to the datastore using the new connection parameters you have set for this datastore, then enable the Propagate changes to users checkbox. Note: You can only set connection parameters on a datastore if you are a System Administrator that can manage datastores and user accounts. Related concepts Setting up datastores for replication on page 59
26
To edit a user
1. Click Access Manager > User Management. 2. Select an existing user.
Setting up datastores and user accounts in Access Manager
27
3. Click File > Access Server > Properties. 4. If you want to change the full name or description of the user, type this information in the Full Name and Description boxes. 5. If you want the user to specify a new password, type and confirm it in the Password and Confirm boxes. As the system administrator, if you have enabled complex passwords, then you must specify a password that meets the requirements. 6. If you want to change the role assigned to the user, choose one of the following: Role v System Administratorspecifies that users assigned to this role can perform all available operations in Management Console. Only users that require full operational access to the Monitoring and Configuration perspectives should be assigned to this role. System administrators can also modify system parameters to calibrate their replication environment. v Administratorspecifies that users assigned to this role can perform all available operations in Management Console, but cannot modify system parameters. Users assigned to this role can access both the Monitoring and Configuration perspectives. v Operatorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. v Monitorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. Enable user account and datastore administrationenables a user assigned the System Administrator role access to the Access Manager perspective. If you enable this option for a user, then they can create new users, new datastores, and define Access Server password settings. Note: You can only edit a user if you are a System Administrator and have the privilege to manage datastores and user accounts. Notes: v Users assigned to the Operator role can start, stop, and monitor replication activities. They can also view the tables selected for refresh and start a refresh on a subscription. Operators also have access to the Replication Diagram view, and can view notifications sent by subscriptions or datastores. However, users assigned to this role cannot configure replication and select or remove tables from a refresh. v Users assigned to the Monitor role can view the event log, view statistics, and view table mappings. Users can view the replication state and status of a subscription and can view latency threshold information. Monitors also have access to the Replication Diagram view. However, users assigned to this role cannot start or stop replication, configure replication, refresh tables, or view notifications sent by subscriptions and datastores.
To delete a user
1. Click Access Manager > User Management. 2. Select an existing user or hold the CTRL key to select multiple users. 3. Click File > Access Server > Delete. Note: You can only delete a user if you are a System Administrator that can manage datastores and user accounts.
28
To copy a user
1. 2. 3. 4. Click Access Manager > User Management. Select an existing user. Click File > Access Server > Copy. Type the name of the user in the Enter the name of the user box. Note: You can only copy a user if you are a System Administrator that can manage datastores and user accounts.
29
30
v Database/URLspecifies the name of the database or the Universal Resource Locator (URL) of the database server you want to connect to. v DB Loginspecifies the database user name to connect to the database. If you want users to connect to the database for replication with WebSphere DataStage, then you must specify the user you created when installingInfoSphere CDC. v DB Passwordspecifies the password to connect to the database. v Confirm Passwordspecifies the confirmed password. 8. If you want to set specific options on how these connection parameters are displayed to the user when connecting to the datastore in the Connect to datastore dialog box, then enable one or more of the following options: v Always show connection dialogenables the user to specify the password each time they want to connect to the datastore. v Show parameter valuess (except password)displays the connection parameters to the user (except password) each time the user tries to connect to the datastore. v Write-protect parameters (except password)displays the connection parameters to the user (except password) in read-only format each time the user tries to connect to the datastore. v Allow connection parameters savingenables the user to save the connection parameters when connecting to a datastore. Note: You can only assign a datastore to users if you are a System Administrator and have the privilege to manage datastores and user accounts.
7. If you choose to override the defaults, specify the following: v Database/URLspecifies the name of the database or the Universal Resource Locator (URL) of the database server you want to connect to. v DB Loginspecifies the database user name to connect to the database. If you want users to connect to the database for replication with WebSphere DataStage, then you must specify the user you created when installingInfoSphere CDC. v DB Passwordspecifies the password to connect to the database. v Confirm Passwordspecifies the confirmed password. 8. If you want to set specific options on how these connection parameters are displayed to the user when connecting to the datastore in the Connect to datastore dialog box, then enable one or more of the following options: v Always show connection dialogenables the user to specify the password each time they want to connect to the datastore.
31
v Show parameter valuess (except password)displays the connection parameters to the user (except password) each time the user tries to connect to the datastore. v Write-protect parameters (except password)displays the connection parameters to the user (except password) in read-only format each time the user tries to connect to the datastore. v Allow connection parameters savingenables the user to save the connection parameters when connecting to a datastore. Note: You can only assign users to a datastore if you are a System Administrator and have the privilege to manage datastores and user accounts.
32
To delete a connection
1. Ensure you have assigned a datastore and a user. 2. Click Access Manager. 3. Delete an existing connection using one of the following methods: v Click Datastores Management and select an existing datastore that has a user assigned to it. Click Connection Management and right-click on the user assigned to the datastore. Click Delete Connection. v Click User Management and select an existing user that has a datastore assigned to it. Click Connection Management and right-click on the datastore assigned to the user. Click Delete Connection. Note: You can only delete a datastore if you are a System Administrator that can manage datastores and user accounts.
7. Type the database user name in the DB Login box. If you want users to connect to a database for replication with WebSphere DataStage, then you must specify the user you created when installing InfoSphere CDC. 8. Type and confirm the password to connect to this database in the DB Password and Confirm boxes. 9. If you want to set specific options on how these connection parameters are displayed to the user when connecting to the datastore in the Connect to datastore dialog box, then enable one or more of the following options: v Always show connection dialogenables the user to specify the password each time they want to connect to the datastore. v Show parameter valuess (except password)displays the connection parameters to the user (except password) each time the user tries to connect to the datastore. v Write-protect parameters (except password)displays the connection parameters to the user (except password) in read-only format each time the user tries to connect to the datastore. v Allow connection parameters savingenables the user to save the connection parameters when connecting to a datastore. Note: You can only override connection parameters on a datastore if you are a System Administrator and have the privilege to manage datastores and user accounts.
33
34
35
36
3. Ensure the Enforce new account expiry checkbox is enabled. 4. Type the maximum number of days before a new account expires in the Maximum new account age (days) box. The number must be between 1 and 999. The default number is 15. Note: You can only enforce new account expiry if you are a System Administrator and have the privilege to manage datastores and user accounts.
37
v Modified security settings on user accounts Use the Security Log dialog box to generate a security log report. You can generate security log reports after enabling audit logging. The following activities are recorded the report: v v v v v v v Modified user passwords Disabled or enabled user accounts Locked or unlocked user accounts Successful or failed log in attempts by a user Which users are logged or logged out of Management Console Which datastores users are connected to or disconnected from Started or stopped Access Servers
v Generated report lists Each of the activities contained in either an audit trail or security log report has the following categories and items of information: v Eventspecifies the description of the activity being audited. v Timestampthe date and time of activity. v Identificationdepending on the activities being audited, the report will specify the name on the user account, datastore name, and the process responsible for generating the activity. v Commentprovides more information if applicable. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: To To To To enable auditing generate an audit trail log on page 39 generate a security log report on page 39 clear the log on page 39
To enable auditing
1. 2. 3. 4. Click File > Access Server > Access Server Options. Click Audit. Enable the Audit log checkbox. Enable one or more of the following: v Audit account managementenable if you want to audit user account management activities such as the creation, modification, and deletion of users. v Audit datastore managementenable if you want to audit datastore management activities such as the creation, modification, and deletion of datastores. v Audit security policy managementenable if you want to audit security policy settings related to passwords and user accounts. v Audit general eventsenable if you want to audit general events generated by Access Server.
38
Note: You can only enable auditing if you are a System Administrator and have the privilege to manage datastores and user accounts.
39
40
dmdeletedatastoreDeleting a datastore on page 45 dmdeleteuserDeleting a user on page 46 dmdisableuserDisabling a user account on page 46 dmenableuserEnabling a user on page 46 dmlistdatastoreusersGenerating a report list of users assigned to a datastore on page 47 dmlistuserdatastoresGenerating a report list of datastores assigned to a user on page 47 dmlistusersListing user accounts on page 48 dmresetuserResetting a user account on page 49 dmunlockuserUnlocking a user account on page 49
Syntax Parameters
userName Specifies the name of the user for which you want to create a connection. datastoreName Specifies the name of the datastore you want the user to connect to. database Specifies the name of the database that you want users to replicate to or from. Not all datastore connections are to a database. Use if not required. databaseOwner Specifies the user name of the database. Not all datastore connections are to a database. Use if not required. databasePassword Specifies the password to log into the database. Not all datastore connections are to a database. Use if not required. alwaysPrompt Specifies that you want the user to always be prompted for a connection each time the user tries to connect to the datastore. If you want the user to be prompted for a connection, then specify a value of TRUE. Otherwise, specify a value of FALSE. showParams Specifies that you want all the connection parameters displayed to the user (except for the password) each time the user tries to connect to the datastore. If you want the parameters displayed, then specify a value of TRUE. Otherwise, specify a value of FALSE.
41
writeProtected Specifies that you want all the connection parameters displayed to the user in read-only format each time the user tries to connect to the datastore. If you want the parameters displayed in read-only format, specify a value of TRUE. Otherwise, specify a value of FALSE. saveParams Specifies that you want the user to be able to save connection parameters when connecting to the datastore. If you want to enable parameter saving, then specify a value of TRUE. Otherwise, specify a value of FALSE. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.
Syntax Parameters
userName Specifies the name of the user for which you want to create a connection. datastoreName Specifies the name of the datastore you want the user to connect to. database Specifies the name of the database that you want users to replicate to or from. Not all datastore connections are to a database. Use if not required. databaseOwner Specifies the user name of the database. Not all datastore connections are to a database. Use if not required. databasePassword Specifies the password to log into the database. Not all datastore connections are to a database. Use if not required. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.
42
Syntax
DMCHANGEPASSWORD username password [-accessserver hostname port adminuser adminpassword]
Parameters
userName Specifies the name of the user that you are changing the password for. password Specifies the password you want the user to supply when logging into Management Console. If you have enabled complex passwords, then you must specify a password that meets the requirements. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.
dmcreatedatastoreAdding a datastore
Use this command to add a new datastore. Adding a datastore in Management Console means that you are in the process of making an installation of InfoSphere CDC and the database you want users to replicate to or from available for connection by other users. When adding a datastore, you must specify information about where your installation of InfoSphere CDC resides. To add a datastore, you must be a System Administrator and have the privilege to manage datastores and user accounts.
Syntax Parameters
datastoreName Specifies the name of the datastore you want to add. description Specifies a brief description about this datastore. hostname Specifies the hostname of the server where you have installed InfoSphere CDC. port Specifies the port number of the server where you have installed InfoSphere CDC. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.
Setting up datastores and user accounts in Access Manager
43
dmcreateuserAdding a user
Use this command to add a new user. Adding a user account is necessary to provide users with the ability to log into Management Console. To add a user, you must be a System Administrator and have the privilege to manage datastores and user accounts.
Syntax Parameters
username Specifies the unique name for the user you want to create an account for. fullname Specifies the full name of the user. description Specifies a description about the user. password Specifies the password you want the user to supply when logging into Management Console. If you have enabled complex passwords, then you must specify a password that meets the requirements. role Specifies the role you want to assign to the user. Enable one of the following values: v SYSADMINspecifies that a user assigned to this role is a System Administrator and can perform all available operations in Management Console. Only users that require full operational access to the Monitoring and Configuration perspectives should be assigned to this role. System administrators can also modify system parameters to calibrate their replication environment. v ADMINspecifies that a user assigned to this role is an Administrator and can perform all available operations in Management Console, but cannot modify system parameters. Users assigned to this role can access both the Monitoring and Configuration perspectives. v OPERATORspecifies a that user assigned to this role is an Operator and only has access to the Monitoring perspective in Management Console. v MONITORspecifies that a user assigned to this role is a Monitor and only has access to the Monitoring perspective in Management Console. manager Specifies that a user assigned the role of SYSADMIN also has privileges to manage datastores and user accounts in the Access Manager perspective of Management Console. If you want to enable this privilege for a System Administrator, then specify a value of TRUE. Otherwise, specify a value FALSE. changePassword Specifies you want the user to change their password when logging into Management Console for the first time. If you want the user to change the password, specify a value of TRUE. Otherwise, if you want the user to login using the same password you have assigned to them, then specify a value of FALSE.
DMCREATEUSER username fullname description password role manager changePassword passwordExpires [-acc
44
passwordExpires Specifies that you want to override any existing password expiry policies set in Management Console so that the password never expires. If you want to override an existing password expiry policy, specify a value of TRUE. Otherwise, if you want the password to expire, then specify a value of FALSE. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required. Notes: v Users assigned to the Operator role can start, stop, and monitor replication activities. They can also view the tables selected for refresh and start a refresh on a subscription. Operators also have access to the Replication Diagram view, and can view notifications sent by subscriptions or datastores. However, users assigned to this role cannot configure replication and select or remove tables from a refresh. v Users assigned to the Monitor role can view the event log, view statistics, and view table mappings. Users can view the replication state and status of a subscription and can view latency threshold information. Monitors also have access to the Replication Diagram view. However, users assigned to this role cannot start or stop replication, configure replication, refresh tables, or view notifications sent by subscriptions and datastores.
Syntax
DMDELETECONNECTION userName datastoreName [-accessserver hostname port adminuser adminpassword]
Parameters
username Specifies the unique name of the user you want to delete the connection for. datastoreName Specifies the name of the datastore you want to delete the connection for. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.
dmdeletedatastoreDeleting a datastore
Use this command to delete a datastore. To delete a datastore, you must be a System Administrator and have the privilege to manage datastores and user accounts.
Syntax
DMDELETEDATASTORE datastoreName [-accessserver hostname port adminuser adminpassword]
45
Parameters
datastoreName Specifies the name of the datastore you want to delete. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.
dmdeleteuserDeleting a user
Use this command to delete a user. To delete a user, you must be a System Administrator and have the privilege to manage datastores and user accounts.
Syntax
DMDELETEUSER username [-accessserver hostname port adminuser adminpassword]
Parameters
username Specifies the name of the user you want to delete. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.
Syntax
DMDISABLEUSER username [-accessserver hostname port adminuser adminpassword]
Parameters
username Specifies the name of the user you want to disable. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.
dmenableuserEnabling a user
Use this command to enable a user account. This lets the user log into Management Console. To enable a user, you must be a System Administrator and have the privilege to manage datastores and user accounts.
Syntax
DMENABLEUSER username [-accessserver hostname port adminuser adminpassword]
46
Parameters
username Specifies the name of the user you want to enable. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.
Syntax
DMLISTDATASTOREUSERS adminUser adminPassword datastoreName
Parameters
adminUser Specifies the name of the System Administrator. adminPassword Specifies the password of the System Administrator. datastoreName Specifies the name of the datastore you want to generate a list for. This list specifies the names of the users assigned to this datastore.
Syntax
DMLISTUSERDATASTORES username [-accessserver hostname port adminuser adminpassword]
Parameters
username Specifies the name of the user you want to generate a list for. This list specifies the datastores assigned to this user. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.
47
Syntax
DMLISTUSERS [-accessserver hostname port adminuser adminpassword]
Parameters
accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.
Output
User Specifies the name of the user. Role Specifies the role assigned to the user. v SYSADMINspecifies that a user assigned to this role is working in a System Administrator account and can perform all available operations in Management Console. Only users that require full operational access to the Monitoring and Configuration perspectives should be assigned to this role. System administrators can also modify system parameters to calibrate their replication environment. v ADMINspecifies that a user assigned to this role is working in an Administrator account and can perform all available operations in Management Console, but cannot modify system parameters. Users assigned to this role can access both the Monitoring and Configuration perspectives. v OPERATORspecifies a that user assigned to this role is working in an Operator account and only has access to the Monitoring perspective in Management Console. v MONITORspecifies that a user assigned to this role is working in a Monitoring account and only has access to the Monitoring perspective in Management Console. Manager Specifies if the user assigned to the role of System Administrator has also been assigned privileges to manage datastores and user accounts. TRUE indicates that the System Administrator has been given these privileges. FALSE indicates that the System Administrator has not been given these privileges. Disabled Specifies if the account has been disabled. TRUE indicates that the account is disabled. FALSE indicates the account is enabled. Locked Specifies if the account has been locked. This is automatically set to TRUE if the number of failed login attempts exceeds the locking policy you may have set. PwdChange Specifies if the user is required to change their password the next time the user
48
logs into Management Console. TRUE indicates the user is required to change the password. FALSE indicates the user can use the same password assigned to them. Expires Specifies if the user account overrides any existing password expiry policy set in Management Console. TRUE indicates the password supplied will not expire and overrides any expiry policy. FALSE indicates the password does expire based on an expiry policy. Notes: v Users assigned to the Operator role can start, stop, and monitor replication activities. They can also view the tables selected for refresh and start a refresh on a subscription. Operators also have access to the Replication Diagram view, and can view notifications sent by subscriptions or datastores. However, users assigned to this role cannot configure replication and select or remove tables from a refresh. v Users assigned to the Monitor role can view the event log, view statistics, and view table mappings. Users can view the replication state and status of a subscription and can view latency threshold information. Monitors also have access to the Replication Diagram view. However, users assigned to this role cannot start or stop replication, configure replication, refresh tables, or view notifications sent by subscriptions and datastores.
Syntax
DMRESETUSER username [-accessserver hostname port adminuser adminpassword]
Parameters
username Specifies the name of the user account that needs to be reset. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.
49
set in the Access Server Options dialog box in Management Console. To unlock a user, you must be a System Administrator and have the privilege to manage datastores and user accounts.
Syntax
DMUNLOCKUSER username [-accessserver hostname port adminuser adminpassword]
Parameters
username Specifies the name of the user you want to unlock. accessserver hostname port adminuser adminpassword These parameters are optional. Specifies that you want to connect to a remote installation of Access Server. If you have installed Access Server on the same machine as Management Console, then these parameters are not required.
50
Note: You can click Restore Defaults at any time to use the default preferences. Related concepts Setting connection preferences
Copyright IBM Corp. 2008
51
52
53
Shutting Down Datastoreenables Management Console to prompt you with a confirmation message before shutting down a InfoSphere CDC for Oracle datastore. Note: You can click Restore Defaults at any time to use the default preferences. See also: To set prompt preferences
Note: You can click Restore Defaults at any time to use the default preferences.
54
55
4. Click Apply.
56
57
58
Connecting to a datastore
Before you can connect to a datastore, you must have user access to a datastore. If you do not see a datastore listed, request your system administrator to set access parameters for you in the Access Manager perspective in Management Console. See also: To connect to a datastore
To connect to a datastore
1. Click File Connect to Datastores. 2. Select the datastore. 3. Click Connect. You can set preferences to connect to a datastore automatically, each time you log into Access Server. Notes: v Before you can connect to a datastore in Management Console, your system administrator must have given you user access to that datastore. For more information, see Assigning users to datastores on page 30. v If Management Console cannot establish a connection with a particular datastore, then this datastore is listed with the following icon: . You can view general information about the datastore and possible reasons as to why a connection could not be established in the Datastore Properties dialog box. To view general information, make sure you are in the Datastores view, select the datastore and right-click Properties.
59
60
The default values for most system parameters should be adequate. However, depending on your requirements, you can modify the a system parameter to specify a behavior for InfoSphere CDC that is different than the default. See also: To add a system parameter To modify a system parameter To delete a system parameter
61
To add an alias
1. 2. 3. 4. Click Configuration Datastores. Right-click on a datastore and select Properties. On the Alias tab, click Add. Type a name in the Alias box. Related concepts Creating aliases for a target datastore on a private network connection on page 61
To modify an alias
1. Click Configuration Datastores. 2. Right-click on a datastore and select Properties. 3. On the Alias tab, select an alias. 4. Click Modify. 5. Type a name in the Alias box. Related concepts Creating aliases for a target datastore on a private network connection on page 61
To delete an alias
1. 2. 3. 4. Click Configuration Datastores. Right-click on a datastore and select Properties. On the Alias tab, select an alias. Click Delete. Related concepts Creating aliases for a target datastore on a private network connection on page 61
62
Upgrading subscriptions
InfoSphere CDC allows you to upgrade your subscriptions from InfoSphere CDC for Microsoft SQL Server version 5.3.4 to version 6.2 by following the upgrade process outlined in this section. Note: Contact IBM support before you begin the upgrade process. The upgrade process may not be automatic if your subscriptions depend on notifications or output from expressions. In this section, you will learn: Upgrading Transformation Server subscriptions from version 5.3.4 to 6.2
To upgrade a subscription to Transformation Server for Microsoft SQL Server version 6.2
1. Ensure that you have installed Transformation Server for Microsoft SQL Server version 6.2 and created a datastore. The Transformation Server instances and datastores should be associated with the database containing the tables being replicated by Transformation Server for Microsoft SQL Server version 5.3.4. 2. Log into Management Console.
Copyright IBM Corp. 2008
63
3. Connect to the Transformation Server for Microsoft SQL version 5.3.4 datastore. 4. Connect to the Transformation Server for Microsoft SQL Server version 6.2 datastore. 5. Click Configuration Subscriptions. 6. Select one or more subscriptions that use Transformation Server for Microsoft SQL version 5.3.4 as a source or target datastore and click Subscription Upgrade Upgrade Subscription. 7. Click Continue if you want to upgrade your subscriptions without assistance from Product Support. 8. Type a new name for each subscription in the New Name box. 9. Type a new source ID for each subscription in the New Source ID box. 10. Select a new source datastore for each subscription in the Source Datastore box. 11. Select a new target datastore for each subscription in the Target Datastore box. 12. Click OK to upgrade your subscription. After upgrading your subscription, Management Console displays an upgrade report that outlines any issues encountered during the upgrade process to version 6.2 of Transformation Server. To install Transformation Server for Microsoft SQL Server version 6.2, see the Transformation Server for Microsoft SQL Server version 6.2 documentation. Related tasks To log in to Management Console on page 21 To connect to a datastore on page 59
64
3. Enable the Clear Log check box for subscriptions for which you want to clear the log position. 4. Click Clear Log Position to set the replication method for the specified subscriptions to Refresh. You will not be able to resume replication with this subscription. Related tasks To upgrade a subscription to Transformation Server for Microsoft SQL Server version 6.2 on page 63 To transfer a bookmark to a new subscription on page 64
Upgrading subscriptions
65
66
5. Select the table that has changed in your relational database management system and click Update. Related concepts Updating, removing, and viewing tables for replication
67
Notes: v Before removing the table, you must first search for tables used in the replication by subscriptions, and then delete the table mapping if necessary. v Remove a table only if you have first deleted it from your relational database management system and it is still available for replication in Management Console. Related concepts Searching for tables used in replication on page 86 Updating, removing, and viewing tables for replication on page 67 Related tasks To delete a table mapping on page 140
68
Setting notifications
You can use notifications when you want to be alerted of any problems in your replication environment. Notifications are most useful when performing diagnostic analysis of replication activities in the Management Console and you want to detect events that are happening in your source and target datastores and/or subscriptions.
Filtering notifications
You can filter notifications. When an event occurs in your replication environment, InfoSphere CDC generates messages in the Event Log view. Each message is identified with an event ID. Using the event ID, you can specify the messages for which you want to be notified or those which should be suppressed. For example, if you want to be notified when mirroring fails on a subscription, you can specify the event ID for that message in the Filter Messages dialog box.
Copying notifications
You can copy notification settings to notification categories in the same datastore or subscription. Email notification settings include information such as the name of the person to which you send a notification or the subject line of an email. You can copy this information to other notification categories in the same datastore. For example, you may have already set an email notification that gets sent to jane@datamirror.com when the datastore DM0001@50000 on the source-side detects a fatal communications error on the network. You may have set other notifications that get sent in different events, but want all those notifications sent to the same account. Instead of having to manually specify that jane@datamirror.com receive all notifications detected from DM0001@50000 in each notification, you can copy this setting to other notification categories. Before you setup an email notification for MAPI, you should read the considerations outlined for these protocols in your InfoSphere CDC for Microsoft SQL Server documentation.
69
70
SYSLOG
v DB2 UDB for z/OSYou can indicate that you want to send the generated message to the operator system log maintained on zSeries servers. For more information about the operator system log, see the InfoSphere CDC for z/OS End-User Documentation. v Oracle (on UNIX servers only)You can indicate that you want to send a generated message to the UNIX syslogd program that logs messages from external applications like InfoSphere CDC Related concepts Setting notifications for a datastore on page 72 Setting notifications for a subscription on page 77
Notification categories
Notification categories represent the events that InfoSphere CDC detects in your source and/or target datastores. v Scrape/Refresh Events (Source)categorizes notifications that are generated for events that occur when InfoSphere CDC scrapes or refreshes data from your source datastore. v Apply Events (Target)InfoSphere CDC generates notifications related to events that occur during the target apply process. For example, InfoSphere CDC can generate a message when there is failure to apply on the target table. v Communications Eventscategorizes notifications that are generated for communication events that can occur between source and the target datastores. For example, InfoSphere CDC can generate a message when there is a failure to create TCP/IP socket. v Environment Eventscategorizes notifications that are generated when requirements for a basic replication environment are not met. For example, InfoSphere CDC can generate a message when it cannot connect to a database, or when permissions have not been set. v Journal/Log Maintenance Eventscategorizes notifications that are generated when InfoSphere CDC reads the journal or during log maintenance.
Setting notifications
71
v Status Messagesenables you to setup a notification for status messages. InfoSphere CDC sends a notification when it encounters a specific event during replication. For example, InfoSphere CDC can generate status messages in the Event Log view when it is going to refresh a table, when it cannot journal changes on a table, or when it has parked a table for replication. v Operational Messagesenables you to setup a notification for operational messages. InfoSphere CDC sends a notification when it has completed an operation during replication. For example, InfoSphere CDC can generate operational messages in the Event Log view after applying an operation to the target table, or when it has completed a refresh on a table. Related concepts Setting notifications for a datastore Setting notifications for a subscription on page 77
an an an an
set a notification for the TSDPRINT spool file on page 74 set a notification for an operator system log on page 74 set a notification for a UNIX system log on page 75 set a notification using a user exit program on page 75 set a notification using a user exit program on page 75 set a notification using a user exit program on page 76 set a notification for a message queue on page 76 filter a notification message on page 77
72
8. Type the name of the mail profile you created to identify the mailbox of the specific domain user in theProfile box. The subject and profile name cannot exceed 254 characters. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70
Setting notifications
73
74
Setting notifications
75
3. Depending on whether you want InfoSphere CDC to detect events on the source datastore or on the target datastore, click the Source tab or the Target tab. 4. Select a category from Notification Categories. 5. Select the User Exit box. 6. Type the name of the user exit program in the Program box. 7. Type the name of the library in the Library box. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70
Note: You can relay the same message up to 10 message queues. Related concepts Setting notifications on page 69 Selecting a notification handler on page 70
76
77
Depending on the InfoSphere CDC product you have installed, you can send this notification through email message queues, or a user exit program. Related concepts Setting notifications for a subscription on page 77
78
v Warninglatency for the journal or log is above the warning threshold but below the problem threshold. Latency is starting to become a problem according to the latency thresholds you have set for the subscription. v Problemlatency for the journal or log is above the problem threshold. Latency is now a problem according to the latency thresholds you have set for the subscription. See also: To set a latency threshold and notification
5. Specify a problem threshold (in minutes). The problem threshold must be greater than the warning threshold. 6. ClickSet Notification. 7. As a best practice, ensure that Target Apply Informational is enabled. You must configure at least one notification setting in the Informational category so that you can receive notification messages and this must be set on the Target tab. These changes will take effect the next time you start replication on this subscription. 8. Specify how you want to send this notification in the Notification Settings area. Depending on the InfoSphere CDC product you have installed, you can send this notification through email message queues, or a user exit program. In this section, you will learn: Related concepts Setting latency thresholds and notifications on page 78 Profiling the latency and throughput performance of your subscription on page 235
Setting notifications
79
80
81
To delete a project
To rename a project
1. Click Configuration Subscriptions. 2. Right-click on a project and select Project Rename Project. 3. Enter a new name for your project. Related concepts Using projects to organize your subscriptions on page 81 Related tasks To add a new project To delete a project
To delete a project
1. Click Configuration Subscriptions. 2. Right-click on a project and select Project Delete Project. Management Console will delete the project and move all subscriptions to your Default project. Related concepts Using projects to organize your subscriptions on page 81 Related tasks To rename a project To add a new project
To export projects
1. Click Configuration Subscriptions. 2. Right-click on a project and select Project Export Projects.
82
3. Type a name for the template in the File Name box. 4. Click Save. Related concepts Exporting and importing projects on page 82 Related tasks To import projects
To import projects
1. Click Configuration Subscriptions. 2. Right-click on a project and select Project Import Projects. Existing projects will be deleted during project import. 3. Select the CSV template that you want to import into Management Console and click Open. You will have to restart Management Console or reconnect to Access Server to see the changes. Related concepts Exporting and importing projects on page 82 Related tasks To export projects on page 82
Setting up subscriptions
Before you can start replicating data, you need to add a subscription. When adding a new subscription, you can organize your subscription into a project, select the datastores you want to use as the source and target of data during replication activities, and specify optional communication settings. How you decide to set up the datastores in your subscriptions depends on your replication requirements. See also: To add a subscription To modify a subscription on page 84 To delete a subscription on page 84
To add a subscription
1. 2. 3. 4. 5. Click Configuration Subscriptions. Right-click on a project and select New Subscription. Type the name of the subscription in the Name box. Type the description of the subscription in the Description box. From the Project list, select an existing project or click New Project to create a new project.
6. Select the source datastore from the Source list. 7. Select the target datastore from the Target list. Notes: v If you want to replicate data to a target datastore using a host name that differs from the one used in Management Console, then click Details and select the alias you created for the host name. v If you want this subscription to send data to an external target, then select External and click Details to configure an external target datastore.
Setting up and managing subscriptions
83
v By default, each new subscription you create is assigned a unique source ID in Management Console. If the subscription is sending data to an external target, you can specify a source ID that makes the subscription identifiable for the receiving organization. Click Advanced Settings. Related concepts Setting up subscriptions on page 83 Setting up subscriptions for datastores outside of your organization on page 86 Creating aliases for a target datastore on a private network connection on page 61
To modify a subscription
1. Click Configuration Subscriptions. 2. Right-click on a subscription and select Properties. 3. You can modify the following: v DescriptionType the description of the subscription. v ProjectSelect a project or click New Project to create a new project. Note: If you want to replicate data to a target datastore using a host name that differs from the one used in Management Console, then click Details and select the alias you created for the host name. Related concepts Setting up subscriptions on page 83 Setting up subscriptions for datastores outside of your organization on page 86 Creating aliases for a target datastore on a private network connection on page 61
To delete a subscription
1. Click Configuration Subscriptions. 2. Right-click on a subscription and select Delete subscription. You cannot delete a subscription when: v Your subscription is active. Before deleting a subscription, you must end replication. v You are using InfoSphere CDC Version 5.2 and have a subscription with an external target datastore. You must remove the table mappings for the subscription before you can delete the subscription. v Your subscription is not connected to the target datastore. You must connect to the target datastore before you can delete the subscription. Related tasks To end replication on page 199 To delete a table mapping on page 140 To connect to a datastore on page 59
84
v Firewall Portif the source and target datastores have a limited number of ports for communication through a firewall, you may need to specify a firewall port for your subscription. v TCP Hostspecifies the TCP host that your source datastore will use to recognize the target datastore when the computer where InfoSphere CDC is installed has multiple network cards. This is useful if you want to specify a host that is different from the host that you specified in InfoSphere CDC Access Manager. v Propagation Controlyou can use propagation control to prevent the replication of data from a particular source. This is useful if you are using a hub-and-spoke replication configuration and prevents subscriptions from unnecessarily repeating operations like inserting data. See also: To specify a TCP host for a subscription To specify a firewall port for a subscription To set propagation control on a subscription
85
3. Click Advanced Settings. 4. From the Propagation Control area, click Add to select the source ID of the subscription from which you want to prevent data from being replicated to the target. 5. Select the Do not replicate data received from any subscriptions box if you want to prevent data from being replicated to the target for all subscriptions. Related concepts Specifying advanced settings for a subscription on page 84
86
You can also copy subscriptions that send data to an external target. This is a time-saving mechanism. If your organization is at the receiving end of replication activities co-ordinated with another organization that is outside of your database security policy, then you should seeUnknown source datastores in your subscription list. This is because you are receiving replicated data from a source datastore that is outside of your security policy (and, therefore, to which you do not have access to) and the name of the source datastore is not known to you. See also: To add a subscription for an external target datastore To modify a subscription for an external target datastore
InfoSphere CDC creates the metadata tables when you install InfoSphere CDC. For more information, see the appropriate InfoSphere CDC End-User Documentation. 8. Type the name of the metadata database in the Database Name box. 9. Type the name of the database user that owns the external target metadata in the Owner box. 10. Type the password for the database user in the Password box. Note: This information is provided by the organization or department that owns the external target datastore. Related concepts Setting up subscriptions for datastores outside of your organization on page 86 Related tasks To modify a subscription for an external target datastore
87
Copying subscriptions
Copying a subscription is a time-saving mechanism. If you have a subscription that contains table mappings that you do not want to recreate, then you can copy the subscription under a new name. You can also recreate an existing subscription with the same table mappings if you want to setup a replication scenario within in another environment. See also: To a copy subscription To copy a subscription for an external target datastore
To a copy subscription
Click Configuration Subscriptions. Right-click on a subscription and select Copy Subscription. Type a name for the subscription in the Name box. Type a description for the subscription in the Description box. Select an existing project for the subscription from the Project list or click New Project to organize the subscription into a new project. 6. If you want to specify advanced settings, click Advanced Settings. 1. 2. 3. 4. 5. 7. Click Next. 8. Select the source datastore for the new subscription from the New Source Datastore list. 9. Select the databases and/or owners for the new source datastore under New Name and click Next. 10. Select the target datastore for the new subscription from theNew Target Datastore list. 11. Select the databases and owners for the new target datastore underNew Name and click Next. 12. If the existing subscription contains user exits, then specify their location for the new subscription under New Location and click Next. 13. If you built a derived column, an expression, or a row-filtering expression that uses the %SELECT column function, then confirm the list of displayed expressions and click Next. After copying the subscription, you may have to change these expressions manually. 14. Review the list of changes and click Finish. Related concepts Copying subscriptions Related reference Retrieve column%SELECT on page 293
88
4. Type the description of the new subscription in the Description box. 5. Select a project for the new subscription from the Project list or click New Project to create a new project. 6. If you want to specify advanced settings, click Advanced Settings. 7. Click Next. 8. Select the new source datastore for the subscription from the New Source Datastore list. 9. Select the databases and owners for your new source datastore under New Name. 10. Click Next. 11. If you want to change the properties of the external target datastore, then make the necessary changes and click Next. Note: This information is provided by the organization or department that owns the external target datastore. 12. Review the list of changes and click Finish. Related concepts Copying subscriptions on page 88
89
90
Mapping tables
After defining a subscription in Management Console, use the Map Tables wizard to map source and target tables. Subscriptions can contain as many table mappings as necessary. The number of table mappings you create depends on how many source tables you want InfoSphere CDC to replicate to the target system. In this section, you will learn: Mapping using standard replication Mapping using LiveAudit on page 100 Mapping using WebSphere DataStage on page 106 Mapping using Adaptive Apply on page 110 Mapping to summarize data on page 113 Mapping to consolidate data (one-to-one) on page 117 Mapping to consolidate data (one-to-many) on page 121 Mapping to a datastore outside of your organization on page 126 Mapping to a JMS message destination using InfoSphere CDC Event Server on page 127
91
92
16. Verify the mappings in the Complete Mappings page. The Map Tables wizard may leave some source tables unmapped if it did not find a target table that shared the same table structure or similar column names. You must map these manually. 17. Click Next. 18. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. 19. If you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then enable one of the following: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC Event Server creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table. 20. If you are using InfoSphere CDC for Microsoft SQL Server 5.3 to replicate source database changes and have configured bidirectional replication, then enable the Prevent Recursion check box. This prevents InfoSphere CDC Event Server from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM technical support to implement bidirectional replication in your environment. 21. Click Next. 22. Review the mapping summary and click Finish. Related tasks To map a custom source table to a custom target table (standard) To map multi-member source tables on AS/400 (standard) on page 95 To map multi-member source tables to existing target tables on AS/400 (one-to-one) on page 97 To map multi-member source tables to new tables on AS/400 (one-to-one) on page 99
93
4. Select Standard from the Mapping type list and clickNext. 5. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 6. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 7. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 8. If you want to modify this filter, select a database user or schema and click Specify Filter. 9. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 10. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 11. Click Next. 12. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 13. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 14. Select a table from the Target Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to map to a new target table, click Create Table. 15. Choose one of the following and click Next: v Use an Indexselect the index name from the Index box. Use if your target table has an index that uniquely identifies a row. v Specify the keyselect the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. v Use all searchable columnssearches all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Availability of the above options is dependent on the platform and version of InfoSphere CDC Event Server that you have installed. 16. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and
94
replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. 17. If you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then enable one of the following: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC Event Server creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table. 18. If you are using InfoSphere CDC for Microsoft SQL Server 5.3 to replicate source database changes and have configured bidirectional replication, then enable the Prevent Recursion check box. This prevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM technical support to implement bidirectional replication in your environment. 19. Click Next. 20. Review the mapping summary. 21. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping using standard replication on page 91 Setting member identifiers for multi-member source tables on page 187
95
7. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 8. If you want to modify this filter, select a database user or schema and click Specify Filter. 9. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 10. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 11. Click Next. 12. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 13. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 14. Select a table from the Target Tables list. If you do not see your table listed, select the database user or schema and click Refresh. Choose one of the following options and click Next: v Source and Target Files are Single Membermerges all members from the source table to a single-member target table. v Use Source member Structure on Targetmaintains the same multi-member structure on the target table as the one on the source table. Each source member is mapped to the corresponding target member. v Merge Source Members into One Target Membermerges all members from the source table to a single member in a multi-member. 15. Choose one of the following and click Next: v Use an Indexselect the index name from the Index box. Use if your target table has an index that uniquely identifies a row. v Specify the keyselect the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. v Use all searchable columnssearches all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Availability of the above options is dependent on the platform and version of InfoSphere CDC Event Server that you have installed. 16. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box.
96
v Refresh (Snapshot)replicates a snapshot of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. 17. Click Next. 18. Review the mapping summary. 19. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Attention: AS/400 must be installed on both source and target. Related concepts Mapping using standard replication on page 91 Setting member identifiers for multi-member source tables on page 187
97
7. 8. 9.
10.
v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next.
11. Enable Map to existing target tables and clickNext. 12. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 13. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. The wizard uses the relationship between this target table and the selected source table to map the remaining source and target tables. You can click Change Example Table if you want the Map Tables wizard to base the mapping on a different source table. This option is only available if you have selected more than one source table. 14. Select the target table from the Target Table list and clickNext. If any of the mappings are incorrect, you can click the assigned target table and pick another target table from the displayed list. If you have not chosen similar tables, you can select target tables individually by clicking on the target list beside the source table you want to map. 15. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make
98
use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. 16. Click Next. 17. Review the mapping summary. 18. Review the mapping summary and click Finish. Related concepts Mapping using standard replication on page 91 Setting member identifiers for multi-member source tables on page 187
5. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 6. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 7. If you want to modify this filter, select a database user or schema and click Specify Filter. 8. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 9. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 10. Click Next. 11. Enable Create New Target Tables and click Next. 12. Click Click to select a target owner under Target Library and select a target owner. 13. Choose from the following options and click Next: v Identical to the source table namesNames the new target tables the same name as the source tables.
Mapping tables
99
v Source table names with prefixes and/or suffixesAdds the suffix and/or prefix to the source table name. Enable the Use Prefix/Suffix for index name to use the prefix/suffix as the index name. 14. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. 15. Review the mapping summary and click Finish. Related concepts Mapping using standard replication on page 91 Setting member identifiers for multi-member source tables on page 187
100
Target Operations Either: v INSERT the row that contains the after image. v INSERT row containing before image values, and INSERT another row containing after image values.
Either: v INSERT the row that contains the after image. v INSERT row containing before image values, and INSERT another row containing after image values.
DELETE
a single source table using LiveAudit a multi-member table using LiveAudit for AS/400 on page 102 multiple source tables to existing tables using LiveAudit on page 104 multiple source tables to new tables using LiveAudit on page 105
Mapping tables
101
8. 9. 10.
11. 12.
13.
14.
You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. Select a table from the Target Tables list. If you do not see your table listed, select the database user or schema and click Refresh.
15. Click Next. 16. Review the mapping summary. 17. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping using LiveAudit on page 100
102
8.
9. 10. 11.
12. 13.
14.
15.
16. 17.
displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. Select a target table from the Target Tables list and choose one of the following options. v Source and Target Files are Single MemberMerges all members from the source table to a single-member target table. v Use Source member Structure on TargetMaintains the same multi-member structure on the target table as the one on the source table. Each source member is mapped to the corresponding target member. v Merge Source Members into One Target MemberMerges all members from the source table to a single member in a multi-member. Review the mapping settings. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view.
Attention: AS/400 must be installed on both source and target. Related concepts Mapping using standard replication on page 91 Setting member identifiers for multi-member source tables on page 187
Mapping tables
103
5.
6.
7.
8. 9. 10.
14.
15. 16.
104
If any of the mappings are incorrect, you can click the assigned target table and pick another target table from the displayed list. If you have not chosen similar tables, you can select target tables individually by clicking on the target list beside the source table you want to map. 17. Review the mapping summary and click Finish. InfoSphere CDC inserts a row into the target table for every row-level operation (insert, update, or delete) applied to a row in the source table. The target table can become extremely large. Ensure that you allow sufficient disk space and perform regular maintenance for target tables that audit data. Related concepts Mapping using LiveAudit on page 100
8. 9. 10.
11. 12.
Mapping tables
105
13. Click Click to select a target owner under Target Library and select a target owner. 14. Choose from the following options and click Next: v Identical to the source table namesNames the new target tables the same name as the source tables. v Source table names with prefixes and/or suffixesAdds the suffix and/or prefix to the source table name. Enable the Use Prefix/Suffix for index name to use the prefix/suffix as the index name. 15. Review the mapping summary and click Finish. Related concepts Mapping using LiveAudit on page 100
106
8. 9. 10.
11. 12.
13.
14. 15.
You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next. In the Directory box, type the output directory for the WebSphere DataStage flat files that are generated by InfoSphere CDC and utilized by WebSphere DataStage. Enable one of the following options for the record format of the flat files and click Next: v Single Recordan update operation is sent as a single row. v Multiple Recordan update operation is sent as two rows. Review the mapping settings. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view.
Mapping tables
107
9. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 10. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 11. Click Next. 12. In the Host box, type the host name of your WebSphere DataStage installation. 13. In the Port box, type port number for the WebSphere DataStage host. 14. Enable one of the following options for the output records used by WebSphere DataStage and click Next: v Single Recordan update operation is sent as a single row. v Multiple Recordan update operation is sent as two rows. 15. Review the mapping settings. 16. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view.
5. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 6. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 7. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next.
8. 9. 10.
11.
108
12. In the Directory box, type the output directory for the WebSphere DataStage flat files that are generated by InfoSphere CDC Event Server and utilized by WebSphere DataStage. 13. Enable one of the following options for the flat file output records and click Next: v Single Recordan update operation is sent as a single row. v Multiple Recordan update operation is sent as two rows. 14. Review the mapping settings and click Finish.
Mapping tables
109
6.
7.
8. 9. 10.
110
12. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 13. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 14. Select a table from the Target Tables list and click Next. If you do not see your table listed, select the database user or schema and click Refresh. Click Next. If you want to create a new table to map to, click Create Table. 15. Choose one of the following and click Next: v Use an Indexselect the index name from the Index box. Use if your target table has an index that uniquely identifies a row. Specify the keyselect the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. v Use all searchable columnssearches all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. v Availability of the above options is dependent on the platform and version of InfoSphere CDC Event Server that you have installed. 16. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. 17. If you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then enable one of the following: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC Event Server creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table. 18. If you are using InfoSphere CDC for Microsoft SQL Server 5.3 to replicate source database changes and have configured bidirectional replication, then enable the Prevent Recursion check box. This prevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM Technical Support to implement bidirectional replication in your environment.
Mapping tables
111
19. Click Next. 20. Review the mapping summary. 21. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping using Adaptive Apply on page 110
112
Specify the keyselect the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. v Use all searchable columnssearches all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Availability of the above options is dependent on the platform and version of InfoSphere CDC Event Server that you have installed. v 14. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. 15. Review the mapping settings. 16. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping using Adaptive Apply on page 110
Mapping tables
113
See also: To map a source table to summarize data To map multi-member source tables using Summarization on AS/400 on page 115
5.
6.
7. 8. 9.
10.
11. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 12. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 13. Select a table from the Target Tables list and click Next. If you do not see your table listed, select the database user or schema and click Refresh. Click Next. If you want to create a new table to map to, click Create Table. 14. Select the target columns from the Key Columns list and click Next. 15. Choose one of the following from the Summarization Type list: v AccumulationNumeric changes applied to target columns are directly proportional to changes applied to source columns. v DeductionNumeric changes applied to target columns are inversely proportional to changes applied to source columns.
114
16. Select the source column from the Summarized Column list and click Next. 17. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. 18. If you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then enable one of the following: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC Event Server creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table. 19. If you are using InfoSphere CDC for Microsoft SQL Server 5.3 to replicate source database changes and have configured bidirectional replication, then enable the Prevent Recursion check box. This prevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM Technical Support to implement bidirectional replication in your environment. 20. Click Next. 21. Review the mapping settings. 22. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping to summarize data on page 113
115
6.
7. 8. 9.
10. 11.
12.
13.
14.
15.
16. 17.
displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. Select a table from the Target Tables list and click Next. If you do not see your table listed, select the database user or schema and click Refresh. Click Next. If you want to create a new table to map to, click Create Table. Select the target columns from the Key Columns list and click Next. InfoSphere CDC for AS/400 requires that the selected key columns match an existing index. Choose one of the following from the Summarization Type list: v AccumulationNumeric changes applied to target columns are directly proportional to changes applied to source columns. v DeductionNumeric changes applied to target columns are inversely proportional to changes applied to source columns. Select the source column from the Summarized Column list and click Next. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on
116
the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. 18. Review the mapping settings. 19. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping to summarize data on page 113
Mapping tables
117
4. Expand the database user or schema from the Source Tables list. Management Console retrieves the tables from your database that are available for mapping. 5. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database use or schema and click Specify Filter. 6. If you have decided to specify a filter, choose a filtering method from the following options: v Show all tablesdisplays all the tables in your database that are available for mapping. v Show filtered tablesdisplays only the tables that meet the filter criteria you specified. You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. 7. If you want to modify this filter, select a database user or schema and click Specify Filter. 8. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. 9. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 10. Click Next. 11. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 12. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 13. Select a table from the Target Tables list and click Next. If you do not see your table listed, select the database user or schema and click Refresh. Click Next. If you want to create a new table to map to, click Create Table. 14. Check the key for the target columns and click Next. 15. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. 16. If you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then enable one of the following: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target.
118
v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC Event Server creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table. 17. If you are using InfoSphere CDC for Microsoft SQL Server 5.3 to replicate source database changes and have configured bidirectional replication, then enable the Prevent Recursion check box. This prevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM Technical Support to implement bidirectional replication in your environment. 18. Click Next. 19. Review the mapping settings. 20. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping to consolidate data (one-to-one) on page 117
Mapping tables
119
9. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. 10. Click Next. 11. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 12. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 13. Select a table from the Target Tables list and click Next. If you do not see your table listed, select the database user or schema and click Refresh. Click Next. If you want to create a new table to map to, click Create Table. 14. Check the key for the target columns and click Next. 15. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. 16. Review the mapping settings. 17. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping to consolidate data (one-to-one) on page 117
120
Before you map your lookup table for one-to-many consolidation, make sure you have completed the following tasks:
v Created a lookup table For InfoSphere CDC to accomplish one-to-many row consolidation, you need to create a lookup table that contains the columns you want InfoSphere CDC to update in your target table. For example, if you want InfoSphere CDC to update tax codes for a specific state, then make sure these columns exist in your lookup table and that you set a primary key. For example, the primary key in the TAXCODES table would be STATE. You can then map your lookup table to the target table using one-to-many consolidation. v Mapped your source table to the target table using Standard mapping type InfoSphere CDC requires that at least one source table is mapped to the target table using a mapping type other than one-to-many consolidation, such as Standard. When you map a source table using one-to-many mapping, InfoSphere
Mapping tables
121
CDC only updates the target table and does not insert or delete rows in the target table. Therefore, another mapping type such as Standard ensures that InfoSphere CDC populates the target table with source data. You need to identify the primary key on the source table. For example, to populate the target table STOREDATA with data from the source table STORELOC, you would map the source columns STORE, CITY, STATE, and TAX to the target columns STORE_CON, CITY_CON, STATE_CON, and TAX_CON. You can map these columns using Standard mapping type. v Created a derived column on the source table using %GETCOL to retrieve data from your lookup table After mapping your source table to the target table using Standard mapping type, InfoSphere CDC requires you create a derived column on the source table to retrieve data from the lookup table when replicating data from the source to the target table. For example, if you want your source table to retrieve tax codes and state information from the TAXCODES table, your %GETCOL expression would be: %GETCOL(TAX, TAXCODES, <default value>, STATE, STATE). The default value of the tax you want InfoSphere CDC to retrieve is up to you. In this example, a typical default value would be 0. See also: To map a source table to consolidate data (one-to-many) To map multi-member source tables using Consolidation one-to-many on AS/400 on page 124
5.
6.
7. 8. 9.
122
10. Click Next. 11. Expand the database user or schema from the Target Tables list. Management Console retrieves the tables from your database that are available for mapping. 12. If the Automatically prompt for filter when expanding nodes check box is enabled in your preferences, then the Filter Tables dialog box automatically displays when you expand a database user or schema. If this preference is not enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. 13. Select a table from the Target Tables list and click Next. If you do not see your table listed, select the database user or schema and click Refresh. Click Next. If you want to create a new table to map to, click Create Table. 14. Check the consolidation key for the target columns and click Next. InfoSphere CDC uses the consolidation key to determine the rows that will be updated in the target table in response to an update in the look-up table. The consolidation key must identify the same column you identified as the primary key in the lookup table. 15. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. 16. If you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then enable one of the following: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC Event Server creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table. 17. If you are using InfoSphere CDC for Microsoft SQL Server 5.3 to replicate source database changes and have configured bidirectional replication, then enable the Prevent Recursion check box. This prevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM Technical Support to implement bidirectional replication in your environment. 18. Click Next. 19. Review the mapping settings. 20. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping
Mapping tables
123
v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. After you map your lookup table for one-to-many consolidation, make sure you have set the following on the table mapping: 1. In the Table Mappings view, select the table mapping you just created and right-click Edit Mapping Details. 2. On the Column Mappings tab, verify your column mappings to the target table. Make sure that the appropriate columns from the lookup table are mapped to the target table. 3. On the Operations tab, selectUpdate all if exists from theOn Insert list. This ensures that InfoSphere CDC updates all rows where the consolidation key is the same when there is an insert on the lookup table. 4. Click Apply.
124
13.
enabled and you want to manually define a filter, select a database user or schema and click Specify Filter. Specify your filter and click OK. Select a table from the Target Tables list. If you do not see your table listed, select the database user or schema and click Refresh. Choose one of the following options and click Next: v Source and Target Files are Single Membermerges all members from the source table to a single-member target table. v Use Source member Structure on Targetmaintains the same multi-member structure on the target table as the one on the source table. Each source member is mapped to the corresponding target member. v Merge Source Members into One Target Membermerges all members from the source table to a single member in a multi-member. If you want to create a new table to map to, click Create Table. Check the key for the target columns and click Next. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target.
Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. 17. Review the mapping settings. 18. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. After you map your lookup table for one-to-many consolidation, make sure you have set the following on the table mapping: 1. In the Table Mappings view, select the table mapping you just created and right-click Edit Mapping Details.
Mapping tables
125
2. On the Column Mappings tab, verify your column mappings to the target table. Make sure that the appropriate columns from the lookup table are mapped to the target table. 3. On the Operations tab, selectUpdate all if exists from theOn Insert list. This ensures that InfoSphere CDC updates all rows where the consolidation key is the same when there is an insert on the lookup table. 4. Click Apply.
126
Mapping tables
127
9. 10. 11.
12. 13.
14. 15.
You can also import any existing filters or choose to export your filter to a text file for future use. Specify your filter and click OK. If you want to modify this filter, select a database user or schema and click Specify Filter. Select one or more tables from the Source Tables list. If you do not see your table listed, select the database user or schema and click Refresh. If you want to hide columns so that the target is not aware of them, select a source table and click Filter Columns. Clear the check box for the column you want to hide and click OK. Click Next. Enable one of the following options: v Use the source table structure for the XML message: Include before-image valuesenable this option when you want the XML message to include the before image of a row-level operation. The before-image represents the data in the source column before an insert, update, or delete operation on the row. Include after-image valuesenable this option when you want the XML message to include the after image of a row-level operation. The after-image represents the data in the source column after an insert, update, or delete operation on the row. Include journal control valuesenable this option when you want the XML message to include journal control fields. These provide information about the source table, the source database, or the row-level operations taking place in the database log or journal of the source database. For example, the _ENNTYPE journal control field indicates the type of row-level operation (insert, update, or delete) that took place on the source table. v Value Formatchoose how you want to format source column data in the XML message. You can choose from one of the following: Use attributes for data valuesformats data values of the before image, the after image, or journal control fields in your XML message as XML attributes. Use elements for data valuesformats data values of the before image, the after image, or journal control fields in your XML message as XML elements. v Do not specify the message format at this timeenable this option when you want to manually decide whether you want to include the before or after image values for source columns, or journal control fields in your XML document. Click Next. Select the JMS connection you had configured in the InfoSphere CDC Event Server Configuration Tool and click Add Destination to add a queue or a topic. Type the name of queue or topic in theName box. Type a brief description about the queue or topic in the Description box. Type the JNDI name of the JMS queue or topic to which you want to send the XML message in the Request Destination box. Enable one of the following options: v Use persistent deliveryenable to ensure the message is not lost in transit due to a JMS provider failure.
128
v Use transacted sessionsenables InfoSphere CDC Event Server to open a transacted session and commit every message to the JMS queue or topic. 20. Click Test and OK. 21. Click Next and Finish. Related concepts Mapping to a JMS message destination using InfoSphere CDC Event Server on page 127 Related tasks To map a single source table to a JMS message destination To stage a source table on page 131
129
before-image represents the data in the source column before an insert, update, or delete operation on the row. Include after-image valuesenable this option when you want the XML message to include the after image of a row-level operation. The after-image represents the data in the source column after an insert, update, or delete operation on the row. Include journal control valuesenable this option when you want the XML message to include journal control fields. These provide information about the source table, the source database, or the row-level operations taking place in the database log or journal of the source database. For example, the _ENNTYPE journal control field indicates the type of row-level operation (insert, update, or delete) that took place on the source table. v Value Formatchoose how you want to format source column data in the XML message. You can choose from one of the following: Use attributes for data valuesformats data values of the before image, the after image, or journal control fields in your XML message as XML attributes. Use elements for data valuesformats data values of the before image, the after image, or journal control fields in your XML message as XML elements. v Do not specify the message format at this timeenable this option when you want to manually decide whether you want to include the before or after image values for source columns, or journal control fields in your XML document. 14. If you have decided to format the XML message based on an imported schema, mapping project, or XML file, then browse for the file and enable one or both of the following options: v Import repeated elements with the same parentby default, InfoSphere CDC Event Server imports only one repeated element in a group node with the same parent. Enable this option to import all repeated elements. v Import attribute valuesby default, InfoSphere CDC Event Server imports only the structure of your XML. Enable this option to import the attribute values. This may be necessary if attribute values represent the structure of your XML document. 15. Click Next. 16. Select the JMS connection you had configured in the InfoSphere CDC Event Server Configuration Tool and click Add Destination to add a queue or a topic. 17. Type the name of queue or topic in the Name box. 18. Type a brief description about the queue or topic in the Description box. 19. Type the JNDI name of the JMS queue or topic to which you want to send the XML message in the Request Destination box. 20. Enable one of the following options: v Use persistent deliveryenable to ensure the message is not lost in transit due to a JMS provider failure. v Use transacted sessionsenables InfoSphere CDC Event Server to open a transacted session and commit every message to the JMS queue or topic. 21. Click Test and OK. 22. Click Next and Finish. Related concepts
130
Mapping to a JMS message destination using InfoSphere CDC Event Server on page 127 Related tasks To map multiple source tables to a JMS message destination on page 127 To stage a source table
131
16. Choose one of the following and click Next: v Use an Indexselect the index name from the Index box. Use if your target table has an index that uniquely identifies a row. v Specify the keyselect the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. v Use all searchable columnssearches all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Availability of the above options is dependent on the platform and version of InfoSphere CDC Event Server that you have installed. 17. Choose a replication method from the following and click Next: v Mirror (Change Data Capture)immediately replicates changes made to the source table to the target table or accumulate source table changes and replicate at a later time. If your configuration requires you to prevent recursive updates when mirroring, enable the Prevent Recursion check box. v Refresh (Snapshot)replicates a snapshot of the source table to the target table. 18. Review the mapping summary. 19. Choose one of the following options and click Finish: v Define column mappingscontinues with the column mapping v Create a new table mappingallows you to start a new table mapping v Return to current viewreturns you to the current view. Related concepts Mapping to a JMS message destination using InfoSphere CDC Event Server on page 127
132
133
2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select the subscription that contains the mapped source and target tables. Ensure you have ended replication on the subscription. 4. Select the table mapping in the Table Mappings view. 5. Right-click Remap Source Table. This option is only available if you have already mapped your source table to a message destination or to a staging target table. 6. Enable one of the following: v Message Destination Mappingsenable this option if you want to map this source table to a message destination. v One mapping of any typeenable this option if you want to map this source table to a staging target table. Select Standard as the mapping type. 7. Click Next and map the source table to a message destination or to a staging target table. Related concepts Remapping a source table on page 133 Related tasks To map multiple source tables to a JMS message destination on page 127 To stage a source table on page 131
134
135
manually mark a table capture point in Management Console. When you decide to start mirroring on the subscription, InfoSphere CDC identifies the position you have set as the point in time from which to capture and replicate database changes to the target. See also: To mark a table capture point on a source table before mirroring
Tip: You can park more than one table-mapping at a time. Related concepts Parking a table mapping from replication Ending replication on a subscription on page 198
136
137
138
6. Right-click, click Change Replication Method. 7. Enable Refresh. This disassociates the journal table from the source table. If you are using this same source table in other subscriptions, then you must set the replication method to Refresh for these subscriptions as well. InfoSphere CDC disassociates the journal table from the source table in each subscription. 8. Click OK. The table mapping should have a replication method and status of Refresh/Refresh. 9. Select the same table mapping and click Change Replication Method. 10. Enable Mirror. This lets you select a new journal table. 11. Choose one of the following options and click OK. v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC Event Server creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table.
Managing table mappings
139
Namelists the name of the journal table. Related concepts Ending replication on a subscription on page 198 Selecting a new journal table on page 139 Mapping tables on page 91
5. Select a table mapping. 6. Right-click, click Set Member Replication. 7. You can choose from one of the following: v All current and future membersEnables InfoSphere CDC to replicate all members, including members you may add a future point in time. v Selected members onlyEnables InfoSphere CDC to only replicate the members you selected. Related concepts Setting members for replication
140
4. Select the table mapping in the Table Mappings view. 5. Right-click and click Delete Table Mappings. Related concepts Ending replication on a subscription on page 198
141
Note: As a best practice, you should verify your mapping details. If you have added a new column and you want InfoSphere CDC to replicate data from this column, then you need to map that column to the target. Related concepts Flagging a source table for a refresh on page 135 Updating the definition of mapped source and target table in a subscription on page 141 Mapping source columns to target columns on page 157
142
143
Add an XML attribute Rename an element or attribute Move an XML element or attribute up and down the result tree Change the node type to either XML element or attribute 8. For each XML element or attribute you have mapped to a source column, verify the following options from the Output area: v Alwaysindicates that if the value of an XML element or attribute is empty, then InfoSphere CDC Event Server includes the XML element or attribute in the XML message and sets the value to an empty string. This occurs when you have mapped an XML element or attribute to a source column that is blank, or when you have mapped the XML element or attribute to a source column that contains a derived expression that results to an empty string. v Output when empty or NULLindicates that if the value of an XML element or attribute is mapped to a source column that is empty or NULL, then the XML element or attribute is not included in the XML message. v Optional when NULLindicates that if the value of an XML element or attribute is mapped to a source column that is NULL, then the XML element or attribute is not included in the XML message. However, if the XML element or attribute is mapped to a source column that contains an empty string, then InfoSphere CDC Event Server includes the XML element or attribute in the XML message. 9. Verify the XPath expression for each mapping in the Value area. When you map a source column to an XML element or attribute, you are mapping the value of the source column to an XML element or attribute. This value is represented as an XPath expression in the Value area. If necessary, you can edit the expression using the Expression editor. 10. Click Apply. Related concepts Importing and exporting XML files, schemas, and mapping projects Related tasks To build an XPath expression on page 146 To end replication on page 199
144
Importing and exporting XTRANS filesyou can export the mapping definition of your XML document with values to your local computer. You can later reuse the mapping definition for other XML documents by importing it back into Management Console. It is important to note that any preexisting mappings between source columns to XML elements and attributes in Management Console are replaced with the imported mapping definition.
See also: To import an XML, schema, or mapping definition file To export an XML schema or mapping definition file
145
3. Select the subscription that contains the table mapping to a message destination. 4. Click the Table Mappings view and select the table mapping. 5. Right-click Edit Mapping Details. 6. Click the XML Message tab. Ensure you have created the structure of an XML message that you can export. 7. Click and from the Save as Type list, select one of the following: v Schema file (XSD)exports only the structure of the XML document. This includes the name of the element, attribute, and the tree structure. Any pre-existing mapping definitions are not exported. v Mapping definition (XTRANS)exports the structure of the XML document and the mapping definition you created in Management Console. 8. Click Save. Related concepts Importing and exporting XML files, schemas, and mapping projects on page 144
146
DatabaseRepresents the source database and lists all the nodes (such as source columns and journal control fields) in your source table. Select the node you want to search for, double-click it to add to the Expression box. You can repeat this process for all the nodes you want to add to the expression. v Target XML DocumentRepresents the XML document that you want to send to the JMS queue or topic. v Saved expressionsLists any saved expressions you have built. Your XPath expression can reference these. 9. Click Validate to verify the expression and click OK. v The XPath expression should now reference the before or after image of the column, a function, a literal or a combination of each of these. Related concepts Building an XPath expression on page 146
147
v Click Next to continue with the wizardenable when you want the wizard to create the SQL statement for you based on the columns in the other table. You can modify the SQL statement in the SQL Expression editor. v Click Finish to add the table and open the SQL editorenable when you want to create your own SQL statement in the SQL Expression editor. 13. If you had enabled the Click Finish to add the table and open the SQL editor option, click Finish. The SQL Expression Editor opens and you are required to build a valid SQL expression. When you have completed building the SQL statement, you must map this expression to an XML element or attribute in your XML document. When you start replication, InfoSphere CDC Event Server will retrieve data values from the table based on your query. Otherwise, click Next to continue build your SQL statement with the help of the wizard. 14. On the Select Clause page, review the columns in your select statement. If you want to add more columns, click Add. Specify a name for the column and the column or expression you want InfoSphere CDC Event Server to retrieve. Note: You can modify the name to an alias name. With SQL, aliases can be used for column names and table names. If you specify an alias for the column name, the SELECT statement will retrieve the column and return the result with the alias name you specified. 15. Click OK and click Next. 16. On the WHERE Clause page, you can choose to add filters to restrict which rows are returned by the query. The where clause is optional. Omitting the WHERE clause from your SQL statement specifies that all rows are returned by the query. If you want to create a WHERE clause, click Add to enable the fields required to build your WHERE clause statement. Your WHERE clause can return one of the following values: v Static valuesto build your WHERE clause so that it returns a static value, select Value from the Type list and specify the value in the Value box. v The before image or the after image of a rowto build your WHERE clause so that it returns the before image or the after image of the column, select Trigger from the Type list and then select either the before image or the after image of the column from the Value list. Also, if you want InfoSphere CDC Event Server to detect any missing before images or after images, then enable the If before/after image does not exist, then use other image check box. For example, if you map the before image of a column to an XML element or attribute and the operation on the source database was an insert, then because there is no before image of that column, InfoSphere CDC Event Server inserts the after image of the column instead when you enable this check box. Also, if you map the after image of a column to XML element or attribute and the operation on the source database was a delete, then because there is no after image of a delete operation, InfoSphere CDC Event Server inserts the before image of that column instead. v The column of a parent tableto build your WHERE clause so that it returns the column of the parent table, select Parent Table Column from the Type list and then select the column name from the Value list. This option is only available if the table is added a child of a parent table. 17. Click Next.
148
18. On the GROUP BY clause page, group the results by one or more columns. The GROUP BY clause is optional. When specified, it can be used in a SELECT statement to collect data across multiple rows. 19. Click Next. 20. On the ORDERED BY clause page, sort the records in your result set. The ORDER BY clause is optional. You can order the result set in either ascending or descending order. 21. Click Finish. Related concepts Querying columns from other tables on page 147
149
150
151
4. JMS uses a priority scale from 0 to 9, where 0 indicates the lowest priority and 9 indicates the highest priority. v JMS Reply Tocontains a destination supplied by a client when a message is sent. If you want to receive a response from the JMS queue or topic when either of these destinations receive a message, then specify the destination. v JMS Time to Livespecifies the number of milliseconds that you want the XML message to remain in the queue or topic. This value is used by your JMS provider to delete XML messages automatically once the amount of time specified in the box expires. The default value is 0, which indicates that the XML message will never be deleted automatically from the queue or topic. v JMS Typespecifies the type of message you are sending. This could be the name of the queue or topic. Your JMS provider can use a message repository that contains the definition of messages sent by third party applications. You should enter a symbolic value that can be configured to the values defined in the current providers message repository. 8. Click to open the expression editor and set a value for the JMS property. 9. Specify a value (enclose the value in quotation marks) or an expression for the JMS property and click Verify . 10. Click OK and Apply. Related concepts Setting JMS message header properties on page 151
9. Click to set a value in the Expression editor. 10. Click OK. 11. Click Apply. Related concepts Setting JMS message header properties on page 151
152
3. 4. 5. 6. 7.
Ensure you have created a subscription that uses the Event Server datastore as the target database. Select the subscription that contains the table mapping to a message destination. Click the Table Mappings view and select the table mapping. Right-click Edit Mapping Details. Click the XML Settings tab. Select the JMS property you want to delete in the Custom Settings area.
8. Click Delete. 9. Click Apply. Related concepts Setting JMS message header properties on page 151
153
5. 6. 7. 8.
Right-click Edit Mapping Details. Click the XML Settings tab. Enable the Trim Text check box. Click Apply. Related concepts Setting general runtime options on page 153
To disable InfoSphere CDC Event Server from differentiating between an empty string from a NULL value
1. Click Configuration Datastores. Ensure you are connected to an Event Server datastore. 2. Click Configuration Subscriptions. Ensure you have created a subscription that uses the Event Server datastore as the target database. 3. Select the subscription that contains the table mapping to a message destination. 4. Click the Table Mappings view and select the table mapping. 5. Right-click Edit Mapping Details. 6. Click the XML Settings tab. 7. Disable the Nullable XPath expression check box. 8. Click Apply. Related concepts Setting general runtime options on page 153
154
155
156
Mapping columns
After mapping your tables using the Map Tables wizard, you can use the Column Mappings tab to customize what items you want to map to target columns in a subscription. If you have mapped your tables using any mapping type, then most or all of your target columns are already mapped to source columns that have identical names and attributes. However, using the Columns Mappings tab, you can customize the kind of information you want to map to a target column and populate it with. In this section, you will learn: Mapping source columns to target columns Mapping journal control fields to target columns on page 158 Mapping expressions to target columns on page 158 Mapping source and target columns automatically on page 160 Mapping initial values to target columns on page 161 Adding and mapping derived columns to target columns on page 162
157
Related concepts Mapping source columns to target columns on page 157 Starting and ending replication on subscriptions on page 197
158
manipulation function. If you are calling a stored procedure that is not owned by the InfoSphere CDC user, you must provide the name in the form <schema>.<stored procedure name>. Mapping accumulation and deduction expressions to a target columnIf you have mapped your tables using Summarization in the Map Tables wizard, then you can map accumulation or deduction expressions to a target column. When you map tables for summarization, the target table is largely a repository of numerical data increments or decrements in response to source row-level operations transferred by refresh or mirroring activity. For example, if you have a target column such as REVENUE and you want the value in this column to increment each time a product gets sold in the SALESAMOUNT source column, then you can map SALESAMOUNT to REVENUE. Drag and drop the source column from the list beside the target column to which you want to map. See also: To map an expression to a target column To accumulate or deduct numeric data on a target column Related concepts Mapping to summarize data on page 113 Related tasks To configure a derived column or an expression that calls %STPROC (Oracle and Sybase) on page 218
159
6. Depending on which source columns you want to summarize data, map your source columns to target columns. 7. Expand the Summarization list and drag and drop eitherAccumulation or Deduction expressions on the source and target column mapping. You can also build an expression that summarizes data. 8. Select the source column and clickOK. Depending on how you want to summarize data, the source column in the list updates with a plus or minus sign. 9. Click Apply. When you start replication on the subscription, InfoSphere CDC accumulates or deducts the summarized data in response to row-level operations occurring on the source table. Related concepts Mapping expressions to target columns on page 158
7. Enable one of the following mapping modes: v Original positionmaps columns based on changes made on the Column Mapping tab before you opened the Map Columns Automatically dialog box. v Ordinal positionmaps columns based on the order of columns in the source and target tables. The first column in the target table is mapped to the first column in the source table, the second column in the target table is mapped to the second column in the source table, and so on. If the number of columns in the target table is greater than the number of the columns in the source table, then initial values are used for trailing columns in the target table. If the number of columns in the source table is greater than the number of columns in the target table, then trailing columns in the source table remain unmapped. You can only map by ordinal position provided the data types are compatible.
160
v Name to namemaps columns based on matching column names. For example, if a column in the source table is called EMPNAME, then this column is automatically mapped to the column in the target table called EMPNAME. v Name to descriptionmaps columns based on matching target column names in source column descriptions. This is useful when you are working on an iSeries database platform and you need to map the source table names to target columns. 8. Click OK. 9. Click Apply. You should see your target columns mapped in the mode you selected on the Column Mappings tab. When you start replication on the subscription, InfoSphere CDC populates the target columns using the mapping mode you set. Related concepts Mapping source and target columns automatically on page 160
Mapping columns
161
v ZeroPopulates the target column with a value of zero. The data type of the target column must be numeric. v Database DefaultPopulates the target column with the default specified in your RDBMS. Whenever a row gets inserted into the target table, the value that populates this column is determined from the column defaults defined in your RDBMS. v Current DatePopulates the target column with the current date. The data type of the target column must be datetime. If your subscription uses InfoSphere CDC for z/OS as a target datastore, and you have mapped your tables using the LiveAudit mapping type, then both the before image and the after image of an update operation are populated with the same current date. 9. Click OK. 10. Click Apply. When you start replication on the subscription, InfoSphere CDC populates this target column with the initial value you specified. Related concepts Mapping initial values to target columns on page 161
162
In each of these scenarios, you can then map the derived column to the appropriate target column. InfoSphere CDC will evaluate the expression on the source table and send the results to the target column. See also: To add a derived column To map a derived column to a target column on page 164 To modify a derived column on page 164 To delete a derived column on page 165
For performance reasons, evaluate the After Image Only value. An evaluation frequency of Before and After Images (*BTH) is only necessary when you are performing conflict detection and resolution, which requires the before image to recognize conflicts, or when you are auditing so that you can audit the full before image. You also need to select this evaluation frequency if the target column to which you mapped the derived column is a primary key column. This maintains database integrity. Click Editor to build the expression for the derived column. Click Verify to verify the syntax of the expression. Click OK to return to the Define Derived Column dialog box. Click OK.
16. Click Apply. You should see the new derived column listed in the Source Columns list of the Column Mappings tab. You can map this derived column to a target column so that InfoSphere CDC can populate the results of the derived column in the target column.
Mapping columns
163
Notes: v If you already have a source column in your RDBMS on which you want to base the properties of your derived column, click Copy Column and select the column from the list of tables. The properties of this column (the data type, length, and any precision) are used as the properties of your derived column. v Derived columns and the expressions you build for them are evaluated on source tables. v Since the derived expression is evaluated each time a change is replicated to the target table, the complexity of the expression can affect overall performance.
164
Mapping columns
165
166
Filtering rows
In order to include or exclude particular rows for replication, you need to build a row-filtering expression. All row-filtering expressions that you define must return a boolean result. For example, you may have a source column such as SALARY that maintains the salary for each employee in your organization. You may only want to replicate those rows to the target table for those employees that have a salary greater than $48,000. In this scenario, you would need to define a row-filtering expression (SALARY > 48000). You can use column manipulation functions, basic numeric operators, and SQL SELECT WHERE clauses in your row-filtering expressions. The following are examples of valid row-filtering expressions: v (SALES < 10000) OR (SALES > 90000) v ((AIRPORT = JFK) OR (AIRPORT = LAX)) v %IF(COUNTRY = US, PRODUCTPRICE, PRODUCTPRICE *1.2) > 50 v PRODUCTPRICE * (1 + TAX) > 20000 See also: To filter rows
To filter rows
Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Filtering tab. Click Editor and build a row-filtering expression. The expression must return a boolean result. 7. Click Verify to check the syntax of the expression and click OK to return to the Filtering tab. 8. Choose one of the following options in the Row-filtering area: v Select rows that match the expressionSelect this option if you want InfoSphere CDC to replicate the source rows that satisfy your row-filtering expression. v Omit rows that match the expressionSelect this option if you want InfoSphere CDC to select for replication all rows except those that satisfy your row-filtering expression. 1. 2. 3. 4. 5. 6.
Copyright IBM Corp. 2008
167
9. Click Apply. When you start replication on the subscription, InfoSphere CDC excludes this column for replication. Related concepts Filtering rows on page 167
If you are using InfoSphere CDC for AS/400 on the source, then you need to enable the Critical Column Filtering system parameter to *YES. Related reference Critical Column Filtering on page 452
Filtering columns
By default, InfoSphere CDC replicates all mapped source columns to the target table. If there is a source column you want to exclude for replication, then you can clear it on the Filtering tab. Excluding source columns for replication may become necessary if the column contains confidential information that you do not want the target to receive. See also: To filter columns on page 169
168
To filter columns
Click Configuration Subscriptions. Select the subscription. Click the Table Mappings view and select the table mapping. Right-click and select Edit Mapping Details. Click the Filtering tab. Source columns that you can clear for replication are selected with a green check mark in the Replicate column. 6. If you do not want InfoSphere CDC to replicate data from a source columns, then clear the green checkmark for that column. 7. Click Apply. 1. 2. 3. 4. 5. Note: You cannot clear a source columns from replication if you have already mapped them to target columns. You need to unmap the source column on the Column Mappings tab. When you start replication on the subscription, InfoSphere CDC excludes this column for replication. Related concepts Filtering columns on page 168
169
170
v v v
See also: To add a data translation on page 172 To modify a data translation on page 172 To delete a data translation on page 173
Copyright IBM Corp. 2008
171
Related tasks To add a data translation To modify a data translation To delete a data translation on page 173 To import a data translation on page 173 To export a data translation on page 174
5. Click the Translation tab. 6. Select a mapped source and target column. 7. ClickAdd. 8. Type the data you want to translate in the From box. 9. If you want to translate a NULL data type, then check the Translate from NULL box. 10. Type the value to which you want to translate, in the To Value box. 11. If you want to translate to a NULL value, check the Translate to NULL box. 12. If you want to add another translation, ClickAdd. 13. Click OK to add the translation to your list of data translations. When you start replication on the subscription, InfoSphere CDC converts the value in the source column to the value you specified, and populates the mapped target column with the converted value. Related concepts Mapping tables on page 91 Starting and ending replication on subscriptions on page 197
When you start replication on the subscription, InfoSphere CDC converts the value in the source column to the value you specified, and populates the mapped target column with the converted value. Related concepts Mapping tables on page 91 Starting and ending replication on subscriptions on page 197
172
Notes: v If you want to apply the data translation to the column mapping, select the translation and clickApply. v When you import a data translation into Management Console, any existing translations are replaced with the imported translations. Related concepts Importing and exporting data translations Related tasks To export a data translation on page 174
173
174
175
Management Console provides standard character sets and encodings. If you want to add more character sets and encodings, then you need to add it to the CSV (comma separated variable) template. Conversion of multibyte character sets is supported on InfoSphere CDC Version 6.0 or higher. See also: To convert multibyte character sets
176
non-single-byte character data. NOCHANGE ensures that InfoSphere CDC handles non-single-byte character data in the same way as previous InfoSphere CDC releases. See also: To set handling for Unicode character encodings
6. Select the source column that supports character handling from the Source Columns list. This enables the Encoding Conversion area. 7. Select Character Handling from the Source list. 8. If you have set the system parameter Unicode Handling to use the system default method to handle the character set, select System Default. 9. If you want to use an encoding for the character set, select from one of the following: v CHARSelect this if you have set the system parameter Unicode Handling to CHAR. InfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this encoding when Unicode columns contain single-byte character data. v NOCHANGESelect this if you have set the system parameter Unicode Handling to NO CHANGE. InfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this encoding when Unicode columns contain non-single-byte character data. NOCHANGE ensures that InfoSphere CDC handles non-single-byte character data in the same way as previous InfoSphere CDC releases. 10. Click Apply. 11. Depending on the platform on which you have installed InfoSphere CDC, set one of the following system parameters: v For InfoSphere CDC for AS/400, see Unicode Handling on page 444. v For InfoSphere CDC for Oracle, see UNICODE_HANDLING on page 364. v For InfoSphere CDC for Microsoft SQL Server, see Unicode Handling on page 325. Related concepts Handling Unicode character encodings on page 176 Related reference Unicode Handling on page 444
177
178
4. 5. 6.
7.
Depending on your selections, when you start replication, InfoSphere CDC does not apply the row operation.
Copyright IBM Corp. 2008
179
180
When you start replication, the target table only audits the source table when there is a change made to the after image. Related concepts Preventing the audit of row operations on page 180
181
182
183
184
You can also specify additional SQL statements that execute after InfoSphere CDC applies a table refresh or truncate/clear operation to the target table. For all InfoSphere CDC products (except for InfoSphere CDC for z/OS and InfoSphere CDC for DB2 UDB), you need to run the DMSQL command to enable the Additional SQL feature in Management Console. For more information, see the commands section of the appropriate InfoSphere CDC End-User Documentation for your InfoSphere CDC product. If you have installed InfoSphere CDC for z/OS, then you need to set the keyword ALLOWSQL to YES to enable theAdditional SQL feature in Management Console. You can add this keyword to the TSDDBMxx Configuration Control data set member. For more information about this keyword, see Section 4.3 Modifying DBMS LOAD Configuration Control Statements in the InfoSphere CDC for z/OS End-User Documentation. If you have installed InfoSphere CDC for DB2 UDB, then you need to create a metadata table to enable the Additional SQL feature in Management Console. For more information, see InfoSphere CDC for DB2 UDB End-User Documentation. Before issuing SQL statements in Management Console, consider the following: v If you are referencing a database, table, or column name that contains spaces, then you must enclose the name in square brackets. For example, to reference the table name EMP NY, you must enter it as [EMP NY]. v If your delete WHERE clause references a character column, the specified value must be enclosed in single quotes. For example, MGR = Anna Kim. v You cannot reference LOB columns in delete WHERE clauses. v Specify only SQL INSERT, UPDATE, and DELETE statements. v SQL statements must be 4,000 bytes or less in length. If you specify SQL statements that do not fit on one line, do not press the Enter key to break the statements over more than one line. The text will feed automatically to the next line. v No support for logical branching and iteration. v The database running on the target server must recognize the syntax of the SQL statements. v Separate multiple SQL statements by semi-colons (;). If a character string in a SQL statement contains a semi-colon, specify two semi-colons consecutively (;;) in the string. v Management Console does not verify SQL statements for syntactical correctness. The target DBMS verifies statements during replication. See also: To specify additional SQL after a refresh To delete selected rows on a refresh on page 186
185
6. From the On Clear/Truncate list, select Delete Selected Rows. 7. Click Additional SQL. 8. If you want InfoSphere CDC to execute SQL after a truncate operation, then type SQL statement in the SQL Immediately After Truncate box. 9. If you want InfoSphere CDC to execute SQL after a refresh operation, then type SQL in the SQL Immediately After Refresh box. 10. Click OK to save your changes. 11. Click Apply. Note: If InfoSphere CDC encounters an error during execution of a SQL statement, it ignores all remaining statements. Also, depending on the system parameters you have set, InfoSphere CDC either continues or ends data replication in response to the error. Related concepts Specifying SQL to control refresh operations on page 184 Related tasks To delete selected rows on a refresh
186
7. 8. 9. 10.
Copyright IBM Corp. 2008
187
You can continue adding identifiers for each member in your source table. 11. Click OK. 12. Click Apply. Related concepts Setting member identifiers for multi-member source tables on page 187
6. Click Member Identifiers. 7. Click Modify. 8. Make the necessary changes and clickOK. You can continue making changes to other member identifiers or click OK to save your changes. 9. Click Apply. Related concepts Setting member identifiers for multi-member source tables on page 187
188
189
to the target.
Note: Conflict detection and resolution is only available when you map your tables using Standard replication. Conflict detection and resolution is supported for InfoSphere CDC version 5.3 and higher. See also: To resolve conflicts for source row wins To resolve conflicts for target row wins on page 191 Related concepts Resolving conflicts for source or target wins on page 189 Mapping using standard replication on page 91
190
The Target Column displays all of the columns in the target table. 6. Select the columns on which you want to detect conflicts. 7. Select Source Wins from the Conflict Resolution Method list. 8. Click Apply. When you start replication on the subscription, if InfoSphere CDC detects a conflict in the target column, the source data is replicated to the target. Note: Conflict detection and resolution is only available when you map your tables using Standard replication. Conflict detection and resolution is supported for InfoSphere CDC version 5.3 and higher. Related concepts Resolving conflicts for source or target wins on page 189 Mapping using standard replication on page 91
191
then InfoSphere CDC uses NULL as the comparison value. If InfoSphere CDC detects the conflict while deleting a row, then it uses the before image of the source table and compares it to the target value. If both the source and target values are the same, then InfoSphere CDC resolves the conflict using the Target Wins method (no change is applied to the target).
When resolving conflicts for smallest value wins, InfoSphere CDC treats NULL values as the smallest possible value. If the row does not exist on the target table, then InfoSphere CDC uses NULL as the comparison value. If InfoSphere CDC detects the conflict while deleting a row, then it uses the before image of the source table and compares it to the target value. If both the source and target values are the same, then InfoSphere CDC resolves the conflict using the Target Wins method (no change is applied to the target). If both the source and target values are the same, then InfoSphere CDC resolves it using the Target Wins method (no change is applied to the target). Note: Conflict detection and resolution is only available when you map your tables using Standard replication. Conflict detection and resolution is supported for InfoSphere CDC version 5.3 and higher. See also: To resolve conflicts for largest value wins on page 193 To resolve conflicts for smallest value wins on page 193 Related concepts Mapping using standard replication on page 91
192
193
Resolving conflicts for source or target wins on page 189 Mapping using standard replication on page 91
Note: Conflict detection and resolution is only available when you map your tables using Standard replication. Conflict detection and resolution is supported for InfoSphere CDC version 5.3 and higher. See also: To resolve conflicts with user exit programs on page 195 Related concepts Mapping using standard replication on page 91
194
195
196
197
3. Select the subscription. 4. Right-click and select Start Mirroring (Net-change) . Related concepts Starting mirroring on a subscription on page 197
To start a refresh
1. Specify the rows on which you want InfoSphere CDC to apply a refresh. You can do this by specifying SQL statements in the Operation tab of Management Console. If you do not specify rows, then InfoSphere CDC refreshes all rows in the target table. 2. Click Monitoring Subscriptions. 3. Select the subscription. 4. Right-click and select Start Refresh. 5. Select the tables you want to refresh. Note: If you have installed InfoSphere CDC for AS/400 or InfoSphere CDC for Microsoft SQL Server, then you need to make sure that there are no changes taking place on the source table while InfoSphere CDC refreshes the target table. Related concepts Controlling the apply of refresh operations on page 183
198
v Modifying mapping details such as source and target column mappings, derived columns, data translations, row and column selections, user exits, and so on. v Updating the properties of a subscription when the structure of your source and/or target tables change. v Synchronizing source and target tables before restarting mirroring. See also: To end replication
To end replication
1. Click Monitoring Subscriptions. 2. Select the subscription. 3. Right-click and select End Replication. 4. Choose one of the following options:
Option Controlled Description Lets InfoSphere CDC complete all in-progress operations and apply pending changes to the target table. Interrupts any current operations. InfoSphere CDC does not apply pending changes to the target table.
Immediate
199
5. Click Monitoring Subscriptions. 6. Select the subscription that contains the table mapping, right-click Start Mirroring. If this is the first time you are starting replication, InfoSphere CDC Event Server sends a copy of all the rows to your message destination, staging target table, or both. After this is complete, it switches to Mirror Continuous. Related concepts Sending XML messages to multiple JMS message destinations on page 226 Related tasks To create an XML message on page 143
200
When promoting expressions to a new environment, the table called CustomerData might exist in another database, other than Northwind. If so, then you need to specify the name of the new source database that contains this table in the Promote Subscription wizard. v Identify the full path name or program name of user exits called by an expressionif you have an expression that calls a stored procedure on the source using the %USER column function, you need to make sure that stored
201
procedure exists in the new source database and specify the location of the stored procedure (for example, the DLL path) in the Promote Subscription wizard. Also, if you have an expression that calls a stored procedure on the target using the %STPROC function, you need to make sure that stored procedure exists in the new target database. You should also know the location (full path) for the stored procedure. Related concepts Promoting changes to subscriptions on page 201 Related tasks To end replication on page 199
Promoting subscriptions
Use the Promote Subscription wizard to promote your subscription to a new environment. For example, you can promote your subscription from a development environment and into a production environment when you are ready to use that subscription in replication activities. Using the Promotion Wizard, you can: v Promote a Subscription to a New Environmentin this scenario, you are promoting a subscription to a new environment. For example, you may have projects that are exclusive for development or testing purposes. You can promote subscriptions into one of these environments. v Promote Changes to an Existing Subscriptionin this scenario, you have made changes to a subscription that has already been promoted to another environment. For example, the subscription may already exist in a project that you have reserved for testing subscriptions, but you may have made some minor changes on the subscription. To make sure the subscription in the test environment includes the changes that you made, you need to promote your changes to the into the testing environment. Note: When promoting changes to an existing subscription, InfoSphere CDC maintains synchronization between your source and target tables and you do not need to set the log position in the new environment. However, if you are making changes that causes you to lose synchronization between your source and target tables (such as updating the definition of a source table), then InfoSphere CDC does not maintain the log position and you will have to resynchronize your source and target tables in the original and in the new environment. For more information on how to synchronize source and target tables in a table mapping, see Flagging a source table for a refresh on page 135. See also: To promote a subscription to a new environment To promote changes to an existing subscription on page 204
202
5. Type the description of the new subscription in the Descriptionbox. 6. Select a project for the new subscription from the Project list or click New Project to create a new project. 7. If you want to specify advanced settings for the subscription, click Advanced Settings. Modify the following properties and click OK, then click Next.
Option Source ID Firewall Port TCP Host Description Type the source ID for the new subscription. Type a port number for the new subscription. Specifies the TCP host that your source datastore will use to recognize the target datastore when the computer where InfoSphere CDC is installed has multiple network cards. This is useful if you want to specify a host that is different from the host that you specified in the Access Manager perspective. The default option is Auto-selectwhich will automatically select the network card that can communicate with the target datastore. The host that you specified in theAccess Manager perspective also appears by default as well as any alias that you configured in the Datastore Propertiesdialog box. Propagation Control Click Addand select the source ID for any subscription for which you want to prevent data from being replicated to the target. Specifies that you want to prevent replication from all subscriptions.
8. Select the name of the new source datastore from the New Source Datastore list. 9. Select the name of the database and owner from the New Name list and click Next. If you have built a derived column on the source that references another table in another database using the %GETCOL column function, specify the name of the database and owner that contains the table that is referenced in the %GETCOL function. Also, make sure that the table referenced in the derived column exists in the new source database. 10. Select the name of the new target datastore from the New Target Datastore list. 11. If you have added an alias for the target datastore that the source system can recognize, then click Advanced Settings and choose a valid alias and click OK. 12. Select the name of the database and owner from the New Name list and click Next. 13. If you have configured expressions with column functions that call user exit programs, such as %USER or %STPROC, then specify the full path that contains the stored procedure, or the name of the user exit program referenced in the expression, then click Next. Make sure that the stored procedure or user exit program already exists in the new source database.
Promoting changes to subscriptions
203
14. If you have built a derived column, an expression, or a row-filtering expression that uses the %SELECT column function, then confirm the list of displayed expressions and click Next. After the promotion, make sure that the table or column referenced in the %SELECT expression exists in the new database. 15. Click View XML to confirm the location and attributes of the promoted subscription. 16. Review the list of changes and click Finish. Note: If you do not select a project, Management Console places the new subscription into the Default Project. Related concepts Before you promote a subscription on page 201 Promoting subscriptions on page 202
204
Note: The steps to importing a new or existing subscription are the same as promoting a new or existing subscription. Related concepts Exporting and importing subscriptions Related tasks To promote a subscription to a new environment on page 202 To promote changes to an existing subscription on page 204
205
206
Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB
You can configure the following types of user exits with InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB: IDispatch COM DLL (InfoSphere CDC for Microsoft SQL Server)You can invoke at run-time a function you defined using IDispatch. When configuring an IDispatch COM DLL user exit,Management Console lets you enable or disable user exits developed for IDispatch. Before you can use Management Console to configure a user exit, you need to do the following in Microsoft SQL Server: v Create the user-defined function.
Copyright IBM Corp. 2008
207
Create the user exit. Extract or build the DLL file and place it in a location. For example, C:\Program Files\Microsoft SQL Server\MSSQL\Binn (or wherever appropriate). v If you are using Visual Basic, you must reference the library dts_usrext.tlb after starting Visual Basic. InfoSphere CDC provides a pre-defined interface (IDTS_UserExit) so that InfoSphere CDC can interact with the server object you define. The interface contains four pre-defined user exit program stubs that you should not modify. As a result, you can only select (not name) the functions that you want to call at the various processing points. For more information, see your user exits documentation for InfoSphere CDC for Microsoft SQL Server. v v C or C++ (InfoSphere CDC for Microsoft SQL Server)you can specify a DLL library that contains the compiled user exit program. Stored Procedure (InfoSphere CDC for Microsoft SQL Server (version 5.3)you can configure a user exit as a stored procedure for InfoSphere CDC for Microsoft SQL Server Version 5.3. Depending on how you have configured the stored procedure, you need to identify temporary or permanent tables so that InfoSphere CDC can populate these tables with the images of the row-level operations applied to the target table. Your stored procedure user exit can then retrieve the image of the row from these tables and use them as required. Stored Procedure (InfoSphere CDC for Microsoft SQL Server (version 6.1))you can configure a stored procedure user exit for InfoSphere CDC for Microsoft SQL Server Version 6.1 and higher. You need to identify the schema that contains the stored procedure and identify the InfoSphere CDC operations on which you want to run the user exit. Java Class (InfoSphere CDC for Microsoft SQL Server (version 6.1), InfoSphere CDC for DB2 UDB)for Java class user exits, method names are pre-defined. This means that you can only enable and disable user exit programs. You need to configure a user exit in java that implements the UserExitIF interface class provided by InfoSphere CDC for DB2 UDB and InfoSphere CDC for Microsoft SQL Server (version 6.0). For more information about this class, see the InfoSphere CDC End-User Documentation for each of these platforms. See also: To configure for IDispatch COM DLL on page 209 To configure for C or C++ on page 210 To configure a stored procedure (Microsoft SQL Server version 5.3) on page 211 To configure a stored procedure (Microsoft SQL Server (version 6.0 and higher) and DB2 UDB (version 6.1 and higher)) on page 213 To configure a derived column or an expression that calls %STPROC (Microsoft SQL Server 6.0 and above and DB2 UBD 6.1 and above) on page 214 To configure a user exit for a Java class on page 214 Related concepts Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207
208
10. Click Apply. In some environments, the target table may contain one or more columns that store user-defined constants. Other applications usually maintain these constant values, and they are not affected by InfoSphere CDC. If you do not enable Update All Columns, then InfoSphere CDC passes the default column value (for example, zero, blank, or NULL) to the user exit program. Due to performance reasons, it is important that you clear this box if you do not need to pass the user-defined constant values. Related concepts
209
Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207
11. Click Apply. In some environments, the target table may contain one or more columns that store user-defined constants. Other applications usually maintain these constant values, and they are not affected by InfoSphere CDC. If you do not enable Update All Columns, then InfoSphere CDC passes the default column
210
value (for example, zero, blank, or NULL) to the user exit program. Due to performance reasons, it is important that you clear this box if you do not need to pass the user-defined constant values. Related concepts Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207
211
conforms to a database naming convention. If you are referencing a database or table that contains spaces, then you must enclose the name in square brackets. For example, to reference the table name EMP NY, you must enter it as [EMP NY]. v The image tables and the target tables should reside in different databases to prevent any possibility of locking the database. 12. If you want to create permanent tables using Management Console, then click Create Tables. 13. If you want to retrieve the current constant value (also known as the before or after image of the source row) and pass it to a user exit program that runs before or after a row-level operation is replicated to the target table, then check the Update All Columns box. 14. Type the name of the user exit programs you want InfoSphere CDC to call beside one or more of the following operations:
Option Before Insert After Insert Before Update After Update Before Delete After Delete Before Refresh After Refresh Before Truncate After Truncate Description InfoSphere CDC runs the user exit before replicating an insert operation. InfoSphere CDC runs the user exit after replicating an insert operation. InfoSphere CDC runs the user exit before replicating an update operation. InfoSphere CDC runs the user exit after replicating an update operation. InfoSphere CDC runs the user exit before replicating a delete operation. InfoSphere CDC runs the user exit after replicating a delete operation. InfoSphere CDC runs the user exit before replicating a refresh operation. InfoSphere CDC runs the user exit after replicating a refresh operation. InfoSphere CDC runs the user exit before replicating a truncate operation. InfoSphere CDC runs the exist after replicating a truncate operation.
15. Click Apply. In some environments, the target table may contain one or more columns that store user-defined constants. Other applications usually maintain these constant values, and they are not affected by InfoSphere CDC. If you do not enable Update All Columns, then InfoSphere CDC passes the default column value (for example, zero, blank, or NULL) to the user exit program. Due to performance reasons, it is important that you clear this box if you do not need to pass the user-defined constant values. Related concepts Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207 Related tasks To configure a stored procedure (Microsoft SQL Server (version 6.0 and higher) and DB2 UDB (version 6.1 and higher)) on page 213
212
To configure a stored procedure (Microsoft SQL Server (version 6.0 and higher) and DB2 UDB (version 6.1 and higher))
Note: This information is applicable to InfoSphere CDC for Microsoft SQL Server (version 6.0 and higher) and InfoSphere CDC for DB2 UDB (version 6.1 and higher). 1. Click Configuration Subscriptions. 2. Select the subscription. 3. Select the table mapping in the Table Mappings view. 4. Right-click and select Edit Mapping Details. 5. Click the User Exits tab. 6. Select Stored Procedure from the User Exit Type list. Note: Use the Stored Procedure - Deprecated option to maintain user exits that were created using InfoSphere CDC for Microsoft SQL Server (version 5.3). Use the Stored Procedure option for all new user exits. 7. Type the name of the schema that contains the stored procedure in the Schema box. 8. Type the name of the user exit programs you want InfoSphere CDC to call beside one or more of the following operations:
Option Before Insert After Insert Before Update After Update Before Delete After Delete Before Refresh After Refresh Before Truncate After Truncate Description InfoSphere CDC runs the user exit before replicating an insert operation. InfoSphere CDC runs the user exit after replicating an insert operation. InfoSphere CDC runs the user exit before replicating an update operation. InfoSphere CDC runs the user exit after replicating an update operation. InfoSphere CDC runs the user exit before replicating a delete operation. InfoSphere CDC runs the user exit after replicating a delete operation. InfoSphere CDC runs the user exit before replicating a refresh operation. InfoSphere CDC runs the user exit after replicating a refresh operation. InfoSphere CDC runs the user exit before replicating a truncate operation. InfoSphere CDC runs the exist after replicating a truncate operation.
9. Click Apply. Related concepts Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207 Related tasks
213
To configure a stored procedure (Microsoft SQL Server version 5.3) on page 211
To configure a derived column or an expression that calls %STPROC (Microsoft SQL Server 6.0 and above and DB2 UBD 6.1 and above)
Note: This information is applicable to InfoSphere CDC for Microsoft SLQ Server (version 6.0 and above) and InfoSphere CDC for DB2 UBD (version 6.1 and above). 1. Click the User Exits tab, and configure a stored procedure. 2. Click the Column Mappings tab, and do one of the following: v If you want InfoSphere CDC to evaluate an expression on the source table, then add a derived column. v If you want InfoSphere CDC to evaluate an expression on the target table, then build an expression. Make sure the expression you define contains a valid call to the %STPROC column function. If you are calling a stored procedure that is not owned by the InfoSphere CDC user, you must provide the name in the form <schema>.<stored procedure name>. 3. Map the derived column or the expression to the target column. Related concepts Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207 Related tasks To configure a stored procedure (Microsoft SQL Server version 5.3) on page 211 To configure a stored procedure (Microsoft SQL Server (version 6.0 and higher) and DB2 UDB (version 6.1 and higher)) on page 213 To add a derived column on page 163 To map a derived column to a target column on page 164 To map an expression to a target column on page 159
214
The files you generate from compiling the user exit program must be located in a library or folder that is referenced by the CLASSPATH environment variable. 8. Type the parameters that you want to make available to the user exit program in the Parameter box. You can access the parameters in the user exit program class by invoking the getParameter( ) method during the initialization process. There are no conventions for specifying the parameters. The values you type in this box are free-form. The string of parameter values cannot exceed 255 characters in length. 9. Type the name of the user exit programs you want InfoSphere CDC to call beside one or more of the following operations:
Option Before Insert After Insert Before Update After Update Before Delete After Delete Before Refresh After Refresh Before Truncate After Truncate Description InfoSphere CDC runs the user exit before replicating an insert operation. InfoSphere CDC runs the user exit after replicating an insert operation. InfoSphere CDC runs the user exit before replicating an update operation. InfoSphere CDC runs the user exit after replicating an update operation. InfoSphere CDC runs the user exit before replicating a delete operation. InfoSphere CDC runs the user exit after replicating a delete operation. InfoSphere CDC runs the user exit before replicating a refresh operation. InfoSphere CDC runs the user exit after replicating a refresh operation. InfoSphere CDC runs the user exit before replicating a truncate operation. InfoSphere CDC runs the exist after replicating a truncate operation.
10. Click Apply. Related concepts Configuring user exits for InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for DB2 UDB on page 207
215
Configuring user exits for InfoSphere CDC for Oracle or InfoSphere CDC for Sybase
C Shared Libraryyou can configure a C user exit program for InfoSphere CDC. You can configure the InfoSphere CDC to run the user exit program before or after an insert, update, delete, or truncate operation. Stored Procedureyou can configure a stored procedure user exit for InfoSphere CDC. You need to identify the schema that contains the stored procedure and identify the InfoSphere CDC operations on which you want to run the user exit. InfoSphere CDC can call your stored procedure from either the source or target when you use the %STPROC column function in an expression. If you want InfoSphere CDC to evaluate and call your stored procedure on the source, then you need to add a derived column. If you want InfoSphere CDC to evaluate and call your stored procedure on the target, then you need to build an expression. See also: To configure a C shared library To configure a stored procedure (Oracle and Sybase) on page 217 To configure a derived column or an expression that calls %STPROC (Oracle and Sybase) on page 218
216
Option Before Delete After Delete Before Refresh After Refresh Before Truncate After Truncate
Description InfoSphere CDC runs the user exit before replicating a delete operation. InfoSphere CDC runs the user exit after replicating a delete operation. InfoSphere CDC runs the user exit before replicating a refresh operation. InfoSphere CDC runs the user exit after replicating a refresh operation. InfoSphere CDC runs the user exit before replicating a truncate operation. InfoSphere CDC runs the exist after replicating a truncate operation.
Specify the parameters that you want InfoSphere CDC to pass to the user exit program. 11. Click Apply. In some environments, the target table may contain one or more columns that store user-defined constants. Other applications usually maintain these constant values, and they are not affected by InfoSphere CDC. If you do not enable Retrieve Current Value, then InfoSphere CDC passes the default column value (for example, zero, blank, or NULL) to the user exit program. Due to performance reasons, it is important that you clear this box if you do not need to pass the user-defined constant values. 10. Related concepts Configuring user exits for InfoSphere CDC for Oracle or InfoSphere CDC for Sybase on page 216
217
Option After Insert Before Update After Update Before Delete After Delete Before Refresh After Refresh Before Truncate After Truncate
Description InfoSphere CDC runs the user exit after replicating an insert operation. InfoSphere CDC runs the user exit before replicating an update operation. InfoSphere CDC runs the user exit after replicating an update operation. InfoSphere CDC runs the user exit before replicating a delete operation. InfoSphere CDC runs the user exit after replicating a delete operation. InfoSphere CDC runs the user exit before replicating a refresh operation. InfoSphere CDC runs the user exit after replicating a refresh operation. InfoSphere CDC runs the user exit before replicating a truncate operation. InfoSphere CDC runs the exist after replicating a truncate operation.
10. Click Apply. In some environments, the target table may contain one or more columns that store user-defined constants. Other applications usually maintain these constant values, and they are not affected by InfoSphere CDC. If you do not enable Retrieve Current Value, then InfoSphere CDC passes the default column value (for example, zero, blank, or NULL) to the user exit program. Due to performance reasons, it is important that you clear this box if you do not need to pass the user-defined constant values. Related concepts Configuring user exits for InfoSphere CDC for Oracle or InfoSphere CDC for Sybase on page 216
To configure a derived column or an expression that calls %STPROC (Oracle and Sybase)
Note: This information is applicable to InfoSphere CDC for Oracle and InfoSphere CDC for Sybase. 1. Click the User Exits tab, and configure a stored procedure. 2. Click the Column Mappings tab, and do one of the following: v If you want InfoSphere CDC to evaluate an expression on the source table, then add a derived column. v If you want InfoSphere CDC to evaluate an expression on the target table, then build an expression. Make sure the expression you define contains a valid call to the %STPROC column function. If you are calling a stored procedure that is not owned by the InfoSphere CDC user, you must provide the name in the form <schema>.<stored procedure name>. 3. Map the derived column or the expression to the target column. Related tasks To configure a stored procedure (Oracle and Sybase) on page 217
218
To add a derived column on page 163 To map a derived column to a target column on page 164 To map an expression to a target column on page 159
Configuring user exits for InfoSphere CDC for AS/400 (version 6.2 and below) or InfoSphere CDC for z/OS
You can write standard function user exits in RPG, COBOL, and C/C++. See also: To configure a standard function
219
Configuring user exits for InfoSphere CDC for AS/400 (version 6.2 and below) or InfoSphere CDC for z/OS on page 219
In the Class Name box in the Custom Data Format area, you need to type:
Option CustomFormat1 <Java package>.CustomFormat1 Description If it is a stand-alone class. If the class is included in a Java package (for example, com.datamirror.interface.CustomFormat1 ).
The files you generate from compiling the class must be located in a library or folder that is referenced by the CLASSPATH environment variable. 7. Click Apply.
220
221
Update
Delete
Related concepts Sending XML messages to multiple JMS message destinations on page 226 Defining the JMS message header on page 151 Overriding JMS message header properties on page 221 Configuring user exits for InfoSphere CDC Event Server on page 221
222
223
Option Update
Description InfoSphere CDC Event Server runs the user exit before applying an update operation to a table you have staged and/or before applying an update operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying a delete operation to a table you have staged and/or before applying a delete operation to a JMS message destination.
Delete
10. Click Apply. You can start mirroring on the subscription that contains the source table assigned to a JMS message destination. The user exit program will set the new destination before InfoSphere CDC Event Server applies the operation to a JMS message destination. Related concepts Sending XML messages to a JMS message destination on page 199 Sending the XML message to a different JMS message destination on page 223 Configuring user exits for InfoSphere CDC Event Server on page 221
224
Update
Delete
225
You can start mirroring on the subscription that contains the source table assigned to a JMS message destination. The user exit program will set the new destination before InfoSphere CDC Event Server applies the operation to a JMS message destination. Related concepts Sending XML messages to a JMS message destination on page 199 Creating XML output and applying XSLT to an XML message on page 224 Configuring user exits for InfoSphere CDC Event Server on page 221
3. 4. 5. 6. 7.
In the Class Name box, type: 8. Type the parameters that you want to make available to the user exit program in the Parameter box. You can access the parameters in the Java class by invoking the getParameter() method during the initialization process. There are no conventions for specifying the parameters. The values you type in this box are free-form. The string of parameter values cannot exceed 255 characters in length.
226
9. Enable the Before check box for one or more of the following operations:
Option Insert Description InfoSphere CDC Event Server runs the user exit before applying an insert operation to a table you have staged and/or before applying an insert operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying an update operation to a table you have staged and/or before applying an update operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying a delete operation to a table you have staged and/or before applying a delete operation to a JMS message destination.
Update
Delete
10. Click Apply. You can start mirroring on the subscription that contains the source table assigned to a JMS message destination. The user exit program will set the new destination before InfoSphere CDC Event Server applies the operation to a JMS message destination. Related concepts Sending XML messages to a JMS message destination on page 199 Sending XML messages to multiple JMS message destinations on page 226 Configuring user exits for InfoSphere CDC Event Server on page 221
227
3. Ensure you have created at least one source table to XML message destination mapping within this subscription. 4. Select the table mapping and right-click Edit Mapping Details. 5. Click the User Exits tab. 6. Choose Java Class from the User Exit Type box. 7. In the Class Name box, type the Java class name of the user exit that implements the UserExitIF interface if you have developed the user exit in Java. For example, you may have imported the EventServerIF interface, and the Java class user exit that implements this interface in your function has the following definition: public class UE1 implements UserExitIF. In the Class Name box, type: 8. Type the parameters that you want to make available to the user exit program in the Parameter box. You can access the parameters in the Java class by invoking the getParameter() method during the initialization process. There are no conventions for specifying the parameters. The values you type in this box are free-form. The string of parameter values cannot exceed 255 characters in length. 9. Enable the Before check box for one or more of the following operations:
Option Insert Description InfoSphere CDC Event Server runs the user exit before applying an insert operation to a table you have staged and/or before applying an insert operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying an update operation to a table you have staged and/or before applying an update operation to a JMS message destination. InfoSphere CDC Event Server runs the user exit before applying a delete operation to a table you have staged and/or before applying a delete operation to a JMS message destination.
Update
Delete
10. Click Apply. You can start mirroring on the subscription that contains the source table assigned to a JMS message destination. The user exit program will set the new destination before InfoSphere CDC Event Server applies the operation to a JMS message destination. Related concepts Sending XML messages to a JMS message destination on page 199 Querying a Web service to access content on page 227 Configuring user exits for InfoSphere CDC Event Server on page 221
228
For example, you may want to create a simple XML message whenever a new employee is created. You can detect new employees by monitoring inserts into the dbo.Employee table and create an source table to XML mapping using all columns from this table. You can then send the XML message to a JMS queue called HR1 and also send this XML message to another queue called IT1 each time a new employee is added to the IT department. See also: To route the content of an XML message to another JMS message destination
Update
229
Option Delete
Description InfoSphere CDC Event Server runs the user exit before applying a delete operation to a table you have staged and/or before applying a delete operation to a JMS message destination.
10. Click Apply. You can start mirroring on the subscription that contains the source table assigned to a JMS message destination. The user exit program will set the new destination before InfoSphere CDC Event Server applies the operation to a JMS message destination. Related concepts Sending XML messages to multiple JMS message destinations on page 226 Content based routing on page 228 Configuring user exits for InfoSphere CDC Event Server on page 221
230
231
Subscription state
Subscriptions configured in Management Console can be in one of the following states: v StartingIndicates that InfoSphere CDC is starting replication for the subscription. v RefreshIndicates that InfoSphere CDC is refreshing data from the source to the target. After completing the refresh, InfoSphere CDC starts mirroring the subscription or returns to a state of Inactive, depending on the replication method that you have selected for the subscription. v Mirror ContinuousIndicates that InfoSphere CDC is mirroring data between the source and target. This occurs when you have started continuous mirroring on the subscription. Mirror Net ChangeIndicates that InfoSphere CDC is mirroring changes that were made to the source since replication last ended. InfoSphere CDC ends replication after the changes are mirrored to the target. v EndingIndicates that InfoSphere CDC is close to completing replication activity on the subscription and is in the process of shutting down. v InactiveIndicates that InfoSphere CDC is not replicating data on the subscription. v UnknownIndicates that InfoSphere CDC cannot determine the state of the subscription. This may be a result of a lack of communication between the monitoring process and the datastores, or your subscription is using an external source datastore. Related concepts Starting mirroring on a subscription on page 197 Setting up subscriptions for datastores outside of your organization on page 86 v
Subscription status
Subscriptions configured in Management Console can have one of the following statuses: v NormalIndicates that the subscription is normal and there are no known problems. v ErrorIndicates that a problem is preventing InfoSphere CDC from replicating data on the subscription. You can use the Event Log view to monitor and diagnose any errors that occur during replication. v UnknownIndicates that InfoSphere CDC cannot determine the status of the subscription. This may be a result of a lack of communication between the monitoring process and the datastores, or your subscription is using an external source datastore. Related concepts Displaying event messages during replication
232
Copy events. You can then paste the event into another application. For example, you may want to copy an event into an email for technical support reasons. v Clear the Event Log view of messages that you no longer need to investigate. v Export events to your local computer. v The Event Log view displays the following four categories of events which are listed by increasing severity: v Informationthese events provide feedback about InfoSphere CDC operations. These events do not indicate that an error has occurred. v Diagnosticthese events contain information that helps you diagnose or solve a problem that may occur as a result of a certain action or operation. v Warning or Noticethese events describe situations that InfoSphere CDC has detected, which alerts you about a potential error. v Error or Escapethese events describe an error that InfoSphere CDC has detected, or explain conditions that led to InfoSphere CDC shutting down. See also: To show the event log for a subscription To view event details To copy events on page 234 To clear events on page 234 To export events on page 235
233
4. Right-click in the list of events and select Event Details. Related concepts Displaying event messages during replication on page 232
To copy events
1. Click Monitoring Subscriptions. 2. Select a subscription and right-click Show Event Log. 3. Select one of the following options from the Log list:
Option Source General Source Replication Target General Target Replication Description Displays events generated by the source datastore. Displays events generated by the subscription on the source datastore. Displays events generated by the target datastore. Displays events generated by the subscription on the target datastore.
4. Right-click in the list of events and select Copy Events. Related concepts Displaying event messages during replication on page 232
To clear events
1. Click Monitoring Subscriptions. 2. Select a subscription and right-click Show Event Log. 3. Select one of the following options from the Log list:
Option Source General Source Replication Target General Target Replication Description Displays events generated by the source datastore. Displays events generated by the subscription on the source datastore. Displays events generated by the target datastore. Displays events generated by the subscription on the target datastore.
234
4. Right-click in the list of events and select Clear Events. Note: If you have installed InfoSphere CDC for Microsoft SQL Server, you must set the registry entry (AllowEventLogClear in HKEY_LOCAL_MACHINE\ Software\DataMirror\InfoSphere CDC\SQL Server\<TS_instance_name>\Agent) to 1. Related concepts Displaying event messages during replication on page 232
To export events
1. Click Monitoring Subscriptions. 2. Select a subscription and right-click Show Event Log. 3. Select one of the following options from the Log list:
Option Source General Source Replication Target General Target Replication Description Displays events generated by the source datastore. Displays events generated by the subscription on the source datastore. Displays events generated by the target datastore. Displays events generated by the subscription on the target datastore.
4. Right-click in the list of events and select Export Events. 5. You are prompted to save the list of events in a formatted text file to your local computer. Related concepts Displaying event messages during replication on page 232
235
v A large refresh is occurring. v Resource intensive batch jobs or background tasks on the source or target. This will likely result in increased latency for a subscription until these processes are complete. v InfoSphere CDC is replicating tables with Large Objects (LOB). The large size of the table rows may increase latency for a subscription. v Database lock contention on the target database. An application such as a reporting system on the target database may unexpectedly lock data in the database, forcing InfoSphere CDC to wait for the locks to be released. Note: For each machine where you have installed InfoSphere CDC, make sure that your system time is synchronized and that the time zone matches the time zone of your region. InfoSphere CDC calculates latency based on your system time and the offset from Coordinated Universal Time (UTC). To receive accurate latency statistics on a subscription, make sure these settings are correct. Throughput The amount of replication activity (measured in the number of operations or size of data) a system can sustain over time. See also: To start profiling the performance of a subscription To stop profiling the performance of a subscription on page 237 To view and save plotted performance statistics of a subscription on page 237 Related concepts Setting latency thresholds and notifications on page 78 Related tasks To set a latency threshold and notification on page 79
5. If you want to save the collected statistics as a plotted graph, then click Show Statistics and click Save Data. The plotted graph is saved in .csv format to your local computer. Note: If you click Show Statistics to view the plotted graph, you will see a timestamp that indicates when you started profiling the performance of the subscription. Related concepts Starting mirroring on a subscription on page 197 Profiling the latency and throughput performance of your subscription on page 235 Related tasks To set a latency threshold and notification on page 79 To view and save plotted performance statistics of a subscription on page 237 To start profiling the performance of a subscription
236
High
Low
Average
Throughput Depending on the InfoSphere CDC product you have installed, you can also view throughput information for the subscription.
237
Option Current
Description Indicates the current rate of throughput for the subscription since you opened the Statistics view. Throughput is the amount of data (in bytes) or the number of operations that InfoSphere CDC applies on the target database process per second. Indicates the highest rate of throughput for the subscription since you opened the Statistics view. Throughput is the amount of data (in bytes) or the number of operations that InfoSphere CDC applies on the target database process per second. Indicates the lowest rate of throughput for the subscription since you opened the Statistics view. Throughput is the amount of data (in bytes) or the number of operations that InfoSphere CDC applies on the target database process per second. Indicates the average rate of throughput for the subscription since you opened the Statistics view. Throughput is the amount of data (in bytes) or the number of operations that InfoSphere CDC applies on the target database process per second.
High
Low
Average
4. In the Graph area, select one of the following from the list:
Option Latency Throughput Operation/second Description Displays a graph that illustrates the latency of your subscription. Displays a graph that illustrates the number of operations that InfoSphere CDC applies to the target database per second. Displays a graph that illustrates the amount of data (in bytes) that InfoSphere CDC applies to the target database per second.
Throughput Bytes/second
5. You should see a graph that plots performance for the subscription. 6. If you want to save and export the graph in .csv format, then click Save Data. Related concepts Setting latency thresholds and notifications on page 78 Displaying event messages during replication on page 232
238
In the Replication Diagramview, you can do the following: v Monitor the activity of subscriptions in a specific project by using the project list in the toolbar. v View state, status, and latency information for each subscription. v Right-click a datastore to connect to a datastore, set a datastore notification, view properties, and show related subscriptions. v Right-click a subscription to start or stop replication, start a refresh, show table mappings, set a subscription notification, and view properties. v Determine the source and target datastore for a subscription by examining the arrows that point to the target datastore.
239
240
241
Setting properties for a subscription that targets IBM WebSphere DataStage on page 89
242
be relevant. If you customize the data that is sent to WebSphere DataStage, you are responsible for ensuring that the DSX file is still relevant in WebSphere DataStage. Related concepts Creating a custom data format for IBM WebSphere DataStage on page 220
243
244
245
Source Job Number (&JOBNO) on page 249 Source Job User (&JOBUSER) on page 250 Journal Name (&JOURNAL) on page 250 Source Table Library (&LIBRARY) on page 251 Source Table Member Name (&MEMBER) on page 252 Source Table Name (&OBJECT) on page 252 Source Program Name (&PROGRAM) on page 253 Journal Sequence Number (&SEQNO) on page 254 Source Server Name (&SYSTEM) on page 254 Record Modification Time (&TIMESTAMP) on page 255 Record Modification User (&USER) on page 256
246
v InfoSphere CDC for AS/400Support for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for Microsoft SQL ServerSupport for this journal control field is available only when InfoSphere CDC refreshes data, and is not available when mirroring data. If you decide to use this journal control field when mirroring data, InfoSphere CDC sets this journal control field to a default value of 0. v InfoSphere CDC for DB2 UDB Support for this journal control field is available only when InfoSphere CDC refreshes data, and is not available when mirroring data. If you decide to use this journal control field when mirroring data, InfoSphere CDC sets this journal control field to a default value of 0. v InfoSphere CDC for z/OSSupport for this journal control field is not available.
247
record with the event that occurred on your source table that caused the audit record to be written to the target table. This is represented by a distinct two-letter code. Data TypeCharacter InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. v InfoSphere CDC for AS/400Support for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to a default value of RR on the subscriber. InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for Microsoft SQL ServerSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for DB2 UDBSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for z/OSSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v
248
mirroring data, InfoSphere CDC leaves it empty. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to InfoSphere CDC. v InfoSphere CDC for DB2 UDBSupport for this journal control field is not available. If you decide to use this journal control field when mirroring data, InfoSphere CDC leaves it empty. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to InfoSphere CDC. v InfoSphere CDC for z/OSSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the Logical Unit of Works Correlation ID. The Correlation ID is an internal DB2 identifier. It is usually the name of the job that created the Logical Unit of Work.
249
250
InfoSphere CDC Supportdepending on the InfoSphere CDC product that you install, journal control fields may or may not be supported when mirroring or refreshing data. Unsupported journal control fields contain default values that vary between the InfoSphere CDC products. If both the name and library are included in this journal control field, then &JRNLIB journal control field is not supported by InfoSphere CDC. v InfoSphere CDC for AS/400Support for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, it contains the journal name and journal library. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to UNKNOWN on the subscriber. v InfoSphere CDC for Oracle and SybaseSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the journal name in the format <schema>.<journal>. If you decide to use this journal control field when refreshing data, InfoSphere CDC sets this journal control field to NULL. InfoSphere CDC for Microsoft SQL ServerSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for DB2 UDBSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. If you decide to use this journal control field when refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for z/OSSupport for this journal control field is only available when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, this journal control field contains the name of the DB2 subsystem or data sharing group to which InfoSphere CDC is connected. v
251
v InfoSphere CDC for DB2 UDBSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. v InfoSphere CDC for z/OSSupport for this journal control field is only available when InfoSphere CDC mirrors data, and is not available when refreshing data. When mirroring data, the journal control field contains the database name in which the table was created and owner ID of the table in the format <dbname.owner>.
252
InfoSphere CDC for Microsoft SQL ServerSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data v InfoSphere CDC for DB2 UDBSupport for this journal control field is available only when InfoSphere CDC mirrors data, and is not available when refreshing data. v InfoSphere CDC for z/OSSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring or refreshing data, this journal control field contains the name of the source table. v
253
254
InfoSphere CDC for Microsoft SQL Server (V5.x)Support for this journal control field is not available. If you decide to use this journal control field when mirroring or refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for Microsoft SQL Server (V6.x)Support for this journal control field is not available. If you decide to use this journal control field when mirroring or refreshing data, InfoSphere CDC leaves this journal control field empty. v InfoSphere CDC for DB2 UDBSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data v InfoSphere CDC for z/OSSupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring or refreshing data, this journal control field contains the system name on which InfoSphere CDC is running. The system name is extracted from the root control block (CVT) of the z/OS operating system. v
255
this journal control field contains the date and time of when InfoSphere CDC applied the row-level operation (insert, update, or delete) to the source table. When refreshing data, this journal control field contains the date and time of when InfoSphere CDC refreshed the first row. v InfoSphere CDC for z/OSsupport for this journal control field is available when InfoSphere CDC mirrors or refreshes data. When mirroring data, this journal control field contains the time when InfoSphere CDC applied the row-level operation (insert, update, or delete) to the source table. When refreshing data, this journal control field contains the current date and time.
256
Table Clear
The Table Clear events clear data in a table on the source system. Depending on the type of Table Clear event that has taken place on the source system, InfoSphere CDC supports an iSeries journal code.
257
v JMindicates that journaling on the file or table has been started on the source system. v EJindicates that journaling on the file or table ended on the source system. v RGindicates that a file, table, or member has been reorganized on the source system. v MNBefore Rename, which indicates when the file or member has been renamed on the source system. InfoSphere CDC appends this entry to the audit table on the target system. v NZAfter Rename, which indicates that a new name has been given to a file or member on the source system. InfoSphere CDC appends this entry to the audit table on the target system. v MMBefore Publication File Move, which indicates when the file has been moved on the source system. InfoSphere CDC appends this entry to the audit table on the target system. v MZAfter Publication File Move, which indicates a new location for a file that has been moved on the source system. InfoSphere CDC appends this entry to the audit table on the target system. MZ is a journal code generated by InfoSphere CDC. It is not an iSeries journal code. v MRindicates that a file on the source system has been restored. v CHindicates that a file on the source system has been changed. When a non-schema change is applied to the audit table on the source system, InfoSphere CDC appends this entry to the audit table on the target system.
Delete
The Delete events delete records in a table on the source system. Depending on the type of Delete event that has taken place on the source system, InfoSphere CDC supports an iSeries journal code.
Insert
The Insert events insert rows in a table on the source system. Depending on the type of Insert event that has taken place on the source system, InfoSphere CDC supports an iSeries journal code.
Update Before
The Update Before events provide you with the before image of records updated in a table on the source system. Depending on the type of Update Before event that has taken place on the source system, InfoSphere CDC generates a journal code.
258
Update After
The Update After events provide you with the after image of records updated in a table on the source system. Depending on the type of Update After event that has taken place on the source system, InfoSphere CDC generates a journal code.
259
source table, then in response to this update, InfoSphere CDC inserts a row into the target table with the journal code PT. The journal codes your system generates depend on the database platform that you are using. You may want to customize journal codes so that they are more meaningful in your organization. For example, instead of having the journal code PT to indicate that there has been a new row inserted in your source table, you may want to use a one-letter code such as I to identify the insert. The %IF column function evaluates conditional expressions and returns different values if the expression is true or false. The example below illustrates how you can use the %IF column function to convert journal codes into custom letters
%IF(&ENTTYP=PT OR &ENTTYP="RR","I", %IF(&ENTTYP= "UB", "B", %IF(&ENTTYP= "UP", "A", %IF(&ENTTYP="DL","D","R"))))
This expression does the following: v If a row has been inserted or refreshed on the source table, then InfoSphere CDC generates I on the audit table. v If the before image on the source table has been updated, then InfoSphere CDC generates B on the audit table. v If the after image has been updated on the source table then InfoSphere CDC generates A in the audit table. v If a row on the source table has been deleted, then InfoSphere CDC generates D on the audit table, otherwise it generates R on the audit table.
260
Column functions
InfoSphere CDC provides a number of column functions that you can use in expressions when mapping target columns. This topic describes each of the column functions, their syntax and parameters, and also provides examples that illustrate how to use them. In this section, you will learn: Conventions in using column functions String functions on page 262 Date and time functions on page 269 Conversion functions on page 274 Conditional and variable functions on page 282 Data functions on page 284 User exit functions on page 297 %GETCOL column function scenarios (DB2 UDB for iSeries) on page 305 %GETCOL column function scenarios (Dynamic SQL) on page 307 Publishing multiple derived columns using the %GETCOL function (Dynamic SQL) on page 309
261
v You can specify multiple characters in the same character literal. For example, if you are using the ASCII character set, the notation <<65>><<78>><<78>><<65>> and <<65>>NN<<65>> represent the string ANNA. v If you do not follow the double-angled bracket notation, such as <45>>, then InfoSphere CDC does not generate an error. Instead, InfoSphere CDC treats it as a sequence of characters (<, 4, 5, >, and >), and returns the result based on this sequence. v To specify NULL as a parameter in a column function, enter NULL without any delimiter.
String functions
Use these functions when you want InfoSphere CDC to manipulate strings. During replication, you can have InfoSphere CDC concatenate multiple strings, remove blank characters from a string, change the case of the characters in a string, replace characters of a string with other characters, or extract a substring from a string. Note: Some examples in this section use the double-angled bracket notation (<< >>) and are based on the American Standard Code for Information Interchange (ASCII) character set. Under a different character set, these examples do not produce the same results as described. See also: Concatenation%CONCAT Lowercase%LOWER on page 263 Left trim%LTRIM on page 263 Capitalization%PROPER on page 264 Character substitution%REPLACE on page 265 Right trim%RTRIM on page 266 Substring%SUBSTRING on page 267 Uppercase%UPPER on page 268
Concatenation%CONCAT
Use this function when you want InfoSphere CDC to concatenate multiple character fields and literals to form a single string. You can concatenate up to 20 character fields and literals up to a total length of 2,048 characters.
Syntax
%CONCAT(<parm1>, <parm2>, ...<parm20>)
Parameters
parm1 to parm20Specify character columns, literals, or column functions that return character strings.
Examples
%CONCAT(FNAME, " ", LNAME)
262
Concatenates the values from the FNAME and LNAME columns with a blank character inserted between them. For example, if FNAME = Ray and LNAME = Kennedy, this function returns Ray Kennedy.
WITH P %CONCAT("InfoSphere", " ", "CDC", "Management", "Console")
Returns the NUL-terminated ASCII string Anna Kim. For information about the double-angled bracket notation, see String functions on page 262.
Lowercase%LOWER
Use this function when you want InfoSphere CDC to trim all leading blank characters from a character string during replication.
Syntax
%LOWER(<parm>)
Parameters
parmSpecifies a character column, literal, or column function that returns a character string.
Examples
%LOWER(DEPARTMENT)
Returns the strings in the DEPARTMENT column in lowercase. For example, accounting, marketing, and so on.
%LOWER("BrUcE JoNeS")
Returns the ASCII string anna kim. Related concepts String functions on page 262 Related reference Substring%SUBSTRING on page 267
Left trim%LTRIM
Use this function when you want InfoSphere CDC to convert all uppercase characters in a string to lowercase during replication.
Column functions
263
Syntax
%LTRIM(<parm>)
Parameters
parmSpecifies a character column, literal, or column function that returns a character string.
Examples
%LTRIM(" George Smith")
Returns the string Andrea Moss . The %LTRIM function does not trim trailing and embedded blank characters.
%LTRIM("<<32>><<32>><<32>>Anna Kim")
Returns the ASCII string Anna Kim, with no leading blank characters. Related concepts String functions on page 262
Capitalization%PROPER
Use this function when you want InfoSphere CDC to convert the first letter of each word to uppercase, and the remaining letters to lowercase during replication. A word is a consecutive sequence of non-blank characters encapsulated by blank characters and string boundaries.
Syntax
%PROPER(<parm>)
Parameters
parmSpecifies a character column, literal, or column manipulation function that returns a character string.
Examples
%PROPER(NAME)
Returns the value in the NAME column with the first letter of each word capitalized. For example, Steve Malone.
%PROPER("TiNa MaNcInI")
264
Returns the string Mary-lou Fernandez. Note that lou is not converted to Lou.
%PROPER("<<97><<110>><<110>><<97>><<32>><<107>><<105>><<109>>")
Returns the ASCII string Anna Kim. Related concepts String functions on page 262 Related reference Substring%SUBSTRING on page 267
Character substitution%REPLACE
Use this function when you want InfoSphere CDC to replace leading, trailing, or all occurrences of a specified character with another character during replication. It provides a character-by-character replacement. You can use this function to replace leading blank characters with zeros.
Syntax
%REPLACE(<parm>, "<type>", "<str1>", "<str2>")
Parameters
v parmSpecifies a character column, literal, or column function that returns a character string. v typeSpecifies the substitution type. You must enclose values of this parameter in double quotes. *ALLReplaces all occurrences of the specified character. *TRAILReplaces all trailing occurrences of the specified character. *LEADReplaces all leading occurrences of the specified character. v str1Specifies the set of characters to be replaced. v str2Specifies the set of characters to replace those specified in str1 . If the number of characters in str1 is greater than that in str2 , the extraneous characters in str1 are deleted in the result. If the number of characters in str1 is less than that in strthe extraneous characters in str2 are ignored. If you specify str2 as two consecutive double quotes () , you can remove instances of a character from str1.
Examples
%REPLACE(CUSTNO, "*LEAD", " ", "0")
Replaces all leading blank characters in the CUSTNO column with zeros.
%REPLACE(CUSTNO, "*LEAD", "ABC", "123")
Replaces all leading occurrences of A with 1, B with 2, and C with 3 in the CUSTNO column. Evaluation begins with the first character and continues until a character other than A, B or C
Column functions
265
is found. For example, if a column value is AC7777, this example returns 137777. If a column value is ADC7777, this example returns 1DC7777.
%REPLACE(PHONENO, "*ALL", " ", "")
Removes all blank characters in the PHONENO column. This example illustrates how the %REPLACE function can be used to remove a character from a string instead of replacing it with another character.
%REPLACE(PHONENO, "*LEAD", " ", "")
Removes all leading blank characters in the PHONENO column. This example is similar to the previous example, except that only leading blank characters are removed. To remove leading blank characters, you can also use the %LTRIM function. To remove trailing blank characters, use the %RTRIM function.
%REPLACE(PARTNO, "*TRAIL", "ACY", "acy")
Replaces all trailing occurrences of A with a, C with c, and Y with y in the PARTNO column. Evaluation begins with the last character and continues until a character other than A, C or Y is found. For example, if a column value is 2361ACY, this example returns 2361acy. If a column value is 2361ADY, this example returns 2361ADy.
%REPLACE("259899", "*ALL", "29", "4")
Returns 458. Replaces all occurrences of 2 with 4, and removes all occurrences of 9.
%REPLACE("259899", "*ALL", "2", "45")
Returns 459899. Replaces all occurrences of 2 with 4. Does not remove occurrences of 5.
%REPLACE(PRODDESC, "*ALL", "<<0>><<13>>", "<<32>><<32>>")
On platform that use the ASCII character set, this functions replaces all occurrences of NUL and carriage return in the PRODDESC column with blank characters. Related concepts String functions on page 262 Related reference Left trim%LTRIM on page 263 Right trim%RTRIM
Right trim%RTRIM
Use this function when you want InfoSphere CDC to trim all trailing blank characters from a character string during replication.
Syntax
%RTRIM(<parm>)
Parameters
v parmSpecifies a character column, literal, or column function that returns a character string. v posSpecifies the starting position. This value must be greater than or equal to 1.
266
v lenSpecifies the length of the substring. This value must be greater than or equal to 1.
Examples
Related concepts String functions on page 262
Substring%SUBSTRING
Use this function when you want InfoSphere CDC to create a character string that is a subset of an existing string that begins at a specified starting position and continues for a specified length.
Syntax
%SUBSTRING(<parm>, <pos>, <len>)
Parameters
v parmSpecifies a character column, literal or column function that returns a date value accepted by the function. v typeSpecifies the format of the input date. You must enclose values of this parameter in double quotes. *YMDThe input format is yymmdd. *MDYThe input format is mmddyy. *DMYThe input format is ddmmyy. *YMThe input format is yymm. *MYThe input format is mmyy. *JULThe input format is yyjjj, where jjj represent the sequence number of a day in the calendar year. jjj must be between 1, which represents January 1st, and 366, which represents December 31st in a leap year. For jjj values less than 100, you must specify the leading zero or zeros. For example, the Julian date for February 4th is 035, which represents the 35th day of the year. v centurylineSpecifies the year in the century used to determine which century is added to the date. All years that precede the century line year will be designated as being in the 21st century. All years including and following the century line year will be designated as being in the 20th century. If centuryline is greater than 99, all years are designated as being in the 21st century. For example, if centuryline is set to 30 and the two-digit year specified by parm is 19, this function returns 2019. If centuryline is set to 20 and the two-digit year specified by parm is 33, this function retrrns 1933. This parameter is optional. If you omit this parameter, InfoSphere CDC assumes a default value of 40.
267
is greater then the length of parm , then the function returns a string of length len that has the portion of parm that starts at pos and ends at the end of parm, right-padded with blank characters.
Examples
%SUBSTRING(DIVISION,3,2)
Returns two characters from the DIVISION column beginning from the third position.
%SUBSTRING("Tony Jackson",0,2)
Generates a runtime error because the starting position cannot be less than 1.
%SUBSTRING("Anna<<32>>Kim<<0>>", 1, 8)
Returns the ASCII string Anna Kim with no NUL-termination. Related concepts String functions on page 262
Uppercase%UPPER
Use this function when you want InfoSphere CDC to convert all lowercase characters in a string to uppercase during replication.
Syntax
%UPPER(<parm>)
Parameters
parmspecifies a character column, literal, or column function that returns a character string.
Examples
%UPPER(DEPARTMENT)
Returns the strings in the DEPARTMENT column in uppercase. For example, ACCOUNTING, MARKETING, and so on.
%UPPER("AnDrEa MoSs")
Returns the string DR. For information about the %SUBSTRING function, see .
%UPPER("<<97>><<110>><<110>><<97>><<32>><<75>><<73>><<77>>")
268
String functions on page 262 Related reference Substring%SUBSTRING on page 267 Uppercase%UPPER on page 268
Century%CENTURY
Use this function when you want InfoSphere CDC to add a two-digit century specification to a date that identifies the year without the century during replication. This function accepts a character date value specified in one of six different formats.
Syntax
%CENTURY(<parm>, "<type>", [centuryline])
Parameters
v parmSpecifies a character column, literal or column function that returns a date value accepted by the function. v typeSpecifies the format of the input date. You must enclose values of this parameter in double quotes. *YMDThe input format is yymmdd. *MDYThe input format is mmddyy. *DMYThe input format is ddmmyy. *YMThe input format is yymm. *MYThe input format is mmyy. *JULThe input format is yyjjj, where jjj represent the sequence number of a day in the calendar year. jjj must be between 1, which represents January 1st, and 366, which represents December 31st in a leap year. For jjj values less than 100, you must specify the leading zero or zeros. For example, the Julian date for February 4th is 035, which represents the 35th day of the year. v centurylineSpecifies the year in the century used to determine which century is added to the date. All years that precede the century line year will be designated as being in the 21st century. All years including and following the century line year will be designated as being in the 20th century. If centuryline is greater than 99, all years are designated as being in the 21st century. For example, if centuryline is set to 30 and the two-digit year specified by parm is 19, this function returns 2019. If centuryline is set to 20 and the two-digit year specified by parm is 33, this function returns 1933.
Column functions
269
This parameter is optional. If you omit this parameter, InfoSphere CDC assumes a default value of 40.
Examples
Input Date (parm) 101001 211197 032080 0493 2001 99365 Input Format (type) *YMD *DMY *MDY *MY *YM *JUL 92 0 60 80 Input century line (centuryline) Result 20101001 (October 1, 2010) 21111997 (November 21, 1997) 03201980 (March 20, 1980) 041993 (April 1993) 202001 (January 2002) 1999365 (December 31, 1999)
Current date%CURDATE
Use this function when you want InfoSphere CDC to return the current date during data replication (refresh or mirroring) activities on the source or target. For example, you may want to track when InfoSphere CDC inserts a record or when it performs updates on source and target columns. This function uses the system clock you have set on the source or target. Note: InfoSphere CDC for AS/400 and InfoSphere CDC for Microsoft SQL Server do not support this function. Table 1 Input Date (parm) Input Format (type) Input century line Result 101001 *YMD 20101001 (October 1, 2010) 211197 *DMY 0 21111997 (November 21, 1997) 032080 *MDY 60 03201980 (March 20, 1980) 0493 *MY 80 041993 (April 1993) 2001 *YM 202001 (January 2020) 99365 *JUL 92 1999365 (December 31, 1999) Mapping a target column to an expression that uses the %CURDATE function is not the same as defining the current date as the initial value for the target column. When you map a target column to an expression, InfoSphere CDC populates the target column with the current date when a record is inserted or updated in the target table. However, when you define the initial value as the current date, InfoSphere CDC populates the target column with the current date only when it inserts a record into the target table.
Syntax
%CURDATE("<timezone>")
270
Parameters
timezoneSpecifies the time zone of the result. You must enclose values of this parameter in double or single quotes. v *LOCReturns the date local to the source or target. v *UTCReturns the date in Coordinated Universal Time (UTC). v *GMTReturns the date in Greenwich Mean Time (GMT). This is the same as *UTC.parmSpecifies a character column, literal, or column function that returns a character string.
Examples
%CURDATE("*LOC")
If the local time is March 11, 2004, this function returns 2004-03-11.
%CURDATE("*UTC")
For a server located in the Japan Standard Time (JST) zone, on August 28, 2007, at 1:21 AM, this function returns 2007- 08-27. JST is 9 hours ahead of UTC (UTC+9).
%CURDATE("*GMT")
For a server located in the Japan Standard Time (JST) zone, on August 28, 2007, at 1:21 AM, this function returns 2007- 08-27. JST is 9 hours ahead of UTC (UTC+9). This example is equivalent to %CURDATE (*UTC).
%SUBSTRING(%TOCHAR(%CURDATE("*LOC"), 10), 6, 5)
Returns the month and day of the %CURDATE function invocation local to the source or target. You can use this example if you require the month and day only. For example, if the local date is January 29, 2007, the expression returns 01-29. The %TOCHAR function extracts the month, separator character, and day. Related concepts Date and time functions on page 269 Mapping initial values to target columns on page 161 Related reference Character conversion%TOCHAR on page 274 Substring%SUBSTRING on page 267
Current time%CURTIME
Use this function when you want InfoSphere CDC to return the time when it inserts or updates a row on source and target columns. This function uses the system clock on the source or target. Note: InfoSphere CDC for AS/400 and InfoSphere CDC for Microsoft SQL Server do not support this function.
Syntax
%CURTIME("<timezone>")
Column functions
271
Parameters
timezoneSpecifies the time zone of the result. You must enclose values of this parameter in double or single quotes. v *LOCReturns the time local to the source or target. v *UTCReturns the time in Coordinated Universal Time (UTC). v *GMTReturns the time in Greenwich Mean Time (GMT). This is the same as *UTC.
Examples
%CURTIME("*LOC")
For a server located in the Hawaiian Standard Time (HST) zone, at 9:14:33 PM, this function returns 07.14.33. HST is 10 hours behind UTC (UTC-10). %CURTIME(*GMT) For a server located in the Hawaiian Standard Time (HST) zone, at 9:14:33 PM, this function returns 07.14.33. HST is 10 hours behind UTC (UTC-10). This example is equivalent to %CURTIME (*UTC).
%TOCHAR(%IF(%VAR(EST, %TONUMBER(%REPLACE(%TOCHAR(%CURTIME("*LOC"), 8), "*ALL", ".", "")) + 30000) < 240000, %VAR(EST), %VAR(EST) 240000), 6)
Returns the time of the %CURTIME function invocation three time zones ahead relative to the local time zone on the source or target. This example illustrates that an expression can be defined to convert local time to the equivalent time in any other time zone (not necessarily UTC). It returns a character result after performing time calculations. For example, if this expression is evaluated on a server located in the Pacific Standard Time (PST) zone at 3:22:48 PM, the expression returns 182248. The result represents the same time in the Eastern Standard Time (EST) zone, which is 3 hours ahead of PST (PST+3). In the event that the returned Pacific time is in the interval from 9:00:00 PM to 12:00:00 AM, the %IF function ensures that the expression returns the equivalent Eastern time on the following day. To modify the above expression to select a different time zone ahead or behind the local time zone, change + 30000 to a different sign and value. For example, changing +30000 to +20000 returns the equivalent time in the Central Standard Time (CST) zone.
%IF(%VAR(DIFF, %TONUMBER(%TOCHAR(%CURTIME("*LOC"), 2)) %TONUMBER(%TOCHAR(%CURTIME("*UTC"), 2))) > 12, %VAR(DIFF) 24, %IF(%VAR(DIFF) < 12, %VAR(DIFF) + 24, &VAR(DIFF)))
Returns the time difference between UTC and the time zone of the source or target where the %CURTIME functions are invoked.
272
For example, if this expression is evaluated on a server located in the Central Europe Time (CET) zone at 6:43:07 PM, the expression returns 1. If the server is located in the Mountain Standard Time (MST) zone and the functions are invoked at 1:22:13 AM, the expression returns -7. Note: This example compares equivalent times after obtaining two separate time samples, which may not always produce the correct results. The expression will not produce the correct result if %CURTIME ("*LOC") is invoked at 7:59:59 AM, local time, and %CURTIME ("*UTC") is invoked one second later at 8:00:00 AM, local time.
Current timestamp%CURTMSTP
Use this function to when you want InfoSphere CDC to track the date and time when it inserts or updates a row in source and target columns. This function uses the system clock on the source or target. Note: InfoSphere CDC for AS/400 and InfoSphere CDC for Microsoft SQL Server do not support this function.
Syntax
%CURTMSTP("<timezone>")
Parameters
timezoneSpecifies the time zone of the result. You must enclose values of this parameter in double or single quotes. v *LOCReturns the time local to the source or target. v *UTCReturns the time in Coordinated Universal Time (UTC). v *GMTReturns the time in Greenwich Mean Time (GMT). This is the same as *UTC.
Examples
%CURTMSTP("*LOC")
If the local time is 2:05:54 AM on June 18, 2005, this function returns 2005-06-18-02.05.54.
%CURTMSTP("*UTC")
For a server located in the Japan Standard Time (JST) zone, at 4:31:01 AM on September 22, 2011, this function returns 2011-09-21-19.31.01. JST is 9 hours ahead of UTC (UTC+9).
%CURTMSTP("*GMT")
For a server located in the Japan Standard Time (JST) zone, at 4:31:01 AM on September 22, 2011, this function returns 2011-09-21-19.31.01. JST is 9 hours ahead of UTC (UTC+9). This example is equivalent to %CURTMSTP(*UTC).
Column functions
273
%TOCHAR(%CURTMSTP("*UTC"), 16)
Returns the date and time (hours and minutes only) of the %CURTMSTP function invocation in UTC. You can use this example if you do not require the number of seconds and microseconds. For example, if the %CURTMSTP function is invoked on a server located in the Western Standard Time (WST) zone on April 24, 2013 at 4:05:22 AM, the expression returns 2013-04-23-20.05. WST is 8 hours ahead of UTC (UTC+8). The %TOCHAR function converts the date to character data and returns the first 16 characters of the timestamp returned by the %CURTMSTP function. For information about the %TOCHAR function, Character conversion%TOCHAR.
Conversion functions
Use these functions when you want InfoSphere CDC to convert values from one data type to another during replication. You can convert from any value to a character string or a numeric value, or from a numeric or character value to a datetime-type value. See also: Character conversion%TOCHAR Date conversion%TODATE on page 275 Date and time conversion%TODATETIME on page 277 Number conversion%TONUMBER on page 279 Time conversion%TOTIME on page 280
Character conversion%TOCHAR
Use this function to convert any value to a character string.
Syntax
%TOCHAR(<parm>, <length>, [decimal])
Parameters
v parmSpecifies a column name or literal. v lenSpecifies the number of characters to be returned. A decimal place counts as a returned value. For example, if you specify that you want to return three characters, this function returns the three leftmost or high order digits of parm. Note: Specify a negative value for this parameter if you would like %TOCHAR to treat the incoming value as unsigned. This feature is only available with InfoSphere CDC for z/OS. v decimalAn integer value that specifies the number of decimal places in the returned value. This parameter is optional and is only available with InfoSphere CDC for z/OS. The following table provides several examples with integers that have a defined number of decimal places and an example of how InfoSphere CDC for z/OS converts real floating decimals.
Input value 1.2345 1234.5 Length 6 7 Decimal 2 2 Result 001.23 1234.50
274
Length 7 7
Decimal 2 2
Examples
Input value (parm) 12345 123.45 0.123 1234 Input length (len) 3 5 3 6 Decimal places (decimal) Not specified. Not specified. Not specified. Not specified. Result 123 123.4 0.1 001234 The integer value is left-padded with zeros to return a string of six characters. 1.02 7 Not specified. 1.020000 The decimal part is right-padded with zeros to return a string of seven characters. 45699 9 2 000456.99 The integer value is left-padded with zeros and two decimal places to return a string of nine characters. Note: The decimal parameter is only supported by InfoSphere CDC for z/OS. $SEQNO -20 Not specified. 13878964169332555778. By specifying a negative length, %TOCHAR treats the &SEQNO journal control field as unsigned. Note: The ability to specify negative lengths is only supported by InfoSphere CDC for z/OS.
Date conversion%TODATE
Use this function when you want InfoSphere CDC to convert a numeric or character data type value to a datetime-data type during replication. You can convert dates from packed-numeric, zoned-numeric, or from character formats without century, to datetime or character-type values with century.
Column functions
275
Syntax
%TODATE(<date>, "<type>")
Parameters
v datespecifies the input date. If date is the name of a column containing a character string, the length of that string must match the length for the format specified by type, as indicated below. InfoSphere CDC generates an error if the length is any other value.
type value *YMD (yymmdd) *MDY (mmddyy) *DMY (ddmmyy) *YYMD (ccyymmdd) *CYMD (cyymmdd) *JUL (yyjjj) *CJUL (cyyjjj) *YJUL (ccyyjjj) Length of date 6 digits 6 digits 6 digits 8 digits 7 digits 6 digits 6 digits 7 digits
v typespecifies the format of the input date. You must enclose values of this parameter in double quotes. *YMDthe input format is yymmdd. MDYthe input format is mmddyy. *DMYthe input format is ddmmyy. *YYMDthe input format is ccyymmdd, where cc represents the century. *CYMDthe input format is cyymmdd, where c represents the century. A value of 0 for c represents the 20th century. Any other value represents the 21st century. *JULthe input format is yyjjj, where jjj represent the sequence number of a day in the calendar year. jjj must be between 1, which represents January 1st, and 366, which represents December 31st in a leap year. For jjj values less than 100, you must specify the leading zero or zeros. For example, the Julian date for February 4th is 035, which represents the 35th day of the year. When you set type to *JUL, if you specify a value for yy between 40 and 99, the %TODATE function returns the corresponding year in the 20th century. For example, 1940. If you specify a value for yy between 0 and 39, the %TODATE function returns the corresponding year in the 21st century. For example, 2039. *CJULthe input format is cyyjjj, where c represents the century. A value of 0 for c represents the 20th century. Any other value represents the 21st century. *YJULthe input format is ccyyjjj, where cc represents the century.
276
Examples
These examples show the hyphen (-) as the separator character in the returned ISO dates. Depending on your environment, a different character may separate the year, the month, and the day in the output date.
Input date (date) 760704 100195 000000 010768 19560205 1100216 95004 102032 1991359 Input format (type) *YMD *MDY *MDY *DMY *YYMD *CYMD *JUL *CJUL *YJUL Result 1976-07-04 (July 4, 1976) 1995-10-01 (October 10, 1995) 1901-01-01 (January 1, 1901) 1968-07-01 (July 1, 1968) 1956-02-05 (February 5, 1956) 2010-02-16 (February 16, 2010) 1995-01-04 (January 4, 1995) 2002-02-01 (February 2, 2002) 1991-12-25 (December 25, 1991)
Syntax
%TODATE(<date>, "<type>", <time>)
Parameters
v datespecifies the input date. If date is the name of a column containing a character string, the length of that string must match the length for the format specified by type, as indicated below. InfoSphere CDC generates an error if the length is any other value.
type value *YMD (yymmdd) *MDY (mmddyy) *DMY (ddmmyy) *YYMD (ccyymmdd) *CYMD (cyymmdd) *JUL (yyjjj) *CJUL (cyyjjj) *YJUL (ccyyjjj) Length of date 6 digits 6 digits 6 digits 8 digits 7 digits 6 digits 6 digits 7 digits
Column functions
277
v typespecifies the format of the input date. You must enclose values of this parameter in double quotes. *YMDthe input format is yymmdd. MDYthe input format is mmddyy. *DMYthe input format is ddmmyy. *YYMDthe input format is ccyymmdd, where cc represents the century. *CYMDthe input format is cyymmdd, where c represents the century. A value of 0 for c represents the 20th century. Any other value represents the 21st century. *JULthe input format is yyjjj, where jjj represent the sequence number of a day in the calendar year. jjj must be between 1, which represents January 1st, and 366, which represents December 31st in a leap year. For jjj values less than 100, you must specify the leading zero or zeros. For example, the Julian date for February 4th is 035, which represents the 35th day of the year. When you set type to *JUL, if you specify a value for yy between 40 and 99, the %TODATE function returns the corresponding year in the 20th century. For example, 1940. If you specify a value for yy between 0 and 39, the %TODATE function returns the corresponding year in the 21st century. For example, 2039. *CJULthe input format is cyyjjj, where c represents the century. A value of 0 for c represents the 20th century. Any other value represents the 21st century. *YJULthe input format is ccyyjjj, where cc represents the century. v timeSpecifies the input time. The table below indicates the length and format for this parameter, depending on the data type of the input time.
Data type Numeric Length 5 digits 6 digits Character 8 digits Format HMMSS. For example, 71500 represents 7:15 AM. HHMMSS. For example, 223000 represents 10:30 PM. HH:MM:SS. You must enclose values of this parameter in double quotes. For example, 10:30:00 represents 10:30 AM.
Examples
The table below provides examples for this function. These examples show the hyphen (-) as the separator character in the returned ISO dates, and the colon (:) as the separator in the returned ISO time values. Depending on your environment, a different character may separate the year, the month, and the day in the output date. Also, a different character may separate the hours, the minutes, and the seconds in the output time.
278
Result 1989-11-02 11:25:00 (November 2, 1989 at 11:25 AM) 1996-03-04 13:42:00 (March 4, 1996 at 1:42 PM) 1901-01-01 10:55:00 (January 1, 1901 at 10:55 AM) 1970-05-21 09:05:00 (May 21, 1970 at 9:05 AM) 2010-09-02 02:30:00 (February 9, 2010 at 2:30 AM) 2006-07-23 19:33:00 (July 23, 2006 at 7:33 PM) 1991-03-01 22:01:00 (March 1, 1991 at 10:01 PM) 1997-04-16 04:35:00 (April 16, 1997 at 4:35 AM) 2002-04-02 17:15:00 (April 2, 2002 at 5:15 PM)
030496
*MDY
13:42:00
000000
*MDY
10:55:00
210570
*DMY
09:05:00
20100902
*YYMD
023000
1060723
*CYMD
193300
91060
*JUL
220100
097106
*CJUL
043500
2002092
*YJUL
17:15:00
Number conversion%TONUMBER
Use this function when you want InfoSphere CDC to convert a character field or literal to a numeric value during replication.
Syntax
%TONUMBER(<parm>)
Parameters
v parmSpecifies a character column, literal or column function that returns a character string. It must be in the following format:
[<whitepsace>] [<sign>] [<digits>] [.<digits>] [{e | E} [<sign>] <digits>]
In the specification above, the white space can consist of one or more blank or tab characters. The signs must be plus (+) or minus (-), and you can specify only decimal digits. At least one digit must appear after the decimal point. The decimal digits may be followed by an exponent that consists of the letter E (in upper or lower case) and an optionally signed decimal integer. Note the following when using the %TONUMBER function: If parm does not follow the format above, the %TONUMBER function returns zero. If you convert a correctly formed character field or literal that contains an exponent, the %TONUMBER function returns a floating point number.
Column functions
279
Floating point values expressed in character form are converted to 8-byte floating-point data types. Integer values expressed in character form are converted to 4-byte integer data types. Precision may be lost when you convert numerical values expressed in character form that exceed a certain number of digits.
Examples
Input value (parm) 12.45 Result Returns a floating point value of 12.45. If this function is mapped to an integer column, then it truncates the decimal part is truncated and returns 12. Returns an integer value of 3. Returns a floating point value of -12.4. Returns an integer of -920824. Leading zeros are removed. If the column from which this function is called is nullable, this function returns NULL. Otherwise, it returns an integer value of 0. Returns an integer value of 0, because the %TONUMBER function cannot convert character strings that do not conform to the data format described for parm. Returns an integer value of 0. InfoSphere CDC generates a message in Event Log. The input value is valid as a character string, but it cannot be converted to a numeric value. Returns a non-zero result, but precision may be lost. Returns an integer value of 0. Returns an integer value of 0. Returns a floating point value of 220. Returns a floating point value of 4500. Returns an integer value of 0. Returns a floating point value of -0.1. Returns an integer value of 0. Returns a floating point value of 66.67
ABC
Time conversion%TOTIME
Use this function when you want InfoSphere CDC to convert a character, numeric, or time data type to a time data type during replication. You can convert from different formats based on the type of the input value.
280
Note: InfoSphere CDC for Microsoft SQL Server does not support this function. Use this function to when you want InfoSphere CDC to track the date and time when it inserts or updates a row in source and target columns. This function uses the system clock on the source or target. Note: InfoSphere CDC for AS/400 and InfoSphere CDC for Microsoft SQL Server do not support this function.
Syntax
%TOTIME(<time>)
Parameters
timeSpecifies a column or literal that can have one of the following types: v Time, in the format HMMSS or HHMMSS. For example, 71500 represents 7:15 AM and 223000 represents 10:30 PM. v Numeric. This value must be positive, and if it contains a fractional part, the fraction must be zero. v Character, in one of the following formats:
[whitespace] digit digit digit digit digit digit [whitespace]
This format lets you specify a time value that contains six consecutive digits. Any number of blank characters can precede or follow the six digits. For example, %TOTIME ( 012537 ) returns 01:25:37.
[whitespace] digit [digit] separator digit [digit] [separator digit [digit]] [whitespace]
This format lets you specify a time value that contains valid separator characters (colon, comma, period or one or more spaces) between hours, minutes, and seconds. Any number of blank characters can precede the first digit or follow the last digit. You cannot specify more than one separator character in the time value. For example, %TOTIME (12:05.20) is not valid. You can omit the number of seconds, in which case the %TOTIME function assumes zero seconds. For example, %TOTIME ("12:05") returns 12:05:00. You can omit leading zeros in the number of hours, minutes, and seconds. For example, %TOTIME ("12 5 20") returns 12:05:20.
[whitespace] digit [digit] separator digit [digit] [whitespace] {A | a | P | p} [{M | m}] [whitespace]
This format lets you specify a time value that indicates AM or PM. You can specify AM and PM in a number of different ways, such as A, AM, Am, a, aM, am, P, or PM. Any number of blank characters can precede the first digit or follow the AM/PM specification. You cannot specify more than one separator character in the time value. For example, %TOTIME ("04: 20 PM") is not valid. You cannot specify seconds in this format. If you do so, the %TOTIME function assumes zero seconds. You can omit leading zeros in the number of hours and minutes. For example, %TOTIME ("3 5 P") returns 15:05:00.
281
environment, a different character may separate the hours, minutes, and seconds in the output time.
Examples
Input value (parm) 012537 22:4:12 4:05P 2 5 Am 204521 91035.0000 250521 10: 10:35 Result 01:25:37 22:04:12 16:05:00 02:05:00 20:45:21 09:10:35 00:00:00 00:00:00
Conditional%IF
Use this function when you want InfoSphere CDC to evaluate a conditional expression and return different results during replication.
Syntax
%IF(<conditional>, <expression_if_true>, <expression_if_false>)
Parameters
v conditionalspecifies a conditional expression that evaluates to true or false. The conditional expression must compare identical data types. v expression_if_truespecifies an expression that is evaluated if the condition is true. v expression_if_falsespecifies an expression that is evaluated if the condition is false. The values returned by expression_if_true and expression_if_false must both be of the same data type.
282
Examples
%IF(ID=1, "ID is 1", "ID is not 1")
If the value in the ID column is equal to 1, this function returns the string ID is 1. Otherwise, it returns the string ID is not 1.
%IF(DATSTR="010101", %TODATE(19010101, "*YYMD"), %IF(DATSTR="999999", NULL, %TODATE(DATSTR, "*YMD")))
If a value in the DATSTR column is 010101, this function returns 1901-01-01. If a value in DATSTR is 999999, it returns NULL. In all other cases, it returns equivalent dates to values in DATSTR. For example, for a value of 710723 in the DATSTR column, this example returns 71-07-23. For information about the %TODATE function, see Date conversion%TODATE on page 275. Related reference Date conversion%TODATE on page 275
Variable%VAR
Use this function when you want InfoSphere CDC to evaluate a conditional expression and return different results during replication.
Syntax
%VAR(<variable_name>, [expression])
Parameters
v variable_nameSpecifies the name of the defined or retrieved variable. v expressionSpecifies a literal or a complex expression. This parameter is optional. If you specify it, the function creates a new variable, assigns the given value to it, and returns the value of the variable. If the variable already exists, the function assigns the new value to it. If you omit this parameter, the function retrieves the value of the variable, provided that the variable is defined (using the %VAR function) in a preceding column or previously in the current expression. You can pass a variable in the same row, from column to column, in ascending column sequence. However, you cannot pass a variable between rows.
Examples
%VAR(SBTTL, PRICE*QTY)
If the value in the PRICE column is 10 and the value in the QTY column is 5, then this function assigns the value 50 to the SBTTL variable, and returns the value 50. %VAR(SBTTL) If SBTTL is defined either in an expression for a preceding column or earlier in the current expression, this function returns the current value of the SBTTL variable.
%IF(%VAR(QTY, QTYORD + QTYBACKORD) <100, %VAR(QTY) * PRICE, %VAR(QTY) * PRICE * (1- DISCOUNT))
Sets the QTY variable to QTYORD plus QTYBACKORD. If QTY is less than 100, then the result of the expression is QTY * PRICE. Otherwise, the result of the expression is QTY * PRICE * (1 - DISCOUNT). For information about the %IF
Column functions
283
function, see Conditional%IF on page 282. Related reference Conditional%IF on page 282
Data functions
Use these functions when you want InfoSphere CDC to retrieve column values during replication. When you use these functions, InfoSphere CDC can return the value of a source column before applying an update, the value of a target column before applying an update, and the value of a column for a specific row in a table. See also: Before value%BEFORE Current value%CURR Retrieve column%GETCOL (DB2 UDB for iSeries) on page 285 Retrieve column%GETCOL (Dynamic SQL) on page 288 Retrieve column%SELECT on page 293
Before value%BEFORE
Use this function when you want InfoSphere CDC to retrieve the value of a source column before applying an update.
Syntax
%VAR(<parm>)
Parameters
parmSpecifies the name of a source column. You cannot specify a journal control field, an expression, or a column function as the input parameter.
Examples
%VAR(CRLIMIT)
Returns the previous value in the CRLIMIT column, before it was updated on the source by the change being replicated.
Current value%CURR
Use this function when you want InfoSphere CDC to retrieve the value of a target column before applying an update on a source column. Note: InfoSphere CDC for z/OS does not support this function.
Syntax
%VAR(<parm>)
284
Parameters
parmSpecifies the name of a source column. You cannot specify a journal control field, an expression, or a column function as the input parameter.
Examples
%CURR(BALANCE)
Returns the current value of the target column BALANCE. In an expression, the current balance would be placed in the derived column before the update to BALANCE is applied to the target table.
%CURR(BALANCE) - %BEFORE(BALANCE)
Calculates the difference between the values in the source and target columns before an update is made. If the result is not equal to zero, the column values were not the same before the update was applied on the source and on the target. You can use this example only for numeric fields.
(SRCCNT - %BEFORE(SRCCNT)) + %CURR(TGTTOT)
You can use this example to maintain the total of two or more numeric column values that are contained in the same table on different datastores. In each source table, the SRCCNT column is mapped to the corresponding target column with the same name. The expression in this example is assigned to the derived column TGTTOL on the target. When a value in a SRCCNT column is updated, the difference between the new value and the previous value is calculated using the %BEFORE function. This difference is added to the current sum stored in the derived column TGTTOL. The result of the expression is assigned to the derived column.
%CURR(%TONUMBER(EMPNO))
InfoSphere CDC generates an error when verifying the expression, because %CURR does not accept another column function (in this example, %TONUMBER) as its parameter. Related reference Before value%BEFORE on page 284
Column functions
285
You can use the %GETCOL function in expressions to perform the following operations: v Obtain columns from one or more keyed secondary tables and join them with an existing primary table before sending data to the target. The primary table refers to the source table being replicated. The secondary tables refer to tables referenced in the %GETCOL function. v Specify how keys of the secondary tables are populated, to allow InfoSphere CDCto perform the necessary secondary reads. v Use columns from secondary tables that were retrieved previously to populate keys for subsequent reads (the population of key column values is not restricted to primary columns only). v Specify the order that table reads are performed. v Condition the table reads that are performed. v Read tables external to InfoSphere CDC to perform dynamic translations on the target. Note: This topic contains information about the %GETCOL function supported by InfoSphere CDC for AS/400.
This function reads a table and returns the value of the column specified, based on the key column values that are identified. If more than one row satisfy the key requirements specified, then this function returns the first row only. If the read is unsuccessful, then this function returns the default value specified and sends a message to the appropriate message queue. The specified column in the table must exist when specifying the expression.
This function returns the value of the specified column from a row retrieved by a previous %GETCOL function invocation. The short syntax lets you retrieve more than one column from a table (that was read previously using the %GETCOL function), without reading the table again. The previous %GETCOL function invocation must be for the same journal entry during continuous mirroring or the same row during refresh. The table_name and record_format parameters specified in the short format of the %GETCOL function invocation must match the table_name and record_format parameters specified in the long format of the %GETCOL function invocation.
Parameters
v column_nameSpecifies the name of a column. You cannot specify an expression for this parameter. v table_nameSpecifies the name of a table. This table must be keyed. You cannot specify an expression for this parameter. You can specify the table name using one of the following formats:
286
The library, file, and member names are specified. For example, LIBRARY/FILE(MEMBER). The library and file are specified. InfoSphere CDC assumes a default value of *FIRST for the member name. For example, LIBRARY/FILE. The file is specified. InfoSphere CDC assumes a default value of *LIBL for the library name and a default value of *FIRST for the member name. For example, FILE. The file and member names are specified. InfoSphere CDC assumes a default value of *LIBL for the library name. For example, FILE(MEMBER). v default_valueSpecifies a default value to return if the read fails. This value must be a literal or constant, depending on the data type of the specified column. For character, date, time, and timestamp data types, you must enclose values of this parameter in double quotes. For example, NO SALESREP or 1995-05-10. If you specify NULL as the default value, then the column must be nullable. You cannot specify an expression for this parameter. If you omit this parameter, then you must enter a comma instead of the parameter value to indicate its position in the parameter list. If you omit this parameter, then this function returns a default value according to the data type of the column specified.
Field type Character Decimal (packed) Numeric (zoned) Real (4byte floating point) Float (8byte floating point) Date Default value Blank character Zero Zero Zero Zero 0001-01-01 (Date Zero). This applies to all date formats except *JUL (Julian). 1940-01-01 (Date Zero). This applies to the *JUL (Julian) date format. Time Integer (4 bytes) Small integer (2 bytes) Timestamp 00:00:00 (Time Zero) Zero Zero 0001-01-01 00:00:00 (Timestamp Zero)
v record_formatSpecifies the record format for the record to read. You cannot specify an expression for this parameter. Specify this parameter if more than one record format exist. If you omit this parameter, then you must enter a comma instead of the parameter value to indicate its position in the parameter list. If you omit this parameter, then InfoSphere CDC reads the first record format. v key_countIndicates the number of key values specified as parameters. It should be the number of key columns of the record format selected. It must be an integer greater than 0. You cannot specify an expression for this parameter. If you omit this parameter, then InfoSphere CDC assumes a default value of 1. v key_value1, key_value2, ...key_valuenSpecify the key values to use when performing the read. These key values must match the key columns of the table to read. Character data passed as key parameters is padded with blank characters, or truncated if the length does not match the length of the key column.
Column functions
287
The key value can be either a primary table column (direct column mapping) or an expression. Some examples include: An expression performed on a primary table column that matches the definition of the key column in the table to read. A column from a previous read using the %GETCOL function. An expression performed on a column that was previously read using the %GETCOL function. You must specify these parameters if the key_count parameter is specified.
Examples
The following examples are of scenarios where the %GETCOL function is used:
%GETCOL (CUSTNAME, "PRODLIB/CUSTMAST")
Retrieves the CUSTNAME column from a previous read of the CUSTMAST table in library PRODLIB, member *FIRST, and record format *FIRST. If the read is unsuccessful (for example, not found) and assuming that the data type for the CUSTNAME column is CHARACTER, then this function returns blanks characters.
%GETCOL (CUSTNAME, "PRODLIB/CUSTMAST", "NO CUSTMAST")
Retrieves the CUSTNAME column from a previous read of the CUSTMAST table in library PRODLIB, member *FIRST, and record format *FIRST. If the read is unsuccessful (for example, not found), then this function returns NO CUSTMAST.
%GETCOL (CUSTNAME, "PRODLIB/CUSTMAST", , "FMT2")
Retrieves the CUSTNAME column from a previous read of the CUSTMAST table in library PRODLIB, member *FIRST, and record format FMT2. The previous read must have FMT2 specified for the record format. If the read is unsuccessful (for example, not found) and assuming that the data type for the CUSTNAME column is CHARACTER, then this function returns blank characters. Related reference Retrieve column%GETCOL (Dynamic SQL) Retrieve column%SELECT on page 293
288
To use this function, the primary and secondary tables must have one or more key columns. The key columns in the primary and secondary tables are used to retrieve a different column in the secondary table. The key columns that are used to retrieve data can have different names and data types. However, if the key column data types are different, then you must convert them to the appropriate data types using conversion column functions, such as %TOCHAR. If you are using InfoSphere CDC for z/OS, then see %GETCOL and %SELECT Function Calls and Processing Efficiency in your InfoSphere CDC for z/OS documentation for information about performance considerations when using the %GETCOL or %SELECT column functions. Note: This topic contains information about the %GETCOL function supported by any InfoSphere CDC product except for InfoSphere CDC for AS/400.
This function reads a table and returns the value of the column specified, based on the key column names and values that are identified. If you specify a table or column name that contains spaces, then you must enclose that name in square brackets. For example, enter [EMP NY] to reference a table named EMP NY.
This function returns the value of a the specified column from a row retrieved by a previous %GETCOL function invocation. The short syntax lets you retrieve more than one column from a table (that was read previously using the %GETCOL function), without reading the table again. The table_name parameter specified in the short format of the %GETCOL function invocation must match the table_name parameter specified in the long format of the %GETCOL function invocation. If the read is unsuccessful or a previous %GETCOL function invocation was not performed, then InfoSphere CDC generates an error message and sets the values of the derived column in which the %GETCOL function is used to default values, based on the data type of the derived column.
Parameters
v column_nameSpecifies the name of a column. You cannot specify an expression for this parameter. If the specified column does not exist in the secondary table, then InfoSphere CDC generates an error message when verifying the expression that contains the %GETCOL function. v table_nameSpecifies the name of a table. Note the following when specifying this parameter: If you installed InfoSphere CDC for Oracle, you can specify the table name in the format <OWNER_NAME>.<TABLE_NAME>, where the owner and table are in uppercase. If you omit the owner name, then InfoSphere CDC assumes that the owner is the user that installed InfoSphere CDC. If ownership of the table cannot be determined, then InfoSphere CDC assumes the default value of PUBLIC for the owner name.If you installed InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for Sybase, you must specify the table name in the format ...
Column functions
289
If you installed InfoSphere CDC for z/OS, you must specify the table name in the format <owner_name>.<table_name> or <owner_name>.<table_name>. If you installed InfoSphere CDC for DB2 UDB or InfoSphere CDC for PointBase, you must specify the table name in the format [owner_name].<table_name> or [owner_name].<table_name>. v default_valueSpecifies a default value to return when no row can be found in the secondary table using the key value that matches the value of the referring (foreign) key column in the primary table row. If the corresponding row cannot be found in the secondary table, then the default value populates the derived column for the row sent to the target. If you specify NULL as the default value, then the column must be nullable. For certain InfoSphere CDC products, this is a required parameter. InfoSphere CDC generates an error if a default value is required, but is not specified in a %GETCOL function invocation. If you omit this parameter, then you must enter two consecutive commas (for the long syntax) or a comma (for the short syntax) prior to the right parenthesis to indicate its position in the parameter list. In this case, the %GETCOL function returns a default value according to the data type of the column specified. v key_nameIdentifies the key column name in the secondary table used to retrieve the secondary column specified by column_name. Note: The DB2 UDB for z/OS API requires that the column specified in key_name is not nullable. InfoSphere CDC for z/OS generates an error message if it encounters a NULL key value when processing the %GETCOL function. To ensure that the %GETCOL function is invoked only for records with non-NULL key values, use the %IF function. v key_valueSpecifies, for each key column, an associated key value. The key value can be any expression. If you specify a primary column name, then InfoSphere CDC uses the after image value of that column as the key_value for the key column in the secondary table to locate the corresponding row in the secondary table. You can specify multiple key name and value pairs. Note: For InfoSphere CDC for z/OS, you can specify up to nine key_name/key_value pairs.
Examples
The following examples use the relationship between primary and secondary tables.
290
Assuming the primary and secondary tables shown above, you map the %SELECT function to the EMPCOUNTRY column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table, this example returns their country from the COUNTRY secondary table record. If COUNTRY does not contain a record that satisfies the condition in the WHERE clause, then this function returns the default value for the data type of the COUNTRY column. For example, blank characters if the data type is character.
%SELECT("SELECT Q1, Q2, Q3, Q4 FROM DB1.GSMITH.SALES WHERE EMP = ? AND ? = 4", EMPID, EMPBRANCH, 0, 0, 0, 0)
Assuming the primary and secondary tables shown above, you map the %SELECT function to the EMPQ1 column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table, who works at Branch 4, this example returns their first quarter sales figure from the SALES secondary table record. Since this example returns more than one column value, InfoSphere CDC defines three variables, named Q2, Q3, and Q4, to maintain the second, third, and fourth quarter sales figures, respectively. You can retrieve these values using the %VAR function and map them to the EMPQ2, EMPQ3, and EMPQ4 columns in EMPLOYEE.
Column functions
291
If SALES does not contain a record that satisfies the condition in the WHERE clause, then the function returns 0. In addition, InfoSphere CDC sets the three variables Q2, Q3, and Q4 to 0.
%SELECT("SELECT INCOME, CODE, LASTADJDATE, NEXTADJDATE FROM DB1.GSMITH.SALARY WHERE EMP = ? AND BRANCH = ?", EMPID, EMPBRANCH, 0, "Z", 1970-01-01)
Assuming the primary and secondary tables shown in the table diagram previously, you map the %SELECT function to the EMPINCOME column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table, this example returns their income from the SALARY secondary table record. Since this example returns more than one column value, InfoSphere CDC defines three variables, named CODE, LASTADJDATE, and NEXTADJDATE, to maintain the other items of salary information. You can retrieve these values using the %VAR function and map them to columns that you must add to the primary table. If SALARY does not contain a record that satisfies the condition in the WHERE clause, then: v The %SELECT function returns 0. v The CODE variable is set to Z. v The LASTADJDATE variable is set to 1970-01-01. v The NEXTADJDATE variable is set to 19010101 (the z/OS default date value). In this example, you must specify a default value for LASTADJDATE only. Since this column is listed third in the SQL SELECT statement, you must also specify default values for the INCOME and CODE columns. To eliminate the need to specify a default value for CODE, reference LASTADJDATE before CODE in the SQL SELECT statement, as follows: %SELECT("SELECT INCOME, LASTADJDATE, CODE, NEXTADJDATE FROM DB1.GSMITH.SALARY WHERE EMP = ? AND BRANCH = ?", EMPID, EMPBRANCH, 0, 1970-01-01).
%SELECT("SELECT USED FROM DB1.GSMITH.VACATION WHERE EMP = ? AND EMPCOUNTRY IN (USA, UK, JAPAN, FRANCE)", EMPID, 0)
Assuming the primary and secondary tables shown in the previous image, you map the %SELECT function to the EMPVACUSED column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table located in United States, United Kingdom, Japan, or France, this example returns the amount of vacation used from the VACATION secondary table record. If VACATION does not contain a record that satisfies the condition in the WHERE clause, then the %SELECT function returns 0.
%SELECT("SELECT NEXT VALUE FOR SEQ1 FROM SYSIBM.SYSDUMMY1", 1)
This example returns the next value for sequence SEQ1. In this case, the data type of the result is the same as the data type of the sequence object. This example uses the %SELECT function to retrieve the next value for a sequence in DB2 UDB for z/OS V8 or higher. SYSDUMMY1 is an existing DB2 dummy system table referenced in the SQL SELECT statement to satisfy syntax requirements.
292
You must enter any integer value for the second parameter, in order to call the function. For example, 1. For information about sequences and the types of values that you can generate from sequences, see your DB2 UDB for z/OS documentation.
%SELECT("SELECT PREVIOUS VALUE FOR SEQ2 FROM SYSIBM.SYSDUMMY1", 24)
This example returns the previous value for sequence SEQ2. In this case, the data type of the result is the same as the data type of the sequence object. This example uses the %SELECT function to retrieve the previous value for a sequence in DB2 UDB for z/OS V8 or higher. SYSDUMMY1 is an existing DB2 dummy system table referenced in the SQL SELECT statement to satisfy syntax requirements. You must enter any integer value for the second parameter, in order to call the function. For example, 24. For information about sequences and the types of values that you can generate from sequences, see your DB2 UDB for z/OS documentation. Related reference Character conversion%TOCHAR on page 274 Retrieve column%GETCOL (DB2 UDB for iSeries) on page 285 Conditional%IF on page 282
Retrieve column%SELECT
Use this function to specify a valid SQL SELECT statement that retrieves one or more column values from a secondary table so that they can be logically joined to a primary table record. For information about performance considerations when using the %GETCOL or %SELECT column functions, see the %GETCOL and %SELECT Function Calls and Processing Efficiency section in your InfoSphere CDC for z/OS documentation. You can specify only one SQL SELECT statement in each %SELECT function. To use this function, the z/OS user identifier that is used to start the InfoSphere CDC address space must have sufficient DB2 UDB for z/OS privileges to perform SQL SELECT statements. Note: This function is only supported by InfoSphere CDC for z/OS. CAUTION: The use of SQL SELECT statements may constitute a security concern in your environment. Certain clauses and functions may have side effects that result in the changing of DB2 table data and/or the generation of data outside of the control of DB2. Therefore, you should exercise caution when using the %SELECT function to issue SQL SELECT statements.
Syntax
%SELECT(<sql_select_stmt>, <parm>, <parm2>, ..., <parm>, [default_value], [default_value2], ...,[default_value])
Parameters
v sql_select_stmtSpecifies a character string containing a valid SQL SELECT statement. The statement must be valid according to DB2 UDB for z/OS usage rules. For usage rules, see your DB2 UDB for z/OS documentation. You must
Column functions
293
use parameter placeholders to refer to values that are not available until the expression is being executed. To identify parameter placeholders in the SQL SELECT WHERE clause, use question marks (?). In the SQL WHERE clause, you can use any operators that are supported by DB2 UDB for z/OS, such as IN. For information about other operators that you can use, see your DB2 UDB for z/OS documentation. v parm1, parm2, ..., parmnSpecify literals, column functions, expressions, expression variables, or primary table columns. In the WHERE clause, the value specified for parm1 replaces the first question mark, the value specified for parm2 replaces the second question mark in the WHERE clause, and so on. You cannot specify NULL for any parameter placeholder. default_value1, default_value2, ..., v default_valuemSpecify default values that the function returns for each column when the record specified by the WHERE clause does not exist in the secondary table. If you do not specify a default value for a column and the secondary table record does not exist, then this function returns an appropriate value, based on the data type of the column. For example, zero for numeric-based columns, zero-length strings for characterbased columns, and so on. To specify a default value for a column that is not listed first in the SQL SELECT statement, you must specify default values for all preceding columns. Note the following when specifying parameters for this function: The number of parameters cannot exceed 21. You must specify a minimum of two parameters. If you only want to specify the SQL SELECT statement parameter, then you must also specify another parameter for the function. See examples below for situations where you must specify an unused parameter.
294
Examples
The following examples use the relationship between primary and secondary tables:
Assuming the primary and secondary tables shown above, you map the %SELECT function to the EMPCOUNTRY column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table, this example returns their country from the COUNTRY secondary table record. If COUNTRY does not contain a record that satisfies the condition in the WHERE clause, then this function returns the default value for the data type of the COUNTRY column. For example, blank characters if the data type is character.
%SELECT("SELECT Q1, Q2, Q3, Q4 FROM DB1.GSMITH.SALES WHERE EMP = ? AND ? = 4", EMPID, EMPBRANCH, 0, 0, 0, 0)
Assuming the primary and secondary tables shown above, you map the %SELECT function to the EMPQ1 column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table, who works at Branch 4, this example returns their first quarter sales figure from the SALES secondary table record. Since this example returns more than one column value, InfoSphere CDC defines three variables, named Q2, Q3, and Q4, to maintain the second, third, and fourth
Column functions
295
quarter sales figures, respectively. You can retrieve these values using the %VAR function and map them to the EMPQ2, EMPQ3, and EMPQ4 columns in EMPLOYEE. If SALES does not contain a record that satisfies the condition in the WHERE clause, then the function returns 0. In addition, InfoSphere CDC sets the three variables Q2, Q3, and Q4 to 0.
%SELECT("SELECT INCOME, CODE, LASTADJDATE, NEXTADJDATE FROM DB1.GSMITH.SALARY WHERE EMP = ? AND BRANCH = ?", EMPID, EMPBRANCH, 0, "Z", 1970-01-01)
Assuming the primary and secondary tables shown in the previous image, you map the %SELECT function to the EMPINCOME column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table, this example returns their income from the SALARY secondary table record. Since this example returns more than one column value, InfoSphere CDC defines three variables, named CODE, LASTADJDATE, and NEXTADJDATE, to maintain the other items of salary information. You can retrieve these values using the %VAR function and map them to columns that you must add to the primary table. If SALARY does not contain a record that satisfies the condition in the WHERE clause, then: v The %SELECT function returns 0. v The CODE variable is set to Z. v The LASTADJDATE variable is set to 1970-01-01. v The NEXTADJDATE variable is set to 1901-01-01 (the z/OS default date value). In this example, you must specify a default value for LASTADJDATE only.Since this column is listed third in the SQL SELECT statement, you must also specify default values for the INCOME and CODE columns. To eliminate the need to specify a default value for CODE, reference LASTADJDATE before CODE in the SQL SELECT statement, as follows: %SELECT("SELECT INCOME, LASTADJDATE, CODE, NEXTADJDATE FROM DB1.GSMITH.SALARY WHERE EMP = ? AND BRANCH = ?", EMPID, EMPBRANCH, 0, 1970-01-01)
%SELECT("SELECT USED FROM DB1.GSMITH.VACATION WHERE EMP = ? AND EMPCOUNTRY IN (USA, UK, JAPAN, FRANCE)", EMPID, 0)
Assuming the primary and secondary tables shown in the previous image, you map the %SELECT function to the EMPVACUSED column in the EMPLOYEE table. For an employee in the EMPLOYEE primary table located in United States, United Kingdom, Japan, or France, this example returns the amount of vacation used from the VACATION secondary table record. If VACATION does not contain a record that satisfies the condition in the WHERE clause, then the %SELECT function returns 0.
%SELECT("SELECT NEXT VALUE FOR SEQ1 FROM SYSIBM.SYSDUMMY1", 1)
This example returns the next value for sequence SEQ1. In this case, the data type of the result is the same as the data type of the sequence object. This example uses the %SELECT function to retrieve the next value for a sequence in DB2 UDB for z/OS V8 or higher. SYSDUMMY1 is an existing DB2 dummy system table referenced in the SQL SELECT statement to satisfy syntax requirements.
296
You must enter any integer value for the second parameter, in order to call the function. For example, 1. For information about sequences and the types of values that you can generate from sequences, see your DB2 UDB for z/OS documentation.
%SELECT("SELECT PREVIOUS VALUE FOR SEQ2 FROM SYSIBM.SYSDUMMY1", 24)
This example returns the previous value for sequence SEQ2. In this case, the data type of the result is the same as the data type of the sequence object. This example uses the %SELECT function to retrieve the previous value for a sequence in DB2 UDB for z/OS V8 or higher. SYSDUMMY1 is an existing DB2 dummy system table referenced in the SQL SELECT statement to satisfy syntax requirements. You must enter any integer value for the second parameter, in order to call the function. For example, 24. For information about sequences and the types of values that you can generate from sequences, see your DB2 UDB for z/OS documentation.
Stored procedure%STPROC
Use this function to call a stored procedure. You can call a stored procedure from a derived column on the source or create an expression on the target. Note: InfoSphere CDC for z/OS and InfoSphere CDC for DB2 UDB do not support this function. On the z/OS platform, use the %USER function to call a user exit program that issues SQL statements.
Syntax
%STPROC(stored_procedure_name, <parm1>, <parm2>, ..., <parm20>)
Parameters
v stored_procedure_nameSpecifies the name of the stored procedure in the default database. You must enclose values of this parameter in single quotes. If you installed InfoSphere CDC for Microsoft SQL Server, you must specify the name of the stored procedure in the format <databae_name>.<owner_name>.<stored_procedure_name>. The database and owner name are not required if the stored procedure is defined in the default database.
Column functions
297
v parm1, parm2, ..., parm20Specify columns or literals that are passed as parameters to the stored procedure (maximum 20). The type and order of the parameters specified in the %STPROC function invocation must match the type and order of the parameters defined in the stored procedure. If you installed InfoSphere CDC for Sybase, the first parameter defined in the stored procedure specifies the value returned by the function. Do not specify this parameter in the list of parameters for the %STPROC function (parm1, parm2, ..., parm20). You can omit any number of trailing parameters. InfoSphere CDC assumes the default value if a parameter is not specified. For example, for a stored procedure with five parameters, if you specify values for the first two parameters only, InfoSphere CDC assigns default values to the last three parameters.
Examples
The following example returns the customer name that corresponds to a specified customer identification number. Perform the following steps: 1. Define a stored procedure, as presented below, in the default database: v If you installed InfoSphere CDC for Microsoft SQL Server or InfoSphere CDC for Sybase: create procedure CUSTNAME @CUSTNAME varchar(30) OUT, @CUSTID int as select @CUSTNAME=name from customer where custno=@CUSTID v If you installed InfoSphere CDC for Oracle:
create or replace function custname (custid integer) return varchar2 as nameFound varchar2(30); begin select name1 into nameFound from customer where custno = custid; return nameFound; end custname;
This call returns the customer name that corresponds to the customer identification number CUSTOMER_ID. Related tasks To add a derived column on page 163 To map an expression to a target column on page 159 Related reference User exit%USER
User exit%USER
Use this function to call a user exit program from an expression. This function provides flexibility when complex logic that cannot be expressed using the provided column functions is required. You can use this function to call a user exit program with input parameters.
298
For more information about user exit programs, see the appropriate InfoSphere CDC user exits guide. Note: InfoSphere CDC for Microsoft SQL Server does not support this function. If you are using a InfoSphere CDC product other than InfoSphere CDC for z/OS, you cannot use this function to call a stored procedure.
Syntax
%USER(<program_name>, <parm1>, <parm22>, ..., <parmn>
Parameters
v program_nameSpecifies the name of the user exit program. You must enclose values of this parameter in single quotes. You can write the user exit program in any high-level language. You must place an executable object for the user exit program in the InfoSphere CDC installation directory prior to starting refresh or mirroring. v parm1, parm2, ..., parmnSpecify columns or literals that are passed as parameters to the user exit program (maximum 20). In the user exit program that you write, you must declare a data structure that defines specific fields for the result and each input parameter (parm1, parm2, ..., parmn).
Field DATATYPE Length and data type Two-byte binary Description Specifies the data type of the result or input parameter: v 1Character v 2Date v 3Float v 4Integer v 5Packed numeric v 6Time v 7Zoned numeric LENGTH Two-byte integer Specifies the length of the result or input parameter in bytes. Specifies the number of digits in the result or input parameter. Specifies the number of decimal places in the result or input parameter. Specifies whether or not the result or input parameter is NULL: v 0Result or input parameter is not NULL. v 1Result or input parameter is NULL.
DIGITS
Two-byte binary
DECPLC
Two-byte binary
NULLIND
Two-byte binary
Column functions
299
Field DTMFMT
Description Specifies the date format in the result or input parameter: v *USAUnited States date format. v *ISOISO (International Organization for Standardization) date format. v *EUREuropean date format. v *JISJapanese Industrial Standard. v *YMDThe date format is yymmdd. v *MDYThe date format is mmddyy. v *DMYThe date format is ddmmyy.
<VALUE>
Specifies one of the following: v For each input parameter, the field that contains the input parameter value passed to the user exit program. v For the user exit program result, the field that contains the result returned by the user exit program. The name of this field in the user exit program is user-defined. For example, see the COBOL user exit program below.
Examples
%USER(USERSEL1, BRANCH)
This function calls the COBOL program USERSEL1, passing the BRANCH column as a parameter. USERSEL1 checks whether or not BRANCH is set to 11. If it is, then the user exit program returns a one-byte character value of Y. Otherwise, it returns a character value of N. Note: This user exit program is provided for illustration purposes only. IBM recommends that you test this program before invoking it in your environment.
IDENTIFICATION DIVISION. PROGRAM-ID. USERSEL1. AUTHOR. DATAMIRROR CORP.
300
INSTALLATION. DATAMIRROR CORP. DATE-COMPILED. ******************************************************************* * Program : USERSEL1. * ---------------* Version: 1.0 * ---------------* Description: SAMPLE COBOL USER ENTRY POINT PROGRAM * ---------------* ****************************************************************** ENVIRONMENT DIVISION. CONFIGURATION SECTION. SOURCE-COMPUTER. IBM-AS400. OBJECT-COMPUTER. IBM-AS400. ****************************************************************** * D A T A D I V I S I O N ****************************************************************** DATA DIVISION. ****************************************************************** * W O R K I N G S T O R A G E S E C T I O N ****************************************************************** WORKING-STORAGE SECTION. * 01 DATATYPES COMP-4. 03 TYP-CHAR PIC S9(4) VALUE 1. 03 TYP-DATE PIC S9(4) VALUE 2. 03 TYP-FLOAT PIC S9(4) VALUE 3. 03 TYP-INTEGER PIC S9(4) VALUE 4. 03 TYP-PACKED PIC S9(4) VALUE 5. 03 TYP-TIME PIC S9(4) VALUE 6. 03 TYP-ZONED PIC S9(4) VALUE 7. ****************************************************************** * L I N K A G E S E C T I O N ****************************************************************** LINKAGE SECTION. 01 RETURN-VALUE. 03 RV-DATATYPE PIC S9(4) COMP-4. 03 RV-LENGTH PIC S9(4) COMP-4. 03 RV-DIGITS PIC S9(4) COMP-4. 03 RV-DECPLC PIC S9(4) COMP-4. 03 RV-NULLIND PIC S9(4) COMP-4. 03 RV-DTMFMT PIC X(4). 03 RV-SELECT PIC X(1). 01 PARM-1. 03 P1-DATATYPE PIC S9(4) COMP-4. 03 P1-LENGTH PIC S9(4) COMP-4. 03 P1-DIGITS PIC S9(4) COMP-4. 03 P1-DECPLC PIC S9(4) COMP-4. 03 P1-NULLIND PIC S9(4) COMP-4. 03 P1-DTMFMT PIC X(4). 03 P1-BRANCH PIC X(2). ****************************************************************** * P R O C E D U R E D I V I S I O N ****************************************************************** PROCEDURE DIVISION USING RETURN-VALUE PARM-1. ML-0010. * * This example program checks parm 1 for a value of 11 and if found, * returns Y, else returns N. * * Define the Returned Value as a 1-byte character field. * MOVE TYP-CHAR TO RV-DATATYPE. MOVE 1 TO RV-LENGTH. MOVE ZERO TO RV-DIGITS.
Column functions
301
MOVE ZERO TO RV-DECPLC. MOVE ZERO TO RV-NULLIND. MOVE SPACES TO RV-DTMFMT. * * Test for a value of 11 in the first parameter. * IF P1-BRANCH IS EQUAL TO 11 MOVE Y TO RV-SELECT ELSE MOVE N TO RV-SELECT. EXIT PROGRAM.
Related reference Stored procedure%STPROC on page 297 User exit%USER (InfoSphere CDC for Microsoft SQL 5.x) User Exit%USERFUNC on page 303
Syntax
%USER(<database_name>.<owner_name>.<stored_procedure_name>, <parm1>, <parm2>, ..., <parm20>
Parameters
v database_namespecifies the name of the database where the stored procedure resides. v owner_namespecifies the owner of the stored procedure. For example, dbo. v stored_procedure_namespecifies the name of the stored procedure. v parm1, parm2, ..., parm20specify columns or literals that are passed as parameters to the stored procedure (maximum 20). The type and order of the parameters specified in the %USER call must match the type and order of the parameters defined in the stored procedure. The first parameter defined in the stored procedure must be the OUTPUT parameter followed by the input parameters. Do not specify this parameter in the %USER parameter list (parm1, parm2, ..., parm20). The number of parameters specified in the stored procedure must match the number of parameters specified in Management Console. You can omit any number of trailing parameters. InfoSphere CDC assumes the default value if a parameter is not specified. For example, for a stored procedure with five parameters, if you specify values for the first two parameters only, InfoSphere CDC assigns default values to the last three parameters.
302
Examples
%USER("datamirror.dbo.sp_date_diff",COL_DATE) %USER("datamirror.dbo.sp_date_diff","12-jan-2000")
The first call example specifies a source column name as input parameter (COL_DATE), while the second call example specifies a value as input parameter (12-jan-2000). These examples assume that a stored procedure, similar to the following, is defined in the database. The example stored procedure calculates the difference in days between the current date and a date specified as parameter:
CREATE PROCEDURE dbo.sp_date_diff @out_int int output, @in_date datetime AS select @out_int = DATEDIFF(day, @in_date, getdate()) GO %USER("datamirror.dbo.sp_join",col_item_number) %USER("datamirror.dbo.sp_join",12)
The first call example specifies a source column name as input parameter (col_item_number), while the second call example specifies a value as input parameter (12). These examples assume that a stored procedure, similar to the following, is defined in the database. The example stored procedure performs a join to a description table to get the description of an item given its item number:
CREATE PROCEDURE dbo.sp_join @out_item_description varchar(10) output @in_item_number int AS SELECT @out_item_description = inventory_db.dbo.description.item_desc FROM inventory_db.dbo.item_list INNER JOIN inventory_db.dbo.description ON inventory_db.dbo.item_list.item_number = inventory_db.dbo.description.item_number WHERE (inventory_db.dbo.description.item_number = @in_item_number) GO
Related reference Stored procedure%STPROC on page 297 User exit%USER on page 298 User Exit%USERFUNC
User Exit%USERFUNC
Use this function to call a Java class user exit program or a stored procedure from an expression. This function provides flexibility when complex logic that cannot be expressed using the provided column functions is required. You can use this function to call a user exit program with input parameters. This function also supports MBCS data. For more information about user exit programs, see your InfoSphere CDC user exits documentation.
Syntax
%USERFUNC(function_type, program_name, [<parm1>, <parm2>, ..., <parmn>]
Parameters
v function_typeIndicate the type of user exit. Specify JAVA to call a Java class user exit program or STOREDPROC to call a stored procedure user exit program. You must enclose these values in double quotes to indicate they are strings, not column names.
Column functions
303
The Java class should be placed in your lib directory. If your Java class has a package name then you must create the appropriate directories under the lib directory. The stored procedure must exist in your database and you must specify the database owner or schema. v program_nameThe name of your Java class or stored procedure. Stored procedures must exist in your database you must specify the database owner or schema as well as the name of the stored procedure. v parm1, parm2, ..., parmnSpecify columns or literals that are passed as parameters to the Java class user exit or stored procedure user exit.
Examples
%USERFUNC("JAVA", "USERSEL1", BRANCH)
This function calls the Java user exit program of USERSEL1 and passes the BRANCH column as a parameter. USERSEL1 checks whether or not BRANCH is set to 11. If it is, then the user exit program returns a one-byte character value of Y. Otherwise, it returns a character value of N.
%USERFUNC("STOREDPROC","dbo.sp_date_diff",COL_DATE) %USERFUNC("STOREDPROC","dbo.sp_date_diff","12-jan-2000")
The first call example specifies a source column name as input parameter (COL_DATE), while the second call example specifies a value as input parameter (12-jan-2000). These examples assume that a stored procedure, similar to the following, is defined in the database. The example stored procedure calculates the difference in days between the current date and a date specified as parameter. The stored procedure must exist in your database and you must specify the stored procedure name and database owner or schema:
CREATE PROCEDURE dbo.sp_date_diff @out_int int output, @in_date datetime AS select @out_int = DATEDIFF(day, @in_date, getdate()) GO %USERFUNC("STOREDPROC","dbo.sp_join",col_item_number) %USERFUNC("STOREDPROC","dbo.sp_join",12)
The first call example specifies a source column name as input parameter (col_item_number), while the second call example specifies a value as input parameter (12). These examples assume that a stored procedure, similar to the following, is defined in the database. The example stored procedure performs a join to a description table to get the description of an item given its item number. The stored procedure must exist in your database and you must specify the stored procedure name and database owner or schema.
CREATE PROCEDURE dbo.sp_join @out_item_description varchar(10) output @in_item_number int AS SELECT @out_item_description = inventory_db.dbo.description.item_desc FROM inventory_db.dbo.item_list INNER JOIN inventory_db.dbo.description ON
304
Related concepts Setting multibyte and Unicode character set conversions on page 175 Related reference Stored procedure%STPROC on page 297 User exit%USER on page 298 User exit%USER (InfoSphere CDC for Microsoft SQL 5.x) on page 302
Retrieving a column from another table using the %GETCOL function (DB2 UDB for iSeries)
This example uses the relationship between a primary (EMPLOYEE) and secondary (BRANCE, STATE, and COUNTRY) tables.
In this example, you will retrieve the column NAME from the STATE table using the STATE column from the EMPLOYEE table. To use this example, perform the following steps: 1. Add a derived column, STNAME, based on the NAME column, to the STATE table. 2. Enter the following expression for the STNAME derived column: %GETCOL(NAME, PRODLIB/STATE, , , 1, STATE)
Column functions
305
Performing an outer join using the %GETCOL function (DB2 UDB for iSeries)
This example uses the relationship between primary and secondary tables. In this example, you will retrieve the column NAME from the COUNTRY table using the COUNTRY column from the STATE table. The COUNTRY column, used to read the COUNTRY table, is not from the primary table. To use this example, perform the following steps: 1. Add a derived column, CTNAME, based on the NAME column, to the COUNTRY table. 2. Enter the following expression for the CTNAME column: %GETCOL(NAME, PRODLIB/COUNTRY, , , 1, %GETCOL(COUNTRY, PRODLIB/STATE)) The second %GETCOL function retrieves the COUNTRY column from the STATE table. This column was retrieved in a previous %GETCOL invocation. In the first %GETCOL function, the default_value and record_format parameters are not specified, as they are specified in the long version of the %GETCOL function that performed the read.
Nesting columns to join data using the %GETCOL function (DB2 UDB for iSeries)
This example uses the relationship between primary and secondary tables. In this example, you will consolidate data from secondary tables without replicating the secondary tables. To use this example, perform the following steps: 1. Add a derived column, CTNAME, based on the NAME column, to the COUNTRY table. 2. Enter the following expression for the CTNAME column: %GETCOL(NAME, PRODLIB/COUNTRY, , , 1, %GETCOL(COUNTRY, PRODLIB/STATE, , , 1, STATE)) This function retrieves the NAME column from the COUNTRY table using the STATE column from the EMPLOYEE table and the COUNTRY column from the STATE table.
Combining columns using the %GETCOL function (DB2 UDB for iSeries)
This example uses the relationship between primary and secondary tables. In this example, you will combine the STATE and COUNTRY columns from the STATE table using the %CONCAT function. To use this example, perform the following steps: 1. Add a derived column, REGION, based on the STATE and COUNTRY columns in the STATE table. 2. Enter the following expression for the REGION column: %CONCAT(%GETCOL(STATE, PRODLIB/STATE, FAILED, , 1, STATE), -, %GETCOL(COUNTRY, PRODLIB/STATE, FAILED)) The second %GETCOL function retrieves the COUNTRY column from the STATE table. This column was retrieved in a previous %GETCOL function invocation. Related reference
306
Filtering rows using the %GETCOL function (Dynamic SQL) on page 309
To use the example, you must add a derived column to the MASTER.DBO.EMPLOYEE primary table and enter the specified %GETCOL function in that column. %GETCOL(NAMEB, MASTER.DBO.BRANCH, <NO NAME>, BRANCHB, BRANCH) This example retrieves the NAMEB column from the MASTER.DBO.BRANCH secondary table, using the value in the BRANCH column in the primary table and the key column BRANCHB in the secondary table. If a record in the primary table has a branch number that does not exist in the MASTER.DBO.BRANCH table, then this function returns for that record in the retrieved column.
Column functions
307
Retrieving a column using the %GETCOL function without reading the same row from the table
This example refers to the primary and secondary tables. The table names referenced in the examples follow the format for InfoSphere CDC for Microsoft SQL Server and InfoSphere CDC for Sybase. If you installed another InfoSphere CDC product, see the table_name parameter for information about specifying table names for this function, depending on your database. To use the example, you must add a derived column to the MASTER.DBO.EMPLOYEE primary table and enter the specified %GETCOL function in that column. %GETCOL(NAMES, MASTER.DBO.STATE, , STATES, STATE) This function call retrieves the NAMES column from the MASTER.DBO.STATE secondary table, using the key column STATE in the primary table and the key column STATES in the secondary table. If a record in the primary table has a state that does not exist in MASTER.DBO.STATE, then this function returns the default value for the data type of the NAMES column. For example, blank characters if the data type is character. %GETCOL(COUNTRYS, MASTER.DBO.STATE, ) Used after the previous %GETCOL function, this function call retrieves the COUNTRYS column from the MASTER.DBO.STATE secondary table, without reading again the same row from the table. If a record in the primary table has a state that does not exist in MASTER.DBO.STATE, then this function returns the default value for the data type of the COUNTRYS column. For example, blank characters if the data type is character.
308
Used after the previous %GETCOL function, the second %GETCOL function in this example is called first to retrieve the COUNTRYS column from the MASTER.DBO.STATE table. Then, the first %GETCOL function is called to retrieve the NAMEC column from the MASTER.DBO.COUNTRY table using the key column COUNTRYS in MASTER.DBO.STATE and the key column COUNTRYC in MASTER.DBO.COUNTRY. In this example you do not retrieve the NAMEC column in the MASTER.DBO.COUNTRY table directly, using the COUNTRYC key column, because the primary table does not contain a key column to retrieve NAMEC. Instead, you retrieve the NAMEC column indirectly using the COUNTRYS key column in MASTER.DBO.STATE and the COUNTRYC key column in MASTER.DBO.COUNTRY.
Publishing multiple derived columns using the %GETCOL function (Dynamic SQL)
This example refers to the primary and secondary table relationship. The table names referenced in the examples follow the format for InfoSphere CDC for Microsoft SQL Server and InfoSphere CDC for Sybase. If you installed another InfoSphere CDC product, see the table_name parameter for information about specifying table names for this function, depending on your database.
Column functions
309
This example combines the CUSTID and CUSTADDR tables into a single CUSTOMER table with all five columns. By calling the %GETCOL function twice, you retrieve values of two columns from the same row in the secondary table. The first call reads the entire row into memory and the second call retrieves data from the same row in memory, without reading the same table twice.
To use this example, perform the following steps: 1. Add a derived column, ADDR1, to the CUSTID source table and enter the following expression for the column: %GETCOL(ADDRESS1, MASTER.DBO.CUSTADDR, Not Found, CUSTNO, CUSTNO) 2. Add a derived column, ADDR2, to the CUSTID source table and enter the following expression for the column: %GETCOL(ADDRESS2, MASTER.DBO.CUSTADDR, Not Found) The expression for ADDR1 queries the CUSTADDR table and returns the value in the ADDRESS1 column where the two CUSTNO values match. The expression for ADDR2 uses the results returned by the previous %GETCOL function invocation without reading the CUSTADDR table. Instead, it uses matching rows from the ADDR2 definition to know when to return the value from the ADDRESS2 column. If either %GETCOL function cannot find a matching row, then it returns a value of Not Found.
310
Column functions
311
312
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Notes: v If you make changes to a system parameter during active replication, you must stop and restart replication for the changes to take effect. v When upgrading to a higher version of InfoSphere CDC, any pre-existing settings for system parameters are maintained. In this section, you will learn: General product system parameters Replication system parameters on page 317 Database translation log system parameters on page 319 Commitment control system parameters on page 323 Event log system parameters on page 325 Multibyte character set system parameters on page 325 Latency system parameters on page 326 Notification system parameters on page 329 Tracing system parameters on page 332 Data type system parameters on page 335 Lock detection system parameters on page 335
313
AuthCode
Use this system parameter to adjust the authorization code issued by IBM. You may need to modify your authorization code when: v Moving from a temporary license to a permanent license v Machine classes have changed v Upgrading to a new version of InfoSphere CDC Applies ToSource and Target Note: You can also modify the authorization using the Authorization Code Setup utility Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
DBMS
For information about setting this system parameter, see your IBM representative. Applies ToTarget
dbUser
For information about setting this system parameter, see your IBM representative. Applies ToSource and Target
dllname
For information about setting this system parameter, see your IBM representative. Applies ToTarget
DSN
Use this system parameter to identify ODBC data source name used by InfoSphere CDC to define the metadata database on either the source or target system. Applies ToSource and Target Note: This parameter was specified during InfoSphere CDC installation. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
314
NetServiceName
For information about setting this system parameter, see your IBM representative. Applies ToTarget
pwdencrypt
Use this system parameter to encrypt or decrypt user identifiers and passwords stored in InfoSphere CDC metadata tables. Applies ToSource The pwdencrypt system parameters is set to either 0 or 1: v 0Do not encrypt user identifiers and passwords in metadata tables. v 1Encrypt user identifiers and passwords in metadata tables. Default Setting1 Guidelines Encryption or decryption does not affect existing user identifiers and passwords in InfoSphere CDC metadata tables. Any changes you make to this system parameter apply only to user identifiers and passwords added after setting the system parameter. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference Deadband Percentage on page 326
Startup Timeout
For information about setting this system parameter, see your IBM representative. Applies ToSource and Target Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435
TSSrcCP
Use this system parameter to identify the code page InfoSphere CDC uses for each instance of a target database. Applies ToTarget Default SettingThe system code page when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)
315
TSTgtCP
Use this system parameter to identify the source system code page of InfoSphere CDC. Applies ToSource Default SettingThe system code page when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
TCP_KEEPALIVE_SECS
Use this system parameter to determine the time (in seconds) InfoSphere CDC waits before sending a keep alive notification over the network. During idle periods, InfoSphere CDC sends a keep alive notification to keep the connection open. Applies ToSource and Target Default Setting300 seconds (5 min) Minimum Setting0 Guidelines v To prevent the firewall from closing during active data replication, set this parameter to a value lower than the configured firewall timeout. v To set TCP_KEEPALIVE_SECS: 1. Create a registry key called HKEY_LOCAL_MACHINE\SOFTWARE\ DataMirror\InfoSphere CDC\Comms 2. Create a string value called TCP_KEEPALIVE_SECS under the registry key created above. 3. Set TCP_KEEPALIVE_SECS to the value that you want. Note: It is important you set this system parameter when you have a firewall connection that has been configured to timeout. This prevents the firewall from closing the connection. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
WindowsAuthentication
For information about setting this parameter, see your IBM representative. Applies ToSource and Target
316
AutoRestart
Use this system parameter to enable or disable InfoSphere CDC to automatically restart replication after detecting a failover in a clustered environment. Applies ToSource The AutoRestart system parameters is set to either 0 or 1: v 0Disables automatic restart of replication operations. v 1Enables automatic restart of replication operations. Default Setting0 Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference convertNotNullableColumns
convertNotNullableColumns
Use this system parameter to indicate whether or not NULL values will be converted to default values when replicating data that contains NULL values to non-nullable target columns. Applies ToTarget Set this parameter to one of the following: v OFFAn error message will be generated in Event Log. Replication will continue or not based on whether the MirrorError or RefreshError system parameters are set to END or ON. v ONInfoSphere CDC will automatically insert an appropriate default value in the target column. No error message is generated in Event Log and replication continues. Depending on the convertNotNullableMsg system parameter setting, a warning message may be generated in Event Log.
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)
317
The default value depends on the data type of the subscription column. For example, zero for numeric data types, blank character for character data types, 1901-01-01 for date data types, and so on. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference MirrorError RefreshError convertNotNullableMsg on page 329 D_MIRROR_MIRROR_ERROR_STOP on page 405 D_MIRROR_REFRESH_ERROR_STOP on page 359
MirrorError
Use this system parameter to start or stop InfoSphere CDC from continuing mirroring when it encounters one or more errors. Applies ToTarget The MirrorEnd system parameter can be set to either END or GO: v ENDStops mirroring after InfoSphere CDC encounters an error. v GOContinues mirroring after InfoSphere CDC encounters an error. Default SettingEND Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
RefreshError
Use this system parameter to start or stop InfoSphere CDC from continuing mirroring when it encounters one or more errors. Applies ToTarget The RefreshError system parameter can be set to either END or GO: v ENDInfoSphere CDC ends a refresh operation after it encounters one or more errors. v GOInfoSphere CDC continues a refresh operation after it encountering one or more errors. Default SettingEND Related concepts
318
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
RefreshMode
Applies To
Target Use this system parameter to set how InfoSphere CDC applies rows to the target during a refresh operation. InfoSphere CDC can use BCP (bulk copy refresh) in which a block of rows are sent as a single unit during a refresh operation. This method is faster than the standard method of refreshing tables used by InfoSphere CDC.s The RefreshMode system parameter can be set to either BCP or SQL: BCP SQL Perform a bulk copy refresh. Perform a standard refresh.
Default Setting
BCP Note: Use the RefreshBlock system parameter to set the number of records in a block. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference RefreshBlock on page 324
Cleanup Interval
Use this system parameter to set the time (in seconds) for InfoSphere CDC to clean up the distribution database on the source system.
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)
319
Applies ToSource Default Setting120 seconds Minimum Settings1 second Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
320
Default Setting8000 log entries Minimum Settings100 log entries Maximum Settings100000 log entries Guidelines v You may want to reduce the number of operations applied to the distribution database and set this parameter to a higher number so that InfoSphere CDC can delete a greater number of log entries. Although this improves the performance of the cleanup cycle, a higher number of log entries can increase the amount of time it takes for InfoSphere CDC to complete the cleanup cycle. This can also conflict with other processes that use the distribution database (for example, the Microsoft log reader process and the InfoSphere CDC log scraper process). To avoid conflicts with other processes that access the distribution database, set this parameter to a smaller number of log entries that InfoSphere CDC can delete during a clean up cycle. v To ensure a short cleanup cycle, set this parameter to the approximate number of log entries that InfoSphere CDC can delete in your environment in 1 second. Notes: v If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. v If you modify the value after setting the system parameter, InfoSphere CDC uses the modified value after completing the next cleanup cycle. v The time between consecutive cleanup cycles is determined by the Cleanup Interval system parameter. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference Cleanup Log Events on page 320
LogCleanupMethod
Use this system parameter to enable or disable InfoSphere CDC from using IBM stored procedures to clean up transactions in the distribution database. Applies ToSource The LogCleanupMethod system parameter is set to either 0 or 1: v 0Use Microsoft stored procedures. v 1Use IBM stored procedures. Default Setting0 Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)
321
Synchronization Interval
Use this system parameter to set how often (in seconds) InfoSphere CDC performs log synchronization between the source and the target. Synchronization is achieved when the source reports to the target the position of the last committed change. Applies ToSource Default Setting60 seconds Minimum Settings1 second Maximum Settings3000 seconds (50 minutes) Guidelines If you are replicating large volumes of data, set this system parameter to a lower number of seconds to remove obsolete logs more frequently.
322
Note: If a value outside the acceptable range is specified, the default setting is used. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435
CommitmentControl
Use this system parameter to enable or disable InfoSphere CDC from using commitment control. Enabling commitment control maintains transaction consistency during replication and ensures that all transactions are applied to the target system. If there is a communications or server failure and you have enabled this system parameter, then InfoSphere CDC rolls back the partially applied transaction to the last commit. Applies ToSource The CommitmentControl system parameter is set to either 0 or 2: v 0Disables commitment control for transaction processing. InfoSphere CDC does not maintain transaction consistency during replication. v 2Enables InfoSphere CDC to use commitment control against the target system after applying all rows. This setting provides true transaction consistency by ensuring that entire transactions are committed to the target database even in the event of a communications or server failure Default Setting0 Note: You can set the maximum number of rows that InfoSphere CDC can contain a committed transaction using the RefreshBlock system parameter. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference RefreshBlock on page 324
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)
323
RefreshBlock
Use this system parameter to set the number of rows InfoSphere CDC can contain in a refresh block or a commit group. Depending on how you are refreshing data to the target, InfoSphere CDC can contain rows for bulk copy refresh or a commit group operations. Applies ToTarget Default Setting10000 records Guidelines v If the table you are replicating is relatively large, IBM recommends increasing the number of records (refresh block or commit group) to improve performance. v If you are encounter errors during replication, reduce the number of records. Although performance is affected, lowering the number of records may eliminate these errors during replication. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference CommitmentControl on page 323 SeparateCommits on page 325
324
SeparateCommits
Use this system parameter to control how InfoSphere CDC commits bookmarks. InfoSphere CDC can commit bookmarks together or separate from the user data. For more information about bookmarks and how to retrieve bookmark values on the target, see Transformation Server for Microsoft SQL Server Commands Reference. Applies ToTarget The SeparateCommits system parameter can set to On or Off: v OnInfoSphere CDC commits the bookmark separate from user data. v OffInfoSphere CDC commits the bookmark together with the user data. Default SettingOff Guidelines IBM recommends that you set this parameter to On only for performance reasons. If you set this parameter to On and InfoSphere CDC encounters an error during the apply process and ends the apply process abnormally, then this may result in the bookmark not being synchronized with the target system. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
AllowEventLogClear
For information about setting this system parameter, see your IBM representative. Applies ToSource
Unicode Handling
Use this system parameter to indicate the default method of treating data in defined Unicode columns. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)
325
columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Applies ToSource Data types Use this system parameter: v nchar v nvarchar This system parameter is set to either CHAR or NOCHANGE: v CHARInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v NOCHANGEInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain non-single-byte character data. NOCHANGE ensures InfoSphere CDC will handle non-single-byte character data in the same way as previous InfoSphere CDC releases. Default SettingNOCHANGE Note: NOCHANGE does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may need to apply user exit programs or other customization to properly represent the data in Unicode columns. For more information about user exit programs, see the InfoSphere CDC for Microsoft SQL Server User Exits Guide. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related tasks To set handling for Unicode character encodings on page 177
Deadband Percentage
Applies ToTarget Identifies the size of the range around each latency threshold setting. Based on latency thresholds defined, a latency message is generated when latency has risen above or fallen below a threshold. Latency is calculated at regular intervals, where
326
the interval is the current setting for the MONITOR_SAMPLE_INTERVAL system parameter. You can set notifications in response to a generated latency message. This system parameter, which is expressed as a percentage, allows you to pad a threshold equally on both sides to create a range around the threshold. By adjusting this system parameter, the size of the range around the threshold can be increased or decreased, and the threshold itself can be made thicker or thinner. A latency message is generated only when latency has risen above the upper limit of the range or fallen below the lower limit of the range. By changing the value assigned to this system parameter, you can control the number of latency messages placed in Event Log. For example, assume that a latency threshold is 5 minutes and this system parameter is set to 10. A 10% range is applied around the 5 minute threshold. The following calculations are performed to determine the lower and upper limits (in minutes) of the range around the threshold: v Padding = 10% of 5 minutes = 0.5 minutes (rounded up to 1 minute) v Padding is rounded up or down to the nearest whole minute: Upper limit of range = 5 minutes + 1 minute (padding) = 6 minutes Lower limit of range = 5 minutes - 1 minute (padding) = 4 minutes As a result, a latency message will be generated only when latency rises above 6 minutes or falls below 4 minutes. Given sample latency over a ten minute period where latency is calculated every minute, three latency messages are generated. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 10%:
If this DEADBAND_PERCENTAGE is set to 3 (the default setting) for the same example, no padding is applied to the latency threshold. Therefore, a latency message is generated each time latency crosses over the latency threshold of 5 minutes. Based on the same sample latency in the previous graph where latency is calculated every minute, five latency messages are generated when this system parameter is set to 3. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 3%:
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)
327
If the number of latency messages generated over the ten minute period for the 10% (3 latency messages) and 3% (5 latency messages) settings are averages, an additional 288 latency messages would be generated each day if this system parameter is not changed from its default setting to 10%. Since there are two latency thresholds that you can set (a warning threshold and a problem threshold), two separate ranges are defined when padding is at least one minute. In this case, each range is attached to its threshold, and the two ranges can overlap with no change in behavior. If a value outside the acceptable range is specified, the default setting is used. Default Setting3% Minimum Setting3% Maximum Setting10% Note: If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting latency thresholds and notifications on page 78 Setting system parameters on source and target datastores on page 60 Related reference pwdencrypt on page 315
328
convertNotNullableMsg
Use this system parameter to indicate whether or not a warning message will be generated in Event Log each time data that contains NULL values is converted to default values for non-nullable target columns. Applies ToTarget This system parameter applies only when convertNotNullableColumns=ON. Otherwise, this parameter has no effect. Set this parameter to one of the following: v OFFNo warning message is generated in Event Log.
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)
329
v ONA warning message is generated in Event Log each time a NULL value is converted to a default value. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference convertNotNullableColumns on page 317 DM_STATUS_INTERVAL Heartbeat Timeout on page 331 InvalidNumericMsg on page 331
DM_STATUS_INTERVAL
Use this system parameter to set how often (in seconds) InfoSphere CDC issues progress notifications about the status of replication activities. On the source, progress notifications identify: v The bookmark sent by the source v The corresponding log name v The subscription name to which the bookmark was sent On the target, progress notifications identify: v The bookmark received by the target v The corresponding log name v The source ID from which the bookmark was received Applies ToSource and Target Default Setting0 seconds. No progress notifications will be issued. Minimum Setting0 seconds. No progress notifications will be issued. Maximum Setting7200 seconds Notes: v InfoSphere CDC places progress notifications in the Event Log. v If a value outside the acceptable range is specified, the default setting is used. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
330
Heartbeat Timeout
Use this system parameter to increase or decrease the communication timeout interval (in minutes) before InfoSphere CDC detects a communication problem and attempts to stop active replication processes. InfoSphere CDC sends internal heartbeat notifications between the source and target systems to verify communications and the status of replication processes for each active subscription. If the source or target do not receive a reply to a notification within the specified timeout interval, then InfoSphere CDC determines that a problem has occurred and attempts to stop all its source and target processes for each active subscription. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Notes: v InfoSphere CDC places notifications (message identifiers 3165 and 11010) in the Event Log when a heartbeat timeout occurs. v If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Displaying event messages during replication on page 232 Setting system parameters on source and target datastores on page 60
InvalidNumericMsg
Use this system parameter to enable or disable InfoSphere CDC from generating a notification each time it detects an invalid numeric field. Applies ToTarget The InvalidNumericMsg system parameter can be set to YES, NO, or NB. v YESGenerate a notification for each invalid numeric field detected by InfoSphere CDC. v NODo not generate a notification for each invalid numeric field detected by InfoSphere CDC. v NBGenerate a notification for certain types of invalid numeric fields detected by InfoSphere CDC. notifications are generated for each invalid numeric fields except those that are not initialized. Default SettingYES Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)
331
CommTrace
Use this system parameter to turn tracing of the communications module on or off. Applies ToTarget The CommTrace system parameter can be set to either ON or OFF: v ONActivates a communications module trace. v OFFDo not activate a communications module trace. Default SettingOFF Notes: v The trace should only be produced if requested by IBM technical support. v Activating a trace adversely affects performance. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
ProgramTrace
Use this system parameter to activate or deactivate InfoSphere CDC from tracing the update module. Applies ToTarget The ProgramTrace system parameter can be set to either ON or OFF: v ONActivate an update module trace.
332
v OFFDo not activate an update module trace. Default SettingOFF Notes: v The trace is encrypted and should only be produced if requested by IBM technical support. v Activating a trace adversely affects performance. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
traceActive
For information about setting this system parameter, see your IBM representative. Applies ToSource
TraceLevel
Use this system parameter to set the level of detail produced by a program trace. Applies ToTarget The TraceLevel system parameter can be set to either 1, 2, or 3: v 1Produces a trace with the highest level of detail. v 2Produces a trace with a medium level of detail. v 3Produces a trace with the lowest level of detail. Default Setting3 Note: Contact IBM technical support for the suggested level of detail. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
trcCleanup
For information about setting this system parameter, see your IBM representative. Applies ToSource
trcCOMM
For information about setting this system parameter, see your IBM representative. Applies ToSource
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)
333
trcFiles
Use this system parameter to identify the location of the file that contains information produced by an update or communications module trace. Applies ToSource and Target Default SettingInfoSphere CDC installation folder. Guidelines You must specify the full path of the folder where you want to place the trace file. Note: You can enable tracing using the ProgramTrace and CommTrace system parameters. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference CommTrace on page 332 ProgramTrace on page 332
trcFncCalls
For information about setting this system parameter, see your IBM representative. Applies ToSource
trcJrlSync
For information about setting this system parameter, see your IBM representative. Applies ToSource
trcReplStatus
For information about setting this system parameter, see your IBM representative. Applies ToSource
trcScan
For information about setting this system parameter, see your IBM representative. Applies ToSource
trcSQL
For information about setting this system parameter, see your IBM representative. Applies ToSource
334
trcThread
For information about setting this system parameter, see your IBM representative. Applies ToSource
TrimVarchar
For information about setting this system parameter, see your IBM representative. Applies ToTarget
DeadlockRetrys
Use this system parameter to identify the number of attempts InfoSphere CDC applies a table or row-level operation (clear table, insert, update, or delete) to the target table after detecting a deadlock. If the operation cannot be applied after the specified number of attempts has been made, InfoSphere CDC cancels the operation and generates an error notification in Event Log. Applies ToTarget Default Setting3 attempts Related concepts Displaying event messages during replication on page 232 System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
DM_LOCK_DETECTION
Use this system parameter to turn lock detection on or off. If InfoSphere CDC attempts to modify a table or row that has been locked by another process, then
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below)
335
turning lock detection ON enables InfoSphere CDC to wait for a specific amount of time before attempting to apply the data again. Applies ToSource and Target The DM_LOCK_DETECTION system can be set to either ON or OFF: v ONEnables table and row lock detection. v OFFDisables table and row lock detection. InfoSphere CDC waits until the locked row becomes available. Default SettingON Note: You can specify the time to wait using the DM_LOCK_TIMEOUT system parameter. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 Related reference DM_LOCK_TIMEOUT
DM_LOCK_TIMEOUT
Use this system parameter to set the amount of time (in seconds) that InfoSphere CDC waits before attempting to modify a locked user or metadata table. When InfoSphere CDC attempts to modify a locked table, it places a notification in the Event Log. These notifications identify the specific table and row that InfoSphere CDC could not modify. Applies ToTarget Default Setting30 seconds Minimum Setting1 second Maximum Setting60 seconds Notes: v If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. v Table locking notification is supported for tables containing user data and replication metadata tables. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60
336
System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Notes: v If you make changes to a system parameter during active replication, you must stop and restart InfoSphere CDC for the changes to take effect. v When upgrading to a higher version of InfoSphere CDC, any pre-existing settings for system parameters are maintained. In this section, you will learn: Notification system parameters Maximize throughput system parameters on page 338 Encoding system parameters on page 341 Supplemental logging system parameters on page 342 Disk resource system parameters on page 343 Apply process system parameters on page 344 Authentication system parameters on page 345
global_shutdown_after_no_heartbeat_response_minutes
Use this system parameter to specify the duration, in minutes, of communication inactivity before active InfoSphere CDC processes for a subscription are stopped. If a value outside the acceptable range is specified, the default setting is used. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes
337
Maximum Setting999 minutes Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60
global_conversion_not_possible_warning
Use this system parameter to control whether or not InfoSphere CDC generates a warning in the Management Console Event Log in the following situations: v Data conversion is not possible for a specific data value. v Converted data types are encountered that are out of range. Set this parameter to one of the following: truegenerates a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. falsedoes not generate a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. Applies ToTarget Default SettingFalse Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60
338
mirror_commit_after_max_transactions
This system parameter specifies a threshold used to determine when to issue a commit to the target database. Commits are issued to the target database in response to commits issued by applications running on the source, but not all source commits will be issued on the target. The frequency at which source commits are issued to the target database will vary depending on the volume of changes. When data volume is higher, less frequent commits on the target will allow for the higher data throughput required to maintain low latency. This system parameter is used to place a limit on how infrequent these target commits can become. If the source commit being processed has reached this threshold of source commits received since the last target commit was issued, then there will be a target commit issued for this source commit. Applies ToTarget Default Setting10 Minimum Setting1 Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60
mirror_commit_after_max_seconds
This system parameter specifies a threshold used to determine when to issue a commit to the target database. Commits are issued to the target database in response to commits issued by applications running on the source, but not all source commits will be issued on the target. The frequency at which source commits are issued to the target database will vary depending on the volume of changes. When data volume is higher, less frequent commits on the target will allow for the higher data throughput required to maintain low latency. This system parameter is used to place a limit on how infrequent these target commits can become. If the specified amount of time, in seconds, has elapsed since the last target commit it issued, then it will issue a target commit either immediately (if it isnt currently in the middle of a source transaction) or as soon as it receives the next source commit. Applies ToTarget Default Setting1 second Minimum Setting1 Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60
mirror_commit_after_max_operations
This system parameter specifies a threshold used to determine when to issue a commit to the target database. Commits are issued to the target database in
System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above)
339
response to commits issued by applications running on the source, but not all source commits will be issued on the target. The frequency at which source commits are issued to the target database will vary depending on the volume of changes. When data volume is higher, less frequent commits on the target will allow for the higher data throughput required to maintain low latency. This system parameter is used to place a limit on how infrequent these target commits can become. If the target has applied this number of operations since the last target commit was issued, then it will issue a target commit at the next source commit it receives from the source. Applies ToTarget Default Setting1000 Minimum Setting1 Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60
mirror_commit_on_transaction_boundary
This system parameter indicates whether or not the commits that InfoSphere CDC does on the target database will always correspond with a commit that occurred on the source database. If you choose to ignore the commitment control of the source database, InfoSphere CDC allows you to see the partial results of large transactions. Set this parameter to one of the following: v trueDoes not ignore the commitment control of the source database. Only records in a committed transaction are mirrored to the target. This setting provides true transaction consistency by ensuring that only committed transactions are sent to the target. v falseIgnores the commitment control of the source database. This value disables commitment control for transaction processing. No attempt to maintain transaction consistency is performed during mirroring. Applies ToTarget Default Settingtrue Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60
refresh_commit_after_max_operations
This system parameter identifies the number of rows comprising each transaction during refresh. To reduce the workload on the target database during refresh, InfoSphere CDC periodically commits the changes to the target database rather than performing the refresh as a single large transaction. Applies ToTarget
340
Default Setting1000 Minimum Setting1 Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60
global_unicode_as_char
This system parameter indicates the default method of treating data in defined Unicode columns. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Set this parameter to one of the following: v trueInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v falseInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain non-single-byte character data. Setting this system parameter to false ensures that InfoSphere CDC handles non-single-byte character data in the same way as previous InfoSphere CDC releases. Note: Setting this parameter to false does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may have to apply user exit programs or other customization to properly represent data in Unicode columns. For more information about user exit programs, see the InfoSphere CDC End-User Documentation for your platform. Applies ToSource Default Settingfalse Note: The following SQL Server data types are considered to be Unicode columns and are therefore affected by the value assigned to this system parameter: v nchar v nvarchar Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337
System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above)
341
Setting system parameters on source and target datastores on page 60 Setting multibyte conversionscommon scenarios on page 175 System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
mirror_logging_by_empty_triggers
This system parameter allows you to choose empty triggers as your supplemental logging method for Microsoft SQL Server 2000. Set this parameter to one of the following: v trueEmpty triggers are used as your supplemental logging method for Microsoft SQL Server 2000. v falseThe Distribution Database is used as your supplemental logging method. This method of supplemental logging is available for Microsoft SQL Server 2000 and Microsoft SQL Server 2005. If you choose false and are using Microsoft SQL Server 2000, you must add your database to replication/publication with the following steps: 1. Set up Microsoft Replication and verify that the Distribution database exists. 2. Add the database to Microsoft Replication using the following query: EXEC sp_replicationdboption @dbname = your_db_name, @optname = publish, @value = true Where your_db_name is your database name. Note that you can use the following query to check if your database is enabled for Microsoft Replication: exec sp_helpreplicationdboption Applies ToSource Default Settingtrue Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60
342
mirror_memory_txqueue_total_mb
This system parameter controls the amount of memory used to stage data on the source. For optimal performance, this system parameter should be large enough to hold the largest amount of uncommited data that will ever exist in the source database. Applies ToSource Default Setting15 Megabytes Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60
mirror_memory_txqueue_each_mb
This system parameter controls the amount of memory used to stage data on the source. For optimal performance, this system parameter should be large enough to hold the data for the largest transactions that occur on the source. Applies ToSource Default Setting3 Megabytes Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60
global_memory_lob_cache_mb
This system parameter controls the amount of memory that will be used to stage LOB values on the target. For optimal performance, this value should be large enough to hold the entire data for the largest LOB values that will be replicated. Default Setting2 Megabytes Applies ToTarget Related concepts
System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above)
343
System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60
mirror_queue_for_buffers_between_cdc_threads_operations
This system parameter controls the ability of InfoSphere CDCs log scraping to take advantage of multiple processors. The default setting is acceptable for most situations. You can increase this value for highly scalable environments. Applies ToSource Default Setting100 entries Minimum Setting100 entries Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60
mirror_end_on_error
Use this system parameter to indicate if you want to end mirroring after an apply error occurs on the target database. Set this parameter to one of the following: v trueEnd mirroring after an apply error on the target database. v falseDo not end mirroring after an apply error on the target database. Applies ToTarget Default Settingtrue Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60
refresh_end_on_error
Use this system parameter to indicate if you want to end a refresh after an apply error occurs. Set this parameter to one of the following:
344
v v
trueEnd a refresh after an apply error occurs. falseDo not end a refresh after an apply error occurs.
Applies ToTarget Default Settingtrue Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60
global_ts_user_authentication_method
This system parameter allows you to specify the authentication method that InfoSphere CDC will use to authenticate the user/password combination specified in in the Access Manager perspective in Management Console. By default, this system parameter is set to the authentication method that you specify when configuring InfoSphere CDC. For more information on configuring InfoSphere CDC, see your InfoSphere CDC for Microsoft SQL Server documentation. Set this parameter to one of the following: Note: IBM recommends that you set these values with the dmset command. For more information, see your InfoSphere CDC for Microsoft SQL Server documentation. v db_authenticationIndicates that InfoSphere CDC uses SQL Server authentication. With this type of authentication, you must specify a SQL Server user/password combination when you create a datastore in the Access Manager perspective in Management Console. The Windows user must have a SELECT permission on the TS_AUTH metadata table. v validationIndicates that InfoSphere CDC verifies that a SQL Server user exists. The password is not verified. With this type of authentication, you must specify a SQL Server user when you create a datastore in the Access Manager perspective in Management Console . v windows_authenticationIndicates that InfoSphere CDC uses Windows authentication. With this type of authentication, you must specify a Windows user/password combination that has access to your SQL Server database when you create a datastore in the Access Manager perspective in Management Console. The Windows user must have a SELECT permission on TS_AUTH metadata table. For more information on how to create a datastore in the Access Manager perspective, see To add a new datastore on page 24. Default SettingNone
System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above)
345
Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60 Related tasks To add a new datastore on page 24
346
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Note: If you make changes to a system parameter during active replication, you must stop and restart replication for the changes to take effect. In this section, you will learn: General product system parameters Apply process system parameters on page 357 Cascading replication system parameters on page 365 Database journal (trigger) system parameters on page 366 Maximize throughput system parameters on page 367 Tracing system parameters on page 372 Refresh loader system parameters on page 375 User exit system parameters on page 379 Table mapping system parameters on page 380 Notification system parameters on page 381 Disk resource system parameters on page 386
347
<subscription>_POOL_BLOCK_SIZE_MB on page 352 LD_LIBRARY_PATH on page 353 LIBPATH on page 353 ORACLE_HOME on page 353 ORACLE_SID on page 353 PASSWORD on page 354 PUBLISH_METADATA on page 354 RLD_SYSTEM_TXQSIZE on page 354 <subscription>_TXQSIZE on page 355 SHLIB_PATH on page 355 STARTUP_TIMEOUT on page 355 TCP_KEEPALIVE_SECS on page 356 USER on page 356
CODE_PAGE
Use this system parameter to specify the code page associated with NLS_LANG. This value is set during installation and should not be modified except under the guidance of a IBM technical support. Applies ToSource and Target Default SettingThe system code page when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference NLS_LANG on page 362
DEFAULT_ORACLE_HOME
Use this parameter to specify the installation directory for the Oracle database instance that is started by default. Modify this parameter only if you installed InfoSphere CDC in multiple database instances. Applies ToSource Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
DEFAULT_ORACLE_SID
Use this system parameter to specify the Oracle SID for the Oracle database instance that is started by default. Modify this parameter only if you installed InfoSphere CDC in multiple database instances. Applies ToSource Default SettingThe Oracle SID specified when InfoSphere CDC was installed. Related concepts
348
System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
DEFAULT_ORACLE_USER
Use this system parameter to specify the name of the user for the Oracle database instance that is started by default. Modify this parameter only if you installed InfoSphere CDC in multiple database instances. Applies ToSource Default SettingThe Oracle user specified when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
DM_COMMS_HOME
For information about setting this system parameter, see your IBM representative. This little command copies things.
D_MIRROR_HOME
Use this system parameter to specify the directory (full path) where InfoSphere CDC is installed on the server. Applies ToSource and Target Default SettingThe installation directory specified when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
D_MIRROR_LOG
Use this system parameter to specify the directory (full path) where InfoSphere CDC log files are located. Applies ToSource and Target Default SettingThe log subdirectory in the installation directory specified when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
349
DM_DYNAMIC_PARAMETER_CHECK_INT
Use this system parameter to specify how often, in seconds, InfoSphere CDC checks for changes to the values of dynamic system parameters during active replication to a subscription. For example, to check once a day, set this parameter to 216,000. Applies ToSource and Target The following system parameters are dynamic: v D_MIRROR_TRACE on page 414 v D_MIRROR_TRACE_ON_ERROR on page 414 (on the target only) v DM_PRINT_DIAGNOSTICS on page 374 v STATISTICS_INTERVAL on page 420 v SYNCHRONIZATION_COMMIT_ GROUP_SIZE on page 412 v SYNCHRONIZATION_INTERVAL on page 413 Default Setting300 seconds (5 minutes) Minimum Setting0. InfoSphere CDC does not check for changes to dynamic system parameters. Maximum Setting2,147,483,648 (maximum integer) Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
DM_MAX_MONITOR_ENTRIES
Use this system parameter to increase or decrease the number of subscriptions that InfoSphere CDC can support in the Monitor in Management Console. InfoSphere CDC allocates an entry for each source and target datastore within a subscription. For example, if you have a datastore that is being used as a source datastore within 20 subscriptions and as a target datastore within 10 subscriptions, then you must set this system parameter to at least 30. InfoSphere CDC will allocate 30 entries for this datastore. Applies ToSource Default Setting20 entries. By default, InfoSphere CDC can handle 20 subscriptions. Minimum Setting1 entry Maximum Setting1000 entries
DM_TS_MAX_POOL_SIZE_MB
Use this system parameter when you need to resize the staging store component of InfoSphere CDC. You can specify a value in megabytes (MB). After specifying the size of the staging store, you should specify the number of blocks you want InfoSphere CDC to create using the DM_TS_POOL_BLOCK_SIZE_MB system parameter.
350
Applies ToSource This setting must be large enough to store data for the largest predicted transaction that occurs in the Oracle database. If the size of the active staging store is not large enough to accommodate all data, InfoSphere CDC issues an error message (Message ID 307) in the event log and shuts down. The staging store size should be at least 150% of the largest predicted transaction. Note: After changing the value of this parameter, you must set the journal position to the last applied position by running the setjrnpos command. Default Setting25% of the default setting for the RLD_SYSTEM_TXQSIZE system parameter which is 128 MB. For more information about the setjrnpos command, see the setjrnposset Jjournal position in the commands section of the InfoSphere CDC for Oracle End-User Documentation. To set the journal position, see Running the Bookmark Viewer Command and Setting the Journal Position on the Source in the Installing InfoSphere CDC section of the InfoSphere CDC for Oracle End-User Documentation. Related reference DM_TS_POOL_BLOCK_SIZE_MB RLD_SYSTEM_TXQSIZE on page 354
DM_TS_POOL_BLOCK_SIZE_MB
Use this system parameter when you are in the process of resizing the staging store component of InfoSphere CDC and need to specify a block size you want InfoSphere CDC to create for the staging store. You must have already specified the size of the staging store (in MB) using the DM_TS_MAX_POOL_SIZE_MB system parameter. The value you specify for DM_TS_POOL_BLOCK_SIZE_MB indicates the block size you want InfoSphere CDC to create for the staging store. The size you had specified with the DM_TS_MAX_POOL_SIZE_MB system parameter is adjusted based on the block size you specify. Applies ToSource Default SettingNone. If you do not specify a block size for this system parameter, then InfoSphere CDC will create a maximum of 4 blocks (no larger than 20 MB each) of space for the staging store. For example, you may have specified 100 MB for the staging store using the DM_TS_MAX_POOL_SIZE_MB system parameter. In this scenario, InfoSphere CDC will create a maximum 5 blocks of 20 MB each. Related reference DM_TS_MAX_POOL_SIZE_MB on page 350
<subscription>_MAX_POOL_SIZE_MB
Use this system parameter when you want to resize the staging store for a specific subscription. You can specify a value in megabytes (MB). After specifying the size
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
351
of the staging store, you should specify the block size you want InfoSphere CDC to create using the <subscription>_POOL_BLOCK_SIZE_MB system parameter. Applies To--Source Default Setting--25% of the default setting for the RLD_SYSTEM_TXQSIZE system parameter which is 128 MB. This setting must be large enough to store data for the largest predicted transaction that occurs in the Oracle database. If the size of the active staging store is not large enough to accommodate all data, InfoSphere CDC issues an error message (Message ID 307) in the event log and shuts down. The staging store size should be at least 150% of the largest predicted transaction. Note: After changing the value of this parameter, you must set the journal position to the last applied position by running the setjrnpos command. For more information about the setjrnpos command, see the setjrnposset Jjournal position in the commands section of the InfoSphere CDC for Oracle End-User Documentation. To set the journal position, see Running the Bookmark Viewer Command and Setting the Journal Position on the Source in the Installing InfoSphere CDC section of the InfoSphere CDC for Oracle End-User Documentation. Related reference RLD_SYSTEM_TXQSIZE on page 354 <subscription>_POOL_BLOCK_SIZE_MB
<subscription>_POOL_BLOCK_SIZE_MB
Use this system parameter when you are in the process of resizing the staging store component for a specific subscription and need to specify a block size you want InfoSphere CDC to create for the staging store. You must have already specified the size of the staging store (in MB) using the <subscription>_TS_MAX_POOL_SIZE_MB system parameter. The value you specify for <subscription>_TS_POOL_BLOCK_SIZE_MB indicates the block size you want InfoSphere CDC to create for the staging store. The size you had specified with the <subscription>_TS_MAX_POOL_SIZE_MB system parameter is adjusted based on the block size you specify. Applies ToSource Default SettingNone. If you do not specify a block size for this system parameter, then InfoSphere CDC will create a maximum of 4 blocks (no larger than 20 MB each) of space for the staging store. For example, you may have specified 100 MB for the staging store using the <subscription>_TS_MAX_POOL_SIZE_MB system parameter. In this scenario, InfoSphere CDC will create a maximum 5 blocks of 20 MB each. Related reference <subscription>_MAX_POOL_SIZE_MB on page 351
352
LD_LIBRARY_PATH
Use this system parameter to specify the path to the InfoSphere CDC libraries and the database libraries for Solaris and Linux operating systems. This value is set during installation and should not be modified. Applies ToSource and Target Default SettingThe path to the InfoSphere CDC libraries and the Oracle libraries when InfoSphere CDC was installed Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
LIBPATH
Use this system parameter to specify the path to the InfoSphere CDC libraries and the database libraries (for AIX operating systems). This value is set during installation and should not be modified. Applies ToSource and Target Default SettingThe path to the InfoSphere CDC libraries and the database libraries when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
ORACLE_HOME
Use this system parameter to specify the Oracle home directory. Applies ToSource Default SettingThe Oracle home directory specified when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
ORACLE_SID
Use this system parameter to specify the Oracle SID. Applies ToSource Default SettingThe Oracle SID specified when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
353
PASSWORD
Use this system parameter to identify the encrypted database password, which can be set using the dmsetpass command. For information about dmsetpass, see dmsetpassSet Password in the Commands section of the InfoSphere CDC for Oracle documentation. Applies ToSource This parameter was set during installation and should not be modified. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
PUBLISH_METADATA
Use this system parameter to enable or disable the display of InfoSphere CDC metadata tables in Management Console. Applies ToSource Set this parameter to one of the following: v OFFInfoSphere CDC metadata tables are not displayed in Management Console. v ONInfoSphere CDC metadata tables are displayed in the Add/Remove Tables dialog box, making them available to be selected for replication. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
RLD_SYSTEM_TXQSIZE
Use this system parameter to specify the size, in megabytes (MB), for the active transaction queue store maintained by InfoSphere CDC. The active transaction queue store contains data for concurrent transactions that have been extracted from the Oracle redo log. Applies ToSource This setting must be large enough to store data for all concurrent transactions that occur in the Oracle database. If the size of the active transaction queue store is not large enough to accommodate all data, InfoSphere CDC issues an error message and shuts down. Default Setting128 MB Minimum Setting5 MB Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
354
<subscription>_TXQSIZE
Use this system parameter to specify the size, in megabytes (MB), you want to allocate per subscription for the active transaction queue store. This area represents the amount of space required to store data for a single transaction, extracted from the Oracle redo log. This system parameter is useful when you want to allocate a specific amount of queue storage for a specific subscription you have added in InfoSphere CDC Management Console. If you want all other subscriptions to use the same storage size, then use the RLD_SYSTEM_TXQSIZE to allocate queue storage size. Applies ToSource Default SettingThere is no default value for this system parameter. If you decide not to specify a value in megabytes for this system parameter, then InfoSphere CDC will use the value you specified for the RLD_SYSTEM_TXQSIZE system parameter. Notes: v The subscription name precedes the name of the system parameter (TXQSIZE). For example, sub1TXQSIZE. v The name of the system parameter is not case-sensitive. If you have added two subscriptions in Management Console named SUB1 and sub1, then both subscriptions will use the same value specified for the system parameter. v This system parameter applies only to the Redo Log edition of InfoSphere CDC for Oracle. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference RLD_SYSTEM_TXQSIZE on page 354
SHLIB_PATH
Use this system parameter to specify the path to the InfoSphere CDC libraries and the database libraries for HP-UX operating systems. This value is set during installation and should not be modified. Applies ToSource and Target Default SettingThe path to the InfoSphere CDC libraries and the database libraries when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
STARTUP_TIMEOUT
Use this system parameter to specify the maximum waiting period, in seconds, for process handling to complete during InfoSphere CDC startup. It indicates how long the communication program waits for the database setup program to start before timing out.
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
355
Applies ToSource and Target Default Setting120 Minimum Setting60 Maximum Setting3600 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
TCP_KEEPALIVE_SECS
Use this parameter to specify the time interval, during idle periods, to wait before sending a keep alive message over the network. If a connection is idle for the specified time interval, InfoSphere CDC sends a keep alive message to keep the connection open. Applies ToSource and Target Setting this system parameter is needed in environments that have firewalls with timeout connection values, to prevent them from closing the connection. Set this parameter to a value lower than the firewall timeout, so that the firewall does not close the connection during data replication. To set this system parameter, do the following: 1. Create a file named dmcommparms.cfg in the <InfoSphere CDC install dir>/lib directory. 2. Insert the following line in the file: TCP_KEEPALIVE_SECS = <value>; where value is the setting for this system parameter. For example, to set to 1 minute, enter: TCP_KEEPALIVE_SECS = 60; Default Setting300 seconds (5 min) Minimum Setting0 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
USER
Use this system parameter to specify the Oracle user name that was specified during installation. You can also set this user using the dmsetpass command. For information about dmsetpass, see the dmsetpassSet Password in the Commands section of the InfoSphere CDC for Oracle documentation. Applies ToSource Default SettingThe InfoSphere CDC user specified when InfoSphere CDC was installed.
356
Apply process system parameters In this section, you will learn about system parameters that adjust how InfoSphere CDC applies rows, column data, and errors to the target. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
convertNotNullableColumns
Use this system parameter to indicate whether or not NULL values will be converted to default values when replicating data that contains NULL values to non-nullable target columns. Applies ToTarget Set this parameter to one of the following: v OFFAn error message will be generated in Event Log. Replication will continue or not based on whether the MirrorError or RefreshError system parameters are set to END or ON. v ONInfoSphere CDC will automatically insert an appropriate default value in the target column. No error message is generated in Event Log and replication continues. Depending on the convertNotNullableMsg system parameter setting, a warning message may be generated in Event Log.
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
357
The default value depends on the data type of the subscription column. For example, zero for numeric data types, blank character for character data types, 1901-01-01 for date data types, and so on. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference D_MIRROR_MIRROR_ERROR_STOP D_MIRROR_REFRESH_ERROR_STOP on page 359 convertNotNullableMsg on page 381
D_MIRROR_MIRROR_ERROR_LIST
Use this system parameter to allow certain errors to be ignored during mirroring. Applies ToTarget If the D_MIRROR_MIRROR_ERROR_STOP on page 405 system parameter is set to ON, use this parameter to allow certain errors to be ignored during mirroring. The value assigned to this parameter is a comma-delimited list of Oracle or Sybase database error numbers. For example, to ignore primary key violations, but to stop mirroring on any other update errors, set D_MIRROR_MIRROR_ERROR_LIST=1. This value corresponds to the Oracle error ORA-00001: unique constraint violated (<schema>.<constraint>). Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference D_MIRROR_MIRROR_ERROR_STOP
D_MIRROR_MIRROR_ERROR_STOP
Use this parameter to indicate whether or not mirroring continues after an error has occurred during a row insert, delete, or update operation. Applies ToTarget Set this parameter to one of the following: v ONMirroring stops after an error has occurred. v OFFMirroring continues after an error has occurred. Default SettingON Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference D_MIRROR_MIRROR_ERROR_LIST
358
D_MIRROR_REFRESH_ERROR_LIST
Use this system parameter to allow certain errors to be ignored during data refresh. Applies ToTarget If the D_MIRROR_REFRESH_ERROR_STOP system parameter is set to ON, use this parameter to allow certain errors to be ignored during data refresh. The value assigned to this parameter is a comma-delimited list of Oracle or Sybase database error numbers. For example, to ignore primary key violations, but to stop refresh on any other update errors, set D_MIRROR_REFRESH_ERROR_LIST=1. This value corresponds to the Oracle error ORA-00001: unique constraint violated (<schema>.<constraint>). Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference D_MIRROR_MIRROR_ERROR_STOP on page 358
D_MIRROR_REFRESH_ERROR_STOP
Use this system parameter to indicate whether or not InfoSphere CDC should continue to perform a refresh after encountering an error during a row insert operation. Applies ToTarget Set this parameter to one of the following: v ONData refresh stops after an error has occurred. v OFFData refresh continues after an error has occurred. Default SettingON Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference D_MIRROR_REFRESH_ERROR_LIST D_MIRROR_MIRROR_ERROR_STOP on page 405
DM_ADAPTIVE_APPLY_SOFT_DELETES
Use this system parameter to enable InfoSphere CDC to apply a soft delete on all target tables mapped using Adaptive Apply in a subscription. Applies ToTarget Set this parameter to one of the following:
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
359
v ONWhen there is a delete on the source table, InfoSphere CDC either: updates the rows on all target tables if the rows exist, or inserts the rows on all target tables if the rows do not exist. v OFFWhen there is a delete on the source table, InfoSphere CDC either: deletes the rows on all target tables if the rows exist, or does nothing and issues an informational message in the Event log if the rows do not exist. See Enabling Apply of Soft Deletes in the InfoSphere CDC Management Console Administration Guide. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Enabling the apply of soft deletes (InfoSphere CDC for Oracle) on page 182
DM_ADAPTIVE_APPLY_<SCHEMA>.<TABLENAME>
Use this system parameter to enable InfoSphere CDC to apply a soft delete on a specific target table mapped using Adaptive Apply in a subscription. Applies ToTarget Set this parameter to one of the following: v ONWhen there is a delete on the source table, InfoSphere CDC either: updates the row on the target table if the row exists, or inserts the row on the target table if it does not exist. v OFFWhen there is a delete on the source table, InfoSphere CDC either: deletes the row on the target table if the row exists, or does nothing and issues an informational message in the Event log if the row does not exist. See Enabling Apply of Soft Deletes in InfoSphere CDC Management Console Administration Guide. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Enabling the apply of soft deletes (InfoSphere CDC for Oracle) on page 182
DM_ADAPTIVE_APPLY_MIMIC_SOURCE_OPERATION
Use this system parameter to modify the how InfoSphere CDC applies data to the target when you have mapped your source and target tables using Adaptive Apply. If you enable this system parameter, InfoSphere CDC avoids performing a SELECT query on the target table and you may benefit with performance improvement. For information about setting this system parameter, see your IBM representative. Applies ToTarget Set this parameter to one of the following:
360
v ONInfoSphere CDC avoids performing a SELECT query on the target table. v OFFInfoSphere CDC performs a SELECT query on the target table. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
DM_ARRAY_BIND_MAX
Use this system parameter to specify the maximum number of rows that InfoSphere CDC can place in an array and apply to the target database. InfoSphere CDC collects rows and places them in an array (in memory) while receiving table-level operations from the source system. InfoSphere CDC applies the rows from the array when there is a change to a different table, when there is a new table-level operation, or when the maximum number of rows in an array has been reached. Applies ToTarget Default Setting25 Minimum Setting1 Maximum SettingMaximum number of rows (integer) Guidelines Before InfoSphere CDC places rows into an array, it allocates memory for the maximum number of rows you specify and multiplies this integer by the maximum length of a row. If the maximum number of rows is too large, then InfoSphere CDC cannot allocate enough memory and will shut down. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
FILTER_NOCHANGE_UPDATES_FOR_AUDIT
Use this system parameter to indicate whether or not updates that have identical before and after column images (that is, the row has been updated to the same value), are replicated to the target table for any tables configured for LiveAudit replication. Applies ToSource Set this parameter to one of the following: v OFFIf a row in a source table is updated to the same value, InfoSphere CDC replicates the value to the target table. v ONIf a row in a source table is updated to the same value, InfoSphere CDC does not replicate the value to the target table. This parameter only affects tables that are configured for LiveAudit replication. For non-audit tables, only updates that change the column data are replicated to the target tables.
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
361
Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
NLS_LANG
Use this system parameter to specify the database character set preceded with a period. For more information about setting this system parameter, see your IBM representative. Applies ToSource and Target Default SettingThe database character set, preceded with a period, corresponding to the language selected when the database was installed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
NLS_NCHAR
Use this system parameter to set the database national character set. For information about setting this system parameter, see your IBM representative.
NOT_NULL_DATE_DEFAULT
Applies ToTarget Specifies the default value that InfoSphere CDC assigns to a NULL date being replicated to a non-nullable date column on the target database. If this parameter is not specified, InfoSphere CDC uses the Default Setting. Default Setting1901-01-01 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference TRIM_TO_NULL on page 363
TRIM_CHAR_TO_VARCHAR
Use this system parameter to specify whether or not trailing blank characters are trimmed from source columns of CHAR data type when replicating data to target columns of VARCHAR data type. Applies ToTarget Set this parameter to one of the following: v OFFTrailing blanks are not trimmed.
362
v ONTrailing blanks are trimmed. If TRIM_TO_NULL =OFF, InfoSphere CDC inserts a single blank character in the target column. If TRIM_TO_NULL =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference TRIM_TO_NULL
TRIM_VARCHAR_TO_VARCHAR
Use this system parameter to specify whether or not trailing blank characters are trimmed from source columns of VARCHAR data type when replicating data to target columns of VARCHAR data type. Applies ToTarget Set this parameter to one of the following: v OFFTrailing blanks are not trimmed. v ONTrailing blanks are trimmed. If TRIM_TO_NULL =OFF, InfoSphere CDC inserts a single blank character in the target column. If TRIM_TO_NULL =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference TRIM_TO_NULL
TRIM_TO_NULL
Use this system parameter to specify how source columns that contain blank characters only are handled during data replication. Applies ToTarget Set this parameter to one of the following: v OFFFor data mapped to VARCHAR columns, trailing blanks are trimmed or not to a single blank depending on the TRIM_CHAR_TO_VARCHAR and TRIM_VARCHAR_TO_VARCHAR system parameters. For data mapped to CHAR columns, setting this parameter to OFF has no effect. v ONFor data mapped to CHAR columns, if the target column is nullable, InfoSphere CDC inserts NULL in the column. For CHAR data mapped to VARCHAR columns, if TRIM_CHAR_TO_VARCHAR =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column. For VARCHAR data mapped to VARCHAR columns, if TRIM_VARCHAR_TO_VARCHAR =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column.
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
363
If the target column is non-nullable, source columns that contain blank characters only are handled according to the convertNotNullableColumns system parameter. The table below explains how the TRIM_ system parameters affect the data replicated to the target for source columns that contain blank characters only.
TRIM_ parameter settings TRIM_CHAR_ TO_ VARCHAR ON ON OFF OFF ON ON OFF OFF TRIM_ VARCHAR_ TO_ VARCHAR ON OFF ON OFF ON OFF ON OFF TRIM_ TO_ NULL ON ON ON ON OFF OFF OFF OFF Target data CHAR to VARCHAR NULL NULL Source data Source data VARCHAR to VARCHAR NULL Source data NULL Source data Any data type to CHAR NULL NULL NULL NULL Blanks Blanks Blanks Blanks
Single blank Single blank Single blank Source data Source data Source data Single blank Source data
Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference TRIM_VARCHAR_TO_VARCHAR on page 363 TRIM_CHAR_TO_VARCHAR on page 362
UNICODE_HANDLING
Use this system parameter to indicate the default method of treating data in defined Unicode columns. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Applies ToSource The following Oracle data types are considered to be Unicode columns, and are therefore affected by the value assigned to this system parameter: v NCHAR v NVARCHAR2 v NCLOB This system parameter is set to either CHAR or NOCHANGE: v CHARInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v NOCHANGEInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain
364
non-single-byte character data. NOCHANGE ensures InfoSphere CDC will handle non-single-byte character data in the same way as previous InfoSphere CDC releases. Note: If replicating data to a non-Oracle subscriber, NOCHANGE does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non single-byte character data, you may need to apply user exit programs or other customization to properly represent data in Unicode columns. For more information about user exit programs, see C user exits for table/row level operations in the User Exits section of the InfoSphere CDC for Oracle documentation. Default SettingNOCHANGE Note: NOCHANGE does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may need to apply user exit programs or other customization to properly represent the data in Unicode columns. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Setting multibyte and Unicode character set conversions on page 175
CASCADE_OMIT_TARGETS
Use this system parameter to indicate whether or not cascading replication will be disabled for specific subscriptions. Applies ToSource The value assigned to this parameter is a comma-separated list of subscription names. Changes applied by InfoSphere CDC are not replicated to these subscriptions, even if you set the system parameter PREVENT_RECURSION to OFF. The list of subscriptions cannot exceed 1023 bytes in length. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference PREVENT_RECURSION
PREVENT_RECURSION
Use this parameter to indicate whether or not to prevent cascading replication for bi-directional configurations.
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
365
Applies ToSource Set this parameter to one of the following: v ONChanges applied by InfoSphere CDC are not be replicated back to the source database from where it came from. v OFFChanges made by InfoSphere CDC are replicated, except when filtered out by the CASCADE_OMIT_TARGETS system parameter. Default SettingON Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference CASCADE_OMIT_TARGETS on page 365
REPORT_POSITION_INTERVAL
Use this system parameter to specify how often (in seconds) the source informs the target about its position in the current journal during times of no activity. During times of no activity, when there are no journal entries to be processed pertaining to the current subscription, the source informs the target of its current position so that the target can advance its bookmarks accordingly. By specifying a low setting for this parameter, the target can reflect more accurately how far replication has progressed. Applies ToSource After a shutdown and restart, you can use this system parameter to prevent InfoSphere CDC from rereading entries that do not apply to the current replication configuration. The value of this parameter affects the information that is displayed in progress and bookmark messages. A high value for this parameter may result in information that is not up-to-date being displayed. Default Setting5 Minimum Setting1 Maximum Setting300 Related concepts
366
System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
MONITOR_PURGE_INTERVAL
Use this system parameter to specify the time interval between journal purges. When this time interval has elapsed, InfoSphere CDC removes from its journals all records that have been committed on all targets to which they are replicated. Applies ToSource Specify this parameter in the format #h#m#s, where # is the number of hours, minutes, and seconds, respectively. For example, 1h30m represents 1 hour and 30 minutes. If a time specification value is 0, you can omit it. Default Setting1h Minimum Setting1m Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
MONITOR_REFRESH_PERIOD
Use this parameter to specify the time interval between journal polls. InfoSphere CDC performs journal polls to check for new changes on the source. Applies ToSource Note: If you replicate large volumes of data, set this parameter to its minimum value so that InfoSphere CDC checks for changes more frequently. Specify this parameter in the format #h#m#s, where # is the number of hours, minutes, and seconds, respectively. For example, 1h30m represents 1 hour and 30 minutes. If a time specification value is 0, you can omit it. Default Setting5s Minimum Setting1s Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
367
database. The default settings are appropriate for most databases, but if your target system has limited resources and an increase in latency is acceptable, you can adjust the settings appropriately. See also: COMMIT_GROUP_SIZE COMMIT_LEVEL COMMIT_INTERVAL on page 369 MAINTAIN_TRANSACTION_CONSISTENCY on page 370 SYNCHRONIZATION_COMMIT_ GROUP_SIZE on page 370 SYNCHRONIZATION_INTERVAL on page 371 TRANSACTION_GROUP_SIZE on page 371 TRANSACTION_INTERVAL on page 372 TRANSACTION_RECORDS_THRESHOLD on page 372
COMMIT_GROUP_SIZE
Use this system parameter to specify the minimum number of rows InfoSphere CDC should apply to the database before a commit is issued. InfoSphere CDC issues a commit on the target when the transaction that contains the rows completes. Use the COMMIT_GROUP_SIZE and COMMIT_INTERVAL system parameters together. InfoSphere CDC issues a commit when either when the number of rows specified by COMMIT_GROUP_SIZE has been applied to the target, or when the time interval specified by COMMIT_INTERVAL has elapsed. Setting only one of these system parameters without the other can result in uncommitted data on the target. Applies ToTarget Default Setting5000 Minimum Setting0. InfoSphere CDC does not use commit groups to apply data to the target. Guidelines Set this parameter to 0 if D_MIRROR_MIRROR_ERROR_STOP=OFF. If a rollback occurs, InfoSphere CDC rolls back all outstanding rows in the commit group. Since InfoSphere CDC is set to continue on error, you may lose data. Note: Use this parameter only if InfoSphere CDC is not running under commitment control (COMMIT_LEVEL =0).
COMMIT_LEVEL
Use this system parameter to indicate the level of commitment control for InfoSphere CDC to process transactions. Applies ToTarget Set this parameter to one of the following:
368
v 0Disables commitment control for transaction processing. No attempt to maintain transaction consistency is performed in the event that replication is interrupted. v 2When replication is interrupted, updates in a transaction that is partially applied on the source and target databases will be rolled back to the last transaction that was successfully committed. This level of commitment control provides true transaction consistency, and ensures that a transaction will not be partially applied on the target database. Replication resumes after the last transaction that was successfully committed. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
COMMIT_INTERVAL
Use this system parameter to specify the time interval between commits, in seconds, to limit the number of commits InfoSphere CDC issues on the target database. Use the COMMIT_GROUP_SIZE and COMMIT_INTERVAL system parameters together. InfoSphere CDC issues a commit when either when the number of rows specified by COMMIT_GROUP_SIZE has been applied to the target, or when the time interval specified by COMMIT_INTERVAL has elapsed. Setting only one of these system parameters without the other can result in uncommitted data on the target. When the COMMIT_INTERVAL time expires, InfoSphere CDC issues a commit on the target database for transactions that completed within that time interval. Applies ToTarget Default Setting60 Minimum Setting0. InfoSphere CDC issues a commit on a target database for each completed transaction. Guidelines Set this parameter to 0 if D_MIRROR_MIRROR_ERROR_STOP=OFF. If a rollback occurs, InfoSphere CDC rolls back all outstanding rows in the commit group. Since InfoSphere CDC is set to continue on error, you may lose data. Note: Use this parameter only if InfoSphere CDC is not running under commitment control (COMMIT_LEVEL =0). Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference COMMIT_LEVEL on page 368 COMMIT_GROUP_SIZE on page 411 D_MIRROR_MIRROR_ERROR_STOP on page 358
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
369
MAINTAIN_TRANSACTION_CONSISTENCY
Use this system parameter to Indicate whether or not to maintain commitment control. Applies ToSource Set this parameter to one of the following: v OFFCommitment control is disabled. In this case, the COMMIT_LEVEL system parameter is treated as 0. v ONCommitment control is enabled. In this case, the COMMIT_LEVEL system parameter must be 0 or 2. Note: To enable commitment control, you must set MAINTAIN_TRANSACTION_CONSISTENCY=ON and COMMIT_LEVEL=2 before configuring any tables for mirroring. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference COMMIT_LEVEL on page 368
SYNCHRONIZATION_COMMIT_ GROUP_SIZE
Use this system parameter to specify the number of transactions applied to the database before InfoSphere CDC performs synchronization between the source and target. Applies ToSource The SYNCRONIZATION_COMMIT_GROUP_SIZE and SYNCHRONIZATION_INTERVAL system parameters are intended to be used together. Synchronization occurs either when the number of transactions (specified by SYNCRONIZATION_COMMIT_GROUP_SIZE) have been applied or when the time interval (specified by SYNCHRONIZATION_INTERVAL) has elapsed, whichever comes first. Default Setting128 Minimum Setting0. InfoSphere CDC does not use commit groups to perform synchronization. Maximum Setting2,147,483,648 (maximum integer) DynamicYes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference SYNCHRONIZATION_INTERVAL on page 371
370
SYNCHRONIZATION_INTERVAL
Use this system parameter to specify the interval, in seconds, at which synchronization is performed between the source and target. Synchronization is achieved when the target reports to the source the position of the last committed change. Applies ToSource The SYNCRONIZATION_INTERVAL and SYNCHRONIZATION_COMMIT_ GROUP_SIZE system parameters are intended to be used together. Synchronization occurs either when the number of transactions (specified by SYNCHRONIZATION_COMMIT_ GROUP_SIZE ) have been applied or when the time interval (specified by SYNCRONIZATION_INTERVAL) has elapsed, whichever comes first. Default Setting1 Minimum Setting1 Maximum Setting300 DynamicYes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference SYNCHRONIZATION_COMMIT_ GROUP_SIZE on page 370
TRANSACTION_GROUP_SIZE
Use this system parameter to specify the number of complete transactions applied to the database before InfoSphere CDC issues a commit. Use the TRANSACTION_GROUP_SIZE, TRANSACTION_INTERVAL, and TRANSACTION_RECORDS_THRESHOLDS system parameters together. InfoSphere CDC issues a commit after applying the number of transactions specified by the TRANSACTION_GROUP_SIZE, or when the time interval specified by TRANSACTION_INTERVAL has elapsed. Setting only one of these system parameters without the other can result in uncommitted transactions on the target. Applies ToTarget Default Setting500 Minimum Setting0 Guidelines To increase the throughput, set to a number of transactions that would be received when busy during the TRANSACTION_INTERVAL. Note: Use this parameter only if InfoSphere CDC is running under commitment control. The COMMIT_LEVEL system parameter should be set to2 on the target
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
371
database, and the MAINTAIN_TRANSACTION_CONSISTENCY system parameter should be set to ON on the source database.
TRANSACTION_INTERVAL
Use this system parameter to specify the time interval, in seconds, that can elapse between transactions before InfoSphere CDC issues a commit. If there are no transactions received by the target system, then InfoSphere CDC issues a commit immediately. Use this system parameter with the TRANSACTION_GROUP_SIZE system parameter. InfoSphere CDC issues a commit after applying the number of transactions specified by the TRANSACTION_GROUP_SIZE system parameter, or when the time interval specified by TRANSACTION_INTERVAL system parameter has elapsed. Setting only one of these system parameters without the other can result in uncommitted transactions on the target. Applies ToTarget Default Setting1 Minimum Setting0 Guidelines InfoSphere CDC issues a commit only when a commit is received by the target system and you have reached the transaction group size, or exceeded the time interval, or exceeded the records threshold.
TRANSACTION_RECORDS_THRESHOLD
Use this system parameter to specify the maximum number of operations within a transaction or group of transactions before InfoSphere CDC issues a commit Applies ToTarget Default Setting3000 Minimum Setting0
372
D_MIRROR_SP_TRACE
Use this system parameter to enable tracing for your stored procedure user exit. Applies ToTarget Set this parameter to one of the following: v OFFTracing is disabled. v ONTracing is enabled and InfoSphere CDC creates the appropriate trace files in the log directory. These trace files are not encrypted. It is a plain ASCII text file and can be read directly for troubleshooting purposes. Default SettingOFF DynamicNo
D_MIRROR_TRACE
Use this system parameter to indicate whether or not tracing is enabled. Applies ToSource and Target Set this parameter to one of the following: v OFFTracing is disabled. This setting has no effect when D_MIRROR_TRACE_ON_ERROR=ON. v ONTracing is enabled and InfoSphere CDC creates the appropriate trace files in the log directory. These trace files are encrypted, and are meant to be sent to IBM technical support for troubleshooting purposes. When enabling this setting, also set the size of the trace file to an appropriate value using the D_MIRROR_TRACE_FILE_SIZE system parameter. To avoid disk space problems, set the size of the trace file to a value that is not too high. Default SettingOFF DynamicYes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference D_MIRROR_TRACE_FILE_SIZE D_MIRROR_LOG on page 349 DIRPATH_LOGGING on page 378 D_MIRROR_ALARM_TRACE on page 375
D_MIRROR_TRACE_FILE_SIZE
Use this system parameter to specify the maximum size of a trace file in bytes. InfoSphere CDC creates two trace files. When the first trace file reaches its maximum size, InfoSphere CDC creates a second file. When the second trace file reaches its maximum size, InfoSphere CDC starts overwriting the first file.
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
373
Applies ToSource and Target Default Setting10,000,000 bytes Minimum Setting1,000,000 bytes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
D_MIRROR_TRACE_ON_ERROR
Use this system parameter to specify whether or not InfoSphere CDC enables tracing automatically when an error occurs. Applies ToSource and Target Set this parameter to one of the following: v OFFInfoSphere CDC does not enable tracing when an error occurs. v ONInfoSphere CDC enables tracing when an error occurs. InfoSphere CDC creates the appropriate trace files in the InfoSphere CDC log directory. These trace files are encrypted, and are meant to be sent to IBM technical support for troubleshooting purposes. When enabling this setting, also set the size of the trace file to an appropriate value using the D_MIRROR_TRACE_FILE_SIZE system parameter. To avoid disk space problems, set the size of the trace file to a value that is not too high. Default SettingOFF DynamicYes (on the target only) Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference D_MIRROR_TRACE_FILE_SIZE on page 373
DM_PRINT_DIAGNOSTICS
Use this system parameter to Indicate whether or not to generate diagnostic messages in the InfoSphere CDC log files. Applies ToSource Set this parameter to one of the following: v OFFDiagnostic messages will not be generated. v ONDiagnostic messages will be generated. Note: If you enable tracing, it may cause large trace files to be created, which can consume a large amount of disk space and affect performance. To avoid running into disk space shortage problems, use this parameter only if advised by IBM technical support. Default SettingOFF
374
Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
D_MIRROR_ALARM_TRACE
Use this system parameter to Indicate whether or not tracing for notification is enabled. Applies ToSource and Target Set this parameter to one of the following: v OFFTracing for notification is disabled. v ONTracing for notification is enabled. Tracing for notification is enabled when D_MIRROR_TRACE system parameter is also set to ON. The notification tracing will be located in the same trace file used for regular tracing located in the directory specified by the D_MIRROR_LOG system parameter. The trace files are encrypted and are meant to be sent to IBM for troubleshooting purposes. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference D_MIRROR_TRACE on page 373
DIRPATH_BUF_ROWS
Use this system parameter to specify the number of rows allocated in the internal buffer used for direct path loading. By setting this parameter to a value greater than 0, you can improve direct path loading performance. Applies ToTarget The table below explains how the DIRPATH_BUF_ROWS and DIRPATH_BUF_SIZE system parameters affect the size of the internal buffer that InfoSphere CDC uses for direct path loading.
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
375
DIRPATH_BUF_ SIZE 0
DIRPATH_BUF_ ROWS 0
Internal buffer size Determined dynamically, based on the size of the table being loaded. As specified by DIRPATH_BUF_ROWS. InfoSphere CDC allocates an internal buffer that is large enough to store the number of rows specified by DIRPATH_BUF_ROWS. As specified by DIRPATH_BUF_SIZE. As specified by DIRPATH_BUF_SIZE.
Greater than 0
0 Greater than 0
Default Setting0 Minimum Setting0 Maximum Setting231 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference DIRPATH_BUF_SIZE
DIRPATH_BUF_SIZE
Use this system parameter to specify the size, in bytes, for the internal buffer used for direct path loading. By setting this parameter to a value greater than 0, you can improve direct path loading performance. Applies ToTarget The table below explains how the DIRPATH_BUF_SIZE and DIRPATH_BUF_ROWS system parameters affect the size of the internal buffer that InfoSphere CDC uses for direct path loading.
DIRPATH_BUF_ SIZE 0 DIRPATH_BUF_ ROWS 0 Internal buffer size Determined dynamically, based on the size of the table being loaded. As specified by DIRPATH_BUF_ROWS. InfoSphere CDC allocates an internal buffer that is large enough to store the number of rows specified by DIRPATH_BUF_ROWS. As specified by DIRPATH_BUF_SIZE.
Greater than 0
Greater than 0
376
Default Setting0 Minimum Setting0 Maximum Setting231 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference DIRPATH_BUF_ROWS on page 375
DIRPATH_CACHE_DATE_SIZE
Use this system parameter to specify the number of DATE (date and timestamp) values to be cached per table being refreshed, during direct path loading. If the table being refreshed contains DATE data type columns, you can improve direct path loading performance by setting this parameter to a value higher than the default setting. If the table being refreshed does not contain any DATE data type columns, this parameter has no effect. Applies ToTarget Default Setting0. DATE values are not cached. Minimum Setting0 Maximum Setting2^32 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
DIRPATH_LOAD
Use this system parameter to enable or disable direct path loading. Applies ToTarget Set this parameter to one of the following: v ONDirect path loading is enabled. InfoSphere CDC uses Oracle Call Interface (OCI) functions to perform data refresh. By using OCI functions, InfoSphere CDC can load multiple rows by loading a direct path stream that contains data for multiple rows. Note: If you want to enable direct path loading, then you need perform a refresh on each subscription to send data to the target datastore. v OFFDirect path loading is disabled.
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
377
Note: This setting is required in cascading replication configurations, to make sure that data changes are correctly replicated to the target tables. Default SettingON Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
DIRPATH_LOGGING
Applies ToTarget Indicates whether or not full image redo logging is performed. This system parameter corresponds to the Oracle NOLOGGING keyword. Set this parameter to one of the following: v OFFFull image redo logging is not performed. Oracle generates a minimum number of redo log entries, thus providing improved performance. However, in case of instance failure, records that were inserted are marked as logically corrupted and cannot be recovered. v ONFull image redo logging is performed. Oracle inserts data with full image redo logging, which ensures that the necessary information is available in case of instance failure. For more information about image redo logging, see your Oracle documentation. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
DIRPATH_DO_RECOVERY
Use this system parameter to modify how InfoSphere CDC handles rows that have conflicting unique index values. In Direct Path Load, InfoSphere CDC places an index in direct load state when it detects one or more conflicts after performing a refresh of all rows. Applies ToTarget OFFNo rows are removed and the index remains in direct load state and ROWID of duplicate rows are stored in the exception table as indicated in the event log. ONAll rows with conflicting unique index values will be removed and the index will be enabled. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
378
D_MIRROR_SP_CONNECTION
Use this system parameter to indicate whether or not a second connection to the Oracle database is established for a stored procedure user exit program to run. Applies ToTarget Set this parameter to one of the following: v OFFA second connection to the database is not established. The stored procedure user exit program and InfoSphere CDC will use the same, shared connection to the Oracle database. This setting ensures that changes to tables made by InfoSphere CDC are visible to the stored procedure user exit program. v ONA second connection to the database is established. The stored procedure user exit program will use this separate, second connection, to the Oracle database. Attention: If any stored procedure user exit program is issuing a commit or rollback, you must set this parameter to ON, otherwise data may be lost, or errors may be generated when applying data to the target database. Setting this parameter to ON does not affect stored procedure user exit programs for conflict resolution, or stored procedure user exit programs invoked within an expression, using the %STPROC column function. They will always use the same connection to the database as InfoSphere CDC. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
DM_FROM_CODEPAGE_V4USEREXIT
Applies ToTarget Set this parameter only if using before or after images in C user exit programs defined in InfoSphere CDC Version 4.x. In InfoSphere CDC Version 4.x, the before and after images in C user exit programs were received in the code page of the source. In Version 5.1 and greater, they are received in the code page of the target. To use the user exit program as defined in Version 4.x, data must be translated back from the code page of the target to the code page of the source.
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
379
Therefore, specify for this parameter the code page to translate from (the code page of the target). If this parameter is not set, no translation will be performed from the code page of the source to the code page of the target. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
DM_TO_CODEPAGE_V4USEREXIT
Applies ToTarget Set this parameter only if using before or after images in C user exit programs defined in InfoSphere CDC Version 4.x. In InfoSphere CDC Version 4.x, the before and after images in C user exit programs were received in the code page of the source. In Version 5.1 and higher, they are received in the code page of the target. To use the user exit program as defined in Version 4.x, data must be translated back from the code page of the target to the code page of the source. Therefore, specify for this parameter the code page to translate to (the code page of the source). If this parameter is not set, no translation will be performed from the code page of the target to the code page of the source. Table mapping system parameters In this section, you will learn about system parameters that control table mappings. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
TS_DELETE_ASSIGNED_OBJECTS_DURING_DESCRIBE
Use this system parameter (when describing source tables to subscriptions) to specify whether or not to remove references to target tables when the mapped source table no longer exists. Applies ToTarget Set this parameter to one of the following: v OFFInfoSphere CDC does not remove references to target tables when the assigned source table no longer exists.
380
v ONInfoSphere CDC removes references to target tables when the assigned source table no longer exists. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
convertNotNullableMsg
Use this system parameter to indicate whether or not NULL values will be converted to default values when replicating data that contains NULL values to non-nullable target columns. Applies ToTarget Set this parameter to one of the following: v OFFAn error message will be generated in Event Log. Replication will continue or not based on whether the MirrorError or RefreshError system parameters are set to END or ON. v ONInfoSphere CDC will automatically insert an appropriate default value in the target column. No error message is generated in Event Log and replication continues. Depending on the convertNotNullableMsg system parameter setting, a warning message may be generated in Event Log. The default value depends on the data type of the subscription column. For example, zero for numeric data types, blank character for character data types, 1901-01-01 for date data types, and so on. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
DEADBAND_PERCENTAGE
Applies ToTarget
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
381
Identifies the size of the range around each latency threshold setting. Based on latency thresholds defined, a latency message is generated when latency has risen above or fallen below a threshold. Latency is calculated at regular intervals, where the interval is the current setting for the MONITOR_SAMPLE_INTERVAL system parameter. You can set notifications in response to a generated latency message. This system parameter, which is expressed as a percentage, allows you to pad a threshold equally on both sides to create a range around the threshold. By adjusting this system parameter, the size of the range around the threshold can be increased or decreased, and the threshold itself can be made thicker or thinner. A latency message is generated only when latency has risen above the upper limit of the range or fallen below the lower limit of the range. By changing the value assigned to this system parameter, you can control the number of latency messages placed in Event Log. For example, assume that a latency threshold is 5 minutes and this system parameter is set to 10. A 10% range is applied around the 5 minute threshold. The following calculations are performed to determine the lower and upper limits (in minutes) of the range around the threshold: v Padding = 10% of 5 minutes = 0.5 minutes (rounded up to 1 minute) v Padding is rounded up or down to the nearest whole minute: Upper limit of range = 5 minutes + 1 minute (padding) = 6 minutes Lower limit of range = 5 minutes - 1 minute (padding) = 4 minutes As a result, a latency message will be generated only when latency rises above 6 minutes or falls below 4 minutes. Given sample latency over a ten minute period where latency is calculated every minute, three latency messages are generated. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 10%:
If this DEADBAND_PERCENTAGE is set to 3 (the default setting) for the same example, no padding is applied to the latency threshold. Therefore, a latency message is generated each time latency crosses over the latency threshold of 5 minutes. Based on the same sample latency in the previous graph where latency is
382
calculated every minute, five latency messages are generated when this system parameter is set to 3. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 3%:
If the number of latency messages generated over the ten minute period for the 10% (3 latency messages) and 3% (5 latency messages) settings are averages, an additional 288 latency messages would be generated each day if this system parameter is not changed from its default setting to 10%. Since there are two latency thresholds that you can set (a warning threshold and a problem threshold), two separate ranges are defined when padding is at least one minute. In this case, each range is attached to its threshold, and the two ranges can overlap with no change in behavior. If a value outside the acceptable range is specified, the default setting is used. Default Setting3% Minimum Setting3% Maximum Setting10% Note: If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Disk resource system parameters on page 386 Setting latency thresholds and notifications on page 78
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
383
DM_STATUS_INTERVAL
Use this system parameter to specify how often progress messages should be issued in seconds. These messages are displayed in Event Log to indicate how replication is advancing and to provide detailed information about InfoSphere CDC replication activities. Applies ToSource and Target Note: Low values of this parameter may result in many messages displayed in Event Log. In this situation, clear Event Log on a regular basis. Default Setting0 seconds. No progress notifications will be issued. Minimum Setting0 seconds. No progress notifications will be issued. Maximum Setting7200 seconds Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
HEARTBEAT_TIMEOUT
Use this parameter to specify the number of minutes of communication inactivity to wait before active InfoSphere CDC processes for a subscription are stopped. Heartbeat is a feature that manages InfoSphere CDC processes when a problem with communications or a process has been detected through the absence of communications over a specified period of time. For each active subscription, internal heartbeat messages are sent regularly between the source and the target to determine communications and process status. If a reply to a message is not received by the source or target within the specified timeout interval, then InfoSphere CDC determines that a problem has occurred, and attempts to stop all its source and target processes for the subscription. In addition, messages (message identifiers 2612 and 3165) are placed in Event Log when heartbeat timeouts occur. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Displaying event messages during replication on page 232
384
LOG_EMAIL_USERNAME
Use this system parameter to specify the user name that receives email messages in response to invoking the dmreadlog command or the warning message that is generated when Event Log exceeds the threshold value set by the LOG_MAX_SIZE system parameter. Applies ToSource and Target In UNIX environments, the value assigned to this parameter is a comma-separated list of user names. The value of this parameter cannot exceed 30 bytes in length. To suppress all email messages, set this parameter to NOMAIL. Default SettingThe InfoSphere CDC account (UNIX user) specified when InfoSphere CDC was installed Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Related reference STATISTICS_INTERVAL on page 386
MONITOR_SAMPLE_INTERVAL
Use this system parameter to identify the period of time, in seconds, between consecutive updates to a storage area that is used to maintain replication latency metrics. Management Console references this area to present replication latency information. Applies ToSource and Target On the target, this setting also represents how often the storage area is sampled to determine if latency has risen above or fallen below specified threshold settings. InfoSphere CDC generates latency messages when latency rises above or falls below the thresholds. In response to a generated message, you can set latency notifications. If a value smaller than the minimum setting is specified, the minimum setting is used. If a value larger than the maximum setting is specified, the maximum setting is used. Default Setting5 seconds Minimum Setting0 seconds. Replication latency metrics are not updated. Maximum Setting3600 seconds Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 Setting latency thresholds and notifications on page 78
System parameters for InfoSphere CDC for Oracle (version 6.2 and below)
385
STATISTICS_INTERVAL
Use this system parameter to specify how often, in seconds, InfoSphere CDC issues messages that contain statistics information. These messages are displayed in Event Log. Applies ToSource and Target Note: Use this parameter only if advised by IBM technical support. Default Setting0. InfoSphere CDC does not provide statistics information. Minimum Setting0. InfoSphere CDC does not provide statistics information. Maximum Setting2,147,483,647 (maximum integer) DynamicYes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
LOG_MAX_SIZE
Use this system parameter to specify the threshold size of Event Log in KB. A warning message is generated in Event Log when its size exceeds specified threshold. The messages in Event Log are deleted automatically when the size of Event Log is ten times the value specified by this parameter. Applies ToSource and Target If you do not want to specify a threshold size, set this parameter to NOMAX. Default Setting5000 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347
386
System parameters for InfoSphere CDC for Oracle (version 6.3 and above)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Note: If you make changes to a system parameter during active replication, you must stop and restart replication for the changes to take effect. In this section, you will learn: General product system parameters Notification system parameters on page 388 Maximize throughput system parameters on page 389 Database journal (trigger) system parameters on page 366 Encoding system parameters on page 391 Disk resource system parameters on page 392 Apply process system parameters on page 393 User exit system parameters on page 379
mirror_set_table_data_capture_timeout
Use this system parameter to indicate how long (in minutes) InfoSphere CDC waits before declaring a failure when preparing a table for mirroring. Applies ToSource Default30 minutes Minimum0 minutes Maximum90 minutes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above)
Copyright IBM Corp. 2008
387
mirror_asm_oracle_path
Use this system parameter if the Oracle database uses ASM to manage its datafile or redo logs on a Linux box. Replace the ORCL label that references the common directory of the ASM-managed devices with the actual directory path.
events_max_retain
Use this system parameter when you want InfoSphere CDC to refresh a target table that contains multibyte object names. Set this parameter to one of the following: v trueInfoSphere CDC will not refresh the target table that contains multibyte object names. v falseInfoSphere CDC will refresh a target table that contains multibyte object names. Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
global_shutdown_after_no_heartbeat_response_minutes
Use this system parameter to specify the duration, in minutes, of communication inactivity before active InfoSphere CDC processes for a subscription are stopped. If a value outside the acceptable range is specified, the default setting is used. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
388
global_conversion_not_possible_warning
Use this system parameter to control whether or not InfoSphere CDC generates a warning in the Management Console Event Log in the following situations: v Data conversion is not possible for a specific data value. v Converted data types are encountered that are out of range. Set this parameter to one of the following: truegenerates a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. falsedoes not generate a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. Applies ToTarget Default SettingFalse Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
mirror_commit_on_transaction_boundary
This system parameter indicates whether or not the commits that InfoSphere CDC does on the target database will always correspond with a commit that occurred on the source database. If you choose to ignore the commitment control of the source database, InfoSphere CDC allows you to see the partial results of large transactions. Set this parameter to one of the following:
System parameters for InfoSphere CDC for Oracle (version 6.3 and above)
389
trueDoes not ignore the commitment control of the source database. Only records in a committed transaction are mirrored to the target. This setting provides true transaction consistency by ensuring that only committed transactions are sent to the target. v falseIgnores the commitment control of the source database. This value disables commitment control for transaction processing. No attempt to maintain transaction consistency is performed during mirroring. v Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
mirror_sess_hist_age_threshold
Use this system parameter to identify the number of days of session history to maintain. If the value is set to a positive number, the session history will be purged accordingly. A negative number results in the retention of all log information. Default Setting1 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
mirror_src_ora_version
This system parameter identifies the database version of the primary database. If the primary database is version 10g or higher, then you must set this parameter on both the primary and backup systems. Set this parameter to the full database version number. For example, 10.2.0.1.0. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
refresh_commit_after_max_operations
This system parameter identifies the number of rows comprising each transaction during refresh. To reduce the workload on the target database during refresh, InfoSphere CDC periodically commits the changes to the target database rather than performing the refresh as a single large transaction. Applies ToTarget Default Setting1000 Minimum Setting1 Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
390
userexit_max_lob_size_queue
Use this system parameter to set the maximum size of LOB data (in kb) that InfoSphere CDC can pass to a user exit. Applies ToTarget Default Setting128 kb MaximumNone MinimumNone Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
mirror_journal_schema
Use this system parameter to enable multiple instances of InfoSphere CDC to share the same trigger and journal table. To enable this system parameter, you must specify the name of the journal that you want shared with another instance of InfoSphere CDC. For example, if you have created an instance INSTANCE1 that specifies the journal SCHEMA1, and created another instance INSTANCE2 that specifies the journal SCHEMA2, then you would set the system parameter mirror_journal_schema on INSTANCE2 so that it points to the journal SCHEMA1. This enables both instances to share the same trigger and journal table. You can only set a value for this system parameter before mapping your tables and setting the subscription for mirroring. The value of this system parameter must refer to the name of an existing journal table. Applies ToSource Default SettingN/A
System parameters for InfoSphere CDC for Oracle (version 6.3 and above)
391
global_unicode_as_char
Use this system parameter to indicate the default method of treating data in defined Unicode columns. For information about how data in each Unicode source column is treated and setting multibyte and Unicode character set conversions, see Setting multibyte and Unicode character set conversions on page 175. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Set this parameter to one of the following: TrueInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. FalseInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain non-single-byte character data. Setting this parameter to false ensures that InfoSphere CDC handles non-single-byte character data in the same way as previous InfoSphere CDC releases. Default Settingfalse Applies ToSource Note: Setting this parameter to false does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. Using Management Console, you can specify how InfoSphere CDC converts multibyte character sets on source columns during replication. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
mirror_queue_for_buffers_between_cdc_threads_operations
Use this system parameter to set the capacity of InfoSphere CDC queues to store captured changes. The capacity is measured by the number of operations you want the queue to be able to store. This includes insert, update, and delete operations. Applies ToSource Default Setting7 database operations
392
Maximum2 63-1 =9223372036854775807 operations Minimum1 database operation Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
mirror_global_disk_quota_mb
Use this system parameter to globally set a disk quota (in MB) for all capture components (including temporary files, transaction queues, staging stores, and operation queues). InfoSphere CDC will manage disk space utilization across all components as required. Applies ToSource and Target Default Setting0 MaximumNone MinimumNone Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
convert_not_nullable_column
Use this system parameter to specify whether or not InfoSphere CDC should strip or leave trailing blanks on string data of the column in the target table. Set this parameter to one of the following: v trueInfoSphere CDC strips the data of trailing blanks. v falseInfoSphere CDC does not strip the string data of trailing blanks.
System parameters for InfoSphere CDC for Oracle (version 6.3 and above)
393
Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
global_max_batch_size
Use this system parameter to specify the maximum number of rows that InfoSphere CDC can place in an array and apply to the target database during refresh or mirroring. InfoSphere CDC collects rows and places them in an array (in memory) while receiving table-level operations from the source system. InfoSphere CDC applies the rows from the array when there is a change to a different table, when there is a new table-level operation, or when the maximum number of rows in an array has been reached. You can use this parameter during mirroring only if mirror_end_on_error is true and mirror_expected_errors_list is empty. Use only during a refresh if refresh_end_on_error is true and refresh_expected_errors_list is empty. Before InfoSphere CDC places rows into an array, it allocates memory for the maximum number of rows you specify and multiplies this integer by the maximum length of a row. If the maximum number of rows is too large, then InfoSphere CDC cannot allocate enough memory and will shut down. Management Console references this area to present replication latency information. Applies ToTarget InfoSphere CDC for Sybase Default Setting25 rows Minimum Setting1 row
mirror_end_on_error
Use this system parameter to indicate if you want to end mirroring after an apply error occurs on the target database. Set this parameter to one of the following: v trueEnd mirroring after an apply error on the target database. v falseDo not end mirroring after an apply error on the target database. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
refresh_end_on_error
Use this system parameter to indicate if you want to end a refresh after an apply error occurs. Set this parameter to one of the following: v trueEnd a refresh after an apply error occurs.
394
Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
refresh_allow_fast_loader
This parameter can be used to allow or prevent Oracle direct path (fast load) from being considered as a refresh method. Set this parameter to one of the following: trueAllows fast load when appropriate. falseDoes not allow fast load. Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
refresh_allow_jdbc_batch
There are three apply modes for refresh: fastload, JDBC batch and JDBC. InfoSphere CDC chooses fastload if possible, then JDBC batch if possible and chooses JDBC if necessary. This parameter can be used to allow or prevent JDBC batch from being considered. Set this parameter to one of the following: trueallows JDBC batch to be considered as an apply mode. falseprevents JDCBC batch from being considered as an apply mode. Applies ToTarget Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
mirror_expected_errors_list
Use this system parameter when you want InfoSphere CDC to ignore specific database errors when applying data changes to the target during mirroring. You must specify the errors in a comma separated list. Applies ToTarget Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
System parameters for InfoSphere CDC for Oracle (version 6.3 and above)
395
refresh_in_unicode
Use this system parameter when you want InfoSphere CDC to refresh a target table that contains multibyte object names. Set this parameter to one of the following: v trueInfoSphere CDC will refresh the target table that contains multibyte object names. v falseInfoSphere CDC will not refresh a target table that contains multibyte object names. Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
trim_char_to_varchar
Use this system parameter to specify whether or not InfoSphere CDC should pad string data with trailing blanks to the length of the column in the target table. Set this parameter to one of the following: v v trueInfoSphere CDC does not pad the string data with trailing blanks. falseInfoSphere CDC pads the string data with trailing blanks.
Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
trim_varchar_to_varchar
Use this system parameter to specify whether or not InfoSphere CDC should strip or leave trailing blanks on string data of the column in the target table. Set this parameter to one of the following: v trueInfoSphere CDC strips the data of trailing blanks. v falseInfoSphere CDC does not strip the string data of trailing blanks. Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Oracle (version 6.3 and above) on page 387
396
userexit_max_lob_size_kb
Use this system parameter to set the maximum size of LOB data (in kb) that InfoSphere CDC can pass to a user exit. Applies ToTarget Default Setting128 kb MaximumNone MinimumNone Related concepts System parameters for InfoSphere CDC Event Server on page 493 Setting system parameters on source and target datastores on page 60
System parameters for InfoSphere CDC for Oracle (version 6.3 and above)
397
398
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Note: If you make changes to a system parameter during active replication, you must stop and restart replication for the changes to take effect. In this section, you will learn: General product system parameters Apply process system parameters on page 404 Cascading replication system parameters on page 409 Database journal (trigger) system parameters on page 410 Maximize throughput system parameters on page 410 Tracing system parameters on page 413 Notification system parameters on page 415 Disk resource system parameters on page 420 Refresh loader system parameters on page 421
399
CODE_PAGE
Use this system parameter to specify the code page associated with NLS_LANG. This value is set during installation and should not be modified except under the guidance of a IBM technical support. Applies ToSource and Target Default SettingThe system code page when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference NLS_LANG on page 406
D_MIRROR_HOME
Use this system parameter to specify the directory (full path) where InfoSphere CDC is installed on the server. Applies ToSource and Target Default SettingThe installation directory specified when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
D_MIRROR_LOG
Use this system parameter to specify the directory (full path) where InfoSphere CDC log files are located. Applies ToSource and Target Default SettingThe log subdirectory in the installation directory specified when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
DM_DYNAMIC_PARAMETER_CHECK_INT
Use this system parameter to specify how often, in seconds, InfoSphere CDC checks for changes to the values of dynamic system parameters during active replication to a subscription. For example, to check once a day, set this parameter to 216,000. Applies ToSource and Target The following system parameters are dynamic: v D_MIRROR_TRACE on page 414
400
v v v v v
D_MIRROR_TRACE_ON_ERROR on page 414 (on the target only) DM_PRINT_DIAGNOSTICS on page 374 STATISTICS_INTERVAL on page 420 SYNCHRONIZATION_COMMIT_ GROUP_SIZE on page 412 SYNCHRONIZATION_INTERVAL on page 413
Default Setting300 seconds (5 minutes) Minimum Setting0. InfoSphere CDC does not check for changes to dynamic system parameters. Maximum Setting2,147,483,648 (maximum integer) Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
DM_MAX_MONITOR_ENTRIES
Use this system parameter to increase or decrease the number of subscriptions that InfoSphere CDC can support in the Monitor in Management Console. InfoSphere CDC allocates an entry for each source and target datastore within a subscription. For example, if you have a datastore that is being used as a source datastore within 20 subscriptions and as a target datastore within 10 subscriptions, then you must set this system parameter to at least 30. InfoSphere CDC will allocate 30 entries for this datastore. Applies ToSource Default Setting20 entries. By default, InfoSphere CDC can handle 20 subscriptions. Minimum Setting1 entry Maximum Setting1000 entries
DSQUERY
Use this system parameter to specify the name of the Sybase server. Applies ToSource and Target
LD_LIBRARY_PATH
Use this system parameter to specify the path to the InfoSphere CDC libraries and the database libraries for Solaris and Linux operating systems. This value is set during installation and should not be modified. Applies ToSource and Target Default SettingThe path to the InfoSphere CDC libraries and the Sybase libraries when InfoSphere CDC was installed Related concepts
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)
401
System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
LIBPATH
Use this system parameter to specify the path to the InfoSphere CDC libraries and the database libraries (for AIX operating systems). This value is set during installation and should not be modified. Applies ToSource and Target Default SettingThe path to the InfoSphere CDC libraries and the database libraries when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
PUBLISH_METADATA
Use this system parameter to enable or disable the display of InfoSphere CDC metadata tables in Management Console. Applies ToSource Set this parameter to one of the following: v OFFInfoSphere CDC metadata tables are not displayed in Management Console. v ONInfoSphere CDC metadata tables are displayed in the Add/Remove Tables dialog box, making them available to be selected for replication. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
SYBASE
Use this system parameter to specify the Sybase home directory. This value is set during the installation and should not be modified. Applies ToSource and Target Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
SYBASE_OCS
Use this system parameter to specify the Sybase Open Client directory. This value is set during the installation and should not be modified. Applies ToSource and Target Related concepts
402
System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
SHLIB_PATH
Use this system parameter to specify the path to the InfoSphere CDC libraries and the database libraries for HP-UX operating systems. This value is set during installation and should not be modified. Applies ToSource and Target Default SettingThe path to the InfoSphere CDC libraries and the database libraries when InfoSphere CDC was installed. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
STARTUP_TIMEOUT
Use this system parameter to specify the maximum waiting period, in seconds, for process handling to complete during InfoSphere CDC startup. It indicates how long the communication program waits for the database setup program to start before timing out. Applies ToSource and Target Default Setting120 Minimum Setting60 Maximum Setting3600 Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
USER
Use this system parameter to specify the database user name that was specified during installation. You can also set this user using the dmsetpass command. Applies ToSource Default SettingThe InfoSphere CDC user specified when InfoSphere CDC was installed. Apply process system parameters In this section, you will learn about system parameters that adjust how InfoSphere CDC applies rows, column data, and errors to the target. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)
403
convertNotNullableColumns
Use this system parameter to indicate whether or not NULL values will be converted to default values when replicating data that contains NULL values to non-nullable target columns. Applies ToTarget Set this parameter to one of the following: v OFFAn error message will be generated in Event Log. Replication will continue or not based on whether the MirrorError or RefreshError system parameters are set to END or ON. v ONInfoSphere CDC will automatically insert an appropriate default value in the target column. No error message is generated in Event Log and replication continues. Depending on the convertNotNullableMsg system parameter setting, a warning message may be generated in Event Log. The default value depends on the data type of the subscription column. For example, zero for numeric data types, blank character for character data types, 1901-01-01 for date data types, and so on. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference MirrorError on page 318 RefreshError on page 318 convertNotNullableMsg on page 329
404
D_MIRROR_MIRROR_ERROR_STOP
Use this parameter to indicate whether or not mirroring continues after an error has occurred during a row insert, delete, or update operation. Applies ToTarget Set this parameter to one of the following: v ONMirroring stops after an error has occurred. v OFFMirroring continues after an error has occurred. Default SettingON Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference D_MIRROR_REFRESH_ERROR_STOP on page 359
D_MIRROR_REFRESH_ERROR_STOP
Use this system parameter to indicate whether or not InfoSphere CDC should continue to perform a refresh after encountering an error during a row insert operation. Applies ToTarget Set this parameter to one of the following: v ONData refresh stops after an error has occurred. v OFFData refresh continues after an error has occurred. Default SettingON Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference D_MIRROR_REFRESH_ERROR_LIST on page 359 D_MIRROR_MIRROR_ERROR_STOP
FILTER_NOCHANGE_UPDATES_FOR_AUDIT
Use this system parameter to indicate whether or not updates that have identical before and after column images (that is, the row has been updated to the same value), are replicated to the target table for any tables configured for LiveAudit replication. Applies ToSource
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)
405
Set this parameter to one of the following: v OFFIf a row in a source table is updated to the same value, InfoSphere CDC replicates the value to the target table. v ONIf a row in a source table is updated to the same value, InfoSphere CDC does not replicate the value to the target table. This parameter only affects tables that are configured for LiveAudit replication. For non-audit tables, only updates that change the column data are replicated to the target tables. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
NLS_LANG
Use this system parameter to specify the database character set preceded with a period. For more information about setting this system parameter, see your IBM representative. Applies ToSource and Target Default SettingThe database character set, preceded with a period, corresponding to the language selected when the database was installed. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
TRANSACTION_GROUP_SIZE
Use this system parameter to specify the number of complete transactions applied to the database before InfoSphere CDC issues a commit. Use the TRANSACTION_GROUP_SIZE, TRANSACTION_INTERVAL, and TRANSACTION_RECORDS_THRESHOLDS system parameters together. InfoSphere CDC issues a commit after applying the number of transactions specified by the TRANSACTION_GROUP_SIZE, or when the time interval specified by TRANSACTION_INTERVAL has elapsed. Setting only one of these system parameters without the other can result in uncommitted transactions on the target. Applies ToTarget Default Setting500 Minimum Setting0 Guidelines To increase the throughput, set to a number of transactions that would be received when busy during the TRANSACTION_INTERVAL. Note: Use this parameter only if InfoSphere CDC is running under commitment control. The COMMIT_LEVEL system parameter should be set to2 on the target
406
database, and the MAINTAIN_TRANSACTION_CONSISTENCY system parameter should be set to ON on the source database. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
TRANSACTION_INTERVAL
Use this system parameter to specify the time interval, in seconds, that can elapse between transactions before InfoSphere CDC issues a commit. If there are no transactions received by the target system, then InfoSphere CDC issues a commit immediately. Use this system parameter with the TRANSACTION_GROUP_SIZE system parameter. InfoSphere CDC issues a commit after applying the number of transactions specified by the TRANSACTION_GROUP_SIZE system parameter, or when the time interval specified by TRANSACTION_INTERVAL system parameter has elapsed. Setting only one of these system parameters without the other can result in uncommitted transactions on the target. Applies ToTarget Default Setting1 Minimum Setting0 Guidelines InfoSphere CDC issues a commit only when a commit is received by the target system and you have reached the transaction group size, or exceeded the time interval, or exceeded the records threshold. Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
TRANSACTION_RECORDS_THRESHOLD
Use this system parameter to specify the maximum number of operations within a transaction or group of transactions before InfoSphere CDC issues a commit Applies ToTarget Default Setting3000 Minimum Setting0 Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
TRIM_CHAR_TO_VARCHAR
Use this system parameter to specify whether or not trailing blank characters are trimmed from source columns of CHAR data type when replicating data to target columns of VARCHAR data type.
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)
407
Applies ToTarget Set this parameter to one of the following: v OFFTrailing blanks are not trimmed. v ONTrailing blanks are trimmed. If TRIM_TO_NULL =OFF, InfoSphere CDC inserts a single blank character in the target column. If TRIM_TO_NULL =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference TRIM_TO_NULL
TRIM_VARCHAR_TO_VARCHAR
Use this system parameter to specify whether or not trailing blank characters are trimmed from source columns of VARCHAR data type when replicating data to target columns of VARCHAR data type. Applies ToTarget Set this parameter to one of the following: v OFF--Trailing blanks are not trimmed. v ON--Trailing blanks are trimmed. If TRIM_TO_NULL =OFF, InfoSphere CDC inserts a single blank character in the target column. If TRIM_TO_NULL =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column. Default SettingOFF Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference TRIM_TO_NULL
TRIM_TO_NULL
Use this system parameter to specify how source columns that contain blank characters only are handled during data replication. Applies ToTarget Set this parameter to one of the following: v OFFFor data mapped to VARCHAR columns, trailing blanks are trimmed or not to a single blank depending on the TRIM_CHAR_TO_VARCHAR and TRIM_VARCHAR_TO_VARCHAR system parameters. For data mapped to CHAR columns, setting this parameter to OFF has no effect. v ONFor data mapped to CHAR columns, if the target column is nullable, InfoSphere CDC inserts NULL in the column. For CHAR data mapped to VARCHAR columns, if TRIM_CHAR_TO_VARCHAR =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column. For VARCHAR
408
data mapped to VARCHAR columns, if TRIM_VARCHAR_TO_VARCHAR =ON and the target column is nullable, InfoSphere CDC inserts NULL in the column. If the target column is non-nullable, source columns that contain blank characters only are handled according to the convertNotNullableColumns system parameter. The table below explains how the TRIM_ system parameters affect the data replicated to the target for source columns that contain blank characters only.
TRIM_ parameter settings TRIM_CHAR_ TO_ VARCHAR ON ON OFF OFF ON ON OFF OFF TRIM_ VARCHAR_ TO_ VARCHAR ON OFF ON OFF ON OFF ON OFF TRIM_ TO_ NULL ON ON ON ON OFF OFF OFF OFF Target data CHAR to VARCHAR NULL NULL Source data Source data VARCHAR to VARCHAR NULL Source data NULL Source data Any data type to CHAR NULL NULL NULL NULL Blanks Blanks Blanks Blanks
Single blank Single blank Single blank Source data Source data Source data Single blank Source data
Default SettingOFF Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference TRIM_CHAR_TO_VARCHAR on page 407 TRIM_VARCHAR_TO_VARCHAR on page 408
PREVENT_RECURSION
Use this parameter to indicate whether or not to prevent cascading replication for bi-directional configurations. Applies ToSource Set this parameter to one of the following: v ONChanges applied by InfoSphere CDC are not be replicated back to the source database from where it came from.
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)
409
v OFFChanges made by InfoSphere CDC are replicated, except when filtered out by the CASCADE_OMIT_TARGETS system parameter. Default SettingON Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
REPORT_POSITION_INTERVAL
Use this system parameter to specify how often (in seconds) the source informs the target about its position in the current journal during times of no activity. During times of no activity, when there are no journal entries to be processed pertaining to the current subscription, the source informs the target of its current position so that the target can advance its bookmarks accordingly. By specifying a low setting for this parameter, the target can reflect more accurately how far replication has progressed. Applies ToSource After a shutdown and restart, you can use this system parameter to prevent InfoSphere CDC from rereading entries that do not apply to the current replication configuration. The value of this parameter affects the information that is displayed in progress and bookmark messages. A high value for this parameter may result in information that is not up-to-date being displayed. Default Setting5 Minimum Setting1 Maximum Setting300 Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
410
system parameters to significantly reduce the resources required by the target database. The default settings are appropriate for most databases, but if your target system has limited resources and an increase in latency is acceptable, you can adjust the settings appropriately. See also: COMMIT_GROUP_SIZE COMMIT_INTERVAL on page 412 SYNCHRONIZATION_COMMIT_ GROUP_SIZE on page 412 SYNCHRONIZATION_INTERVAL on page 413
COMMIT_GROUP_SIZE
Use this system parameter to specify the minimum number of rows InfoSphere CDC should apply to the database before a commit is issued. InfoSphere CDC issues a commit on the target when the transaction that contains the rows completes. Use the COMMIT_GROUP_SIZE and COMMIT_INTERVAL system parameters together. InfoSphere CDC issues a commit when either when the number of rows specified by COMMIT_GROUP_SIZE has been applied to the target, or when the time interval specified by COMMIT_INTERVAL has elapsed. Setting only one of these system parameters without the other can result in uncommitted data on the target. Applies ToTarget Default Setting5000 Minimum Setting0. InfoSphere CDC does not use commit groups to apply data to the target. Guidelines Set this parameter to 0 if D_MIRROR_MIRROR_ERROR_STOP on page 405=OFF. If a rollback occurs, InfoSphere CDC rolls back all outstanding rows in the commit group. Since InfoSphere CDC is set to continue on error, you may lose data. Note: Use this parameter only if InfoSphere CDC is not running under commitment control (COMMIT_LEVEL =0). Related concepts System parameters for InfoSphere CDC for Oracle (version 6.2 and below) on page 347 System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference COMMIT_INTERVAL on page 369 COMMIT_LEVEL on page 368 D_MIRROR_MIRROR_ERROR_STOP on page 358 COMMIT_INTERVAL on page 412 D_MIRROR_MIRROR_ERROR_STOP on page 405
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)
411
COMMIT_INTERVAL
Use this system parameter to specify the time interval between commits, in seconds, to limit the number of commits InfoSphere CDC issues on the target database. Use the COMMIT_GROUP_SIZE and COMMIT_INTERVAL system parameters together. InfoSphere CDC issues a commit when either when the number of rows specified by COMMIT_GROUP_SIZE has been applied to the target, or when the time interval specified by COMMIT_INTERVAL has elapsed. Setting only one of these system parameters without the other can result in uncommitted data on the target. When the COMMIT_INTERVAL time expires, InfoSphere CDC issues a commit on the target database for transactions that completed within that time interval. Applies ToTarget Default Setting60 Minimum Setting0. InfoSphere CDC issues a commit on a target database for each completed transaction. Guidelines Set this parameter to 0 if D_MIRROR_MIRROR_ERROR_STOP on page 405=OFF. If a rollback occurs, InfoSphere CDC rolls back all outstanding rows in the commit group. Since InfoSphere CDC is set to continue on error, you may lose data. Note: Use this parameter only if InfoSphere CDC is not running under commitment control (COMMIT_LEVEL =0). Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference COMMIT_GROUP_SIZE on page 411 D_MIRROR_MIRROR_ERROR_STOP on page 405
SYNCHRONIZATION_COMMIT_ GROUP_SIZE
Use this system parameter to specify the number of transactions applied to the database before InfoSphere CDC performs synchronization between the source and target. Applies ToSource The SYNCRONIZATION_COMMIT_GROUP_SIZE and SYNCHRONIZATION_INTERVAL system parameters are intended to be used together. Synchronization occurs either when the number of transactions (specified by SYNCRONIZATION_COMMIT_GROUP_SIZE) have been applied or when the time interval (specified by SYNCHRONIZATION_INTERVAL) has elapsed, whichever comes first. Default Setting128
412
Minimum Setting0. InfoSphere CDC does not use commit groups to perform synchronization. Maximum Setting2,147,483,648 (maximum integer) DynamicYes Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference SYNCHRONIZATION_INTERVAL
SYNCHRONIZATION_INTERVAL
Use this system parameter to specify the interval, in seconds, at which synchronization is performed between the source and target. Synchronization is achieved when the target reports to the source the position of the last committed change. Applies ToSource The SYNCRONIZATION_INTERVAL and SYNCHRONIZATION_COMMIT_ GROUP_SIZE system parameters are intended to be used together. Synchronization occurs either when the number of transactions (specified by SYNCHRONIZATION_COMMIT_ GROUP_SIZE ) have been applied or when the time interval (specified by SYNCRONIZATION_INTERVAL) has elapsed, whichever comes first. Default Setting1 Minimum Setting1 Maximum Setting300 DynamicYes Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference SYNCHRONIZATION_COMMIT_ GROUP_SIZE on page 412
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)
413
D_MIRROR_TRACE
Use this system parameter to indicate whether or not tracing is enabled. Applies ToSource and Target Set this parameter to one of the following: v OFFTracing is disabled. This setting has no effect when D_MIRROR_TRACE_ON_ERROR=ON. v ONTracing is enabled and InfoSphere CDC creates the appropriate trace files in the log directory. These trace files are encrypted, and are meant to be sent to IBM technical support for troubleshooting purposes. When enabling this setting, also set the size of the trace file to an appropriate value using the D_MIRROR_TRACE_FILE_SIZE system parameter. To avoid disk space problems, IBM recommends setting the size of the trace file to a value that is not too high. Default SettingOFF DynamicYes Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference D_MIRROR_TRACE_FILE_SIZE
D_MIRROR_TRACE_FILE_SIZE
Use this system parameter to specify the maximum size of a trace file in bytes. InfoSphere CDC creates two trace files. When the first trace file reaches its maximum size, InfoSphere CDC creates a second file. When the second trace file reaches its maximum size, InfoSphere CDC starts overwriting the first file. Applies ToSource and Target Default Setting10,000,000 bytes Minimum Setting1,000,000 bytes Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
D_MIRROR_TRACE_ON_ERROR
Use this system parameter to specify whether or not InfoSphere CDC enables tracing automatically when an error occurs. Applies ToSource and Target Set this parameter to one of the following: v OFFInfoSphere CDC does not enable tracing when an error occurs.
414
v ONInfoSphere CDC enables tracing when an error occurs. InfoSphere CDC creates the appropriate trace files in the InfoSphere CDC log directory. These trace files are encrypted, and are meant to be sent to IBM technical support for troubleshooting purposes. When enabling this setting, also set the size of the trace file to an appropriate value using the D_MIRROR_TRACE_FILE_SIZE system parameter. To avoid disk space problems, IBM recommends setting the size of the trace file to a value that is not too high. Default SettingOFF DynamicYes (on the target only) Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference D_MIRROR_TRACE_FILE_SIZE on page 414
convertNotNullableMsg
Use this system parameter to indicate whether or not a warning message will be generated in Event Log each time data that contains NULL values is converted to default values for non-nullable target columns. Applies ToTarget This system parameter applies only when convertNotNullableColumns=ON. Otherwise, this parameter has no effect. Set this parameter to one of the following: v OFFNo warning message is generated in Event Log. v ONA warning message is generated in Event Log each time a NULL value is converted to a default value. Default SettingOFF Related concepts
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)
415
System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference convertNotNullableColumns on page 317 DM_STATUS_INTERVAL on page 330 Heartbeat Timeout on page 331 InvalidNumericMsg on page 331
DEADBAND_PERCENTAGE
Applies ToTarget Identifies the size of the range around each latency threshold setting. Based on latency thresholds defined, a latency message is generated when latency has risen above or fallen below a threshold. Latency is calculated at regular intervals, where the interval is the current setting for the MONITOR_SAMPLE_INTERVAL system parameter. You can set notifications in response to a generated latency message. This system parameter, which is expressed as a percentage, allows you to pad a threshold equally on both sides to create a range around the threshold. By adjusting this system parameter, the size of the range around the threshold can be increased or decreased, and the threshold itself can be made thicker or thinner. A latency message is generated only when latency has risen above the upper limit of the range or fallen below the lower limit of the range. By changing the value assigned to this system parameter, you can control the number of latency messages placed in Event Log. For example, assume that a latency threshold is 5 minutes and this system parameter is set to 10. A 10% range is applied around the 5 minute threshold. The following calculations are performed to determine the lower and upper limits (in minutes) of the range around the threshold: v Padding = 10% of 5 minutes = 0.5 minutes (rounded up to 1 minute) v Padding is rounded up or down to the nearest whole minute: Upper limit of range = 5 minutes + 1 minute (padding) = 6 minutes Lower limit of range = 5 minutes - 1 minute (padding) = 4 minutes As a result, a latency message will be generated only when latency rises above 6 minutes or falls below 4 minutes. Given sample latency over a ten minute period where latency is calculated every minute, three latency messages are generated. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 10%:
416
If this DEADBAND_PERCENTAGE is set to 3 (the default setting) for the same example, no padding is applied to the latency threshold. Therefore, a latency message is generated each time latency crosses over the latency threshold of 5 minutes. Based on the same sample latency in the previous graph where latency is calculated every minute, five latency messages are generated when this system parameter is set to 3. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 3%:
If the number of latency messages generated over the ten minute period for the 10% (3 latency messages) and 3% (5 latency messages) settings are averages, an additional 288 latency messages would be generated each day if this system parameter is not changed from its default setting to 10%.
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)
417
Since there are two latency thresholds that you can set (a warning threshold and a problem threshold), two separate ranges are defined when padding is at least one minute. In this case, each range is attached to its threshold, and the two ranges can overlap with no change in behavior. If a value outside the acceptable range is specified, the default setting is used. Default Setting3% Minimum Setting3% Maximum Setting10% Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Setting latency thresholds and notifications on page 78 Disk resource system parameters on page 420
DM_STATUS_INTERVAL
Use this system parameter to specify how often progress messages should be issued in seconds. These messages are displayed in Event Log to indicate how replication is advancing and to provide detailed information about InfoSphere CDC replication activities. Applies ToSource and Target Note: Low values of this parameter may result in many messages displayed in Event Log. In this situation, clear Event Log on a regular basis. Default Setting0 seconds. No progress notifications will be issued. Minimum Setting0 seconds. No progress notifications will be issued. Maximum Setting7200 seconds Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
HEARTBEAT_TIMEOUT
Use this parameter to specify the number of minutes of communication inactivity to wait before active InfoSphere CDC processes for a subscription are stopped. Heartbeat is a feature that manages InfoSphere CDC processes when a problem with communications or a process has been detected through the absence of communications over a specified period of time. For each active subscription, internal heartbeat messages are sent regularly between the source and the target to determine communications and process status. If a reply to a message is not received by the source or target within the specified timeout interval, then InfoSphere CDC determines that a problem has occurred, and attempts to stop all its source and target processes for the subscription. In addition, messages (message identifiers 2612 and 3165) are placed in Event Log when heartbeat timeouts occur.
418
Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Displaying event messages during replication on page 232
LOG_EMAIL_USERNAME
Use this system parameter to specify the user name that receives email messages in response to invoking the dmreadlog command or the warning message that is generated when Event Log exceeds the threshold value set by the LOG_MAX_SIZE system parameter. Applies ToSource and Target In UNIX environments, the value assigned to this parameter is a comma-separated list of user names. The value of this parameter cannot exceed 30 bytes in length. To suppress all email messages, set this parameter to NOMAIL. Default SettingThe InfoSphere CDC account (UNIX user) specified when InfoSphere CDC was installed Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Related reference STATISTICS_INTERVAL on page 420
MONITOR_SAMPLE_INTERVAL
Use this system parameter to identify the period of time, in seconds, between consecutive updates to a storage area that is used to maintain replication latency metrics. Management Console references this area to present replication latency information. Applies ToSource and Target On the target, this setting also represents how often the storage area is sampled to determine whether or not latency has risen above or fallen below specified threshold settings. InfoSphere CDC generates latency messages when latency rises above or falls below the thresholds. In response to a generated message, you can set latency notifications. If a value smaller than the minimum setting is specified, the minimum setting is used. If a value larger than the maximum setting is specified, the maximum setting is used. Default Setting5 seconds
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)
419
Minimum Setting0 seconds. Replication latency metrics are not updated. Maximum Setting3600 seconds Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399 Setting latency thresholds and notifications on page 78
STATISTICS_INTERVAL
Use this system parameter to specify how often, in seconds, InfoSphere CDC issues messages that contain statistics information. These messages are displayed in Event Log. Applies ToSource and Target Note: Use this parameter only if advised by IBM technical support. Default Setting0. InfoSphere CDC does not provide statistics information. Minimum Setting0. InfoSphere CDC does not provide statistics information. Maximum Setting2,147,483,647 (maximum integer) DynamicYes Related concepts System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
LOG_MAX_SIZE
Use this system parameter to specify the threshold size of Event Log in KB. A warning message is generated in Event Log when its size exceeds specified threshold. The messages in Event Log are deleted automatically when the size of Event Log is ten times the value specified by this parameter. Applies ToSource and Target If you do not want to specify a threshold size, set this parameter to NOMAX. Default Setting5000 Related concepts
420
System parameters for InfoSphere CDC for Sybase (version 6.0 and below) on page 399
D_HOME_BCP
Use this system parameter to specify the directory where InfoSphere CDC will place a BCP log file. The log file contains the statements that were used to re-create the indexes after the BCP operation was completed. Applies ToTarget Default Settingthe directory specified by the D_MIRROR_LOG system parameter.
D_MIRROR_BCP
Use this system parameter to indicate if BCP refresh operations are enabled. Under BCP, a block of data is accumulated and applied to target tables in a single operation. InfoSphere CDC accumulates records on the Sybase server, and then performs a bulk copy when the block contains a specific number of records. Applies ToTarget Set this parameter to one of the following: v ONInfoSphere CDC uses the Sybase Bulk Copy (BCP) library to perform data refresh. The bulk copy is generally faster. However, all updates performed under BCP cannot be reversed. v OFFInfoSphere CDC uses SQL inserts to perform data refresh. This setting lets InfoSphere CDC roll back the previous copy operation. Default SettingON Note: To enable InfoSphere CDC to refresh target tables using BCP, make sure that this parameter is set to ON, and that D_MIRROR_FASTBCP is set to OFF. If D_MIRROR_FASTBCP is set to ON as well, then fast BCP refresh is enabled.
D_MIRROR_BCP_ROWS
Use this system parameter to specify the number of rows that the server will buffer before InfoSphere CDC commits to the database in a single operation.You need to
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)
421
consider the amount of storage available to buffer rows. For example, to copy blocks of 500 rows to target tables, you would set D_MIRROR_BCP_ROWS to a value of 500. Applies ToTarget Default Setting50000 rows. If the system parameter D_MIRROR_BCP is set to OFF or if D_MIRROR_BCP_ROWS is set to a negative number, then the server will buffer 50000 rows before InfoSphere CDC commits these blocks to target tables. Note: If you specify a value of zero, then the server will buffer all the rows in the table before committing data to the database.
D_MIRROR_FASTBCP
Use this system parameter to enable or disable fast BCP refresh operations. Fast BCP applies records in blocks, but provides better performance than BCP. Applies ToTarget Set this parameter to one of the following: v ONenables InfoSphere CDC to apply records to target tables using fast BCP. When you enable this parameter, InfoSphere CDC removes all indexes from the target table, loads the data into the table, and then rebuilds the indexes. If InfoSphere CDC cannot rebuild the indexes because of an error (for example, a duplicate value encountered in a unique index) then InfoSphere CDC generates an error in the Event Log and the command to rebuild the index is saved in a file in the log directory. You must also set the D_MIRROR_BCP system parameter to ON to enable fast BCP. v OFFdisables InfoSphere CDC from using fast BCP. Default SettingOFF
DM_BCP_PACKET_SIZE
Use this system parameter to specify the length (bytes) of the network packets you want InfoSphere CDC to send to the Sybase server when a BCP refresh is enabled. The value of this parameter impacts the speed at which the load of data will occur. You should specify network packet sizes larger than the default to improve the performance of BCP refresh operations. Applies ToTarget Default Setting512 bytes Minimum Setting512 bytes Maximum Setting65535 bytes Note: The number of bytes cannot be greater than the maximum network packet size value you have specified for the Sybase database. While Sybase documentation states that this is a negotiated value, the connection will fail if the size specified for this system parameter is larger than the Sybase database setting. Therefore, the maximum value for the Sybase database should be set to a value that allows large packet sizes.
422
For more information about the Sybase configuration variables related to network communication, see your Sybase documentation.
System parameters for InfoSphere CDC for Sybase (version 6.0 and below)
423
424
System parameters for InfoSphere CDC for Sybase (version 6.3 and above)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Note: If you make changes to a system parameter during active replication, you must stop and restart replication for the changes to take effect. In this section, you will learn: Notification system parameters Maximize throughput system parameters on page 426 Encoding system parameters on page 428 Disk resource system parameters on page 429 Apply process system parameters on page 431 Supplemental logging system parameters on page 342
events_max_retain
Use this system parameter when you want InfoSphere CDC to refresh a target table that contains multibyte object names. Set this parameter to one of the following: v trueInfoSphere CDC will not refresh the target table that contains multibyte object names. v falseInfoSphere CDC will refresh a target table that contains multibyte object names. Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above)
425
global_shutdown_after_no_heartbeat_response_minutes
Use this system parameter to specify the duration, in minutes, of communication inactivity before active InfoSphere CDC processes for a subscription are stopped. If a value outside the acceptable range is specified, the default setting is used. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
global_conversion_not_possible_warning
Use this system parameter to control whether or not InfoSphere CDC generates a warning in the Management Console Event Log in the following situations: v Data conversion is not possible for a specific data value. v Converted data types are encountered that are out of range. Set this parameter to one of the following: truegenerates a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. falsedoes not generate a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. Applies ToTarget Default SettingFalse Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
426
global_max_batch_size
Use this system parameter to specify the maximum number of rows that InfoSphere CDC can place in an array and apply to the target database during refresh or mirroring. InfoSphere CDC collects rows and places them in an array (in memory) while receiving table-level operations from the source system. InfoSphere CDC applies the rows from the array when there is a change to a different table, when there is a new table-level operation, or when the maximum number of rows in an array has been reached. You can use this parameter during mirroring only if mirror_end_on_error is true and mirror_expected_errors_list is empty. Use only during a refresh if refresh_end_on_error is true and refresh_expected_errors_list is empty. Before InfoSphere CDC places rows into an array, it allocates memory for the maximum number of rows you specify and multiplies this integer by the maximum length of a row. If the maximum number of rows is too large, then InfoSphere CDC cannot allocate enough memory and will shut down. Management Console references this area to present replication latency information. Applies ToTarget InfoSphere CDC for Sybase Default Setting25 rows Minimum Setting1 row
mirror_commit_on_transaction_boundary
This system parameter indicates whether or not the commits that InfoSphere CDC does on the target database will always correspond with a commit that occurred on the source database. If you choose to ignore the commitment control of the source database, InfoSphere CDC allows you to see the partial results of large transactions. Set this parameter to one of the following: v trueDoes not ignore the commitment control of the source database. Only records in a committed transaction are mirrored to the target. This setting provides true transaction consistency by ensuring that only committed transactions are sent to the target. v falseIgnores the commitment control of the source database. This value disables commitment control for transaction processing. No attempt to maintain transaction consistency is performed during mirroring. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
System parameters for InfoSphere CDC for Sybase (version 6.3 and above)
427
refresh_commit_after_max_operations
This system parameter identifies the number of rows comprising each transaction during refresh. To reduce the workload on the target database during refresh, InfoSphere CDC periodically commits the changes to the target database rather than performing the refresh as a single large transaction. Applies ToTarget Default Setting1000 Minimum Setting1 Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
global_unicode_as_char
This system parameter indicates the default method of treating data in defined Unicode columns. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Set this parameter to one of the following: v trueInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v falseInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain non-single-byte character data. Setting this system parameter to false ensures that InfoSphere CDC handles non-single-byte character data in the same way as previous InfoSphere CDC releases. Note: Setting this parameter to false does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may have to apply user exit programs or other customization to properly represent data in Unicode columns. For more information about user exit programs, see the InfoSphere CDC End-User Documentation for your platform. Applies ToSource Default Settingfalse
428
Note: The following SQL Server data types are considered to be Unicode columns and are therefore affected by the value assigned to this system parameter: v nchar v nvarchar Related concepts System Parameters for InfoSphere CDC for Microsoft SQL Server (version 6.0 and above) on page 337 Setting system parameters on source and target datastores on page 60 Setting multibyte conversionscommon scenarios on page 175 System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
global_memory_lob_cache_mb
This system parameter controls the amount of memory that will be used to stage LOB values on the target. For optimal performance, this value should be large enough to hold the entire data for the largest LOB values that will be replicated. Default Setting2 Megabytes Applies ToTarget Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
mirror_global_disk_quota_mb
Use this system parameter to globally set a disk quota (in MB) for all capture components (including temporary files, transaction queues, staging stores, and operation queues). InfoSphere CDC will manage disk space utilization across all components as required. Applies ToSource and Target Default Setting0
System parameters for InfoSphere CDC for Sybase (version 6.3 and above)
429
MaximumNone MinimumNone Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
mirror_memory_txqueue_each_mb
This system parameter controls the amount of memory used to stage data on the source. For optimal performance, this system parameter should be large enough to hold the data for the largest transactions that occur on the source. Applies ToSource Default Setting3 Megabytes Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
mirror_memory_txqueue_total_mb
This system parameter controls the amount of memory used to stage data on the source. For optimal performance, this system parameter should be large enough to hold the largest amount of uncommited data that will ever exist in the source database. Applies ToSource Default Setting15 Megabytes Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
mirror_queue_for_buffers_between_cdc_threads_operations
Use this system parameter to set the capacity of InfoSphere CDC queues to store captured changes. The capacity is measured by the number of operations you want the queue to be able to store. This includes insert, update, and delete operations. Applies ToSource Default Setting7 database operations Maximum2 63-1 =9223372036854775807 operations Minimum1 database operation Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
430
convert_not_nullable_column
Use this system parameter to specify whether or not InfoSphere CDC should strip or leave trailing blanks on string data of the column in the target table. Set this parameter to one of the following: v v trueInfoSphere CDC strips the data of trailing blanks. falseInfoSphere CDC does not strip the string data of trailing blanks.
Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
mirror_end_on_error
Use this system parameter to indicate if you want to end mirroring after an apply error occurs on the target database. Set this parameter to one of the following: v trueEnd mirroring after an apply error on the target database. v falseDo not end mirroring after an apply error on the target database. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
refresh_end_on_error
Use this system parameter to indicate if you want to end a refresh after an apply error occurs.
System parameters for InfoSphere CDC for Sybase (version 6.3 and above)
431
Set this parameter to one of the following: v trueEnd a refresh after an apply error occurs. v falseDo not end a refresh after an apply error occurs. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
userexit_max_lob_size_kb
Use this system parameter to set the maximum size of LOB data (in kb) that InfoSphere CDC can pass to a user exit. Applies ToTarget Default Setting128 kb MaximumNone MinimumNone Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
mirror_expected_errors_list
Use this system parameter when you want InfoSphere CDC to ignore specific database errors when applying data changes to the target during mirroring. You must specify the errors in a comma separated list. Applies ToTarget Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
refresh_expected_errors_list
Use this system parameter when you want InfoSphere CDC to ignore specific database errors when refreshing data to the target. You must specify the errors in a comma separated list. Applies ToTarget Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
432
trim_char_to_varchar
Use this system parameter to specify whether or not InfoSphere CDC should pad string data with trailing blanks to the length of the column in the target table. Set this parameter to one of the following: v trueInfoSphere CDC does not pad the string data with trailing blanks. v falseInfoSphere CDC pads the string data with trailing blanks. Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
trim_varchar_to_varchar
Use this system parameter to specify whether or not InfoSphere CDC should strip or leave trailing blanks on string data of the column in the target table. Set this parameter to one of the following: v trueInfoSphere CDC strips the data of trailing blanks. v falseInfoSphere CDC does not strip the string data of trailing blanks. Applies ToTarget Default Settingfalse Related concepts System parameters for InfoSphere CDC for Sybase (version 6.3 and above) on page 425
auto_configure_supplemental_logging
Use this system parameter to specify how supplemental logging is performed. Set this parameter to one of the following: v trueInfoSphere CDC uses the value generated by the mirror_logging_by_empty_triggers system parameter. v falseIf the table is being replicated, InfoSphere CDC does not take any action as this will enable supplemental logging. If the Replication Server is being used, a fake replication subscription is created to signal to ASE that it must write supplementary information necessary for data replication
System parameters for InfoSphere CDC for Sybase (version 6.3 and above)
433
mirror_logging_by_empty_triggers
Use this system parameter to choose empty triggers as your supplemental logging method for Sybase. InfoSphere CDC only uses this system parameter if auto_configure_supplemental_logging is set to true. Set this parameter to one of the following: v true InfoSphere CDC uses an empty trigger as your supplemental logging method for Sybase. v falseYou must create your own triggers in the Sybase database. Applies ToSource Default Settingtrue
434
System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with InfoSphere CDC replication configuration. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Notes: v If you make changes to a system parameter during active replication, you must stop and restart replication to for the changes to take effect. v When upgrading to a higher version of InfoSphere CDC, any preexisting settings for system parameters are maintained. In this section, you will learn: General product system parameters Replication system parameters on page 437 Cascading replication system parameters on page 439 Database journal (trigger) system parameters on page 440 Remote journal system parameters on page 442 Commitment control system parameters on page 443 Multibyte character set system parameters on page 444 Latency system parameters on page 445 Notification system parameters on page 447 Data type system parameters on page 450 Date and time column function system parameters on page 450 Row and column filtering system parameters on page 451 Event log system parameters on page 452 Lock detection system parameters on page 453
435
Authorization Code
Use this system parameter to adjust the authorization code issued by IBM. You may need to modify your authorization code when: v Moving from a temporary license to a permanent license v Machine classes have changed v Upgrading to a new version of InfoSphere CDC Applies ToSource and Target Note: You can also modify the authorization using the Authorization Code Setup utility Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435
Startup Timeout
For information about setting this system parameter, see your IBM representative. Applies ToSource and Target
436
Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435
TCP_KEEPALIVE_SECS
Use this system parameter to determine the time (in seconds) InfoSphere CDC waits before sending a keep alive notification over the network. During idle periods, InfoSphere CDC sends a keep alive notification to keep the connection open. Applies ToSource and Target Default Setting300 seconds (5 min) Minimum Setting0 Guidelines It is important you set this system parameter when you have a firewall connection that has been configured to timeout. This prevents the firewall from closing the connection. To set this system parameter, do the following: 1. Create a data area named DMCOMMS by issuing the following command: CRTDTAARA DTAARA(<InfoSphere CDC product library>/DMCOMMS) TYPE(*CHAR) LEN(2000) 2. Set the timeout value by issuing the following command: CHGDTAARA DTAARA(<InfoSphere CDC product library>/DMCOMMS (521 10)) VALUE(<value>) where value is a 10-digit number that represents the setting for this system parameter. For example, to set to 1 minute, issue:
CHGDTAARA DTAARA(DMIRROR/DMCOMMS (521 10)) VALUE(0000000060)
To prevent the firewall from closing during active data replication, set this parameter to a value lower than the configured firewall timeout. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435
437
438
Default Setting*YES Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435
439
System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435
440
Synchronization Interval
Use this system parameter to set how often (in seconds) InfoSphere CDC performs log synchronization between the source and the target. Synchronization is achieved when the source reports to the target the position of the last committed change. Applies ToSource Default Setting60 seconds Minimum Settings1 second Maximum Settings3000 seconds (50 minutes) Guidelines If you are replicating large volumes of data, set this system parameter to a lower number of seconds to remove obsolete logs more frequently.
System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)
441
Note: If a value outside the acceptable range is specified, the default setting is used. Related concepts System parameters for InfoSphere CDC for Microsoft SQL Server (version 5.3 and below) on page 313 Setting system parameters on source and target datastores on page 60 System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435
442
Default Setting0 GuidelinesYou must enable the Data Origin TCP/IP Name system parameter to either the IP address or the hostname of the InfoSphere CDC/400 Data Origin Server for this system parameter to take affect.
Commitment Control
Use this system parameter to enable or disable InfoSphere CDC from using commitment control. Enabling commitment control maintains transaction consistency during replication and ensures that all transactions are applied to the target system. If there is a communications or server failure, and you have enabled this system parameter, then InfoSphere CDC rolls back the partially applied transaction to the last commit. For more information about commitment control, see Considerations for Commitment Control (*LEVEL1) in InfoSphere CDC for AS/400 Commands Reference. Applies ToTarget The Commitment Control system parameter can be set to *NONE or *LEVEL1: v *NONEDisables commitment control for transaction processing. InfoSphere CDC does not maintain transaction consistency during replication and in the event of a communications or server failure. To ensure consistency across different platforms and previous releases of InfoSphere CDC, disabling commitment control is the default setting for this parameter. v *LEVEL1Enables InfoSphere CDC to use commitment control against the target system after applying all rows. This setting provides true transaction consistency by ensuring that entire transactions are committed to the target database even in the event of a communications or server failure. Default Setting*NONE
System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)
443
Guidelines If you select *LEVEL1, you must disable the system parameter Refresh While Active on the source. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435 Related reference Allow Refresh While Active on page 438
Unicode Handling
Use this system parameter to indicate the default method of treating data in defined Unicode columns. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Applies ToSource The following DB2 UDB for iSeries data types are considered to be Unicode columns and are affected by the value assigned to this system parameter: v GRAPHIC or VARGRAPHIC with code page 1208 (UTF-8) v CHARACTER or VARCHAR with code page 1208 (UTF-8) This system parameter is set to either CHAR or NOCHANGE: v CHARInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v NOCHANGEInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain non-single-byte character data. NOCHANGE ensures InfoSphere CDC will handle non-single-byte character data in the same way as previous InfoSphere CDC releases. Default SettingNOCHANGE Note: NOCHANGE does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may need to apply user exit programs or other customization to properly represent the data in Unicode columns. For more information about user exit programs, see the InfoSphere CDC for AS/400 User Exits Guide. Related concepts
444
System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435 Related tasks To set handling for Unicode character encodings on page 177
Deadband Percentage
Applies ToTarget Identifies the size of the range around each latency threshold setting. Based on latency thresholds defined, a latency message is generated when latency has risen above or fallen below a threshold. Latency is calculated at regular intervals, where the interval is the current setting for the MONITOR_SAMPLE_INTERVAL system parameter. You can set notifications in response to a generated latency message. This system parameter, which is expressed as a percentage, allows you to pad a threshold equally on both sides to create a range around the threshold. By adjusting this system parameter, the size of the range around the threshold can be increased or decreased, and the threshold itself can be made thicker or thinner. A latency message is generated only when latency has risen above the upper limit of the range or fallen below the lower limit of the range. By changing the value assigned to this system parameter, you can control the number of latency messages placed in Event Log. For example, assume that a latency threshold is 5 minutes and this system parameter is set to 10. A 10% range is applied around the 5 minute threshold. The following calculations are performed to determine the lower and upper limits (in minutes) of the range around the threshold: v Padding = 10% of 5 minutes = 0.5 minutes (rounded up to 1 minute) v Padding is rounded up or down to the nearest whole minute: Upper limit of range = 5 minutes + 1 minute (padding) = 6 minutes Lower limit of range = 5 minutes - 1 minute (padding) = 4 minutes As a result, a latency message will be generated only when latency rises above 6 minutes or falls below 4 minutes. Given sample latency over a ten minute period where latency is calculated every minute, three latency messages are generated. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 10%:
System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)
445
If this DEADBAND_PERCENTAGE is set to 3 (the default setting) for the same example, no padding is applied to the latency threshold. Therefore, a latency message is generated each time latency crosses over the latency threshold of 5 minutes. Based on the same sample latency in the previous graph where latency is calculated every minute, five latency messages are generated when this system parameter is set to 3. This graph illustrates latency message generation with the DEADBAND_PERCENTAGE value set to 3%:
If the number of latency messages generated over the ten minute period for the 10% (3 latency messages) and 3% (5 latency messages) settings are averages, an additional 288 latency messages would be generated each day if this system parameter is not changed from its default setting to 10%.
446
Since there are two latency thresholds that you can set (a warning threshold and a problem threshold), two separate ranges are defined when padding is at least one minute. In this case, each range is attached to its threshold, and the two ranges can overlap with no change in behavior. If a value outside the acceptable range is specified, the default setting is used. Default Setting3% Minimum Setting3% Maximum Setting10% Note: If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435
447
Messages on Column Not Null Capable Messages on Invalid Numerics on page 449 Progress Status Interval on page 449
Heartbeat Timeout
Use this system parameter to increase or decrease the communication timeout interval (in minutes) before InfoSphere CDC detects a communication problem and attempts to stop active replication processes. InfoSphere CDC sends internal heartbeat notifications between the source and target systems to verify communications and the status of replication processes for each active subscription. If the source or target do not receive a reply to a notification within the specified timeout interval, then InfoSphere CDC determines that a problem has occurred and attempts to stop all its source and target processes for each active subscription. InfoSphere CDC places notifications (message identifiers DMU3165 and DMU0647) in the Event Log when a heartbeat timeout occurs. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Note: If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435
448
System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435
Applies ToSource and Target Default Setting0 seconds. No progress messages are issued. Minimum Setting0 seconds Maximum Setting7200 seconds
System parameters for InfoSphere CDC for AS/400 (version 6.2 and below)
449
Notes: v InfoSphere CDC places progress notifications in the Event Log. v If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435
450
The Default Date On Error system parameter can be set to *NEW or *OLD: v *NEWReturns the date 1901-01-01. v *OLDReturns the date 0001-01-01. Default Setting*NEW Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435 Related reference Date conversion%TODATE on page 275
451
v The listed default setting (*YES) applies only to new InfoSphere CDC installations on an iSeries server. The default setting for InfoSphere CDC upgrades is *NO. This setting maintains existing InfoSphere CDC behavior prior to support for this system parameter. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435 About journal control fields on page 245
452
453
Default Setting30 seconds Minimum Setting2 seconds Maximum Setting60 seconds Notes: v If a table or row is locked, InfoSphere CDC waits for a specified timeout period to expire before attempting to apply data again. v If you set a value outside the acceptable range, then InfoSphere CDC uses the defaults. Related concepts System parameters for InfoSphere CDC for AS/400 (version 6.2 and below) on page 435
454
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and target datastores. Note: If you make changes to a system parameter during active replication, you must stop and restart replication for the changes to take effect. When upgrading to a higher version of InfoSphere CDC, any pre-existing settings for system parameters are maintained. In this section, you will learn: General product system parameters Access Server system parameters on page 458 Cascading replication system parameters on page 461 Commitment control system parameters on page 461 Database translation log system parameters on page 464 Fastload system parameters on page 465 Latency system parameters on page 468 Lock detection system parameters on page 469 Multibyte character set system parameters on page 470 Notification system parameters on page 471 Replication system parameters on page 472 Tracing system parameters on page 474 Teradata TPump system parameters on page 475
455
log_total_quota on page 457 md_db_url on page 457 md_schema on page 457 scrape_timeout on page 457 startup_timeout on page 457 target_assert on page 458 target_debug on page 458 target_initial_codepage on page 458 ts_password on page 458 ts_product on page 458 use_uni_listener on page 458
audit_auth_ code
This system parameter identifies the authorization code used to enable the LiveAudit feature in InfoSphere CDC. When assigning the authorization code to this system parameter, authorization codes are case-sensitive; therefore, the code assigned to this parameter must be identical to the one obtained from IBM. Applies ToSource and Target for InfoSphere CDC for PointBase and InfoSphere CDC for DB2 UDB Does Not Apply ToInfoSphere CDC for Teradata Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
auth_ code
This system parameter identifies the authorization code that is required to replicate and receive data with InfoSphere CDC. When assigning the authorization code to this system parameter, authorization codes are case-sensitive; therefore, the code assigned to this parameter must be identical to the one obtained from IBM. Applies ToSource and Target for InfoSphere CDC for PointBase and InfoSphere CDC for DB2 UDB Does Not Apply ToInfoSphere CDC for Teradata Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
db_password
For information about setting this system parameter, see your IBM representative.
db_user
For information about setting this system parameter, see your IBM representative.
456
debug
For information about setting this system parameter, see your IBM representative.
engine_ port
This system parameter identifies the port number on the server that is being used for communications with client workstations running Management Console and other replication servers. This port number was specified during InfoSphere CDC installation. It can be changed by modifying this system parameter or using the Change Listener Port utility. For more information about this utility, see the appropriate InfoSphere CDC installation and user manual. The port number that you specify must be unused, and the same port number cannot be used for any other application installed on the same server. Applies ToSource and Target for InfoSphere CDC for DB2 UDB, Target only for InfoSphere CDC for Teradata and InfoSphere CDC for PointBase Default Setting11111 Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
log_file_quota
For information about setting this system parameter, see your IBM representative.
log_total_quota
For information about setting this system parameter, see your IBM representative.
md_db_url
For information about setting this system parameter, see your IBM representative.
md_schema
For information about setting this system parameter, see your IBM representative.
scrape_timeout
For information about setting this system parameter, see your IBM representative.
startup_timeout
This system parameter specifies the maximum waiting period, in seconds, for process handling to complete during InfoSphere CDC startup. This system parameter indicates how long the communication module waiInfoSphere CDC for the database initialization program to start before timing out.
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)
457
Applies ToSource and Target for InfoSphere CDC for DB2 UDB and InfoSphere CDC for PointBase, Target only for InfoSphere CDC for Teradata Default Setting120 seconds Minimum Setting60 seconds Maximum Setting3,600 seconds Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
target_assert
For information about setting this system parameter, see your IBM representative.
target_debug
For information about setting this system parameter, see your IBM representative.
target_initial_codepage
For information about setting this system parameter, see your IBM representative.
ts_password
For information about setting this system parameter, see your IBM representative.
ts_product
For information about setting this system parameter, see your IBM representative.
use_uni_listener
For information about setting this system parameter, see your IBM representative.
458
agent_msg_resources_file on page 460 agent_src_engine_address on page 460 agent_src_engine_port on page 460 agent_src_engine_socket_tmout on page 460 agent_trace_in_message on page 460 agent_trace_out_message on page 460 agent_udp_ listenport on page 460
accessserver_udp_ listenport
This system parameter identifies the UDP listener port number used by Access Server to receive auto-discovery broadcast InfoSphere CDC from different datastores in your configuration. The port number that you specify must not already be in use on the client workstation, and must be the same port number specified in Management Console when logging on. If the port number is changed on a client workstation running Management Console, this system parameter must be set to the updated port number. Applies ToSource and Target for InfoSphere CDC for DB2 UDB, Source only for InfoSphere CDC for PointBase, Target only for InfoSphere CDC for Teradata Default Setting10101 Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
agent_assert
For information about setting this system parameter, see your IBM representative.
agent_debug
For information about setting this system parameter, see your IBM representative.
agent_jdbcdb2_driver
For information about setting this system parameter, see your IBM representative.
agent_jdbcdb2_driver_net
For information about setting this system parameter, see your IBM representative.
agent_jdbcpb_driver
For information about setting this system parameter, see your IBM representative.
agent_jdbcpb_driver_net
For information about setting this system parameter, see your IBM representative.
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)
459
agent_max_connections_num
For information about setting this system parameter, see your IBM representative.
agent_message_version
For information about setting this system parameter, see your IBM representative.
agent_msg_resources_file
For information about setting this system parameter, see your IBM representative.
agent_src_engine_address
For information about setting this system parameter, see your IBM representative.
agent_src_engine_port
For information about setting this system parameter, see your IBM representative.
agent_src_engine_socket_tmout
For information about setting this system parameter, see your IBM representative.
agent_trace_in_message
For information about setting this system parameter, see your IBM representative.
agent_trace_out_message
For information about setting this system parameter, see your IBM representative.
agent_udp_ listenport
This system parameter identifies the port number on the replication server used by the UDP listener for auto-discovery broadcasts sent from Access Server. The port number that you specify must be unique. Applies ToSource and Target for InfoSphere CDC for DB2 UDB and InfoSphere CDC for PointBase, Target only for InfoSphere CDC for Teradata Default Setting2222 Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
460
cascade_replication
This system parameter indicates whether or not replicated data received from the source can be replicated (or cascaded) to other servers. This system parameter is set on the server that receives replicated data and can cascade the data to one or more other servers. It is applicable when implementing cascading replication. Applies ToSource for InfoSphere CDC for DB2 UDB, Source and Target for InfoSphere CDC for PointBase Does Not Apply ToInfoSphere CDC for Teradata Set this parameter to one of the following: v NPrevent replicated data received from the source from being cascaded to other servers. v YAllow replicated data received from the source to be cascaded to other servers. Default SettingY Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
commit_group_size
This system parameter specifies the number of rows that must be applied to the target database before a commit is issued. Normally, commits issued to the target database are in response to commits issued by applications running on the source. This system parameter should only be used when you want manage commits by controlling how often they are issued to the
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)
461
target database. This approach can be used to reduce the overhead of frequent commits to the database. However, managing commits in this manner may result in inconsistent data in the source and target databases over time. To manage commits to the target database by setting the commit group size, you must disable commitment control on the target, by setting the target_default_commit_level on page 464 system parameter. To properly calibrate database commits in your environment, you must work with this system parameter and the dobatch on page 472 system parameter. If the commit interval frequently expires before a commit group with the specified number of applied rows has been formed, a smaller number of rows are committed. In this case, you can decrease the commit group size or increase the commit interval. However, when a commit group contains an insufficient number of applied rows for it to be committed, you must set the commit interval to ensure data is committed within a reasonable period of time. If this system parameter is set to 0, then: v Commits are issued at regular intervals when a non-zero commit interval is specified. v A commit is issued for each applied row when a zero commit interval is specified. When commit_group_size and dobatch on page 472 are both set to zero, InfoSphere CDC internally sets this system parameter to 1 row (default setting) to ensure commits are issued. Applies ToTarget, InfoSphere CDC for DB2 UDB only Default Setting1 row. A commit is issued for each applied row. Minimum Setting0 Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
commit_ interval
This system parameter specifies the amount of time, in seconds, between consecutive commits issued to the target database. Normally, commits issued to the target database are in response to commits issued by applications running on the source. This system parameter should only be used when you want to manage commits by controlling how often they are issued to the target database. This approach can be used to reduce the overhead of frequent commits to the database. However, managing commits in this manner may result in inconsistent data in the source and target databases over time. To manage commits to the target database by setting the interval between consecutive commits, you must disable commitment control on the target, by setting the target_default_commit_level on page 464 system parameter. To properly calibrate database commits in your environment, you must work with this system parameter and the commit_group_size on page 461 system parameter. For commit groups that have an insufficient number of applied rows for a commit to be issued, use this system parameter to prevent applied rows in the commit group from being uncommitted for a long period of time. In particular, you can use it to force commits during periods of transaction inactivity. However,
462
if you set the commit interval so that it frequently expires before a commit group with the specified number of applied rows has been formed, a smaller number of rows are committed. In this case, you can increase the commit interval or decrease the commit group size. If this system parameter is set to 0, then: v A commit is issued every 5 seconds (default setting) when the size of the commit group is more than one row. In this case, InfoSphere CDC internally sets this system parameter to 5 seconds (default setting) to ensure that a commit group which cannot be committed due to an insufficient number of applied rows is committed in 5 seconds. v A commit is issued for each applied row when a zero commit group size is specified. When commit_group_size and dobatch on page 472 are both set to zero, InfoSphere CDC internally sets commit_group_size to 1 row (default setting) to ensure commits are issued. Applies ToTarget, InfoSphere CDC for DB2 UDB only Default Setting5 seconds Minimum Setting0 Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
refresh_commit_ block_size
This system parameter identifies the number of records to be inserted into a target table during a refresh operation before a commit is issued to make those records persistent. If the tables that you are replicating are relatively large, it is recommended that you increase the block size to improve performance. Applies ToTarget Default Setting1,000 records Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
scraper_trans_ num_limit
This system parameter identifies the number of row level entries that are staged in memory before they are sent to the target. This parameter should be set to the largest commitment cycle size on your server. Commitment cycle size is the number of transactions in one commitment cycle. For example, the size of the following commitment cycle is six:
insert insert insert insert insert commit into into into into into <table> <table> <table> <table> <table> <values> <values> <values> <values> <values>
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)
463
Applies ToSource, InfoSphere CDC for DB2 UDB only Default Setting1,000,000 row level entries Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
target_default_commit_level
This system parameter indicates the commitment control level for transactions applied on the target. Applies ToTarget, InfoSphere CDC for DB2 UDB and InfoSphere CDC for PointBase Does Not Apply ToInfoSphere CDC for Teradata Set this parameter to one of the following: v 2A commit to the target database is performed when all records in a transaction have been received and applied. This setting provides true transaction consistency by ensuring that entire transactions are committed to the target database. If a communications or server failure occurs, a partially applied transaction in the target database is rolled back to the last transaction that was committed. v 0Disables commitment control for transaction processing. No attempt to maintain transaction consistency is performed during mirroring. Default Setting2 Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
report_position_interval
This system parameter specifies how often, in seconds, the source informs the target about its position in the current log during inactive periods. During inactive periods, when there are no log entries pertaining to the current subscription, the source informs the target of its current position so that the target can advance its bookmarks accordingly. By specifying a low setting for this parameter, the target
464
can reflect more accurately how far replication has progressed. This system parameter can also prevent the reprocessing of entries that do not apply to the table currently being replicated. The value of this parameter affects the information that is displayed in Management Console. A high setting for this parameter may result in presented information that is not up-to-date. Applies ToSource, InfoSphere CDC for DB2 UDB and InfoSphere CDC for PointBase Does Not Apply ToInfoSphere CDC for Teradata Default Setting5 seconds Minimum Setting1 second Maximum Setting300 seconds Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
del_fastload_file
This system parameter indicates whether or not Teradata FastLoad files are deleted after using the utility to refresh data in a Teradata database under standard replication. You can keep these files for future reference or delete them to increase available disk space. To refresh data in a Teradata database using the Teradata FastLoad utility, set dofastload =Y. For more information about the Teradata FastLoad utility, see your Teradata documentation. Applies ToTarget, InfoSphere CDC for Teradata only Set this parameter to one of the following:
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)
465
v NKeep the Teradata FastLoad files after data has been refreshed in a Teradata database. v YDelete the Teradata FastLoad files after data has been refreshed in a Teradata database. Default SettingY Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
dofastload
This system parameter enables or disables a Fast Bulk Copy (BCP) refresh. Generally, a BCP refresh provides a better level of performance than a batch refresh (see dobatch on page 472) or the standard row-by-row refresh. Applies ToTarget, InfoSphere CDC for DB2 UDB and InfoSphere CDC for Teradata Does Not Apply ToInfoSphere CDC for PointBase Set this parameter to one of the following: v NDo not perform a BCP refresh. v YPerform a BCP refresh. In addition, you must: 1. Set the fastload_path on page 467 system parameter to the path of the temporary file. 2. Set the fastload_backup_path system parameter to the path of the stored backup image. 3. Ensure there are no large object (LOB) data types within your user data. BCP refresh cannot work with tables containing LOB data types. If a LOB column is found, a standard (row-by-row) refresh is performed. To determine if there is an error in the loading process for BCP refresh, examine the message appended to the loadmsg file in your InfoSphere CDC installation directory. Default SettingN Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
fastload_backup_path
This system parameter identifies the path to a stored backup image of the loaded data for a BCP refresh. The database user that owns the InfoSphere CDC metadata tables must have read and write permissions to the files whose locations are identified by the fastload_path on page 467and fastload_backup_path system parameters. Applies ToTarget, InfoSphere CDC for DB2 UDB only Related concepts
466
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
fastload_in_whole
This system parameter indicates how data is transferred to the Teradata FastLoad utility in order to refresh data in a Teradata database. Data can be refreshed in a single bulk operation or incrementally. The size of each data file passed to the Teradata FastLoad utility is determined by the max_fastload_ file_size on page 468 system parameter. For more information about the utility, see your Teradata documentation. Applies ToTarget, InfoSphere CDC for Teradata only Set this parameter to one of the following: v NSubmit a data file to the Teradata FastLoad utility immediately after the file has been filled with replicated data. v YSubmit all data to the Teradata FastLoad utility after it has been received from the publication server. Default SettingN Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
fastload_path
This system parameter identifies the path to the temporary file used for a Fast Bulk Copy (BCP) refresh. During a BCP refresh, a copy image of the loaded data is saved in this temporary file. The database user that owns the InfoSphere CDC metadata tables must have read and write permissions to the files whose locations are identified by the fastload_path and fastload_backup_path on page 466 system parameters. Applies ToSource and Target for InfoSphere CDC for DB2 UDB, Target only for InfoSphere CDC for Teradata Does Not Apply ToInfoSphere CDC for PointBase Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
make_fastload_log_file
This system parameter indicates whether or not Teradata FastLoad log files are created. Log files contain messages generated during refresh operations performed by the Teradata FastLoad utility. IBM recommends that you create log files and examine their contents to determine whether or not refresh operations were successful.
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)
467
Log files are named DM_<username>_<tablename>.log , where <username> is the database user name that owns the subscription table being refreshed and <tablename> is the name of the subscription table. These files are placed in the directory identified by the fastload_path on page 467 system parameter. The database user name and InfoSphere CDC installation directory were specified during the installation process. Applies ToTarget, InfoSphere CDC for Teradata only Set this parameter to one of the following: v NDo not create Teradata FastLoad log files to track data refresh operations. v YCreate the Teradata FastLoad log files to track data refresh operations. For more information about the Teradata FastLoad utility, see your Teradata documentation. Default SettingN Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
max_fastload_ file_size
This system parameter identifies the size, in bytes, that the data file must reach before the Teradata FastLoad utility refreshes data in a Teradata database. If the amount of refreshed data is larger than the specified size, InfoSphere CDC closes the data file after it has been filled and passes it to the Teradata FastLoad utility so that data is refreshed in the Teradata database. Additional data files are used to ensure the remaining data is refreshed. Applies ToTarget, InfoSphere CDC for Teradata only Default Setting2,000,000,000 bytes Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
monitor_sample_interval
This system parameter identifies the period of time, in seconds, between consecutive updates to a storage area that is used to maintain replication latency metrics. Management Console references this area to present replication latency information.
468
Applies ToSource and Target for InfoSphere CDC for DB2 UDB and InfoSphere CDC for PointBase, Target only for InfoSphere CDC for Teradata Default Setting5 seconds Minimum Setting0 seconds. Replication latency metrics are not updated. Maximum Setting3,600 seconds (1 hour) Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
dm_lock_detection
This system parameter indicates whether or not table and row locking detection is enabled. If a table or row has been locked by another process while InfoSphere CDC attempts to modify that table or row, InfoSphere CDC waits for a specific amount of time, specified by dm_lock_timeout, before attempting to apply data again. InfoSphere CDC generates messages, which can be displayed in Event Log, when an attempt is made to modify a locked target table or row. These messages identify the specific table or row that could not be modified. Applies ToSource and Target for InfoSphere CDC for DB2 UDB, Target only for InfoSphere CDC for Teradata Does Not Apply ToInfoSphere CDC for PointBase Set this parameter to one of the following: v YEnables table and row locking detection. v NDisables table and row locking detection. InfoSphere CDC waits until the locked table or row becomes available. Default SettingY Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
dm_lock_timeout
Applies ToSource and Target for InfoSphere CDC for DB2 UDB, Target only for InfoSphere CDC for Teradata
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)
469
Does Not Apply ToInfoSphere CDC for PointBase Specifies the amount of time, in seconds, InfoSphere CDC waits for a locked table or row to become available. This system parameter is applicable only when table and row locking detection is enabled, using the dm_lock_detection system parameter. Default Setting30 seconds Minimum Setting1 second Maximum Setting60 seconds Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
unicode_handling
This system parameter indicates the default method of treating data in defined Unicode columns. For information about how data in each Unicode source column is treated, see Setting multibyte and Unicode character set conversions on page 175. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Applies ToSource for InfoSphere CDC for DB2 UDB Does Not Apply ToInfoSphere CDC for PointBase The following DB2 UDB data types are considered to be Unicode columns, and are therefore affected by the value assigned to this system parameter: v GRAPHIC v VARGRAPHIC v LONG VARGRAPHIC with code page 1200 (UCS-2 big endian) This system parameter is set to either CHAR or NOCHANGE: v CHARInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v NOCHANGEInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain
470
non-single-byte character data. NOCHANGE ensures InfoSphere CDC will handle non-single-byte character data in the same way as previous InfoSphere CDC releases. Notes: v NOCHANGE does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may have to apply user exit programs or other customization to properly represent data in Unicode columns. For more information about user exit programs, see the InfoSphere CDC for DB2 UDB User Exits Guide. v If you are using IBM DB2 UDB Version 7 database, a BCP refresh locks the replication data tablespace during loading. For this reason, metadata is not updated during a BCP refresh if the metadata tables are located in the same tablespace as the replicated data. For more information on how to avoid this situation, see the appropriate InfoSphere CDC commands reference or user manual. Default SettingNOCHANGE Note: NOCHANGE does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may need to apply user exit programs or other customization to properly represent the data in Unicode columns. Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
dm_status_interval
This system parameter specifies how often, in seconds, progress messages are issued. Progress messages are displayed in Event Log to provide detailed and regular information about InfoSphere CDC replication activities. On the source, these messages identify the current bookmark that was sent by the source, its corresponding log name, and the subscription name to which the bookmark was sent. On the target, progress messages identify the current bookmark that was received by the target, its corresponding log name, and the source ID from which the bookmark was received. Applies ToSource and Target for InfoSphere CDC for DB2 UDB, Target only for InfoSphere CDC for Teradata Does Not Apply ToInfoSphere CDC for PointBase
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)
471
Default Setting0 seconds. No progress messages are issued. Minimum Setting0 seconds Maximum Setting7200 seconds Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
heartbeat_timeout
This system parameter specifies the duration, in minutes, of communication inactivity before active InfoSphere CDC processes for a subscription are stopped. If a value outside the acceptable range is specified, the default setting is used. Applies ToSource, InfoSphere CDC for DB2 UDB and InfoSphere CDC for PointBase Does Not Apply ToInfoSphere CDC for Teradata Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
dobatch
This system parameter enables or disables a batch refresh. Generally, a batch refresh provides a better level of performance than the standard row-by-row refresh.
472
Applies ToTarget, InfoSphere CDC for DB2 UDB and InfoSphere CDC for PointBase Does Not Apply ToInfoSphere CDC for Teradata Set this parameter to one of the following: v YPerform a batch refresh. In addition, you must ensure that there are no large objects (LOB) data types within your user data. A batch refresh cannot work with tables containing LOB data types. If a LOB column is found, a standard (row-by-row) refresh is performed. v NDo not perform a batch refresh. Default SettingY Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
source_default_active_refresh
For information about setting this system parameter, see your IBM representative.
source_default_replication_type
For information about setting this system parameter, see your IBM representative.
target_mirror_number_of_errors_before_abort
This system parameter indicates how many errors to accept on the target before stopping mirroring. To perform mirroring through any number of errors, set this parameter to -1. Applies ToTarget Attention: If you set this parameter to values greater than 0, data inconsistencies between the source and target tables may occur. Default Setting0 Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
target_print_refresh_details
For information about setting this system parameter, see your IBM representative. Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)
473
target_refresh_number_of_errors_before_abort
This system parameter indicates how many errors to accept on the target before stopping a refresh. To perform refresh through any number of errors, set this parameter to -1. Applies ToTarget Attention: Do not set this parameter to 0. This setting stops the refresh after the first record has been successfully refreshed. Default Setting1
message_handler_trace_level
For information about setting this system parameter, see your IBM representative.
message_trace_level
For information about setting this system parameter, see your IBM representative.
target_trace_logical_messages
For information about setting this system parameter, see your IBM representative.
target_trace_physical_messages
For information about setting this system parameter, see your IBM representative.
trace_level
For information about setting this system parameter, see your IBM representative.
trace_on
For information about setting this system parameter, see your IBM representative.
474
tpump_arc_data_files
This system parameter enables or disables the archiving of data (.dat) and script (.script) files that are used by the Teradata TPump utility. InfoSphere CDC generates the data and script files that are used by the Teradata TPump utility to load data into Teradata databases. Data files contain the replicated data that is loaded into Teradata, and script files specify what is contained in the data files and how data is loaded. These files are named DM_<timestamp>.dat and DM_<timestamp>.script, where <timestamp> is the number of milliseconds from midnight on January 1, 1970 to the time when the file was created. Applies ToTarget, InfoSphere CDC for Teradata only Set this parameter to one of the following: v NDisables the archiving of Teradata TPump data and script files. Teradata TPump data and script files are deleted immediately after data has been loaded into a Teradata database. v YEnables the archiving of Teradata TPump data and script files. For more information about the Teradata TPump utility in InfoSphere CDC, see the InfoSphere CDC for Teradata Installation Guide. Default SettingN Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
tpump_files_root_folder
This system parameter identifies the main directory that is created to accommodate all Teradata TPump files. This setting specifies where all Teradata TPump files are located. Subdirectories under the main directory are labeled with the name of the source ID that is used to receive replicated data. This means that for each source ID, Teradata TPump files are maintained in a separate directory. Applies ToTarget, InfoSphere CDC for Teradata only
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)
475
The three subdirectories that are defined are as follows: v <tpump_files_root_folder>\<source_id>\TPump Contains all data (.dat) and script (.script) files that are generated by InfoSphere CDC and used by the Teradata TPump utility to load data into Teradata databases. Data files contain the replicated data that is loaded into Teradata, and script files specify what is contained in the data files and how data is loaded. These files are named DM_<timestamp>.dat and DM_<timestamp>.script , where <timestamp> is the number of milliseconds from midnight on January 1, 1970 to the time when the file was created. v <tpump_files_root_folder>\<pubid>\TPump\archive Contains all archived data (.dat) and script (.script) files. v <tpump_files_root_folder>\<pubid>\TPump\log Contains all Teradata TPump log files. For more information about log files, see tpump_logging. These files are named DM_<timestamp>.log , where <timestamp> is the number of milliseconds from midnight on January 1, 1970 to the time when the file was created. where <tpump_files_root_folder> is the value assigned to this system parameter, and <source_id> is the source ID defined in Management Console that is used to receive replicated data. For example, if <tpump_files_root_folder> is d:\test, and <source_id> is NEWYORK, then the following three Teradata TPump subdirectories are created for the NEWYORK source ID: d:\test\NEWYORK\TPump, d:\test\NEWYORK\TPump\ archive, and d:\test\NEWYORK\TPump\log. For more information about the Teradata TPump utility in InfoSphere CDC, see InfoSphere CDC for Teradata Installation Guide. Default SettingInfoSphere CDC installation directory Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
tpump_logging
This system parameter indicates whether or not Teradata TPump log files are created. The tpump_files_root_folder on page 475system parameter specifies the location of these files. Log files are named DM_<timestamp>.log, where <timestamp> is the number of milliseconds from midnight on January 1, 1970 to the time when the file was created. Applies ToTarget, InfoSphere CDC for Teradata only Set this parameter to one of the following: v YCreate Teradata TPump log files to track data loading operations. v NDo not create Teradata TPump log files to track data loading operations. For more information about the Teradata TPump utility in InfoSphere CDC, see the InfoSphere CDC for Teradata Installation Guide. Default SettingY
476
Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
tpump_max_file_size
This system parameter identifies the size, in bytes, that the data file (.dat) must reach before the Teradata TPump utility loads data into a Teradata database. Data files contain the replicated data that is loaded into Teradata. To optimize performance, you should set this system parameter so that the amount of time it takes for the Teradata TPump utility to load data into a Teradata database is approximately equivalent to the time it takes for the data file to reach the specified size. As a result, the next load operation can start shortly after the current load operation has been completed. Therefore, if the amount of time to load data is longer than the amount of time to fill the data file in preparation for the next load, decrease the number of bytes assigned to this system parameter. In addition to setting this system parameter, you must also set with the tpump_ timeout on page 478 system parameter to specify when the Teradata TPump utility loads data into a Teradata database. If the timeout period frequently expires before the data file reaches its specified size, you can increase the timeout period or decrease the data file size to allow loads to also be determined by data file size. However, when a data file contains an insufficient amount of data for a load to be performed, the timeout period must be set to ensure data is loaded within a reasonable period of time. For information about where the data file is located, see tpump_files_root_folder on page 475. For more information about the Teradata TPump utility in InfoSphere CDC, see InfoSphere CDC for Teradata Installation Guide. Applies ToTarget, InfoSphere CDC for Teradata only Default Setting100,000 bytes Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
tpump_script_params_file
For information about setting this system parameter, see your IBM representative.
tpump_script_val_file
Identifies the name of the XML file that InfoSphere CDC uses to generate script (.script) files during replication. Teradata TPump script files specify what is contained in the data files and how data in these files is loaded into Teradata databases. The file identified by this system parameter contains a set of Teradata TPump command parameter settings. You can modify the settings in this file so that the script files generated by InfoSphere CDC during replication are customized for your working environment. For more information about customizing the generated script files using the XML file identified by this system parameter, see InfoSphere CDC for Teradata Installation Guide.
System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below)
477
IBM recommends that you do not change the default setting for this system parameter. Instead, modify the tpumpscripttsdefaults.xml file so that it contains the command parameter settings that you want. If you want to specify a different XML, this file must exist in the InfoSphere CDC installation directory and contain the correct XML markup to generate valid script files. Generally, the default values in the tpumpscripttsdefaults.xml file are suitable for most working environments. If you want to modify the settings in this file, you must be familiar with XML and Teradata TPump. For more information about Teradata TPump commands and command parameters, see your Teradata documentation. Applies ToTarget, InfoSphere CDC for Teradata only Default Settingtpumpscripttsdefaults.xml Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
tpump_ timeout
This system parameter indicates the amount of time, in seconds, between consecutive Teradata TPump data loads into a Teradata database. You can use this system parameter to force data to be loaded when the data file (see tpump_max_file_size on page 477) contains insufficient data for a load to be performed. It can be used to prevent data in a data file from not being loaded for a long period of time. In particular, you can use this system parameter to force loads during periods of slow transaction activity. However, if you set the timeout period so that it frequently expires before a data file can reach the specified size, a smaller amount of data is loaded. In this case, you can increase the timeout period or decrease the data file size to allow loads to also be determined by data file size. For more information about the Teradata TPump utility in InfoSphere CDC, see the InfoSphere CDC for Teradata Installation Guide. Applies ToTarget, InfoSphere CDC for Teradata only Minimum Setting0 seconds. Disables the timeout so that a load is only performed when the data file reaches the size specified by the tpump_max_file_size system parameter. Default Setting5 seconds Related concepts System parameters for InfoSphere CDC for DB2 UDB, PointBase, and Teradata (version 6.0 and below) on page 455 Setting system parameters on source and target datastores on page 60
478
System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and target datastores. Notes: v If you make changes to a system parameter during active replication, you must stop and restart InfoSphere CDC for the changes to take effect. v When upgrading to a higher version of InfoSphere CDC, any pre-existing settings for system parameters are maintained. In this section, you will learn: Notification system parameters Maximize throughput system parameters on page 480 Encoding system parameters on page 483 Disk resource system parameters on page 484 Apply process system parameters on page 485
global_shutdown_after_no_heartbeat_response_minutes
Use this system parameter to specify the duration, in minutes, of communication inactivity before active InfoSphere CDC processes for a subscription are stopped. If a value outside the acceptable range is specified, the default setting is used. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Related concepts
Copyright IBM Corp. 2008
479
System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
global_conversion_not_possible_warning
Use this system parameter to control whether or not InfoSphere CDC generates a warning in the Management Console Event Log in the following situations: v Data conversion is not possible for a specific data value. v Converted data types are encountered that are out of range. Set this parameter to one of the following: truegenerates a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. falsedoes not generate a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. Applies ToTarget Default SettingFalse Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
480
mirror_commit_after_max_transactions
This system parameter specifies a threshold used to determine when to issue a commit to the target database. Commits are issued to the target database in response to commits issued by applications running on the source, but not all source commits will be issued on the target. The frequency at which source commits are issued to the target database will vary depending on the volume of changes. When data volume is higher, less frequent commits on the target will allow for the higher data throughput required to maintain low latency. This system parameter is used to place a limit on how infrequent these target commits can become. If the source commit being processed has reached this threshold of source commits received since the last target commit was issued, then there will be a target commit issued for this source commit. Applies ToTarget Default Setting10 Minimum Setting1 Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
mirror_commit_after_max_seconds
This system parameter specifies a threshold used to determine when to issue a commit to the target database. Commits are issued to the target database in response to commits issued by applications running on the source, but not all source commits will be issued on the target. The frequency at which source commits are issued to the target database will vary depending on the volume of changes. When data volume is higher, less frequent commits on the target will allow for the higher data throughput required to maintain low latency. This system parameter is used to place a limit on how infrequent these target commits can become. If the specified amount of time, in seconds, has elapsed since the last target commit it issued, then it will issue a target commit either immediately (if it isnt currently in the middle of a source transaction) or as soon as it receives the next source commit. Applies ToTarget Default Setting1 second Minimum Setting1 Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
mirror_commit_after_max_operations
This system parameter specifies a threshold used to determine when to issue a commit to the target database. Commits are issued to the target database in
System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above)
481
response to commits issued by applications running on the source, but not all source commits will be issued on the target. The frequency at which source commits are issued to the target database will vary depending on the volume of changes. When data volume is higher, less frequent commits on the target will allow for the higher data throughput required to maintain low latency. This system parameter is used to place a limit on how infrequent these target commits can become. If the target has applied this number of operations since the last target commit was issued, then it will issue a target commit at the next source commit it receives from the source. Applies ToTarget Default Setting1000 Minimum Setting1 Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
mirror_commit_on_transaction_boundary
This system parameter indicates whether or not the commits that InfoSphere CDC does on the target database will always correspond with a commit that occurred on the source database. If you choose to ignore the commitment control of the source database, InfoSphere CDC allows you to see the partial results of large transactions. Set this parameter to one of the following: v trueDoes not ignore the commitment control of the source database. Only records in a committed transaction are mirrored to the target. This setting provides true transaction consistency by ensuring that only committed transactions are sent to the target. v falseIgnores the commitment control of the source database. This value disables commitment control for transaction processing. No attempt to maintain transaction consistency is performed during mirroring. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
refresh_commit_after_max_operations
This system parameter identifies the number of rows comprising each transaction during refresh. To reduce the workload on the target database during refresh, InfoSphere CDC periodically commits the changes to the target database rather than performing the refresh as a single large transaction. Applies ToTarget
482
Default Setting1000 Minimum Setting1 Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
global_unicode_as_char
This system parameter indicates the default method of treating data in defined Unicode columns. For each InfoSphere CDC installation on a server, this system parameter defines the system default method of treating data in Unicode columns. If a Unicode column is set to the system default, the current system default method, as defined by this system parameter, is used. Set this parameter to one of the following: v trueInfoSphere CDC treats all data in Unicode columns as single-byte characters. Use this setting when Unicode columns contain single-byte character data. v falseInfoSphere CDC treats all data in Unicode columns as a continuous bit stream. Use this setting when Unicode columns contain non-single-byte character data. Setting this system parameter to false ensures that InfoSphere CDC handles non-single-byte character data in the same way as previous InfoSphere CDC releases. Note: Setting this parameter to false does not ensure that replicated non-single-byte character data in Unicode columns are represented properly on the target. For replicated non-single-byte character data, you may have to apply user exit programs or other customization to properly represent data in Unicode columns. For more information about user exit programs, see the InfoSphere CDC End-User Documentation for your platform. Applies ToSource Default Settingfalse Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above)
483
mirror_memory_txqueue_total_mb
This system parameter controls the amount of memory used to stage data on the source. For optimal performance, this system parameter should be large enough to hold the largest amount of uncommited data that will ever exist in the source database. Applies ToSource Default Setting15 Megabytes Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
mirror_memory_txqueue_each_mb
This system parameter controls the amount of memory used to stage data on the source. For optimal performance, this system parameter should be large enough to hold the data for the largest transactions that occur on the source. Applies ToSource Default Setting3 Megabytes Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
global_memory_lob_cache_mb
This system parameter controls the amount of memory that will be used to stage LOB values on the target. For optimal performance, this value should be large enough to hold the entire data for the largest LOB values that will be replicated. Default Setting2 Megabytes Applies ToTarget Related concepts
484
System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
mirror_queue_for_buffers_between_cdc_threads_operations
This system parameter controls the ability of InfoSphere CDCs log scraping to take advantage of multiple processors. The default setting is acceptable for most situations. You can increase this value for highly scalable environments. Applies ToSource Default Setting100 entries Minimum Setting100 entries Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
mirror_end_on_error
Use this system parameter to indicate if you want to end mirroring after an apply error occurs on the target database. Set this parameter to one of the following: v trueEnd mirroring after an apply error on the target database. v falseDo not end mirroring after an apply error on the target database. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
refresh_end_on_error
Use this system parameter to indicate if you want to end a refresh after an apply error occurs. Set this parameter to one of the following:
System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above)
485
v v
trueEnd a refresh after an apply error occurs. falseDo not end a refresh after an apply error occurs.
Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for DB2 UDB (version 6.1 and above) on page 479 Setting system parameters on source and target datastores on page 60
486
System parameters for InfoSphere CDC for Teradata (version 6.2 and above)
System parameters let you control the behavior of InfoSphere CDC. If your replication environment requires a particular configuration, then you can use system parameters to modify the behavior of default operations in InfoSphere CDC. The default system parameter settings are appropriate for most installations. Maintain these default settings until you become familiar with the configuration of InfoSphere CDC. InfoSphere CDC provides system parameters that control the behavior of your source and/or target datastores. Notes: v If you make changes to a system parameter during active replication, you must stop and restart InfoSphere CDC for the changes to take effect. v When upgrading to a higher version of InfoSphere CDC, any pre-existing settings for system parameters are maintained. In this section, you will learn: Notification system parameters Apply process system parameters on page 488 Teradata TPump system parameters on page 489 Fastload system parameters on page 492
global_shutdown_after_no_heartbeat_response_minutes
Use this system parameter to specify the duration, in minutes, of communication inactivity before active InfoSphere CDC processes for a subscription are stopped. If a value outside the acceptable range is specified, the default setting is used. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes Maximum Setting999 minutes Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above)
Copyright IBM Corp. 2008
487
global_conversion_not_possible_warning
Use this system parameter to control whether or not InfoSphere CDC generates a warning in the Management Console Event Log in the following situations: v Data conversion is not possible for a specific data value. v Converted data types are encountered that are out of range. Set this parameter to one of the following: truegenerates a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. falsedoes not generate a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. Applies ToTarget Default SettingFalse Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above) on page 487
mirror_end_on_error
Use this system parameter to indicate if you want to end mirroring after an apply error occurs on the target database. Set this parameter to one of the following: v trueEnd mirroring after an apply error on the target database. v falseDo not end mirroring after an apply error on the target database. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above) on page 487
refresh_end_on_error
Use this system parameter to indicate if you want to end a refresh after an apply error occurs.
488
Set this parameter to one of the following: v trueEnd a refresh after an apply error occurs. v falseDo not end a refresh after an apply error occurs. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above) on page 487
mirror_tpump_files_root_folder_path
Identifies the main directory that is created to accommodate all Teradata TPump files. This setting specifies where all Teradata TPump files are located. Subdirectories under the main directory are labeled with the name of the publisher identifier that is used to receive replicated data. This means that for each publisher identifier, Teradata TPump files are maintained in a separate directory. The three subdirectories that are defined are as follows: v <tpump_files_root_folder>\<pubid>\TPump Contains all data (.dat) and script (.script) files that are generated by InfoSphere CDC and used by the Teradata TPump utility to load data into Teradata databases. Data files contain the replicated data that is loaded into Teradata, and script files specify what is contained in the data files and how data is loaded. These files are named DM_<timestamp>.dat and DM_<timestamp>.script, where <timestamp> is the number of milliseconds from midnight on January 1, 1970 to the time when the file was created. v <tpump_files_root_folder>\<pubid>\TPump\archive Contains all archived data (.dat) and script (.script) files. v <tpump_files_root_folder>\<pubid>\TPump\log Contains all Teradata TPump log files. For more information about log files, see tpump_logging below. Log files are named DM_<timestamp>.log, where <timestamp> is the number of milliseconds from midnight on January 1, 1970 to the time when the file was created.
System parameters for InfoSphere CDC for Teradata (version 6.2 and above)
489
where: <tpump_files_root_folder> is the value assigned to this system parameter. <pubid> is the publisher identifier defined in Management Console that is used to receive replicated data. For example, if: <tpump_files_root_folder> is d:\test, and <pubid> is NEWYORK then the following three Teradata TPump subdirectories are created for the NEWYORK publisher identifier: d:\test\NEWYORK\TPump d:\test\NEWYORK\TPump\archive d:\test\NEWYORK\TPump\log
Default SettingThe InfoSphere CDC installation directory. Applies ToTarget Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above) on page 487
mirror_tpump_max_file_size_mb
Identifies the size, in megabytes, that the data file (.dat) must reach before the Teradata TPump utility loads data into a Teradata database. Data files contain the replicated data that is loaded into Teradata. To optimize performance, you should set this system parameter so that the amount of time it takes for the Teradata TPump utility to load data into a Teradata database is approximately equivalent to the time it takes for the data file to reach the specified size. As a result, the next load operation can start shortly after the current load operation has been completed. Therefore, if the amount of time to load data is longer than the amount of time to fill the data file in preparation for the next load, decrease the number of bytes assigned to this system parameter. In addition to working with this system parameter, you must also work with the tpump_ timeout on page 478 system parameter to specify when the Teradata TPump utility loads data into a Teradata database. If the timeout period frequently expires before the data file reaches its specified size, you can increase the timeout period or decrease the data file size to allow loads to also be determined by data file size. However, when a data file contains an insufficient amount of data for a load to be performed, the timeout period must be set to ensure data is loaded within a reasonable period of time. Default Setting50 Mb Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above) on page 487
mirror_tpump_script_val_file_name
Identifies the name of the XML file that InfoSphere CDC uses to generate script (.script) files during replication.
490
Teradata TPump script files specify what is contained in the data files and how data in these files is loaded into Teradata databases. The file identified by this system parameter contains a set of Teradata TPump command parameter settings. You can modify the settings in this file so that the script files generated by InfoSphere CDC during replication are customized for your working environment. For more information about customizing the generated script files using the XML file identified by this system parameter, see your InfoSphere CDC for Teradata documentation. IBM recommends that you do not change the default setting for this system parameter. Instead, modify the tpumpscripttsdefaults.xml file so that it contains the desired command parameter settings. If you want to specify a different XML, this file must exist in the InfoSphere CDC installation directory and contain the correct XML markup to generate valid script files. Generally, the default values in the tpumpscripttsdefaults.xml file are suitable for most working environments. If you want to modify the settings in tpumpscripttsdefaults.xml, you must be familiar with XML and Teradata TPump. For more information about Teradata TPump commands and command parameters, see your Teradata documentation. Default Settingconf/tpumpscripttsdefaults.xml. This file is located in the conf directory in your InfoSphere CDC installation directory. Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above) on page 487
mirror_tpump_timeout_seconds
Indicates the amount of time, in seconds, between consecutive Teradata TPump data loads into a Teradata database. You can use this system parameter to force data to be loaded when the data file (see tpump_max_file_size on page 477) contains insufficient data for a load to be performed. It can be used to prevent data in a data file from not being loaded for a long period of time. In particular, you can use this system parameter to force loads during periods of slow transaction activity. However, if you set the timeout period so that it frequently expires before a data file can reach the specified size, a smaller amount of data is loaded. In this case, you can increase the timeout period or decrease the data file size to allow loads to also be determined by data file size. Minimum Setting0 seconds (disables the timeout so that a load is only performed when the data file reaches the size specified by the tpump_max_file_size system parameter) Default Setting5 seconds Related concepts System parameters for InfoSphere CDC for Teradata (version 6.2 and above) on page 487
System parameters for InfoSphere CDC for Teradata (version 6.2 and above)
491
refresh_max_fastload_file_size_mb
Identifies the size, in megabytes, that the data file must reach before the Teradata FastLoad utility refreshes data in a Teradata database. If the amount of refreshed data is larger than the specified size, InfoSphere CDC closes the data file after it has been filled and passes it to the Teradata FastLoad utility so that data is refreshed in the Teradata database. Additional data files are used to ensure the remaining data is refreshed. Default Setting100 megabytes
492
global_conversion_not_possible_warning
Use this system parameter to control whether or not InfoSphere CDC generates a warning in the Management Console Event Log in the following situations: v Data conversion is not possible for a specific data value. v Converted data types are encountered that are out of range. Set this parameter to one of the following: truegenerates a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. falsedoes not generate a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. Applies ToTarget Default SettingFalse Related concepts System parameters for InfoSphere CDC Event Server
Copyright IBM Corp. 2008
493
mirror_end_on_error
Use this system parameter to indicate if you want to end mirroring after an apply error occurs on the target database. Set this parameter to one of the following: v trueEnd mirroring after an apply error on the target database. v falseDo not end mirroring after an apply error on the target database. Applies ToTarget Default Settingtrue
refresh_end_on_error
Use this system parameter to indicate if you want to end a refresh after an apply error occurs. Set this parameter to one of the following: v trueEnd a refresh after an apply error occurs. v falseDo not end a refresh after an apply error occurs. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC Event Server on page 493 Setting system parameters on source and target datastores on page 60
userexit_max_lob_size_kb
Use this system parameter to set the maximum size of LOB data (in kb) that InfoSphere CDC can pass to a user exit. Applies ToTarget Default Setting128 kb MaximumNone MinimumNone Related concepts
494
System parameters for InfoSphere CDC Event Server on page 493 Setting system parameters on source and target datastores on page 60
495
496
global_shutdown_after_no_heartbeat_response_minutes
Use this system parameter to specify the duration (in minutes) of communication inactivity before active InfoSphere CDC processes for a subscription are stopped. If a value outside the acceptable range is specified, the default setting is used. Applies ToSource Default Setting15 minutes Minimum Setting3 minutes. Maximum Setting999 minutes. Related concepts System parameters for InfoSphere CDC for WebSphere DataStage
497
global_conversion_not_possible_warning
Use this system parameter to control whether or not InfoSphere CDC generates a warning in the Management Console Event Log in the following situations: v Data conversion is not possible for a specific data value. v Converted data types are encountered that are out of range. Set this parameter to one of the following: truegenerates a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. falsedoes not generate a warning in the Event Log if data conversion is not possible for a specific data value or converted data types are encountered that are out of range. Applies ToTarget Default SettingFalse Related concepts System parameters for InfoSphere CDC for WebSphere DataStage on page 497
mirror_end_on_error
Use this system parameter to indicate if you want to end mirroring after an apply error occurs on the target database. Set this parameter to one of the following: v trueEnd mirroring after an apply error on the target database. v falseDo not end mirroring after an apply error on the target database. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for WebSphere DataStage on page 497
refresh_end_on_error
Use this system parameter to indicate if you want to end a refresh after an apply error occurs.
498
Set this parameter to one of the following: v trueEnd a refresh after an apply error occurs. v falseDo not end a refresh after an apply error occurs. Applies ToTarget Default Settingtrue Related concepts System parameters for InfoSphere CDC for WebSphere DataStage on page 497
userexit_max_lob_size_kb
This system parameter determines when InfoSphere CDC truncates LOB data and is related to the WebSphere DataStage subscription-level properties that you can set for each subscription in Management Console. InfoSphere CDC first truncates your LOB data based on this system parameter and then truncates your data again using the subscription-level properties. For more information on how to set the subscription-level properties, see Setting properties for a subscription that targets IBM WebSphere DataStage on page 89. This system parameter should be set at least as large as the largest subscription-level property while taking into account the units and the type of character data (single-byte or multi-byte). For example, if the largest subscription-level property is set to 8,000 characters and you are using a Japanese system with the possibility of 2 bytes per character (up to 16,000 bytes), you should set this system parameter to at least 16 kB. Default Setting128 kB Applies ToTarget
499
500
Functions
Management Console includes several functions. In this section, you will learn: XPath functions Transform extensions on page 506 Database functions on page 514 Using external Java objects in data transformations on page 515 XPath expression operators on page 516
XPath functions
The XPath functions implemented by InfoSphere CDC Event Server follow specific syntax. For details regarding the XPath functions, see W3Cs Web site at http://www.w3.org. In the current release the following XPath functions are implemented: See also: ceiling concat on page 502 contains on page 502 floor on page 502 false on page 502 formatNumber on page 503 normalizeSpace on page 503 not on page 503 number on page 503 position on page 504 round on page 504 startsWith on page 504 string on page 504 stringLength on page 505 substring on page 505 substringAfter on page 505 substringBefore on page 505 sum on page 506 translate on page 506 true on page 506
ceiling
Returns the smallest integer greater than or equal to the numeric value of the argument. Syntaxceiling(value)
Copyright IBM Corp. 2008
501
Input Parametersvalue represents an input value that can be converted to a number. Example<sxt:element name="Price" value="ceiling(12.5)"/>. This function returns a value of 13.
concat
Concatenates two or more values into one string. Syntaxconcat(value1, value2, [, value3, ...]) Input Parametersvalue1, value2, [, value3, ...] represent input values: expressions, literals, or functions. Return Valuestring Example<sxt:element name="Full_Name" value="concat(First_Name, ` `, Last_Name)"/>
contains
Determines whether a string is contained within another string. The function returns true if value 1 contains value 2, otherwise, false. Syntaxcontains(value1, value2) Input Parametersvalue1, value2 represent input values: expressions, literals, or functions. Return Valueboolean Example<sxt:element name="isQualified" value="contains(/employee/ skill,"Java")"/>
floor
Returns the largest integer that is less than or equal to the numeric value of the argument. Syntaxfloor(value) Input Parametersvalue. Represents an input value that can be converted to a number. Return Valuenumber Example<sxt:element name="Price" value="floor(12.5)"/>. This function returns a value of 12.
false
Returns false. Syntaxfalse( )
502
formatNumber
Formats a numeric value according to a specified pattern. The default pattern implemented follows Java JDK Version 1.1 specification. For more information on number formats, see the Java API documentation. Syntaxformat-number(value, format-pattern) Input Parametersvalue represents an input value that can be converted to a number. format-pattern represents a string value that contains the formatting rules. Return Valuestring Example<sxt:element name="Price" value="format-number(12.5, $#.00)"/>. The preceding declaration formats 12.5 to $12.50 and assigns it as the contents of the Price element.
normalizeSpace
Trims the leading and trailing white spaces (blank spaces, tabs and new line characters), and converts multiple white spaces to a single blank space. Syntaxnormalize-space(value) Input Parametersvalue represents an input string value. Return Valuestring Example<sxt:element name="Test" value="normalize-space (` Hello world! )"/>
not
Returns true if the argument is false, returns false if the argument is true. Syntaxnot(value) Input Parametersvalue represents an input boolean value or expression. Return ValueBoolean Example<sxt:element name="Admit" value="not(/Customers/Customer/ age<18)"/>
number
This function converts a value to a decimal number. Syntaxnumber(value)
Functions
503
Input Parametersvalue represents an input string of numeric values. Return Valuenumber Example<sxt:element name="Cost" value="number(15.6)"/>
position
Returns a number equal to the context position from the expression evaluation context. Syntaxposition( ) Input ParametersNone Return Valuenumber Example<sxt:element name="ColumnNum" value="/root/a[position()=3]"/>
round
Returns the closest integer to the numeric value of the argument. Syntaxround(value) Input Parametersvalue represents an input number, which must be surrounded by single quotes. Return Valuenumber Example<sxt:element name="Cost" value="round(15.6)"/>. For this example, the return value is 16.
startsWith
Returns true if one string begins with another. Syntaxstarts-with(value1, value 2) Input Parametersvalue1 represents an input value: an expression, a literal, or a function. value2 represents the substring to be searched. Return ValueBoolean Example<sxt:element name="isLocal" value="starts-with(Phone, "416")"/>
string
Converts a number or node to a string. Syntaxstring(value) Input Parametersvalue represents an input number. Return Valuestring
504
stringLength
This function returns the length of a string. Syntaxstring-length(value) Input Parametersvalue represents an input value: an expression, a literal, or a function. Return Valuenumber Example<sxt:element name="TestLength" value="string-length(Phone)"/>
substring
This function extracts a substring from a string starting at a specified position, and having a specified length. Syntaxsubstring(value, beginIndex, [length]) Input Parametersvalue represents an input value: an expression, a literal, or a function. beginIndex represents the beginning position, zero-based. length represents the length of substring, zero-based. If omitted, the substring runs to the end of the input string. Return Valuestring Example<sxt:element name="Area_Code" value="substring(Phone, 0, 3)"/>
substringAfter
Extracts a substring from a string. The substring to be extracted appears after the first occurrence of a specified substring. Syntaxsubstring-after(value, searchSubstring) Input Parametersvalue represents an input value: an expression, literal, or a function. searchSubstring represents the substring to be searched. Return Valuestring Example<sxt:element name="LocalNumber" value="substring-after (Phone, ` `)"/>
substringBefore
Syntaxsubstring-before(value, searchSubstring) Descriptionextracts a substring from a string. The substring to be extracted appears before the first occurrence of a specified substring. Input Parametersvalue represents an input value: an expression, a literal, or a function. searchSubstring represents the substring to be searched.
Functions
505
sum
Syntaxsum(node_set) Descriptionreturns the total value of a set of numeric values in a node-set Input Parametersnode_set is an X-Path expression that represents a node-set. Return Valuenumber Example<sxt:element name="TotalPrice" value="sum(//UnitPrice)"/>
translate
Syntaxtranslate(value, from, to) Descriptionsubstitutes characters in a supplied string with specified replacement characters. Input Parametersvalue represents an input value: an expression, a literal, or a function. from represents the characters to be replaced. to represents the characters to be used as the replacement for the from characters. If omitted, the from characters are removed. Return Valuestring Example<sxt:element name="Phone" value="substring(Phone, ` `, `-`)"/>
true
Syntaxtrue( ) Descriptionreturns true. Input ParametersNone Return Valueboolean Example<sxt:element name="OnSale" value="true()"/> Nesting is supported in the current version.
Transform extensions
To meet specific transform requirements, these extensions have been developed to supplement XPath and XSLT recommendations provided by W3C. The first extension is an XPath expression for self-reference. A leading # symbol means self-reference from the target point of view. For example, /root/level1/@attr1 points to an attribute in the source DOM, while #/root/level1/@attr1 points to an
506
attribute in the target that is the XML document to be generated. InfoSphere CDC Event Server functions are marked with the sxt: prefix, which must be used with the function name. See also: sxt:add sxt:db-lookup sxt:divide on page 508 sxt:filter on page 508 sxt:formatDate on page 509 sxt:getSequentialNum on page 509 sxt:getSubField on page 509 sxt:getSysDate on page 510 sxt:getSysTime on page 510 sxt:groupConcat on page 510 sxt:ifExist on page 510 sxt:ifReturn on page 511 sxt:isEqual on page 511 sxt:multiply on page 511 sxt:nodeConcat on page 511 sxt:padLeft on page 512 sxt:padRight on page 512 sxt:proper on page 512 sxt:setDefault on page 513 sxt:subtract on page 513 sxt:toLowerCase on page 513 sxt:toUpperCase on page 513 sxt:trim on page 514
sxt:add
Syntaxsxt:add (value1, value2, [value3,...]) DescriptionThis function adds two or more values provided. Input Parametersvalue1, value2, [value3, ...] represent two or more values that can be converted to numbers. Return Valuenumber Example<sxt:element name="Total_Quantity" value="sxt:add(QOH, QOO)"/>
sxt:db-lookup
Syntaxsxt:db-lookup (JDBCDriver, URL,UserName, Password, SQLStatement |StoredProcedure[,param1,param2,...]) DescriptionThis function gets a single value from the specified database by performing a query. Do not use this function on tables that are being transformed. Use sxtdb:lookup for tables under current transformation
Functions
507
Input Parameters v JDBCDriverRepresents the name of a valid JDBC driver class. v URLRepresents a unique URL to the database. v UserNameRepresents a valid user name to access the database. v PasswordRepresents a valid password associated with the user name. v SQLStatementRepresents the SQL statement to be applied to the database. Only standard SQL types are supported. v StoredProcedure[,param1,param2,...] Represents the stored procedure. The syntax is: (outputParameter Datatype) call ProcedureName ([inputParameter Datatype, ...]) outputParameterThe stored procedure can have only one output parameter, and the output parameter must be the last parameter. The supported data types are: CHAR, VARCHAR, LONGVARCHAR, INTEGER, DOUBLE, DATE, TIME, TIMESTAMP inputParameterRepresents the value of the input parameter (optional). stringThis function will return the first column in the first row of the result set
sxt:db-lookup("sun.jdbc.odbc.JdbcOdbcDriver","jdbc:odbc:pubs", "sa","sa","SELECT country_name FROM countries WHERE country_id=?", @countryID)
sxt:divide
Syntaxsxt:divide (value1, value2) DescriptionThis function divides two values provided. Input Parametersvalue1, value2 represent two values that can be converted to numbers. value2 cannot be zero. Return Valuenumber Example<sxt:element name="Overtime_Rate" value="sxt:divide(overtime, standard)"/>
sxt:filter
Syntaxsxt:filter (node-set, condition) DescriptionThis function filters the node-set using a conditional expression in the context of each of the node-sets. This is equivalent to the XPath [ ] filtering mechanism. Input Parametersnode-set represents the node-set to be selectively returned if a node meets the condition. condition Represents a filter condition that can be evaluated (true or false). Return Valuenode-set Example<sxt:attribute name="keys" value="sxt:groupConcat(sxt:filter(data_key, sxt:is-equal(data_type,2)), )"/>
508
sxt:formatDate
Syntaxsxt:formatDate (value, original-format-pattern, to-format-pattern) DescriptionThis function formats the date string using the specified pattern. The patterns must follow the rules in Java. For more information on date formats, see the Java API documentation. Input Parametersvalue represents an input value that can be converted to a date. original-format-pattern represents a string value that contains the original formatting rules. to-format-pattern represents a string value that contains the formatting rules for the converted date. The patterns must follow the rules in Java. v yyyy-MM-dd (for example, 2001-01-25) v MMM dd, yyyy (for example, Jan 25, 2004) v v v v MMMM d, yyyy (for example, January 25, 2004) M/dd/yyyy (for example 1/25/2004) yyyy-MM-dd HH:mm:ss (for example, 2004-01-25 13:25:30) yyyy-MM-dd hh:mm:ss a (for example, 2004-01-25 01:25:30 PM).
sxt:getSequentialNum
Syntaxsxt:getSequentialNum (seed, increment) Description This function generates sequential numbers in a session. Input Parametersseed represents the start value of a counter. increment represents the increment for each number. Return Valuenumber Example<sxt:element name="ID" value="sxt:getSequentialNum(1,1)"/>. In this example, when the function is called for the first time, the return value is 1; the second time, the return value is 2, the third time, 3, and so on. The counter does not persist between sessions or processes.
sxt:getSubField
Syntaxsxt:getSubField (value, delimiter, subFieldIndex) DescriptionThis function extracts a sub-field value from a string that contains a list of delimited values. Input Parametersvalue represents an input value: an expression, a literal, or a function. delimiter represents a delimiter used to separate the sub-field values. For example: comma, tab, |, and so on. subFieldIndex represents the ordinal position of the sub-field. For example, the first sub-field is 1, and so on. Return Valuestring
Functions
509
sxt:getSysDate
SyntaxgetSysDate ( ) DescriptionThis function returns the system date at runtime. Input ParametersNone Return Valuestring Example<sxt:element name="UpdateDate" value="sxt:getSysDate()"/> sxt:getSysDateTime
sxt:getSysTime
Syntaxsxt:getSysTime ( ) DescriptionThis function returns the system time at runtime. Input ParametersNone Return Valuestring Example<sxt:element name="UpdateTime" value="sxt:getSysTime()"/>
sxt:groupConcat
Syntaxsxt:groupConcat (nodeToConcat, delimiter) DescriptionThis function converts one level node in a node-set to a string and then concatenates them together into a string Input ParametersnodeToConcat represents the node to be concatenated. It must be a node-set. delimiter represents the delimiter to be used for separating each sub-value. Return Valuestring Example<sxt:element name="AuthorPhones" value="sxt:groupConcat(/authors/ phone, ,)"/>
sxt:ifExist
Syntaxsxt:if-exist (nodeOrExpr1, node OrExpr2) DescriptionThis function verifies whether or not the first value is empty. If it is empty, it returns the second value. Otherwise, it returns the first value. Input ParametersnodeOrExpr1 represents the first node or expression. nodeOrExpr2 represents the second node or expression.
510
sxt:ifReturn
Syntaxsxt:if-return (testCondition, valueForTrue, valueForFalse) DescriptionThis function evaluates a condition and, depending on the evaluation result, returns a specified value. Input ParameterstestCondition represents an expression that can be evaluated to true or false. valueForTrue represents the value to be returned when the condition is true. valueForFalse represents the value to be returned when the condition is false. Return Valuestring Example<sxt:element name="Language" value="sxt:if-return(sxt:isequal(@lang,`fr), `French, `English)"/>
sxt:isEqual
Syntaxsxt:is-equal (nodeOrExpr, valueToTestAgainst) DescriptionThis function tests if a node or expression has a specific value. Input Parameters nodeOrExpr represents a node/expression whose value is compared with the specified value. valueToTestAgainst represents a specific value for testing the node or the expression. Return Valueboolean Example<sxt:element name="no_name" value="sxt:is-equal(@name, ")"/>
sxt:multiply
Syntaxsxt:multiply (value1, value2, [value3, ...]) DescriptionThis function multiplies two or more values provided. Input Parametersvalue1, value2, [value3, ...] represent two or more values that can be converted to numbers. Return Valuenumber Example<sxt:element name="Cost" value="sxt:multiply(Quantity, Price)"/>
sxt:nodeConcat
Syntaxsxt:nodeConcat (flag, nodeToConcat, delimiter) DescriptionThis function converts each node in a node-set to a string and then concatenates them together into a string.
Functions
511
Input Parametersflag represents an expression that can be evaluated to true or false. nodeToConcat represents the node to be concatenated. It must be a node-set. delimiter represents the delimiter to be used for separating each sub-value. Return Valuestring Example<sxt:element name="AuthorPhones" value="sxt:nodeConcat(,/ authors/phone, ,)"/>
sxt:padLeft
Syntaxsxt:pad-left (string_to_pad, value, string_to_fill) DescriptionThis function adds a number of characters to the left of a string. If the length of the string to return is less than the value specified, the return string is truncated. Input Parametersstring_to_pad specifies the string to be modified by adding characters to the left. value specifies the length of the string to be returned. string_to_fill specifies the string that contains the characters to fill. Return Valuestring Example<sxt:element name="Leading_Zeros_Number" value="sxt:padleft(number,8, 0)"/>
sxt:padRight
Syntaxsxt:pad-right (string_to_pad, value, string_to_fill) DescriptionThis function adds a number of characters to the right of a string. If the length of the string to return is less than the value specified, the return string is truncated. Input Parametersstring_to_pad specifies the string to be modified by adding characters to the right. value specifies the length of the string to be returned. string_to_fill specifies the string that contains the characters to fill. Return Valuestring Example<sxt:element name="Trailing_Space" value="sxt:pad-right(fname, 10, )"/>
sxt:proper
Syntaxsxt:proper (string) DescriptionThis function performs a capitalization of all the words provided as input. The first letter of a word is converted to uppercase, while the other ones to lowercase. Input Parametersstring Specifies a string that contains a number of words. Return Valuestring
512
sxt:setDefault
Syntaxsxt:setDefault (nodeOrExpr, defaultValue) DescriptionThis function returns a default value if a specified node/expression is evaluated to an empty string. Input ParametersnodeOrExpr represents a node/expression to be tested. defaultValue represents the value to be returned when the node/expression contains an empty string. Return Valuestring Example<sxt:element name="Language" value="sxt:setDefault(@lang,English)"/>
sxt:subtract
Syntaxsxt:subtract (value1, value2, [value3, ...]) DescriptionThis function subtracts one or more values from the first value specified. Input Parametersvalue1, value2, [value3, ...] represent two or more values that can be converted to numbers. Return Valuenumber Example<sxt:element name="Stored_Quantity" value="sxt:subtract(100, 20, 30)"/>. In this example, the return value is 50.
sxt:toLowerCase
Syntaxsxt:toLowerCase (value) DescriptionThis function converts a string to lower case. Input Parametersvalue represents the value to convert to lower case. Return Valuestring Example<sxt:element name="FirstName" value="sxt:toLowerCase(first_name) "/>
sxt:toUpperCase
Syntaxsxt:toUpperCase (value) DescriptionThis function converts a string to upper case. Input Parametersvalue represents the value to convert to upper case. Return Valuestring
Functions
513
sxt:trim
Syntaxsxt:trim (value) DescriptionThis function strips off the leading and trailing blank spaces of a string. Input Parametersvalue represents the string value to be trimmed. Return Valuestring Example<sxt:element name="FirstName" value="sxt:trim(first_name)"/>
Database functions
To meet specific transform requirements, these extensions have been developed to supplement XPath and XSLT recommendations provided by W3C. The first extension is an XPath expression for self-reference. A leading # symbol means self-reference from the target point of view. For example, /root/level1/@attr1 points to an attribute in the source DOM, while #/root/level1/@attr1 points to an attribute in the target that is the XML document to be generated. InfoSphere CDC Event Server functions are marked with the sxt: prefix, which must be used with the function name. See also: sxtdb:getPKSeq sxtdb:lookup sxtdb:procCall on page 515
sxtdb:getPKSeq
Syntaxsxtdb:getPKSeq (tableName, colNameSeq, colNameCounter, seqName) DescriptionThis function retrieves the primary key base on a sequence table. Input Parameters v tableNameRepresents the table name where the sequence is stored. v colNameSeqRepresents the column name where the sequence name is stored. v colNameCounterRepresents the column name where the counter is stored. v seqNameRepresents the name of the sequence. Return Valuenumber Examplesxtdb:getPKSeq(SEQUENCES, SEQ_NAME, SEQ_COUNTER, CUST_ID)
sxtdb:lookup
Syntaxsxtdb:lookup (SQLStatement [,param1, param2, ...]) DescriptionThis function retrieves a single value by performing a query.
514
Input Parameters SQLStatement represents the SQL statement to be performed on the target database. [param1, param2, ...] Represents the values of the input parameters if there are question marks in the statement. This parameter is optional. Only standard SQL types are supported. Return Valuestring Note: This function returns the first column in the first row of the result set. Examplesxtdb:lookup("SELECT country_name FROM countries where country_id=?", countryID).
sxtdb:procCall
Syntaxsxtdb:procCall (SchemaName, ProcName, [param1, param2, ...]) DescriptionThis function retrieves a value by calling a stored procedure. Input Parameters v SchemaNameRepresents the name of the database schema. Note: Only standard SQL types are supported. v ProcNameRepresents the name of the stored procedure. v [param1, param2, ...]Represents the values of the input parameters of the stored procedure. Specifying this parameter is optional. Return Valuestring This function returns the first available OUTPUT parameter. Examplesxtdb:ProcCall("SCOTT", "GET_EMP_ID", @lname)
Functions
515
In the current release, only type I (simple string objects) is fully implemented, while type II (SQL data types) and type III (XML objects) will be implemented in a future release.
516
< Operator on page 518 <= Operator on page 518 > Operator on page 518 >= Operator on page 518 or Operator on page 518 and Operator on page 518 () parentheses Operator on page 518 [ ] Operator on page 519 / Operator on page 519 // Operator on page 519 @ Operator on page 519
+ Operator
DescriptionAdds two numbers. You can also use it to add two expressions that return a numeric result.
- Operator
DescriptionYields the difference between two numbers or indicates the negative value of a numeric expression.
* Operator
DescriptionMultiplies two numbers.
div Operator
DescriptionDivides two numbers and returns a floating decimal.
mod Operator
DescriptionDivides two numbers and returns only the remainder.
= Operator
DescriptionEqual. If the expression is equal to the specified value, the operator returns true. If the expression is not equal to the specified value, the operator returns false. Exampleprice=7.80 ReturnsTrue if price is 7.80; false if price is 7.90
!= Operator
DescriptionNot equal to. If the expression is not equal to the specified value, the operator returns true. If the expression is equal to the specified value, the operator returns false. Exampleprice!=7.80
Functions
517
< Operator
DescriptionCompares two numeric expressions and determines whether expression1 is less than expression2; if so, the operator returns true. If expression1 is greater than or equal to expression2, the operator returns false. Exampleprice<7.80 ReturnsTrue if price is 7.00; false if price is 7.80
<= Operator
DescriptionCompares two specified numeric expressions and determines whether expression1 is less than or equal to the expression2; if it is, the operator returns true. If the expression1 is greater than expression2, the operator returns false. Exampleprice<=7.80 ReturnsTrue if price is 7.00; false if price is 7.90
> Operator
DescriptionCompares two numeric expressions and determines whether expression1 is greater than expression2; if it is, the operator returns true. If expression1 is less than or equal to expression2, the operator returns false. Exampleprice>7.80 ReturnsTrue if price is 7.90; false if price is 7.80
>= Operator
DescriptionCompares two numeric expressions and determines whether expression1 is greater than or equal to expression2 (true) or expression1 is less than expression2 (false).
or Operator
DescriptionLogical or.
and Operator
DescriptionLogical and.
() parentheses Operator
DescriptionControls the order in which the operators execute in the expression. Parentheses override the normal precedence order and cause the expressions within the parentheses to be evaluated first. When parentheses are nested, the contents of the innermost parentheses are evaluated before the contents of the outer ones.
518
[ ] Operator
DescriptionA filter is evaluated as a Boolean on every node that is within the current context. If the Boolean evaluates to true, the node is included in the returned set; otherwise, it is excluded. Filters are enclosed in brackets.
/ Operator
DescriptionSelects from the root node.
// Operator
DescriptionSelects nodes in the document that match the selection no matter where they are.
@ Operator
DescriptionIdentifies an attribute of a node.
Functions
519
520
Dialog boxes
InfoSphere CDC includes several dialog boxes for working with the user interface. In this section, you will learn: Datastore Management User Management on page 525 Connection Management on page 530 Access Server Options on page 531 Preferences on page 534 Datastores on page 536 Notifications on page 541 Source tables on page 543 Target tables on page 546 Subscriptions on page 546 Table mappings on page 551 Column mappings on page 555 XML message mappings on page 559 Data translation on page 560 Table operations on page 560 Promoting changes on page 561 Monitoring on page 562
Datastore Management
Management Console includes several dialog boxes that let you manage datastores in the Access Manager perspective. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: New Datastore dialog box Connection Parameters dialog box on page 522 Copy Datastore dialog box on page 523 Select User dialog box on page 523 Datastore List Report dialog box on page 523 Edit Datastore dialog box on page 524 Datastore tab on page 524 History tab on page 525
521
A datastore represents the InfoSphere CDC installation and the database made available for replication. Identification v NameSpecifies the name of the datastore you want to add. v DescriptionSpecifies a brief description for the datastore. v ServerSpecifies the hostname or full IP address of the server where you have installed InfoSphere CDC. v PortSpecifies the port number of the server where you installed InfoSphere CDC. PingPings the server where you have installed InfoSphere CDC. This returns the type of server where you have installed InfoSphere CDC and the version number of the product. Properties v Datastore TypeSpecifies the type of InfoSphere CDC product you have installed on a server. InfoSphere CDC can be of type Source, Target, or Dual. Source InfoSphere CDC captures data from a source server and sends it to a target destination. Target InfoSphere CDC receives captured data sent by a source server and applies it to a target destination. InfoSphere CDC captures data from a source server and then sends it to a target destination. It then receives the data and applies it to the target destination. v Platform TypeSpecifies the type of platform where you have installed InfoSphere CDC. v Database TypeSpecifies the type of database you have installed. InfoSphere CDC will use this database as the source or target of replicated data. v Datastore VersionSpecifies the version of the InfoSphere CDC product you have installed. Dual Connection ParametersOpens the Connection Parameters dialog box. Use this dialog box to set connection parameters for users. These parameters will be used as default connection parameters for all users assigned to this datastore. System administrators can change these parameters for each user in order to override the default parameters when required. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.
522
v DB Loginspecifies the database user name to connect to the database. If you want users to connect to the database for replication with WebSphere DataStage, then you must specify the user you created when installingInfoSphere CDC. v DB Passwordspecifies the password to connect to the database. v Confirm Passwordspecifies the confirmed password. Propagate changes to usersenable this option when you want users assigned to this datastore using existing connection parameters to use new connection parameters. The intent of this feature is to ease user account administration so that you only have to specify connection parameters once. You can however choose to override the default connection parameters so that each user has their own connection parameters when required. You can set connection parameters for each user when assigning a user to a datastore in the Connection Management view. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.
Dialog boxes
523
v Datastore Platformincludes the type of database platform on which this datastore resides. v Date Createdincludes the date you had created the datastore. v Date Last Modifiedincludes the date the datastore was last modified. v User Accessincludes the users you have assigned to this datastore. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.
Datastore tab
Use this tab view the properties of an existing datastore in the Access Manager perspective of Management Console. A datastore represents the InfoSphere CDC installation and the database made available for replication. Identification v NameSpecifies the name of the datastore you want to add. v DescriptionSpecifies a brief description for the datastore. v ServerSpecifies the hostname or full IP address of the server where you have installed InfoSphere CDC. v PortSpecifies the port number of the server where you installed InfoSphere CDC. PingPings the server where you have installed InfoSphere CDC. This returns the type of server where you have installed InfoSphere CDC and the version number of the product. Properties v Datastore TypeSpecifies the type of InfoSphere CDC product you have installed on a server. InfoSphere CDC can be of type Source, Target, or Dual. Source InfoSphere CDC captures data from a source server and sends it to a target destination.
524
Target InfoSphere CDC receives captured data sent by a source server and applies it to a target destination. InfoSphere CDC captures data from a source server and then sends it to a target destination. It then receives the data and applies it to the target destination. v Platform TypeSpecifies the type of platform where you have installed InfoSphere CDC. v Database TypeSpecifies the type of database you have installed. InfoSphere CDC will use this database as the source or target of replicated data. v Datastore VersionSpecifies the version of the InfoSphere CDC product you have installed. Dual Connection ParametersOpens the Connection Parameters dialog box. Use this dialog box to set connection parameters for users. These parameters will be used as default connection parameters for all users assigned to this datastore. System administrators can change these parameters for each user in order to override the default parameters when required. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.
History tab
Use this tab to view information about a datastore in the Access Manager perspective of Management Console. A datastore represents the InfoSphere CDC installation and the database made available for replication. v Createdspecifies the date the datastore was created. v Last Modifiedspecifies the date the datastore was last modified. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.
User Management
Access Manager includes several dialog boxes that let you manage user accounts in the Management Console perspective. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: New User dialog box on page 526 Copy User dialog box on page 527 Select Datastore dialog box on page 527 Change Role dialog box on page 527 User List Report dialog box on page 528 User Properties dialog box on page 529
Dialog boxes
525
526
v Password never expiresoverrides the password expiration policy you may have set in the Access Server Options dialog box in Management Console. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. Notes: v Users assigned to the Operator role can start, stop, and monitor replication activities. They can also view the tables selected for refresh and start a refresh on a subscription. Operators also have access to the Replication Diagram view, and can view notifications sent by subscriptions or datastores. However, users assigned to this role cannot configure replication and select or remove tables from a refresh. v Users assigned to the Monitor role can view the event log, view statistics, and view table mappings. Users can view the replication state and status of a subscription and can view latency threshold information. Monitors also have access to the Replication Diagram view. However, users assigned to this role cannot start or stop replication, configure replication, refresh tables, or view notifications sent by subscriptions and datastores.
527
v Administratorspecifies that users assigned to this role can perform all available operations in Management Console, but cannot modify system parameters. Users assigned to this role can access both the Monitoring and Configuration perspectives. v Operatorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. v Monitorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. Enable user account and datastore administrationenables a user assigned the System Administrator role access to the Access Manager perspective. If you enable this option for a user, then they can create new users, new datastores, and define Access Server password settings. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. Notes: v Users assigned to the Operator role can start, stop, and monitor replication activities. They can also view the tables selected for refresh and start a refresh on a subscription. Operators also have access to the Replication Diagram view, and can view notifications sent by subscriptions or datastores. However, users assigned to this role cannot configure replication and select or remove tables from a refresh. v Users assigned to the Monitor role can view the event log, view statistics, and view table mappings. Users can view the replication state and status of a subscription and can view latency threshold information. Monitors also have access to the Replication Diagram view. However, users assigned to this role cannot start or stop replication, configure replication, refresh tables, or view notifications sent by subscriptions and datastores.
528
User tab
Use this tab to edit the properties of an existing user in the Access Manager perspective of Management Console. You can modify login credentials and the security role of the user. User Information v Namespecifies the required unique name for the user to login to Management Console. v Full Namespecifies the full name of the user. You may want to provide this information for administration purposes, such as when you generate a list report on the user. v Descriptionspecifies a brief description for the user. You may want to provide this information for administration purposes, such as when you generate a list report on the user. v Passwordspecifies the required password for the user to login to Management Console. As the system administrator, if you have enabled complex passwords, then you must specify a password that meets these requirements. v Confirm Passwordspecifies the confirmed password. Role v System Administratorspecifies that users assigned to this role can perform all available operations in Management Console. Only users that require full operational access to the Monitoring and Configuration perspectives should be assigned to this role. System administrators can also modify system parameters to calibrate their replication environment. v Administratorspecifies that users assigned to this role can perform all available operations in Management Console, but cannot modify system parameters. Users assigned to this role can access both the Monitoring and Configuration perspectives. v Operatorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. v Monitorspecifies that users assigned to this role only have access to the Monitoring perspective in Management Console. Enable user account and datastore administrationenables a user assigned the System Administrator role access to the Access Manager perspective. If you enable this option for a user, then they can create new users, new datastores, and define Access Server password settings.
Dialog boxes
529
Status v Account is disableddisables the user account. Users with a disabled account cannot login to Management Console. v Account is lockedlocks the user account. This checkbox is enabled automatically after the number of failed login attempts exceeds the locking policy you may have set in the Access Server Options dialog box in Management Console. v User must change password at next loginforces a user to change their password at next login. v Password never expiresoverrides the password expiration policy you may have set in the Access Server Options dialog box in Management Console. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. Notes: v Users assigned to the Operator role can start, stop, and monitor replication activities. They can also view the tables selected for refresh and start a refresh on a subscription. Operators also have access to the Replication Diagram view, and can view notifications sent by subscriptions or datastores. However, users assigned to this role cannot configure replication and select or remove tables from a refresh. v Users assigned to the Monitor role can view the event log, view statistics, and view table mappings. Users can view the replication state and status of a subscription and can view latency threshold information. Monitors also have access to the Replication Diagram view. However, users assigned to this role cannot start or stop replication, configure replication, refresh tables, or view notifications sent by subscriptions and datastores.
History tab
Use this tab to view information about a user in the Access Manager perspective of Management Console. v Createdspecifies the date the user was created. v Last Modifiedspecifies the date the user was last modified. v Last Password Changespecifies the date of the last password change. v Last Loginspecifies the last login of the user in Management Console. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.
Connection Management
Management Console includes several dialog boxes that let you manage your connections to datastores in the Access Manager perspective. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. See also: Connection Parameters dialog box on page 531
530
Dialog boxes
531
Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts. Passwords tab Accounts tab Audit tab on page 533 Audit Trail Report dialog box on page 533 Security Log dialog box on page 534 Change Password dialog box on page 534
Passwords tab
Use this tab to set a password policy for all user accounts in the Access Manager perspective of Management Console. Require complex passwords enables Access Server to enforce complex password requirements in order to login to Management Console. v Minimum password lengthspecifies the minimum number of characters required for a password. By default, this setting is defined with a password length of 6 characters. v Minimum alphabetic charactersspecifies the minimum number of alphabetic characters required for a password. By default, this setting is defined with a value of 2 alphabetic characters. v Minimum non-alphabetic charactersspecifies the minimum number of non-alphabetic characters required for a password. By default, this setting is defined with a value of 2 non-alphabetic characters. Enforce password historyenables Access Server to enforce password history. The intent of this policy is to enable administrators to enhance security by ensuring that old passwords are not continually reused. v Passwords rememberedspecifies the number of unique new passwords that have to be associated with a user account before an old password can be reused. The value must be between 1 and 12 passwords. By default, this setting is defined with a value of 5. Enforce password expiryenables Access Server to enforce password expiry policy on user accounts. The intent of this policy is to enable administrators to enhance security by ensuring that new passwords are created and associated with user accounts. v Maximum password age (days)specifies the number of days a password is valid before it expires. By default, this setting is defined with a value of 90 days. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.
Accounts tab
Use this tab to set account policies for all user accounts in the Access Manager perspective of Management Console. Lock accounts on failed login attempts enables Access Server to enforce account locking after a number of failed login attempts into Management Console.
532
v Consecutive failures before lockspecifies the number of allowed attempts before the account is locked. The number of allowed attempts must be between 1 and 100. The default is 3. Enforce new account expiryenables Access Server to enforce an account expiry on new accounts. v Maximum new account agespecifies that if the maximum number of days is exceeded, the user account is automatically locked. A user account is considered new from the moment it is created until the moment it is first accessed. If a new user account has been locked, it can be unlocked only by the System Administrator. The number of days must be between 1 and 999. The default value is 15. Display previous failed login attemptsenables Access Server to display the number of times a user has attempted to log into Management Console. A message that indicates the number of previous failed login attempts appears when the user connects to Access Server in Management Console. Display last successful loginenables Access Server to display a message that indicates the last successful login date and time when the user tries to connect to Access Server in Management Console. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.
Audit tab
Use this tab to set enable auditing on user accounts in the Access Manager perspective of Management Console. Enable audit logenable if you want to audit user account management activities, datastore management activities, security policies, or general events. v Audit account managementenable if you want to audit user account management activities such as the creation, modification, and deletion of users. v Audit datastore managementenable if you want to audit datastore management activities such as the creation, modification, and deletion of datastores. v Audit security policy managementenable if you want to audit security policy settings related to passwords and user accounts. v Audit general eventsenable if you want to audit general events generated by Access Server. Note: To be able to work in the Access Manager perspective, you must be a System Administrator that has the privilege to manage datastores and user accounts.
533
v Modified security settings on user accounts. Fromspecifies that the report will include audited activities starting from this date. Tospecifies that the report will include audited activities ending at this date.
Preferences
Management Console includes several dialog boxes for setting preferences within Management Console. See also: Save Changes dialog box Column Encodings dialog box on page 535 Add Encoding dialog box on page 535 Modify Encoding dialog box on page 536
534
Select AllEnables Management Console to save changes to all subscriptions you made changes to in the Mapping Details view. Select NoneEnables Management Console to save none of the changes you made to the subscriptions in the Mapping Details view.
Dialog boxes
535
ISO/IANA NameSpecifies the ISO/IANA Name for the character set. This is dependent on database platform. Refer to the Java Supported Encodings Document for a list of supported ISO/IANA encoding names. Character LengthLists available character lengths for a character set. Single-Byte character sets (SBCS) provide 256 character codes. Double-Byte character sets (DBCS) provide encoding (including all control characters) two bytes. Multi-Byte character sets (MBCS) provide encoding using varying numbers of bytes (octets).
Datastores
Management Console includes several dialog boxes that work with datastores in Management Console. See also: Datastore Properties dialog box on page 537 Update Access Parameters dialog box on page 537 Add or Modify System Parameter dialog box on page 537 General tab on page 537 System Parameters tab on page 538 Aliases tab on page 538 Retry Datastore Connection dialog box on page 539 Specify Owner and Name page on page 539 Define Columns page on page 539 Review New Table page on page 539 Add Column dialog box on page 540 Modify Column dialog box on page 540
536
General tab
Use this tab to view general information about your datastore. Identification v Namedisplays the unique name for the datastore. v Descriptiondisplays the short description assigned to the datastore when it was created in Access Manager. v Host Namedisplays the host name or full IP address of the server where the datastore is running.
Dialog boxes
537
v Portdisplays the port number that the datastore uses to listen for communication from Access Manager. This port number is specified during InfoSphere CDC installation. v Platformdisplays the platform type of the datastore. v Databasedisplays the type of database associated with the datastore. v Versiondisplays the version of InfoSphere CDC installed on the source or target. Access Parameters v Database Typedisplays the type of database associated with the datastore. v Database Namedisplays the name of the database. v Ownerdisplays the name of the database owner. v Passworddisplays the password for the database. Update Related Subscriptionsopens the Update Access Parameters dialog box. Use this dialog box when you have changed the access parameters for a target datastore and you need to update each subscription associated with this datastore.
Aliases tab
Use this tab to add, modify, and delete aliases for target datastores that exist on a private network. Host namedisplays the host name you specified for this datastore in Access Manager. Access Manager uses the hostname or the IP address to connect to your target datastore. Portdisplays the port number you specified for this datastore in Access Manager. Aliaseslists any existing aliases created for the datastore. Addopens the Add Aliases dialog box. Use this dialog box to add an alias for the datastore. Modifyopens the Modify Aliases dialog box. Use this dialog box to modify an alias for the datastore.
538
Dialog boxes
539
Make this table available for replicationEnables the table for replication. You can view the table in the Source Tables area of Management Console.
540
Notifications
Management Console includes several dialog boxes that work with notications within Management Console. See also: Notification dialog box Filter Messages dialog box on page 542 Copy Notification Settings dialog box on page 542 Latency Threshold dialog box on page 543
Dialog boxes
541
v Informational MessagesEnables you to setup a notification for informational messages. InfoSphere CDC sends a notification when it encounters an event that you need to know about. For example, InfoSphere CDC can generate informational messages in the Event Log view when it is ready to mirror tables, or when it encounters instances that require code page conversions. v Status MessagesEnables you to setup a notification for status messages. InfoSphere CDC sends a notification when it encounters a specific event during replication. For example, InfoSphere CDC can generate status messages in the Event Log view when it is going to refresh a table, when it cannot journal changes on a table, or when it has parked a table for replication. v Operational MessagesEnables you to setup a notification for operational messages. InfoSphere CDC sends a notification when it has completed an operation during replication. For example, InfoSphere CDC can generate operational messages in the Event Log view after applying an operation to the target table, or when it has completed a refresh on a table. Filter MessagesOpens the Filter Messages dialog box. Use this dialog box to filter messages to the notification handler you configured. You receive these messages in the Event Log view. Copy SettingsOpens the Copy Settings dialog box. Use this dialog box when you want to copy notification settings from one category to another.
542
v Apply EventsInfoSphere CDC generates notifications related to events that occur during the target apply process. For example, InfoSphere CDC can generate a message when there is failure to apply an update on the target table.
Source tables
Management Console includes several dialog boxes for working with tables in Management Console. See also: Replication Tables dialog box Table Properties dialog box on page 544 Structure tab on page 544 Subscriptions tab on page 544 Update Source Table Definition dialog box on page 545 Unique Indexes dialog box on page 545
Dialog boxes
543
PropertiesOpens the Table Properties dialog box which lets you view the structure of the table and the search for subscriptions that use the table in replication.
Structure tab
Use this tab to view the structure of the selected table. Column NameLists each column in the selected table. Data TypeLists the type of data each column stores, such as date, numeric, or character data. Different data types exist on different platform databases. LengthLists the length of each column in bytes. PrecisionLists the precision for each numeric column in a table. This is the maximum number of digits used by the data type of the column. When used to describe floating-point numbers, the number of bits used to hold the fractional part. The more precision a system uses, the more exactly it can represent fractional quantities. ScaleLists the scale of each numeric column in a table. This is the maximum number of digits to the right of the decimal point. KeyDisplays a green checkmark when the column is the primary key in the table. This is the column you use to sort data. A table can have more than one primary key columns. NullableDisplays a green checkmark when the column is nullable. Depending on the platform, nullable may also be called a null reference or null object. Unique IndexOpens the Unique Indexes Table dialog box. If you have installed InfoSphere CDC for AS/400, InfoSphere CDC for z/OS, or InfoSphere CDC for DB2 UDB, then you can view unique indexes you have created for the table.
Subscriptions tab
Use this tab to identify the subscriptions that use a table in replication activities. SubscriptionLists the name of the subscriptions that uses the selected table. Used AsLists how the subscriptions is using the selected table. A subscription can use a table as a source or target of replication. Replication MethodLists the replication method chosen for the selected table. Table StatusLists the status of the selected table. A table can be refreshed, mirrored, or parked for replication activities.
544
SearchSearches for subscriptions that use the selected table in replication. For more information, see Starting and ending replication on subscriptions on page 197.
Dialog boxes
545
Target tables
Management Console includes several dialog boxes for working with target tables in Management Console. See also: Update Target Table Definition dialog box
Subscriptions
Management Console includes several dialog boxes for working with subscriptions in Management Console. See also: New Subscription dialog box Subscription Properties dialog box on page 547 Advanced Subscription Settings dialog box on page 547 Specify External Target Datastore dialog box on page 548 Notification dialog box on page 548 Upgrade Subscriptions dialog box on page 549 Naming Options dialog box on page 549 Transfer Bookmark dialog box on page 550 Clear Log Position dialog box on page 550 WebSphere DataStage Properties dialog box on page 550
546
v ProjectLists existing projects from which you can select to organize your subscription. Datastores v New ProjectOpens the New Project window. Specify a name for your new project. v SourceSpecifies the source datastores to which you are connected. Select the source datastore from which you want the subscription to replicate data from the list. v TargetLists the target datastore to which the subscription can replicate data. You can select a target datastore associated with the source datastore or select an external datastore from the list. v DetailsOpens the Modify Target Datastore dialog box when you select a target datastore that is associated with the source datastore. If you want to replicate to a target datastore that is not associated with the source datastore (an external target), then the Specify External Target Datastore dialog box opens. Advanced SettingsOpens the Advanced Subscription Settings dialog box. Use this dialog box to specify communication settings for the subscription, or to set propagation control if you have hub-and-spoke replication.
Dialog boxes
547
Source Settings v Source IDSpecifies the unique ID for the subscription. v Firewall PortSpecifies the firewall port your subscription uses for communication to the target datastore. If the source and target datastores have a limited number of ports for communication through a firewall, then you need to specify a firewall port. v TCP HostSpecifies the TCP host that your source datastore will use to recognize the target datastore when the computer where InfoSphere CDC is installed has multiple network cards. This is useful if you want to specify a host that is different from the host that you specified in InfoSphere CDC Access Manager. The default option is Auto-select which will automatically select the network card that can communicate with the target datastore. The host that you specified in InfoSphere CDC Access Manager also appears by default as well as any alias that you configured in the Datastore Properties dialog box. Propagation ControlYou can use propagation control to prevent the replication of data from a particular source. This is useful if you are using a hub-and-spoke replication configuration and prevents subscriptions from unnecessarily repeating operations like inserting data. v Do not replicate data received from the following subscriptionsClick Add to specify the subscriptions in your replication environment from which you want to prevent replication. v Do not replicate data received from any subscriptionsSpecifies that you want to prevent replication from all subscriptions.
548
Sourceuse this tab when you want to configure a notification that is sent from this datastore when it is used by a subscription as the source datastore. Targetuse this tab when you want to configure a notification that is sent from this datastore when it is used by a subscription as the target datastore. Datastore Defaultsopens the Notifications dialog box. Use this dialog box to view any default notifications you may have already set for the associated datastore that belongs to this subscription. Depending on how your subscription uses the datastore (as a source or target), the notification is sent from this datastore. Copy Settingsopens the Copy Settings dialog box. Use this dialog box when you want to copy notification settings from one category to another.
Dialog boxes
549
550
Table mappings
Management Console includes several dialog boxes for working with table mappings in Management Console. See also: Filter Columns dialog box Change Example Table dialog box Select Target Table dialog box Select Target Owner or Library dialog box on page 552 Add or Modify Audit Column dialog box on page 552 Message Destinations dialog box on page 553 Message Destination dialog box on page 553 Change Message Destination dialog box on page 553 Delete Table Mappings dialog box on page 554 Filter Tables dialog box on page 554
551
552
553
specify the maximum number of retries you want InfoSphere CDC Event Server to post to a message queue and a wait interval in case InfoSphere CDC Event Server fails to post the XML message to a queue or topic. Queues and Topics arealist area lists the queues and topics you created connections for in the InfoSphere CDC Configuration Tool. v Add Destinationopens the Message Destination dialog box. Use this dialog box to specify JMS message destination information for an existing JMS connection which can be either a queue or a topic. The JMS connection was created in the InfoSphere CDC configuration tool. v Editopens the Message Destination dialog box. Use this dialog box to edit JMS message destination information. v Deletedeletes the selected JMS message destination of which can be either a queue or a topic. Message Retry area v Retry sending failed messagesenables you to specify the number of times you want InfoSphere CDC Event Server to attempt to post to a message queue or topic and the interval (in seconds) you want InfoSphere CDC Event Server to wait before trying to post again. v Retriesthe number of times InfoSphere CDC Event Server attempts to post to a message queue or topic. If InfoSphere CDC Event Server cannot send the message and to post it to a JMS message destination, then it is regarded as an unsuccessful post. v Interval (seconds)the time InfoSphere CDC Event Server waits before attempting to post a message to a queue or topic again.
554
Do no automatically prompt for a filterEnable this check box when you do not want Management Console to display the Filter Tables dialog box.
Column mappings
Management Console includes several dialog boxes for working with column mappings in Management Console. See also: Map Columns Automatically dialog box Set Initial Value dialog box Define Derived Column dialog box on page 556 Copy Column Properties dialog box on page 557 Summarize Column dialog box on page 557 Specify Key dialog box on page 557 Define Expression dialog box on page 558 Replace Expressions Variables dialog box on page 558 Select Column dialog box on page 558 Import Options dialog box on page 558
555
NullIndicates that InfoSphere CDC populates the target column that is nullable with a null value. BlankIndicates that InfoSphere CDC populates the target column that has a character or a binary data type with a blank character. ZeroIndicates that InfoSphere CDC populates the target column that has a numeric data type with a value of zero. Database DefaultIndicates that InfoSphere CDC populates the target column with the default specified in your RDBMS. Whenever a row gets inserted into the target table, the value that populates this column is determined from the column defaults defined in your RDBMS. Current DateIndicates that InfoSphere CDC populates the target column that has a data type of datetime with the current date. If your subscription uses InfoSphere CDC for Z/OS as a target datastore, and you have mapped your tables using the LiveAudit mapping type, then both the before image and the after image of an update operation are populated with the same current date.
556
Dialog boxes
557
v InfoSphere CDC for Microsoft SQL Server requires that you select all primary key columns.
Each time the salary amount is greater than or equal to $60,000 in the SALARY column, InfoSphere CDC uses the %IF column function to calculate the tax deduction and applies the result in the mapped target column. You can replace a variable by manually typing a value or replace it with data from a source column. VariableLists the variables in the expression. ValueSpecifies the value for the variable. ColumnsOpens the Select Column dialog box. Use this dialog box to select the source column you want to use as a value for your variable.
558
Import repeated elements with the same parentby default, Management Console imports only one repeated element in a group node with the same parent. Enable this option to import all repeated elements. Import attribute valuesby default, Management Console imports only the structure of your XML. Enable this option to import the attribute values. This may be necessary if attribute values represent the structure of your XML document.
Dialog boxes
559
v Other Tableslists the tables you have added. You can add tables when you want InfoSphere CDC Event Server to retrieve columns from other tables. You can then map these columns to XML elements or attributes or use them in an expression. Target XML Documentlists the elements and attributes in your XML document. You can use these in an expression. Save Expressionsopens the Save Expression dialog box. You can use this to save the expression on the XML Message tab. This expression becomes available for all subscriptions mapped to message destinations or staging target tables.
Data translation
Management Console includes several dialog boxes for setting data translation in Management Console. See also: Define Translation dialog box
Table operations
Management Console includes several dialog boxes when working with setting table operations in Management Console. See also: Additional SQL dialog box Add Member Identifier Dialog Box on page 561 Modify Member Identifier dialog box on page 561 Delete Selected WHERE Clause dialog box on page 561
560
Promoting changes
Management Console includes several dialog boxes for promoting subscriptions in Management Console. See also: Compare XML dialog box on page 562
Dialog boxes
561
Monitoring
Management Console includes several dialog boxes for monitoring subscriptions in Management Console. See also: Start Refresh dialog box on page 563 Change Refresh Order dialog box on page 563 Flag for Refresh dialog box on page 563 Mark Table Capture Point for Mirroring dialog box on page 563 Park (Do not replicate) dialog box on page 564 Replication Method dialog box on page 564 Set Member Replication dialog box on page 565
562
563
InfoSphere CDC can mirror subsequent source changes to the target. When you start mirroring, InfoSphere CDC captures only those changes that occur after the point in time you set a log position. Member NameThe name of the member in the table. DescriptionThe description of the member. StatusDisplays the replication status of the member. Last RefreshDisplays the timestamp of the last refresh that was performed by InfoSphere CDC on this subscription.
564
Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS400 source. Journal areaIf you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then you can enable one of the following options: v Use Default JournalEnable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected JournalEnable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC creates this new journal table and uses it to detect and replicate database changes from the source to the target. OwnerLists the database owner of the journal table. NameLists the name of the journal table.
Dialog boxes
565
566
Wizards
Management Console includes several wizards. In this section, you will learn: Create Table wizard Promote Subscription wizard on page 568 Import Subscription wizard on page 570 Copy Subscription wizard on page 572 Map Tables wizard on page 574 Other Tables wizard on page 604
567
describe floating-point numbers, the number of bits used to hold the fractional part. The more precision a system uses, the more exactly it can represent fractional quantities. ScaleLists the scale of each numeric column in a table. This is the maximum number of digits to the right of the decimal point. NullableDisplays a green check mark when the column is nullable. Depending on the platform, nullable may also be called a null reference or null object. AddAdd a column to the new table ModifyModify an existing column DeleteDelete a column Move upMove a column up the list Move downMove a column down the list
568
v NameSpecifies the name of the subscription you want to promote to a new environment. v DescriptionSpecifies a brief description about the subscription you want to promote. v ProjectLists the available projects where you can promote your subscription. v New ProjectLets you create a new project folder where you can promote your subscription Promote changes to an existing subscriptionEnables InfoSphere CDC Management Console to promote changes to a subscription that has already been promoted to another environment. For example, the subscription may already exist in a project that you have reserved for testing subscriptions, but you may have made some minor changes on the subscription. To make sure the subscription in the test environment includes the changes that you made, you need to promote your changes to the into the testing environment. v Promote ToLists the available source and target datastore locations where you can promote the subscription.
569
Metadata Database v Database Typespecifies the database that maintains the metadata installed with InfoSphere CDC. This is data about your external target datastore. v Database Namespecifies the name of the metadata database. This database holds information about the external target datastore. v Ownerspecifies the name of the database user that owns the metadata. This is data about your external target datastore. v Passwordspecifies the password to access the metadata database.
570
571
v Ownerspecifies the name of the database user that owns the metadata. This is data about your external target datastore. v Passwordspecifies the password to access the metadata database.
572
573
Specify the names of owners and databases in the new target database area v Old Namedisplays the name of the database where the original target datastore resides. You must select the database where your new target datastore resides. v New Namedisplays the name of the owner of the original target datastore. You must select the owner of the new target datastore. Advanced settingsopens the Advanced Target Settings dialog box. Use this dialog box to select an alias that you have added for the target datastore. The source system must be able to recognize this alias on your network.
574
Select Mapping Type page (WebSphere DataStage Automatic) on page 582 Select WebSphere DataStage Connection Method page (WebSphere DataStage Automatic) on page 582 Select Source Tables page (WebSphere DataStage Automatic) on page 583 WebSphere DataStage Flat File page (WebSphere DataStage Automatic) on page 583 WebSphere DataStage Direct Connect page (WebSphere DataStage Automatic) on page 584 Review Mappings page (WebSphere DataStage Automatic) on page 584 Standard mapping type on page 584 Select Mapping Type page (Standard) on page 585 Select Source Table page (Standard) on page 585 Select Target Table page (Standard) on page 585 Specify Key page (Standard) on page 586 Set Replication Method page (Standard) on page 586 Review Mappings page (Standard) on page 587 LiveAudit mapping type (Custom) on page 587 Select Mapping Type page (LiveAudit Custom) on page 587 Define Audit Columns page (LiveAudit Custom) on page 587 Select Source Tables page (LiveAudit Custom) on page 588 Select Target Table page (LiveAudit Custom) on page 588 Review Mappings page (LiveAudit Custom) on page 588 Adaptive Apply mapping type on page 589 Select Mapping Type page (Adaptive Apply) on page 589 Select Source Tables page (Adaptive Apply) on page 589 Select Target Table page (Adaptive Apply) on page 589 Specify Key page (Adaptive Apply) on page 589 Set Replication Method page (Adaptive Apply) on page 590 Review Mappings page (Adaptive Apply) on page 591 Summarization mapping type on page 591 Select Mapping Type page (Summarization) on page 591 Select Source Tables page (Summarization) on page 591 Select Target Table page (Summarization) on page 591 Specify Key page (Summarization) on page 592 Select Summarization type page on page 592 Set Replication Method page (Summarization) on page 592 Review Mappings page (Summarization) on page 593 Consolidation one-to-one mapping type on page 593 Select Mapping Type page (Consolidation one-to-one) on page 593 Select Source Tables page (Consolidation one-to-one) on page 594 Select Target Table page (Consolidation one-to-one) on page 594 Specify Key page (Consolidation one-to-one) on page 594 Set Replication Method page (Consolidation one-to-one) on page 594 Review Mappings page (Consolidation one-to-one) on page 595 Consolidation one-to-many mapping type on page 596
Wizards
575
Select Mapping Type page (Consolidation one-to-many) on page 596 Select Source Tables page (Consolidation one-to-many) on page 596 Select Target Table page (Consolidation one-to-many) on page 596 Specify Key page (Consolidation one-to-many) on page 596 Set Replication Method page (Consolidation one-to-many) on page 597 Review Mappings page (Consolidation one-to-many) on page 598 WebSphere DataStage mapping type (Custom) on page 598 Select Mapping Type page (WebSphere DataStage Custom) on page 598 Select WebSphere DataStage Connection Method page (WebSphere DataStage Custom) on page 598 Select Source Tables page (WebSphere DataStage Custom) on page 598 WebSphere DataStage Flat File page (WebSphere DataStage Custom) on page 599 WebSphere DataStage Direct Connect page (WebSphere DataStage Custom) on page 599 Review Mappings page (WebSphere DataStage Custom) on page 600 Message Destination mapping type (Automatic) on page 600 Select Mapping Type page (Message Destination) on page 600 Select Source Tables page on page 600 Message Content page on page 600 Message Destination page on page 601 Review Mappings page on page 602 Message Destination mapping type (Custom) on page 602 Select Mapping Type page (Message Destination) on page 600 Select Source Tables page on page 602 Message Content page on page 600 Message Destination page on page 601 Review Mappings page on page 602
576
Wizards
577
v Target ownerdisplays the database owner you selected for your new target tables. Double-click this area to open the Select Target Owner dialog box and select the database owner you want for your new target tables.
578
This option is only available when using a InfoSphere CDC for AS/400 source. Journal areaif you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then you can enable one of the following options: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table.
579
Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping. Filter Columnsopens the Filter Columns dialog box. Use this dialog to filter source columns that you do not want InfoSphere CDC to send to the target.
580
581
v Target ownerdisplays the database owner you selected for your new target tables. Double-click this area to open the Select Target Owner dialog box and select the database owner you want for your new target tables.
582
Flat Fileindicates that InfoSphere CDC will produce a series of flat files that are used to deliver source table changes to WebSphere DataStage. WebSphere DataStage uses the Sequential File stage to read the files. Direct Connectindicates TCP/IP is used to deliver source table changes to WebSphere DataStage. With Direct Connect, InfoSphere CDC and WebSphere DataStage must work together. Changes are not stored, but they are captured from source logs and then processed by WebSphere DataStage. End-to-end transactional consistency requires a more complicated WebSphere DataStage job.
Wizards
583
Four standard journal control fields for each column: DM_TIMESTAMP, DM_TXID, DM_OPERATION_TYPE, DM_USER The columns in the table mapping in the following format: mycolumnname
584
585
586
v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table.
Wizards
587
Aud_Userstores the &USER journal control field which indicates the ID of the user who made the change to the source. Addopens theAdd Audit Column dialog box. Use this dialog box to add more audit columns to your target table. Modifyopens the Modify Audit Column dialog box. Use this dialog box to change the audit columns in your target table. Deletedeletes the selected audit column from the table. Move Upmoves the selected audit column up the list. Move Downmoves the selected audit column down the list.
588
589
Specify the keyenable when you want to select the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. Use all searchable columnsenable when you want to search for all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Note: Availability of the above options is dependent on the platform and version of InfoSphere CDC that you have installed.
590
v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table.
591
v Tablespecifies the name of the target table you selected. Create TableOpens the Create Table wizard. Use this wizard to create a new target table. Specify Filteropens the Filter Table dialog box. Use this dialog box to filter tables you want to include in your table mapping.
592
v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. Journal areaif you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then you can enable one of the following options: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table.
593
594
Mirror (Change Data Capture)enables InfoSphere CDC to replicate changes to the target table or accumulate source table changes and replicate these at a later time. v Prevent Recursionprevents InfoSphere CDC from replicating changes back to the source database when you have configured a subscription for bidirectional replication. This is only available in InfoSphere CDC for Microsoft SQL Server 5.3. Contact IBM technical support to implement bidirectional replication in your environment Refresh (Snapshot)enables InfoSphere CDC to replicate a copy of the source table to the target table. v Use Relative Record Numberenables InfoSphere CDC to replicate updates to the target using a relative record number. When this option is checked, InfoSphere CDC sends the Relative Record Number to the target and expects the Relative Record Number to be the identifying column on the target side. This means that the target tables cannot be updated by more than one source table (a target table cannot be a warehouse for multiple source tables). If you do not check this box, then InfoSphere CDC for AS/400 uses a unique key to replicate to the target. Notes: When this option is checked, if the source table is reorganized, InfoSphere CDC will automatically start a refresh for that table. If no Relative Record Number is available on the target table (for example, if the table resides on a non-AS/400 system), you can still make use of this option by mapping the Relative Record Number on the source table to a column in the target table to. For more information, see Source RRN (&CNTRRN) on page 246. This option is only available when using a InfoSphere CDC for AS/400 source. Journal areaif you are replicating source database changes using InfoSphere CDC for Oracle Trigger-based edition and want to use a journal table to mirror database operations from the source to the target table, then you can enable one of the following options: v Use Default Journalenable when you want InfoSphere CDC for Oracle to use the default journal table provided with InfoSphere CDC for Oracle: <TS SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table.
Wizards
595
596
Use an Indexenables you to select an index from the Index box. Use if your target table has an index that uniquely identifies a row. Specify the keyenable when you want to select the target columns from the Key Columns list. Use if one or more target columns uniquely identifies a row. Use all searchable columnsenable when you want to search for all target columns to identify which columns are suitable to uniquely identify rows. The results of the search are used to build a WHERE clause which uniquely identifies the row on the target column to apply data. Note: Availability of the above options is dependent on the platform and version of InfoSphere CDC that you have installed.
597
SCHEMA>.DMCJRN. InfoSphere CDC uses this journal table to detect and replicate database changes from the source to the target. v Use Selected Journalenable when you want InfoSphere CDC for Oracle to use another journal table other than the default journal table provided with InfoSphere CDC for Oracle. When you select the database owner and provide a name for the journal table, InfoSphere CDC creates this new journal table and uses it to detect and replicate database changes from the source to the target. Ownerlists the database owner of the journal table. Namelists the name of the journal table.
598
599
Before images for columns in the following format: before_mycolumnname After images for columns in the following format: after_mycolumnname The operation types for this format and the Multiple Record format below are as follows: insert or delete before image of update after image of update update v Multiple Recordan update operation is sent as two rows. The first row is the before image and the second row is the after image. InfoSphere CDC generates a file with journal control fields, before images for columns, and after images for columns. Separate records are produced for before and after images, and the format of each record is as follows: Four standard journal control fields for each column: DM_TIMESTAMP, DM_TXID, DM_OPERATION_TYPE, DM_USER The columns in the table mapping in the following format: mycolumnname
600
You can use the source table structure for your XML and decide if you want to include the before image, the after image, and/or journal control fields in the message. You can also decide not to choose a structure until you are ready to map source columns to XML elements and attributes in the Column Mappings tab. Use the source table structure for the XML messagethe following options are available to you: v Include before-image valuesenable this option when you want the XML message to include the before image of a row-level operation. The before-image represents the data in the source column before an insert, update, or delete operation on the row. v Include after-image valuesenable this option when you want the XML message to include the after image of a row-level operation. The after-image represents the data in the source column after an insert, update, or delete operation on the row. v Include journal control valuesenable this option when you want the XML message to include journal control fields. These provide information about the source table, the source database, or the table-level operations taking place in the database log or journal of the source database. For example, the _ENNTYPE journal control field indicates the type of table-level operation (insert, update, or delete) that took place on the source table. v Value Formatchoose how you want to format source column data in the XML message. You can choose from one of the following: Use attributes for data valuesformats data values of the before image, the after image, and/or journal control fields in your XML message as XML attributes. Use elements for data valuesformats data values of the before image, the after image, and/or journal control fields in your XML message as XML elements.
Do not specify the message format at this timeenable this option when you do not want to decide on a structure at this time. You can create the structure when mapping source columns to XML elements and attributes in the Column Mappings tab. Do not specify the message format at this timeEnable this option when you do not want to decide on a structure at this time. You can create the structure when mapping source columns to XML elements and attributes in the Column Mappings tab.
601
v Editopens the Message Destination dialog box. Use this dialog box to edit JMS message destination information. v Deletedeletes the selected JMS message destination of which can be either a queue or a topic. Message Retry area v Retry sending failed messagesenables you to specify the number of times you want InfoSphere CDC Event Server to attempt to post to a message queue or topic and the interval (in seconds) you want InfoSphere CDC Event Server to wait before trying to post again. v Retriesthe number of times InfoSphere CDC Event Server attempts to post to a message queue or topic. If InfoSphere CDC Event Server cannot send the message and to post it to a JMS message destination, then it is regarded as an unsuccessful post. v Interval (seconds)the time InfoSphere CDC Event Server waits before attempting to post a message to a queue or topic again.
602
You can use the source table structure for your XML and decide if you want to include the before image, the after image, and/or journal control fields in the message. You can also decide not to choose a structure until you are ready to map source columns to XML elements and attributes in the Column Mappings tab. Use the source table structure for the XML messagethe following options are available to you: v Include before-image valuesenable this option when you want the XML message to include the before image of a row-level operation. The before-image represents the data in the source column before an insert, update, or delete operation on the row. v Include after-image valuesenable this option when you want the XML message to include the after image of a row-level operation. The after-image represents the data in the source column after an insert, update, or delete operation on the row. v Include journal control valuesenable this option when you want the XML message to include journal control fields. These provide information about the source table, the source database, or the table-level operations taking place in the database log or journal of the source database. For example, the _ENNTYPE journal control field indicates the type of table-level operation (insert, update, or delete) that took place on the source table. v Value Formatchoose how you want to format source column data in the XML message. You can choose from one of the following: Use attributes for data valuesformats data values of the before image, the after image, and/or journal control fields in your XML message as XML attributes. Use elements for data valuesformats data values of the before image, the after image, and/or journal control fields in your XML message as XML elements.
Do not specify the message format at this timeenable this option when you do not want to decide on a structure at this time. You can create the structure when mapping source columns to XML elements and attributes in the Column Mappings tab. Do not specify the message format at this timeEnable this option when you do not want to decide on a structure at this time. You can create the structure when mapping source columns to XML elements and attributes in the Column Mappings tab.
603
v Editopens the Message Destination dialog box. Use this dialog box to edit JMS message destination information. v Deletedeletes the selected JMS message destination of which can be either a queue or a topic. Message Retry area v Retry sending failed messagesenables you to specify the number of times you want InfoSphere CDC Event Server to attempt to post to a message queue or topic and the interval (in seconds) you want InfoSphere CDC Event Server to wait before trying to post again. v Retriesthe number of times InfoSphere CDC Event Server attempts to post to a message queue or topic. If InfoSphere CDC Event Server cannot send the message and to post it to a JMS message destination, then it is regarded as an unsuccessful post. v Interval (seconds)the time InfoSphere CDC Event Server waits before attempting to post a message to a queue or topic again.
604
Wizards
605
Parent Table Columnspecifies that you want the WHERE clause to return the column of the parent table. This option is only available if you have already added another table and have chosen to add this table as the child table. v Valuedepending on your selection in the Type column, this specifies the static value, the before image or after image of the column, or the column of the parent table that you want the WHERE clause to return. If before/after images does not exist, use other imageenable this check box when you want InfoSphere CDC Event Server to use the other image of the column because of an operation on the source that could not trigger the before image or the after image. For example, if you map the before image of a column to an XML element or attribute and the operation on the source database was an insert, then because there is no before image of that column, InfoSphere CDC Event Server inserts the after image of the column instead. Also, if you map the after image of a column to XML element or attribute and the operation on the source database was a delete because there is no after image, InfoSphere CDC Event Server inserts the before image of that column instead.
606
RemoveRemoves the column from the Selected column list. Move upMoves the column you want to order by up the list of other selected columns. This lets you order the results by more than one column. Move downMoves the column you want to order by down the list of other selected columns. This lets you order the results by more than one column.
Wizards
607
608
Notices
This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the users responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo 106-0032, Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.
Copyright IBM Corp. 2008
609
Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Canada Limited Office of the Lab Director 8200 Warden Avenue Markham, Ontario L6G 1C7 CANADA Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this information and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. All statements regarding IBMs future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. All IBM prices shown are IBMs suggested retail prices, are current and are subject to change without notice. Dealer prices may vary. This information is for planning purposes only. The information herein is subject to change before the products described become available. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating
610
platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows: (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. Copyright IBM Corp. _enter the year or years_. All rights reserved. If you are viewing this information softcopy, the photographs and color illustrations may not appear.
Trademarks
The following terms are trademarks of International Business Machines Corporation in the United States, other countries, or both: 400 AIX AS/400 Current DB2 IBM InfoSphere iSeries System i Transformation Server WebSphere z/OS zSeries DataStage is a registered trademark of Ascential Software Corporation in the United States, other countries, or both. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Linux is a trademark of Linus Torvalds in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Other company, product, or service names may be trademarks or service marks of others.
Notices
611
612
Printed in USA