SharePlex 8.6.6 - Reference Guide

About this guide Conventions used in this guide SharePlex commands

SharePlex commands at a glance Overview of SharePlex security groups Alphabetical reference for SharePlex commands

abort config abort service activate config analyze config append status authlevel cancel clear history clear status compare / compare using compare status connection copy/append copy config copy status create config create encryption key deactivate config disable jobs / enable jobs edit edit config exit expand flush help host hostinfo job status list config list param lstatus orainfo port purge config qstatus quit reconcile redo remove config remove log rename config repair / repair using repair status report reset encryption key reset param set encryption key set log set param show show activate show capture show config show encryption key show export show import show log show post show read show sql show statusdb show scn show sync shutdown start startup status stop target trace capture trace post trace read truncate log usage verify config version view config view log options

SharePlex parameters

Descriptions of user-configurable parameters

Configuration Parameters Capture Parameters SQL Server Capture Parameters Read Parameters Export Parameters Import Parameters Post Parameters Open Target Post Parameters Queue parameters sp_cop Parameters Log Parameters SNMP Parameters System Parameters Compare Command Parameters Sync Parameters Analyze Config Command Parameters

Deprecated Parameters

SharePlex utilities Appendix B: SharePlex environment variables

activate config

SharePlex commands > Alphabetical reference for SharePlex commands > activate config

Use the activate config command to activate a configuration. Replication begins immediately as soon as the activation process is complete. For more information about what happens when you activate a configuration, see the SharePlex Administration Guide.

The activation process reads the configuration file, from which it gets all of the information needed for SharePlex to:

Identify the objects that are in replication
Route the replicated changes to the appropriate target database
Generate the SQL that Post uses to apply the changes to the target
Activate all of the tables that have been added to replication

The process that sp_cop calls to activate a configuration is sp_tconf.

Activation creates asynchronous, parallel processing threads to activate multiple tables simultaneously. Each table is locked for a very short time, just long enough to activate the table. Replication of each table begins as soon as its activation is complete.

Should one or more table fail to activate, SharePlex continues with the activation of the other tables. If an application uses NOWAIT locking on tables in the replication configuration, it could fail if it attempts to obtain a lock on an object being activated.

Guidelines for activation

To activate a configuration, the database containing the objects to be replicated must be mounted and open. The length of time that activation takes varies, depending on the size, number and structure of the configured objects.
You can activate one configuration per datasource (Oracle instance) on each system. For example, if there are ConfigA, ConfigB and ConfigC for instance ora10, you can activate only one of them at a time. Activating another configuration for the same datasource automatically deactivates the first one.
Do not perform DDL, including TRUNCATE, during activation. DML changes are the only permissible changes during activation.
Activation requires that the applications have retry logic. NOWAIT locking on tables in the replication configuration may cause the application to fail if it attempts to obtain a lock on an object that is being activated.
The activation process retains control of the sp_ctrl interface until the activation is finished. To activate multiple configurations for different datasources on the same system, activate the first one, then open another session of sp_ctrl to activate the second one. Open as many sessions of sp_ctrl as you have configurations to activate.
Before you activate a configuration, use the verify config command to confirm that basic requirements for successful activation and replication have been satisfied. The command alerts you to potential problems that can cause the activation to fail.

Set the number of activation threads

You can set the number of activation threads globally (for all activations) and you can override this setting for any activation.

To set the number of threads globally

Run sp_ctrl
Issue the following command. You may use a value of up to 32 threads.

sp_ctrl> set param SP_OCF_THREAD_COUNT number_of_threads

To set the number of threads for the current activation

Use the [threads=n] option when you issue the activate config command.

View activation status and results

SharePlex activates objects according to their object ID, not their order in the configuration file, so there is no way to predict the order of activation. You can use the show activate command on the source system to view activation statistics as tables are activated.

Because SharePlex continues with activation whether or not individual tables fail to activate, it alerts you when tables fail to activate by displaying the following error message at the sp_ctrl prompt: “WARNING, not all objects activated successfully. Check activation log.”

To view the results of activation:

Issue the show config command

What to do if activation fails

Many things can cause the activation of a table or the entire configuration to fail. For example, if one or more components in the configuration file were entered incorrectly, activation of the affected objects fails.

If you did not issue the verify config command before you activated, run it now, and correct any problems that it finds. Then, try activating again. For more troubleshooting advice, see the SharePlex Administration Guide.

Usage

Supported targets:	All
Authorization level:	Administrator (1)
Issues for:	source system
Related commands:	abort config, copy config, create config, deactivate config, edit config, list config, purge config, remove config, rename config, show activate, show config, verify config, view config

Syntax

Basic command	Command options	Remote options
activate config filename	[threads=n] [nolock] scn=scn_value seqno=log_sequence_number	[ on host \| on host:portnumber \| on login/password@host \| on login/password@host:portnumber ]

Basic command

Command options

Remote options

activate config filename

[threads=n]

[nolock]

scn=scn_value

seqno=log_sequence_number

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description

