User Guide

1.0
- 1.3
- 1.2
- 1.1

Back Next

PowerExchange Extract Configuration Properties

The sample cdcPublisherPowerExchange.cfg file contains properties that the PowerExchange CDC Publisher uses to extract change from PowerExchange and to retrieve PowerExchange extraction map definitions of source objects. The following list describes the properties in the sample file. It also includes some additional properties that you might want to use.

Property Descriptions

The following properties are in the sample cdcPublisherPowerExchange.cfg file:

Extract.pwxCapiConnectionName: Required. The NAME parameter value in the CAPX CAPI_CONNECTION statement in the PowerExchange DBMOVER configuration file. This CAPI_CONNECTION statement is used to connect to the PowerExchange change data stream to read data from PowerExchange Logger log files.
No default value is provided.
Extract.pwxExtractionMapSchemaName: Required. The PowerExchange-generated schema name that is included in the names of the PowerExchange extraction maps for the source objects. This schema name has the format unninstance or dnninstance, where "u" indicates a user-defined extraction map, "d" indicates the default extraction map generated from the capture registration, nn is a two-digit value that represents the source type, and instance is the instance value from the PowerExchange registration group for the data source. The schema name is the first part of the full extraction map name: xnninstance
.mapname_tablename. This property is used to select the extraction maps that the CDC Publisher will use to extract change data.
All extraction maps with names that match the specified schema name or mask are selected. If you want to use a subset of these extraction maps, define the Extract.captureConsumerExcludeNameList or Extract.captureConsumerIncludeNameList property to filter the extraction maps.
No default value is provided.
Extract.captureConsumerIncludeNameList: A list of the extraction maps that match the specified schema name and that you want to explicitly include
in extraction processing. The PowerExchange CDC Publisher process will use only these included extraction maps. Any other extraction maps that were selected based on the extraction-map schema name are ignored. For each extraction map to include, enter the full extraction map name in the format xnninstance.mapname_tablename. Use a comma (,) separator between the values, for example:
Extract.captureConsumerIncludeNameList=xnninstance.mapname_tablename1,xnninstance.mapname_tablename2,...
You can include the asterisk (*) wildcard anywhere in the value to represent one or more characters, thereby creating a mask that matches multiple extraction maps.
Extract.captureConsumerExcludeNameList: A list of the extraction maps that match the specified schema name but that you want to exclude
from extraction processing. For each extraction map to exclude, enter the full extraction map name in the format xnninstance.mapname_tablename. Use a comma (,) separator between the values, for example:
Extract.captureConsumerExcludeNameList=xnninstance.mapname_tablename1,xnninstance.mapname_tablename2,...
You can include the asterisk (*) wildcard anywhere in the value to represent one or more characters, thereby creating a mask that matches multiple extraction maps.
Extract.pwxNodeLocation: Required. The node name (first positional parameter) in the NODE statement that is used to connect to the PowerExchange Listener for change data extraction. This statement is defined in the PowerExchange DBMOVER configuration file. This Listener runs on the system with the PowerExchange Logger for Linux, UNIX, and Windows log files.
No default value is provided.
Extract.pwxNodeUserId: A user ID that is authorized to access to the node that contains the PowerExchange Logger log files from which change data will be extracted. Define this property only if access to the node specified in the Extract.pwxNodeLocation property is secured by a user ID and password. If you use remote logging of source data to PowerExchange Logger for Linux, UNIX, and Windows log files that reside off the source system, this property value matches the CAPTURE_NODE_UID parameter value in the PowerExchange Logger configuration file, pwxccl.cfg.
No default value is provided.
Extract.pwxNodePwd: A password that is associated with the user ID specified in the Extract.pwxNodeUserId property. This password can be a clear-text password or a password that has been encrypted by running the PwxCDCAdmin utility with the ENCRYPT parameter.
Define this property only if access to the node specified in the Extract.pwxNodeLocation property is secured by a user ID and password. If you use remote logging of source data to PowerExchange Logger for Linux, UNIX, and Windows log files that reside off the source system, this property value matches the CAPTURE_NODE_PWD parameter value in the PowerExchange Logger configuration file, pwxccl.cfg.
If you use PowerExchange-encrypted passwords, specify the Extract.pwxNodeEPwd property instead.
No default value is provided.
Extract.pwxNodeEPwd: An encrypted password that is associated with the user ID specified in the Extract.pwxNodeUserId property. This password must have been encrypted by using the PowerExchange Navigator Encrypt Password facility.
Define this property only if access to the node specified in the Extract.pwxNodeLocation property is secured by a user ID and password. If you use remote logging of source data to PowerExchange Logger for Linux, UNIX, and Windows log files that reside off the source system, this property value matches the CAPTURE_NODE_EPWD parameter value in the PowerExchange Logger configuration file, pwxccl.cfg.
If you use clear-text passwords or passwords that have been encrypted by the CDC Publisher PwxCDCAdmin ENCRYPT command, specify the Extract.pwxNodePwd property instead.
No default value is provided.
Extract.pwxXmapLocation: The node name (first positional parameter) in the NODE statement that is used to connect to the PowerExchange Listener on the source system to retrieve extraction maps for source objects. This statement is defined in the local PowerExchange DBMOVER configuration file. If you use remote logging of source data to PowerExchange Logger for Linux, UNIX, and Windows log files that reside off the source machine, this property value matches the CAPTURE_NODE parameter value in the PowerExchange Logger configuration file, pwxccl.cfg.
If the data source and extraction maps are on the same node as the PowerExchange Listener and Logger, you do not need to specify this property. You can specify only the Extract.pwxNodeLocation property to connect the PowerExchange Listener that handles both requests for extraction maps and requests for change data extraction.
No default value is provided.
Extract.pwxXmapUserId: A user ID that is authorized to access the node that contains the PowerExchange extraction maps for source objects. Define this property only if access to the node specified in the Extract.pwxXmapLocation property is secured by a user ID and password. If you use remote logging of source data to PowerExchange Logger for Linux, UNIX, and Windows log files that reside off the source system, this property value matches the CAPTURE_NODE_UID parameter value in the PowerExchange Logger configuration file, pwxccl.cfg.
No default value is provided.
Extract.pwxXmapPwd: A clear-text or encrypted password that is associated with the user ID specified in the Extract.pwxXmapUserId property. To encrypt the password, run the PwxCDCAdmin utility with the EXTRACT parameter.
Define this property only if access to the node specified in the Extract.pwxXmapLocation property is secured by a user ID and password. If you use remote logging of source data to PowerExchange Logger for Linux, UNIX, and Windows log files that reside off the source system, this property value matches the CAPTURE_NODE_PWD parameter value in the PowerExchange Logger configuration file, pwxccl.cfg.
No default value is provided.

