SharePlex 8.6.6 - Reference Guide

copy status

Use the copy status command to view the status of the last copy or append job run. The copy status command can be used to view detailed status on a copy or append job or a portion of a copy or append job, or to view status on all copy and append jobs for which SharePlex has history.

For details and examples about using the copy status command, see the job status command.

Usage

Syntax

Syntax description

Remote options

These options enable you to issue the command on a remote machine and to script commands that include a login name, password, port number, or combination of those items.

create config

Use the create config command to create a new configuration file. This command runs the SharePlex default text editor and opens a new file. To create a configuration, follow the instructions in Chapter 5 of the SharePlex Administrator’s Guide.

If you attempt to give a new configuration the same name as an existing configuration, SharePlex returns this error message “The parameter for create config must be a new filename.”

As an alternative to creating a configuration, you can use the copy config command to duplicate an existing configuration and then use the edit config command to edit the copy.

Usage

Syntax

Syntax description

Remote options

These options enable you to issue the command on a remote machine and to script commands that include a login name, password, port number, or combination of those items.

create encryption key

Use the create encryption key command to create an encryption key for SharePlex to use to encrypt data across the network. SharePlex uses Advanced Encryption Standard (AES) encryption.

The command returns a randomly generated AES key, for example: E5F5D4CBA329D2C86B5D7ABA096C18600595490129F55A1422AAB0248B28D0E4.

Note: This command only generates the key. For detailed instructions for configuring SharePlex encryption, see Encrypt data across the network.

Usage

Syntax

Remote options

These options enable you to issue the command on a remote machine and to script commands that include a login name, password, port number, or combination of those items.

deactivate config

Use the deactivate config command to gracefully terminate replication for an active configuration. This command stops all Capture activity for the configuration, posts all data currently in the queues, and removes the associated SharePlex processes and queues.

The deactivate config command does not remove a configuration from the system, but only stops replication of its objects until you activate it again. When you deactivate a configuration, it can cause the target data to go out of synchronization if users continue making changes to the configured source objects. Deactivating one configuration on a system does not deactivate other active configurations on the same system.

Deactivating when multiple configurations are active

When replicating from multiple instances (datasources) on the same source system, use the deactivate config command only if you have named (separate) export queues in each configuration that separate the data streams of those instances. Normally, the data from all replicated instances accumulates in one export queue. When you issue the deactivate config command, it deletes all the data in the export queue (along with the queue itself), including data for configuration(s) you might not want to deactivate. See Chapter 5 of the SharePlex Administrator’s Guide for instructions on creating a configuration using named export queues.

To save time when activating a configuration that is only slightly different than the active one, you do not need to deactivate the active one first. While it is still active, you can copy the active configuration with the copy config command. Change the copy with the edit config command, and then activate the copy. Using this method saves time because SharePlex will not re-analyze the objects that are common to both configurations. SharePlex will only analyze the new objects. (If you deactivate the first configuration before activating the copy, SharePlex will analyze all of the objects. This process takes longer.) Be sure that the first config has completed the activation process before activating the copy.

Usage

Syntax

Syntax description

Remote options

These options enable you to issue the command on a remote machine and to script commands that include a login name, password, port number, or combination of those items.