Table of Contents

Search

  1. Preface
  2. Introduction to PowerExchange Utilities
  3. createdatamaps - Data Map Creation Utility
  4. DTLCCADW - Adabas PCAT Utility
  5. DTLCUIML - IMS Log Marker Utility
  6. DTLINFO - Release Information Utility
  7. DTLREXE - Remote Execution Utility
  8. DTLUAPPL - Restart Token Utility
  9. DTLUCBRG - Batch Registration Utility
  10. DTLUCDEP - CDEP Maintenance Utility
  11. DTLUCSR2 - IDMS SR2 and SR3 Records Utility
  12. DTLUCUDB - DB2 for Linux, UNIX, and Windows CDC Utility
  13. DTLULCAT and DTLULOGC - IDMS Log Catalog Utilities
  14. DTLURDMO - Data Map Utility
  15. DTLUTSK - Task Control Utility
  16. EDMLUCTR - Log Scan and Print Utility
  17. EDMXLUTL - Event Marker Utility
  18. HOSTENT - TCP/IP Address Reporter Utility
  19. PWXCATMY - MySQL Catalog Utility
  20. PWXUCCLPRT - Print Log Summary Utility
  21. PWXUCDCT - Logger for Linux, UNIX, and Windows Utility
  22. PWXUCREG - Capture Registration Suspend Utility
  23. PWXUCRGP - Capture Registrations Print Utility
  24. PWXUDMX - Data Maps Update Time ECSA Memory Utility
  25. PWXUGSK - SSL Reporting Utility for z/OS
  26. PWXUMAP - Map List Utility
  27. PWXUSSL - PowerExchange SSL Reporting Utility

DTLUCBRG Utility Parameters

DTLUCBRG Utility Parameters

This section describes DTLUCBRG utility parameters.
Define the parameters at one of the following locations, depending on your operating system type:
  • On IBM i (i5/OS), define parameters in the parameters file that you specify on the command line.
  • On Linux, UNIX, and Windows, define parameters in the dtlucbrg.txt file. This file should be in the directory from which you run DTLUCBRG.
  • On z/OS, define parameters in the SYSIN of the JCL.
You are not required to specify parameters that have default values.
Parameter Descriptions:
CONDTYPE
The Condense option to use for the capture registrations. Options are:
  • FULL
    . This option is available if you use PowerExchange Condense on
    i5/OS
    or z/OS. PowerExchange accumulates change data in keyed condense files. Because later changes supersede earlier changes, this condense option does not maintain transactional consistency. Also, the following limitations apply:
    • Adabas and IDMS log-based CDC data sources are not supported.
    • On z/OS, data sources must have key columns. The total length of all key columns for a source cannot exceed 250 bytes.
    • On i5/OS, source tables must have primary keys, or DDS files must be defined with a unique key.
  • PART
    . This option is available if you use PowerExchange Condense on
    i5/OS
    or z/OS or the PowerExchange Logger for Linux, UNIX, or Windows. Changes in successfully committed UOWs are written to condense files or PowerExchange Logger log files in chronological order based on UOW end time. PowerExchange writes all changes for the columns of interest, not just the latest changes. This condense type maintains transactional consistency.
  • NONE
    . Capture registrations are not eligible for full or partial condense processing.
