The zLog Publisher configuration (.cab) file is a binary file created and maintained by the SQDconf utility. While this section focuses primarily on the initial configuration of the Publisher Agent, sequences of SQDconf commands to create and configure the publisher should be saved in a zOS PARMLIB member for migration to other operating environments and for recovery.
The SQDconf create command will be used to prepare the initial Publisher configuration (.cab) file for the IMS Log Reader Capture, IMS TM EXIT Capture and the VSAM Log Replicate capture:
Syntax
sqdconf create <cab_file_name>
--type=zlog
--zlog=<log_stream_name>
[--ccsid=<coded_character_set_identifier>]
[--cache-count=<number>]
[--cache-size=<number>]
[--retry=<number> | --noretry]
[--size=<number>]
[--encryption | --no-encryption]
[--auth-keys-list=<name>]
[--exclude-program=<program_name>]
Keyword and Parameter Descriptions
| Keyword | Description |
|---|---|
| <cab_file_name> | Path and name of the Capture/Publisher Configuration (.cab) file. The directory must exist and the user-id associated with the agent must have the right to create and delete files in that directory. Precisely recommends including the Capture Agent alias as the third node in the directory structure and first node of the file name, for example, /home/sqdata/db2cdc/db2cdc.cab. |
| --type=zlog | Type of the storage agent configuration file. The zlog Publisher works exclusively with z/OS System Log Streams. |
| --zlog=<log_stream_name> | The z/OS System Log Stream must be created using the IXCMIAPU utility as a prerequisite. |
| [--ccsid=<number>] | The coded character set identifier or code page number of the source database. |
| [--cache-count=<number] | Caching transactions in memory while waiting for a commit, avoids having to re-read the zLog and can improve performance. When the cache is full (too little cache compared to the number of in-flight transactions or a given transaction is too large to fit in one cache), a cache miss occurs, and the zlog will have to be re-read to acquire the data instead of using the cache to publish. This parameter specifies the number of individual transactions the capture is allowed to cache. Also see --cache-size. On relevant captures, displaying the capture status will indicate the cache-miss count, due to an insufficient number or size of cache. Default = 50 |
| [--cache-size=<size>] | The size of each individual transaction cache (in KB) Default = 100, consider 500 to 1000. |
| [--retry=<number>] | Number of seconds to wait before re-attempting to write to the zLog transient data store. When a write to fails due to a Full condition, the capture agent will wait the specified number of seconds before re-attempting the write. If the second write fails the agent stops and reports an error, otherwise processing will continue normally. This allows for throttling the output rate. A negative or null value disables the retry mechanism. |
| [--noretry] | Disable the retry mechanism |
| [--size=<number> | -s <number>] | Number of entries in a configuration file at creation. The default is 31 entries. The configuration file will grow automatically by doubling its size when ever needed. The only restriction is that such growth cannot occur while the associated capture agent is in the STARTED state. |
| [--encryption | --no-encryption] | Enables or disables NaCL encryption of the published CDC record payload. On z/OS Precisely recommends zIIP processors be used to enhance CPU cycle efficiency and reduce CPU cost associated with NaCL software encryption. |
| [--auth-keys-list="<name>"] | Required for NaCL software encrypted CDC record payload. File name must be enclosed in quotes and must contain public key(s) of only the subscribing Engines requiring encryption of the CDC record payload. See --encryption option. |
| [--exclude-program=<program_name>] | IMS and VSAM Source Captures only. See those References for details. |