User Guide

1.1
- 1.3
- 1.2
- 1.0

Back Next

Command Reference Overview

This command reference describes the proper syntax, usage, and limitations of commands for controlling the PowerExchange CDC Publisher command-line utilities.

Commands for the following PowerExchange CDC Publisher utilities are covered:

PwxCDCPublisher utility
- The main utility for streaming change data from PowerExchange to the target messaging system. The utility extracts change data from PowerExchange, filters the data by source object if filtering criteria is defined, formats the data into messages, connects to the target, and publishes the messages to the target. The utility initiates a data stream path
that is composed of all of these processes.

PwxCDCAdmin utility
- The utility for issuing administrative commands to an active PwxCDCPublisher process.

PwxCDCInfo utility
- The utility for reporting the status of an active PwxCDCPublisher process and each of its main subprocesses, statistics and state information for each target topic, and internal attributes for diagnostic use.

The following table describes the conventions that the command reference uses to indicate the proper command syntax:

Convention	Description	Example
Monospaced font	Indicates the command syntax or a command example.	PWXCDCPUBLISHER HELP
Italics	Indicates a variable in the syntax for which you enter a specific value.	[ENCRYPT=password_value ]
Square brackets [ ]	Indicates an optional parameter or subparameter.	[SHUTDOWN]
A vertical bar \| between items	Indicates that you enter only one of the items.	TABLE={ALL\|mapname_tablename }
Curly brackets { } around multiple items	Indicates that you must enter at least one of the items within the brackets.	RESTART={FROM_BEGINNING\|FROM_END\|FROM_CONFIG}
Underlining	Indicates the default value	COLDSTART={Y\| N }

To run a command, navigate to the

bin

subdirectory that contains the utility script. Then enter the script name with the appropriate parameters at the command line.

You can run the PwxCDCAdmin and PwxCDCInfo utilities on a system that is remote from host where the PowerExchange CDC Publisher process is running. In this scenario, you must install the PowerExchange CDC Publisher on the remote system as well as on the CDC Publisher system. Also, in the configuration file on the remote system, you must set the Common.pwxCDCPublisherHost property to the public IP address of the CDC Publisher system and define the PWXPUB_HOME environment variable.

Rename Saved Search

Table of Contents

User Guide

User Guide

Command Reference Overview

Command Reference Overview