For more information, see the
PowerExchange Navigator User Guide
or PowerExchange CDC guides.
CREATEBICI
Controls whether the DTLUCBRG utility generates a before-image column, change-indicator column, or both for data columns in extraction maps. This parameter applies to all extraction maps that the utility creates. If you specify multiple tables by using a table-name mask, the CREATEBICI keywords apply to all of the tables that match the mask. See DTLUCBRG Utility Usage Notes for more information about limitations related to this parameter.
The syntax of the CREATEBICI parameter is:
CREATEBICI=(COLUMNS={PKFK|ALL|FILE}, MAXCOLS={
number_of_columns
|
500
}, EXTINFO={BI|CI|
BICI
}, INPUT_FN=
input_file_name
, OUTPUT_FN=
output_file_name
, ERROR_FN=
error_file_name
)
The CREATEBICI parameter contains the following keywords:
  • COLUMNS
    . The columns in the extraction map for which the utility generates before-image columns, change-indicator columns, or both types of columns, as indicated by the EXTINFO keyword. Options are:
    • PKFK
      . Generate before-image and change-indicator columns for primary-key and foreign-key columns.
    • ALL
      . Generate before-image and change-indicator columns for all selected columns in the extraction map.
    • FILE
      . Generate before-image and change-indicator columns for columns that are defined in the table schema in the utility input file.
    No default is provided.
    If you are generating before-image or change-indicator columns and the COLUMNS keyword identifies user-defined columns with expressions that invoke PowerExchange functions, ensure that the functions support BI buffering. If a function does not support BI buffering, PowerExchange does not generate BI or CI columns for the field. For more information, see Expression-Field Functions That Support CREATEBICI Processing.
  • MAXCOLS
    . Optional. The maximum number of columns for which the utility generates before-image and change-indicator columns in the extraction map. Valid values are 10 through 32000. Default is 500.
    How you set this keyword depends on the COLUMNS setting. Use the following guidelines:
    • If COLUMNS=FILE, the MAXCOLS value must be equal to or greater than the number of entries in the input file.
    • If COLUMNS=ALL, the MAXCOLS value must be equal to or greater than the largest number of columns in a registered table.
    • If COLUMNS=PKFK, the MAXCOLS value must be equal to or greater than the number of primary and foreign keys in the largest registered table.
  • EXTINFO
    . Optional. The type or types of metadata columns to generate in the extraction maps. Options are:
    • BI
      . Before-image columns.
    • CI
      . Change-indicator columns.
    • BICI
      . Both before-image and change-indicator columns.
    Default is BICI.
    In some cases, the before-image or change-indicator column cannot be created. For example, the utility cannot create a before-image column for DB2 z/OS LOB columns in extraction maps. If you try to create a before-image column for DB2 for z/OS LOB columns, the request is ignored and a warning message is written to the output file.
  • INPUT_FN
    . On i5/OS, Linux, Unix, and Windows, the name of the input file that contains the column names for the before-image and change-indicator columns. On z/OS, enter
    Y
    or
    N
    . If you enter
    Y
    , the utility uses a default partitioned data set extended (PDSE) that has been pre-allocated with a DSNTYPE of LIBRARY and a record length of 255 bytes. You can use this keyword only if the COLUMNS keyword is set to
    FILE
    .
  • OUTPUT_FN
    . On i5/OS, Linux, Unix, and Windows, the name of the output file that contains log information about the before-image and change-indicator columns created in the extraction maps. On z/OS, enter
    Y
    or
    N
    . If you enter
    Y
    , the utility uses a default partitioned data set extended (PDSE) that has been pre-allocated with a DSNTYPE of LIBRARY and a record length of 255 bytes.
  • ERROR_FN
    . On i5/OS, Linux, Unix, and Windows, the name of the file that lists the columns for which before-image and change-indicator columns failed to be generated in the extraction maps. On z/OS, enter
    Y
    or
    N
    . If you enter
    Y
    , the utility uses a default partitioned data set extended (PDSE) that has been pre-allocated with a DSNTYPE of LIBRARY and a record length of 255 bytes.
If both CREATEBICI and RPTCOLS=Y are specified, the utility adds before-image and change-indicator columns to the output report with the value
Y
or
N
in each of these columns.
CRGNAME
A user-defined capture registration name. This name can be up to 13 alphanumeric characters in length and cannot begin with a number. PowerExchange uses this value as the entire registration name. Because PowerExchange does not append a unique number to it, as it does with CRGPREFIX, you can use CRGNAME to replace registrations that were lost or damaged or to regenerate registrations under their original registration names.
Do not use CRGNAME under any of the following circumstances:
  • The TABLE parameter specifies a mask that contains the asterisk (*) wildcard. To use CRGNAME, the table name must be explicitly specified in the same manner as when registering the table.
  • The REUSECRGNAME parameter is set to
    Y
    .
  • The CRGPREFIX parameter is specified. You must specify CRGPREFIX or CRGNAME, but do not specify both of them.
CRGPREFIX
A prefix of one to four characters in length for the registration name. The utility appends a 4-digit sequential number to this prefix to form a unique registration name.
The registration name can have any of the following formats:
xnnnn
xxnnnn
xxxnnnn
xxxxnnnn
Where:
  • x...
    is the prefix value that you enter. The first
    x
    value must be a letter from a to z. Subsequent
    x
    values can include the letters a to z or the integers 0 to 9.
  • nnnn
    is a sequential number that the utility generates, starting from 0001.