Component	Description
filename	Required. The name of the configuration that you want to activate. Configuration names are case-sensitive. Example: sp_ctrl(sysA)> activate config sales
threads=n	(Valid for Oracle) Use this option to set the number of analysis threads that the activation process generates. This option overrides the default value set by the SP_OCF_THREAD_COUNT parameter. The range of valid values for n is 1 to 32, but it is recommended that you use no more than 5 threads because the benefits of using threads generally diminish beyond that point. SharePlex will not start more threads than the number of tables to be analyzed. When used, this option must appear after the required command arguments. Example: sp_ctrl(sysA)> activate config sales threads=3
nolock	(Valid for Oracle) Use this option to activate without locking the tables being added to replication. Do not use this option with the scn or seqno option.
scn=scn_value	(Valid for Oracle) Use this option to activate the configuration to start replication at a specific SCN in the redo logs. For more information, see the Resume Replication documentation provided with this release. Use this option as part of the Resume Replication feature to direct SharePlex to resume replication from the last transaction that Post applied before a failure. Before activating the configuration, use the show scn command to get the SCNs of the last transactions that were posted from all the Post processes (if using named queues). Use the lowest of those SCN values for activate config. For the full recovery procedure, see the Beta Documentation included with this release. Do not use this option with the nolock option. Example: sp_ctrl> activate config myconfig scn=123456
seqno=log_sequence_number	(Valid for Oracle) Use this option to activate the configuration to start replication at a specific redo log sequence number. Do not use this option with the nolock option. Example: activate config myconfig seqno=98765

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.

Option	Description
on host	Execute the command on a remote system (one other than the one where the current sp_ctrl session is running). You are prompted for login credentials for the remote system. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on SysA
on host:portnumber	Execute the command on a remote system when a remote login and port number must be provided. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on SysA:8304
on login/password@host	Execute the command on a remote system when a remote login, password, and host name must be provided. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on john/spot5489@SysA
on login/password@host:portnumber	Execute the command on a remote system when a remote login, password, host name, and port number must be provided. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on john/spot5489@SysA:8304

analyze config

SharePlex commands > Alphabetical reference for SharePlex commands > analyze config

Use the analyze config command to run an analysis of the tables in a configuration file. This command gathers information about the activity of the tables.

Important! Do not activate the configuration before you run the analysis, and make certain there are no other active configurations when you run it. The use of this command is similar to an actual activation.

The analyze process writes out its results based upon the data gathered at the time that was specified in the command, and then the replication stream cleans itself up.

The analysis is written to a file in the log subdirectory of the variable-data directory. The name of the file is:

o.datasource-analysis.actid

The analyze process maintains information about the activity of each object in replication, as well as transaction information. The transaction information can be used to identify groups of tables that are interrelated in such a way that they should be replicated in the same replication stream (same set of processes).

The analysis lists each group of related tables, the total number of operations per table , and the total number of operations for the group. For example:

>cat o.w111a64f-analysis.1575

Activity Analysis

Group 1 of related tables: 1000 total operations in group

"TEST"."SS2_TEST1" 346

"TEST"."SS2_TEST2" 348

"TEST"."SS2_TEST3" 306

Group 2 of related tables: 1124 total operations in group

"TEST"."SRC_TEST1" 232

"TEST"."SRC_TEST2" 177

"TEST"."SRC_TEST3" 178

"TEST"."SRC_TEST4" 175

"TEST"."SRC_TEST5" 188

"TEST"."SRC_TEST6" 174

Tablename	Inserts	Updates	Deletes	Rollbacks	Total
"TEST"."SS2_TEST2"	146	169	33	0	348
"TEST"."SS2_TEST1"	140	176	30	0	346
"TEST"."SS2_TEST3"	116	158	32	0	306
"TEST"."SS2_TEST1"	75	114	29	14	232
"TEST"."SS2_TEST5"	61	94	22	11	188
"TEST"."SS2_TEST3"	69	73	28	8	178
"TEST"."SS2_TEST2"	69	77	21	10	177
"TEST"."SS2_TEST4"	54	89	19	13	175
"TEST"."SS2_TEST6"	61	79	25	9	174

To view the current state of analysis

Use the show analyze command to view the state of the analysis:

sp_ctrl (alvspxl11:8567)> show analyze detail

Host: alvspxl11.quest.com

Operations
Source	Status	Processed	Since	Total	Backlog
------	------------	-----------	-------	------	-------
o.w111a64f	Running	1497	17-Mar-12 10:41:54	1496	0

Last operation processed:

Redo log: 295 Log offset: 32327800

UPDATE of "TEST"."SRC_TEST3" at 03/17/12 0:59:17

Activation id	: 1573
Operations processed	: 1497
Transactions processed	: 398
Analysis complete	: 20-Mar-12 10:41:54

To terminate the analysis before completion

To terminate the analysis before it is complete, use the abort config or deactivate config command, or modify the SP_ANL_RUN_TIME parameter.

Usage

Supported targets:	All
Authorization level:	Administrator (1)
Issued for:	source system
Related commands:	abort config, copy config, create config, deactivate config, edit config, list config, purge config, remove config, rename config, show activate, show config, verify config, view config

Syntax