The following additional properties can also be included the cdcPublisherPowerExchange.cfg file at your discretion:

Extract.pwxReturnLogInfoMessages: Controls whether the informational messages that PowerExchange returns to the CDC Publisher are written to the PwxCdcPublisher.out file in the logs subdirectory. Set this property to true to log the PowerExchange informational messages, or set this property to false to not log these informational messages. Default is false.
Extract.pwxUpdateImageOption: For UPDATE operations, indicates whether the PowerExchange CDC Publisher receives both the before-image and after-image data or only the after-image data from the PowerExchange change stream. Valid values are:
AI
. Gets the after image only.
TU
. Gets the before image followed by the after image.
AB
. Gets the after image followed by the before image.
The default value is TU. To a CDC Publisher user, the AB and TU options produce the same results.
If the PowerExchange Logger for Linux, UNIX, and Windows is configured to log only after images, you must set this property to AI. Otherwise, PowerExchange issues a fatal error.
Extract.restart1: The PowerExchange sequence token value that you want to use to restart the CDC Publisher process from a specific point in the change stream. For this property value to be used, you must restart the PwxCdcPublisher process with the COLDSTART=Y or RESTART=FROM_CONFIG parameter. You must also specify the Extract.restart2 property. No default value is provided.
Extract.restart2: The PowerExchange restart token value that you want to use to restart the CDC Publisher process from a specific point in the change stream. For this property value to be used, you must restart the PwxCdcPublisher process with the COLDSTART=Y or RESTART=FROM_CONFIG parameter. You must also specify the Extract.restart1 property. No default value is provided.

Rename Saved Search

Table of Contents

User Guide

User Guide

PowerExchange Extract Configuration Properties

PowerExchange Extract Configuration Properties

Property Descriptions