If the utility tries to create a registration for a table that has a table name containing invalid characters, the utility issues an error message and continues processing without creating the registration for the table.
To replace a registration under its previous name, you must use the CRGNAME parameter instead of the CRGPREFIX parameter.
Do not specify both CRGPREFIX or CRGNAME.
DBTYPE
A three-character mnemonic that indicates the data source type. Options are:
  • ADA
    for Adabas
  • AS4
    for DB2 for i (i5/OS)
  • DB2
    for DB2 for z/OS
  • DCM
    for Datacom
  • IDL
    for IDMS log-based
  • IMS
    for IMS
  • MSS
    for Microsoft SQL Server
  • MYS
    for MySQL
  • ORA
    for Oracle
  • PGS
    for PostgreSQL
  • UDB
    for DB2 for Linux, UNIX, and Windows
  • VSM
    for VSAM
Use
DB2
only for DB2 on z/OS. Use
AS4
or
UDB
for DB2 products on other platforms.
EPWD
An encrypted password for the user ID specified by UID.
If the utility accesses an i5/Os or z/OS location, you can enter an encrypted PowerExchange passphrase instead of an encrypted password. Do not encrypt a passphrase that contains invalid characters, such as double-quotation marks, single quotation marks, or currency symbols.
You can create an encrypted password or passphrase in the PowerExchange Navigator by selecting
File
Encrypt Password
.
Use EPWD instead of PWD if you are not allowed to store passwords in a readable format.
INSTANCE
The source instance for your registrations. The value type depends on the source database type that you specify in the DBTYPE parameter.
Based on the DBTYPE option, enter one of the following values:
  • For
    ADA
    , enter an Adabas nucleus name.
  • For
    AS4
    , enter a DB2 for i (i5/OS) instance value that matches the INST parameter value in the AS4J CAPI CONNECTION statement in the DBMOVER member of the
    dtllib
    /CFG file. If you use PowerExchange Condense, this instance value must also match the DBID parameter value in the CAPTPARM member.
  • For
    DB2
    , enter a DB2 subsystem ID (SSID).
  • For
    DCM
    , enter a Datacom Multi-User Facility (MUF) name.
  • For
    IDL
    , enter an IDMS log-based CDC instance value that matches the
    registration_logsid
    parameter in the LOGSID statement in the DBMOVER configuration member.
  • For
    IMS
    , enter an IMS subsystem ID that matches the
    ims_ssid
    parameter value in the IMSID statement in the DBMOVER configuration member.
  • For
    MSS
    , optionally enter a unique user-defined instance identifier for the SQL Server database server and database name combination defined in the MSSOPTS DBSERVER and DBNAME parameters. Maximum length is seven characters. This identifier is incorporated into the names of the extraction maps that the utility creates. If you use the PowerExchange Logger for Linux, UNIX, and Windows, ensure that the instance identifier matches the DBID parameter value in the Logger configuration file. If you do not enter this instance value, PowerExchange generates a unique instance identifier that is composed of all or part of the publication database name followed by a 3-digit number if a number is required to make the identifier unique.
    This INSTANCE parameter is useful in migration scenarios. If you need to deploy change capture from one environment to another, such as from test to production, and you do
    not
    define an instance identifier, PowerExchange uses the generated instance identifier in the new environment. The generated instance identifier might be different than the one in the original source environment. To avoid having to update the extraction map names in PowerCenter workflows and edit the DBID parameter value for the PowerExchange Logger, enter an instance identifier in the INSTANCE parameter that matches the instance identifier in the original environment when creating registrations for the new environment.
    In this migration scenario, ensure that the dbmover.cfg configuration files in the original environment and new environment specify unique paths in CAP_PATH and CAPT_XTRA statements.
  • For
    MYS
    , enter a unique, user-defined instance identifier for the MySQL database server. Maximum length is seven characters. This identifier is used to identify a set of registrations for tables in the database on the MySQL server. This identifier is also incorporated into the names of the extraction maps that the utility creates. If you use the PowerExchange Logger for Linux, UNIX, and Windows, ensure that this instance identifier matches the DBID parameter value in the Logger configuration file.
  • For
    ORA
    , enter the user-defined collection ID for the Oracle instance that matches the
    collection_id
    parameter in the ORACLEID statement in the PowerExchange DBMOVER configuration member.
  • For
    PGS
    , enter a unique, user-defined instance identifier for the PostgreSQL database server and database name combination defined in the PGSOPTS DBSERVER and DBNAME parameters. Maximum length is seven characters. This identifier is incorporated into the names of the extraction maps that the utility creates. If you use the PowerExchange Logger for Linux, UNIX, and Windows, ensure that the instance identifier matches the DBID parameter value in the Logger configuration file. If you do not enter this instance value, PowerExchange generates a unique instance identifier that is composed of all or part of the database name followed by a three-digit number.
  • For
    UDB
    , enter a DB2 for Linux, UNIX, and Windows database name.
  • For
    VSM
    , enter a VSAM collection identifier.