Basic command	Command options	Remote options
analyze config filename	n {minutes \| hours \| days}	[ on host \| on host:portnumber \| on login/password@host \| on login/password@host:portnumber ]

Basic command

Command options

Remote options

analyze config filename

n {minutes | hours | days}

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description

Component	Description
filename	The name of the configuration file that you want to analyze. Configuration names are case-sensitive. Example: sp_ctrl(sysA)>analyze config sales
n {minutes \| hours \| days)	The number of minutes, hours, or days worth of activity to analyze.

Component

Description

filename

The name of the configuration file that you want to analyze. Configuration names are case-sensitive.

Example:

sp_ctrl(sysA)>analyze config sales

n {minutes | hours | days)

The number of minutes, hours, or days worth of activity to analyze.

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.

Option	Description
on host	Execute the command on a remote system (one other than the one where the current sp_ctrl session is running). You are prompted for login credentials for the remote system. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on SysA
on host:portnumber	Execute the command on a remote system when a remote login and port number must be provided. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on SysA:8304
on login/password@host	Execute the command on a remote system when a remote login, password, and host name must be provided. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on john/spot5489@SysA
on login/password@host:portnumber	Execute the command on a remote system when a remote login, password, host name, and port number must be provided. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on john/spot5489@SysA:8304

Example

analyze config testconf 5 days

sp_ctrl (alvspxl11:8567)> show analyze

Process	Source	Target	State	PID
------	------------	-----------	-------	----
Capture	o.w111a64f		Running	2968
Analyze	o.w111a64f		Running	2976

append status

SharePlex commands > Alphabetical reference for SharePlex commands > append status

Use the append status command to view the status of the last copy or append command job run. The append 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 append status command, see the job status command.

Usage

Supported targets:	Oracle
Authorization level:	Viewer
Issued for:	source or target
Related commands:	copystatus

Syntax

Basic command	Command options	Remote options
job status	[job_id] [Job_id.table_id] [all] [full] [detail] [status]	[ on host \| on host:portnumber \| on login/password@host \| on login/password@host:portnumber ]

Basic command

Command options

Remote options

job status

[job_id]

[Job_id.table_id]

[all]

[full]

[detail]

[status]

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description

Component	Description
job_id	Displays status history for the job with the specified SharePlex-assigned job ID. Example: sp_ctrl(sysA)>job status 2828.2
job_id.table_id	Displays status history for the job with the specified SharePlex-assigned job ID and table. Example: sp_ctrl(sysA)>job status 2828.HR.SRC_TEST3
all	Displays a summary line for every job with history in the database. Example: sp_ctrl(sysA)>job status all
full	Displays the status of every object in the job. By default, the job status command displays the status of those objects not completed, or completed with an exceptional status. Example: sp_ctrl(sysA)>job status 2828 full
detail	Displays detail information for every object reported upon. By default, the job status command displays a summary line for every object reported upon. Note that the detail information is the same as is displayed for the job_id.table_id option. Example: sp_ctrl(sysA)>job status detail
[status]	Displays status history for previous jobs with the specified status. Example: sp_ctrl(sysA)>job status "Error"

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.

Option	Description
on host	Execute the command on a remote system (one other than the one where the current sp_ctrl session is running). You are prompted for login credentials for the remote system. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on SysA
on host:portnumber	Execute the command on a remote system when a remote login and port number must be provided. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on SysA:8304
on login/password@host	Execute the command on a remote system when a remote login, password, and host name must be provided. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on john/spot5489@SysA
on login/password@host:portnumber	Execute the command on a remote system when a remote login, password, host name, and port number must be provided. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on john/spot5489@SysA:8304

authlevel

SharePlex commands > Alphabetical reference for SharePlex commands > authlevel

Use the authlevel command to determine your authorization level for issuing SharePlex commands on a system.

The following is an example of the display:

User is a viewer (level=3)

Usage

Supported targets:	All
Authorization level:	Viewer (3)
Issued for:	source or target system
Related commands:	none

Syntax

Basic command	Remote options
authlevel	[ on host \| on host:portnumber \| on login/password@host \| on login/password@host:portnumber ]

Basic command

Remote options

authlevel

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

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.

Option	Description
on host	Execute the command on a remote system (one other than the one where the current sp_ctrl session is running). You are prompted for login credentials for the remote system. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on SysA
on host:portnumber	Execute the command on a remote system when a remote login and port number must be provided. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on SysA:8304
on login/password@host	Execute the command on a remote system when a remote login, password, and host name must be provided. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on john/spot5489@SysA
on login/password@host:portnumber	Execute the command on a remote system when a remote login, password, host name, and port number must be provided. If used, must be the last component of the command syntax. Example: sp_ctrl(sysB)>status on john/spot5489@SysA:8304

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

SharePlex 8.6.6 - Reference Guide

activate config

Guidelines for activation

Set the number of activation threads

View activation status and results

What to do if activation fails

Usage

Syntax

Syntax description

Remote options

analyze config

Usage

Syntax

Syntax description

Remote options

Example

append status

Usage

Syntax

Syntax description

Remote options

authlevel

Usage

Syntax

Remote options