Table of Contents

Search

  1. Preface
  2. PowerExchange CDC Publisher Overview
  3. Installing and Upgrading PowerExchange CDC Publisher
  4. PowerExchange CDC Publisher Key Concepts
  5. PowerExchange Change Capture Environment
  6. Target Messaging Systems
  7. Configuring PowerExchange CDC Publisher
  8. Streaming Change Data
  9. Monitoring PowerExchange CDC Publisher
  10. Administering PowerExchange CDC Publisher
  11. Command Reference for the Command-Line Utilities
  12. Avro Schema Formats
  13. Message Reference

User Guide

User Guide

PwxCDCAdmin Utility - Command and Parameters

PwxCDCAdmin Utility - Command and Parameters

Use the PwxCDCAdmin utility to perform administrative functions for the PowerExchange CDC Publisher process.
With the PwxCDCAdmin command and its parameters, you can perform the following tasks:
  • Report the Avro schemas, or format definitions, for all source tables or a selected source table for viewing or consumer application use.
  • Clear the generated Avro schemas for source tables from cache. The CDC Publisher uses these schemas to format data in the messages to be sent to the target.
  • Re-read extraction map definitions for all data sources from PowerExchange and cache any new and updated information.
  • Shut down the PwxCDCPublisher process after it completes current work in progress.
You can use file-system security to limit rights on the PwxCDCAdmin utility script.

Syntax

PWXCDCADMIN [INSTANCE=
override_instance_directory
] [REPORT=FORMAT TABLE={ALL|
mapname_tablename
}] [CLEAR=FORMAT TABLE={ALL|
mapname_tablename
}] [RESET=FORMAT] [ENCRYPT=
cleartext_password
] [SHUTDOWN]
All parameters are optional. Use one or more spaces as the separator between parameters.

Parameter Descriptions

INSTANCE=
override_instance_subdirectory
Overrides the default name or location of the instance subdirectory, which is
pwxcdcpub_root installation
\instanceA
. You can enter the fully qualified path of the subdirectory or a location that is relative to the root installation directory that is specified in the PWXPUB_HOME environment variable. For example, the following values specify the same directory location if
PWXPUB_HOME=C:\Informatica\ PwxCdcPublisherInstall.1.0.0.windows.64bit:
instanceB
C:\Informatica\PwxCdcPublisherInstall.1.0.0.windows.64bit\instanceB
REPORT=FORMAT TABLE={ALL|
mapname_tablename
}
Reports the existing Avro schemas, or format definitions, for either all source tables or a selected source table in the
/
pwxcdcpub_root installation
/instance
X
/reports
directory. These Avro schemas are produced in a legible format. The schemas can be used for validation purposes or by consumer applications. If no Avro schemas exist for one or more source tables, the utility generates the schemas based on the Formatter properties in the cdcPublisherAvro.cfg configuration file and cached extraction map definitions. If the extraction maps are not in cache, you can use the RESET parameter to re-read them from PowerExchange.
The TABLE parameter is required and has no default value. Set the TABLE parameter to either ALL or a specific
mapname_tablename
value from an extraction map name. If this value includes special characters, the CDC Publisher replaces the special characters with the replacement character that is specified in the Formatter.avroNameReplacementValue parameter. Avro does not support special characters.
To determine the
mapname_tablename
value, look up the extraction map name in the PowerExchange Navigator. The extraction map name has the format
xnninstance
.
mapname
_
tablename
. Use the
mapname_tablename
portion in the TABLE parameter. If the extraction map name does not include the
tablename
, change records have not yet been extracted based on the extraction map. For more information, see the
PowerExchange Navigator User Guide
.
CLEAR=FORMAT TABLE={ALL|
mapname_tablename
}
Clears the Avro schemas, or format definitions, for all source tables or a selected source table from cache. Use this parameter if the Avro format definition for one or more source tables has changed and is no longer valid for CDC Publisher processing. When the CDC Publisher next receives change data for a changed source table, it regenerates the Avro schema. Alternatively, you can force the Avro schema to be regenerated by using the REPORT=FORMAT parameter.
The TABLE parameter is required and has no default value. Set the TABLE parameter to either ALL or a specific
mapname_tablename
value from an extraction map name.
RESET=FORMAT
Re-reads extraction map definitions for all data sources from PowerExchange and caches them. PowerExchange CDC Publisher uses the extraction map information to generate new Avro schemas when either change data is next received for the source tables associated with the extraction maps or when you issue the PwxCDCAdmin command with the REPORT=FORMAT parameter.
If you add a source table, you can use the RESET=FORMAT parameter to get the extraction map definition for the new table right away so that you can generate the Avro schema for verification purposes, before change data is received from the table. Alternatively, you can wait until change data from the new table is first received. At that point, the CDC Publisher caches the extraction map and generates the Avro schema.
ENCRYPT=
cleartext_password
Encrypts a clear-text password so that you can enter an encrypted password in the Extract.pwxXmapPwd or Extract.pwxNodePwd property in the cdcPublisherPowerExchange.cfg configuration file to protect the password from unauthorized viewing. The PwxCDCAdmin utility generates and displays encrypted passwords in the following format:
ENC:
encrypted_password
Where "ENC:" is the prefix that the CDC Publisher uses to identify an encrypted password value. When you enter the encrypted password in the Extract.pwxXmapPwd or Extract.pwxNodePwd property, include the ENC: prefix, for example:
Extract.pwxXmapPwd=ENC:AC/YB0tjDJDR2DBdAUXgqDQ==
Do not use this type of encryption for the Extract.pwxNodeEPwd property value. For this property, use the PowerExchange Navigator Encrypt Password facility to encrypt the password. For more information, see the
PowerExchange Navigator User Guide
.
SHUTDOWN
Shuts down the PowerExchange CDC Publisher process cleanly. If messages are being written to topics when the shutdown request is made, the connection to the target remains open until all of the sent messages are acknowledged by the target as received. Then the CDC Publisher shuts down.

0 COMMENTS

We’d like to hear from you!