LOCATION
Required. A node name that points to the location of the PowerExchange Listener that manages the capture registrations and extraction maps.
If the registrations, data maps, and data source reside on the same system, you can specify LOCATION=LOCAL. In this case, do not define the other LOCATION_
xxx
parameters.
Do not specify LOCATION=LOCAL if you add or modify VSAM, IMS synchronous, or DB2 for z/OS capture registrations. Otherwise, the PowerExchange Agent fails to detect the new or updated registrations, and the ECCR cannot retrieve the registration changes during a restart or refresh operation. Instead, specify the LOCATION value for the PowerExchange Listener that manages the registrations and is connected to the PowerExchange Agent. Then, the updated registration information is available for ECCR processing.
LOCATION_CRG
The location of the registration file (CCT). The default is the LOCATION parameter value.
LOCATION_DM
The location of the DATAMAP file. The default is the LOCATION parameter value.
LOCATION_XDM
The location of the extraction maps. The default is the LOCATION parameter value.
NOTIFYCHANGES
For DB2 and Oracle sources, if you specify NOTIFYCHANGES=Y, any change to the schema for the table causes PowerExchange CDC to fail and log an error message.
For a DB2 for z/OS source, the DB2 ECCR ends abnormally after it reads the first change record for the table after the schema change.
For an Oracle source, Oracle CDC fails and logs an error message in the following situations:
  • A change record for a registered table contains a column that is not registered for change capture.
  • A change record does not contain any column that is registered for change capture.
For Oracle CDC, if a table definition changes in a way that is compatible with the PowerExchange capture registration, Oracle CDC continues to capture changes for that table. For example, if the length of a character column decreases but the capture registration does not reflect this change, Oracle CDC continues to capture changes for the table.
Conversely, if the data type of a column changes from numeric to character and the capture registration is not updated to reflect this change, Oracle CDC continues to capture changes for the table until it encounters the first change record that contains nonnumeric data for the column. Oracle CDC then fails and logs an error message.
For DB2 and Oracle sources, default is
Y
. For other data sources, default is
N
, which causes this parameter to be ignored.
OUTPUT
The location and file name of the report that DTLUCBRG generates. For example:
OUTPUT=c:\pwx\outfile.txt
If the path includes names with spaces, enclose the path in quotation marks.
On z/OS, the report is directed to the SYSPRINT DD output by default. On Windows, the report is directed to STDOUT by default.
PWD
A clear text password for the specified user ID. For access to an i5/OS or z/OS location, you can enter a valid PowerExchange passphrase instead of a password. An i5/OS passphrase can be from 9 to 31 characters in length. A z/OS passphrase can be from 9 to 128 characters in length. A passphrase can contain the following characters:
  • Uppercase and lowercase letters
  • The numbers 0 to 9
  • Spaces
  • The following special characters:
    ’ - ; # \ , . / ! % & * ( ) _ + { } : @ | < > ?
    The first character is an apostrophe.
Passphrases cannot include single quotation marks (‘), double quotation marks (“), or currency symbols.
If a passphrase contains spaces, you must enclose it with double-quotation marks ("), for example,
"This is a passphrase"
. If a passphrase contains special characters, you must enclose it with triple double-quotation characters ("""), for example,
"""This passphrase contains special characters ! % & *."""
. If a passphrase contains only alphanumeric characters without spaces, you can enter it without delimiters.
To use passphrases, ensure that the PowerExchange Listener runs with a security setting of SECURITY=(1,N) or higher in the DBMOVER member. For more information, see "SECURITY Statement" in the
PowerExchange Reference Manual
.
On z/OS, a valid RACF passphrase can be up to 100 characters in length. PowerExchange truncates passphrases longer than 100 characters when passing them to RACF for validation.
Do not also specify EPWD.
REPLACE
Whether to replace existing inactive registrations. Options are:
  • Y
    . Replace existing inactive registrations that match the mask specified in the TABLE parameter.
  • N
    . Do not replace any existing registrations. Add registrations for tables that match the mask and do not yet exist.
Default is
N
.
REPLACEACTIVE
Whether to replace existing active registrations. Options are:
  • Y
    . Replace existing active registrations that match the mask specified in the TABLE parameter. For this replacement to occur, the REPLACE parameter must also be set to Y.
  • N
    . Do not replace active registrations.
Default is
N
.
REUSECRGNAME
Whether the DTLUCBRG retains the current names of existing capture registrations or renames them. Options are:
  • Y
    . Retain the current names of existing registrations.
  • N
    . Rename existing registrations by using the CRGPREFIX and sequential number format.
Default is
N
.
RPTCOLS
Whether to rename any existing capture registrations or retain their current names. Options are:
  • Y
    . Retain the current names of existing registrations.
  • N
    . Rename the existing registrations by using the CRGPREFIX and sequential number format.
Default is
Y
.
STATUS
The status to set for the capture registrations that the DTLUCBRG utility creates. Options are:
  • A
    . Create registrations with the status of Active.
  • I
    . Create registrations with the status of Inactive. Later, you will need to activate the registrations to make them eligible for change capture use.
For Microsoft SQL Server sources, if you specify UPDATESTATUS=Y in the MSSOPTS parameter, this STATUS parameter resets the status of all registrations that match the filter criteria you specify.
TABLE
A mask that restricts the source tables for which the DTLUCBRG utility will create capture registrations.
  • For relational database tables, the mask can be specified in the following format:
    owner_or_schema
    .
    tablename
    Within this mask, the schema name and table name can each be up to 128 characters in length.
  • For nonrelational sources, the mask includes the data map name and can be specified in the following format:
    schema
    .
    mapname
    Optionally, you can define a TABLE parameter value in NRDB or NRDB2 format that includes a table name to narrow the selection of tables when multiple tables are defined in a data map but not all of the tables need to be registered.
    The following example shows the three-tier NRDB format, which uses period (.) separators between the schema name, map name, and table name:
    SCHEMA
    .
    mapname
    .
    tablename
    The following example shows the two-tier NRDB2 format, which is uses an underscore (_) separator between the map name and table name:
    SCHEMA
    .
    mapname
    _
    tablename
To represent one or more characters in any part of the parameter value, use the asterisk (*) wildcard. For example, the following mask matches all relational tables that have the owner "OWNAB" and a table name that starts with "T":
OWNAB.T*
The following example shows a parameter value in NRDB2 format that contains a wildcard mask in both the map name and table name. The parameter value matches map names that start with an "M", and table names that start with "T".
SCHEMA1.M*_T*
The following example shows the same masks in NRDB format:
SCHEMA1.M*.T*
TESTRUN
Whether to perform a test run of the DTLUCBRG utility. Options are:
  • Y
    . Perform a test run to determine the capture registrations to be updated or added. The test run does not actually update or add any registration.
  • N
    . Do not perform a test run. When you run the utility, it will update or add capture registrations.
Default is
Y
.
UID
A user ID that allows access to the source. The requirement for this parameter depends on both the data source that is being registered and the value of the SECURITY statement in the PowerExchange DBMOVER configuration file.
For a source on a supported Linux, UNIX, or Windows system, if you have enabled PowerExchange LDAP user authentication and, if applicable, disabled relational pass-through authentication, the user ID is the enterprise user name. For more information, see the
PowerExchange Reference Manual
.
If you specify a user ID, also specify either a PWD or EPWD value.

0 COMMENTS

We’d like to hear from you!