Chat now with support
Chat with Support

SharePlex Manager 3.0 - User Guide

Running the Discovery Wizard

The first step in using the Discovery Wizard is to specify the connection properties of the starting source instance in a replication model. These properties include host machine, port number, username and password.

Because the wizard identifies replication streams in a strictly linear direction from source to each of its targets, it is recommended that you start the Discovery Wizard with a SharePlex instance defined at the earliest stages of a data replication process. This allows the wizard to identify a greater number of replication streams than would otherwise be possible if you started the discovery process with an instance that was further ‘downstream’.

Note
To run the Discovery Wizard, you must have the ability to connect to SharePlex (meaning, the ability to successfully execute the “su” command). If you receive an “Invalid Username/Password” error message during discovery (and the username and password are correct), this may indicate that you don't have the ability to connect to SharePlex. Also, to control Capture processes, you must be a member of the SharePlex Administrators group.
To run the Discovery Wizard:
1
Do one of the following:
•
If you are a new user, click Discover Replication Stream in the Welcome window.
•
In the Manage Monitoring console, click Discovery.
Note
Access to the Manage Monitoring console is controlled by security rights. If you do not have proper security rights, the Manage Monitoring option is deactivated. For more information, see the section “Manage Monitoring” on page 27.
2
In the Welcome screen, click Next.
3
Specify the connection properties of the initial source instance:
•
Hostname - Name of the machine on which the SharePlex instance is installed
•
Port - Port number used by the instance.
•
Username - Username assigned to the SharePlex instance
•
Password - Password assigned to the SharePlex instance
Note
The default port value is 2100 to match SharePlex. You can change this value as needed.
4
(Optional) Deselect the Use as default credentials option if you do not want the username and password you specify for the initial instance to be used as the default credentials for the other instances identified by the wizard.
Select this option if many of the instances in your SharePlex infrastructure use the same username and password. If the wizard is unable to connect to an instance using the default username and password, it displays a warning message and prompts you to specify different credentials manually.
If you do not select the Use as default credentials option, the wizard prompts you to specify the username and password for each instance it discovers.
5
Click Next.
The Discovery Wizard initiates the discovery process by attempting to connect to the source instance using the connection properties you specified.
•
If the wizard is able to connect, the source is listed as the first identified instance. The wizard then determines the target instances connected to the source and attempts to connect to those instances using the default connection properties.
•
If the wizard is able to connect but the source instance does not have an active configuration file, the wizard prompts you to either activate a configuration file and continue with the discovery process, or to add the source instance and activate one of its configuration files later. An inactive source instance cannot be added to a replication view or monitored. For more information on activating configuration files, see the section, “Managing SharePlex Configuration Files” on page 20.
Note
When you add an inactive source instance and then later activate one of its configuration files, you need to discover the source instance before it can be added to a replication view and monitored. Until you discover a newly activated source instance, it will be labeled as “Undiscovered” in both the Replication Overview and Instance Overview windows.
•
If the wizard cannot connect to an instance, it displays an error message describing the nature of the problem (instance not responding, invalid login credentials, etc.). The wizard cannot proceed until the error is corrected. After correcting any errors that may be reported with the source instance, click Next again to continue with the discovery process.
At this point, you can either correct the error and continue processing, or you can skip the particular instance.
6
If errors are reported, do one of the following:
•
If you want to continue processing, correct the error that was reported, enter the username and password again and click Continue.
•
If you want to skip the instance, click Skip. Skipped instances are included in the list of identified instances but because the connection was not validated, data for that instance cannot be monitored in SharePlex Manager. Also, if you skip an instance that functions as the source in a replication stream, the Discovery Wizard will not be able to identify the target instances in that replication stream.
The Discovery Wizard continues identifying all the instances and replication streams in the replication model. You can wait for the wizard to complete the discovery process, or if you do not want the wizard to continue processing you can click Stop at any point.
After the discovery process is completed or you click Stop, the Discovery Wizard displays more detailed information about each SharePlex instance and replication stream it has identified:
•
For each instance, the wizard identifies the name of its host machine, IP address, port number, and connection status (skipped instances have a Not Connected status).
•
For each replication stream, the wizard identifies the source instance, and in a tree view, each target instance
Note
By default, instance names consist of the name of the host machine concatenated with the port number. You can edit the names of instance and replication streams in the Manage Monitoring console, as described in the section, “Manage Monitoring” on page 27.
At this point, you need to select the replication streams you want to add to a replication view. If this is the first time running the Discovery Wizard, you must first define the replication view you want to use.
7
Click Next.
You have the option of adding the replication streams you want to a new replication view, to an existing replication view (if any are currently defined), or you can opt not to add the replication streams to a replication view, in which case no information about any of the replication streams identified by the Discovery Wizard will be displayed in SharePlex Manager.
8
Do one of the following:
•
If you want to add the replication streams in the replication model to a new replication view, select the New View option.
•
If you have already run the wizard and want to add any of the replication streams in the replication model to an existing replication view, select the Existing View option and select the view you in the drop-down list.
Note
The Existing View Option is disabled if this is the first time you have run the wizard and there are no replication views yet defined.
•
If you do not want to add any of the replication streams in the replication model, select the Do Not Add to View option.
Note
If you do not add any replication streams to a replication view, the discovery process is concluded when you click Next.
9
Click Next.
Whether you are adding replication streams to a new or existing view, the Discovery Wizard displays all the replication streams that have been discovered, including replication streams identified in previous discovery sessions (if any).
Note
When a SharePlex instance is modified or added or removed from a replication stream, SharePlex Manager is able to detect these changes and automatically refresh the displayed data. However, changes to login credentials (such as updated passwords) are not automatically detected. When this is the case, SharePlex Manager displays an error message and prompts you to rediscover the affected replication stream by running the Discovery Wizard again.
10
If you selected the New View option, specify a name for view and (optional) add a description.
11
Select the replication streams you want to add to the view.
Note
You can expand a replication stream to view the target instances.
12
Click Next.
This completes the discovery process. At this point you can do one of the following:
•
Run the Discovery Wizard again to identify any other replication models in your SharePlex infrastructure.
•
Perform Manage Monitoring tasks on the instances, replication streams, and views defined in SharePlex Manager.
•
Proceed directly to the SharePlex Manager dashboard and begin monitoring.
Note
After adding a replication stream to a replication view, it may take up to 5 minutes before all the data has been calculated and displayed.
Caution
An inactive Instance, which is persisted in SPM due to running “Setup Replication Stream” or “Discovery” on an inactive Instance, will not be cleared in two situations: 1) Manually clicking the Discovery link from within SharePlex Management or 2) Auto discovery. The inactive Instance is cleared if the user successfully completes the "Setup Replication Stream" wizard or successfully discovers Streams from the discovery required warning link. The user can also manually remove the inactive Instance via the Instances Property dialog.

Setting Up a New Replication Stream

You can use SharePlex Manager to guide you through the process of setting up new replication streams. When you set up a new replication stream, you have the option of modifying an existing configuration file or creating a new one.

To set up a new replication stream:
1
Do one of the following:
•
If you are a new user, click Setup Replication Stream in the Welcome window.
•
In the Manage Monitoring console, click Setup Replication Stream.
Note
Access to the Manage Monitoring console is controlled by security rights. If you do not have proper security rights, the Manage Monitoring option is deactivated. For more information, see the section “Manage Monitoring” on page 27.
2
Specify the connection properties of the source instance:
•
Hostname - Name of the machine on which the SharePlex instance is installed
•
Port - Port number used by the instance.
•
Username - Username assigned to the SharePlex instance
•
Password - Password assigned to the SharePlex instance
Note
The default port value is 2100 to match SharePlex. You can change this value as needed.
3
Click Next.
SharePlex Manager attempts to connect to the source instance using the connection properties you specified.
If the wizard is able to connect, SharePlex Manager prompt you to select the configuration for the source instance. You can use the currently active configuration file (if one exists), or you can select a different configuration file or create a new configuration.
4
Do one of the following:
•
To use the currently active configuration file, click Next
•
To use a different configuration file, select it and then click Next.
•
To create a new configuration file, click Create New Configuration. Then follow the steps for creating a new configuration described in the section “Creating Configuration Files” on page 23.
SharePlex Manager displays the contents of the file.
5
(Optional) If you selected a currently inactive file, edit the contents of the configuration file as needed. When finished, click Save.
Note
You cannot edit the configuration file that is currently active.
6
Click Next.
SharePlex Manager prompts you to validate the connection properties of the target instances specified in the configuration file.
7
(Optional) Click Validate Connection.
SharePlex Manager attempts to connect to the target instances in the replication stream. If unsuccessful, check the connection properties specified in the configuration file and try again.
8
Click Next.
SharePlex Manager displays a message that it is about to activate the configuration file you selected.
At this point, you need to add the replication stream to a replication view. You can add the replication stream to an existing replication view (if any) or to a new replication view.
9
Click Next.
You have the option of adding the replication stream to a new replication view, to an existing replication view (if any are currently defined), or you can opt not to add the replication stream to a replication view, in which case no information about the replication stream will be displayed in SharePlex Manager.
10
Do one of the following:
•
If you want to add the replication stream to a new replication view, select the New View option.
•
If you want the replication stream to an existing replication view, select the Existing View option and select the view you in the drop-down list.
Note
The Existing View Option is disabled if there are no replication views yet defined.
•
If you do not want to add the replication stream to any replication view, select the Do Not Add to View option.
11
Click Next.
Whether you are adding the replication stream to a new or existing view, SharePlex Manager displays all the replication streams that have been selected for monitoring, including previously selected sessions streams (if any).
Note
When a SharePlex instance is modified or added or removed from a replication stream, SharePlex Manager is able to detect these changes and automatically refresh the displayed data. However, changes to login credentials (such as updated passwords) are not automatically detected. When this is the case, SharePlex Manager displays an error message and prompts you to rediscover the affected replication stream by running the Discovery Wizard again.
12
If you selected the New View option, specify a name for view and (optional) add a description.
13
Select the replication stream you want to add to the view.
Note
You can expand a replication stream to view the target instances.
14
Click Next.
This completes the replication stream setup process. At this point you can do one of the following:
•
Perform Manage Monitoring tasks on the instances, replication streams, and views defined in SharePlex Manager.
•
Proceed directly to the SharePlex Manager dashboard and begin monitoring.
Note
After adding a replication stream to a replication view, it may take up to 5 minutes before all the data has been calculated and displayed.

Managing SharePlex Configuration Files

The Configurations section of a SharePlex Instance screen displays a list of all the configuration files currently saved in the configuration directory of that particular SharePlex instance. For each configuration file the list displays its datasource, its activation status, and (if currently active) the date and time it was activated. From here you can perform various administrative tasks to manage configuration files, including activating and inactivating files, removing and renaming files, and copying files. You can also modify the contents of a configuration file in a text editor, create a new file, or upload an existing one.

Activating and Deactivating Configuration Files

Only one configuration file can be active at a time. This means that when you activate a file, the file that was previously active for the same data source is automatically deactivated.

To activate a configuration file:
1
Click the Active/Inactive status of the configuration file you want to activate.
2
In the Actions pop-up menu, select Activate.
This opens the Active Configuration window.
Note
To deactivate a currently active file, select Deactivate in the pop-up menu. Be aware, however, that at least one configuration file must be active for replication processing to occur on the SharePlex instance. Also, if you have made system changes since activating the current file and want to refresh your configuration, open the Actions pop-up menu for the currently active file and select Reactivate.
3
Click Activate.
SharePlex Manager scans the configuration file and, if properly formatted, activates the file. If the file is not properly formatted, it displays an error message and does not activate the file.
When you activate a configuration file, SharePlex Manager opens the Discovery Wizard and prompts you to go through the steps of discovering the replications streams associated with the source instance. If SharePlex Manager is already monitoring any replications streams associated with the source instance, those replication streams will be updated to reflect any system changes that may have occurred since the last time the source instance was active. See the section, “Running the Discovery Wizard” on page 11 for more information.
Note
If it takes longer than 60 seconds to activate a configuration, SharePlex Manager displays a window indicating that the configuration is taking an extended amount of time to activate. You can continue working in SharePlex Manager while the activation process is occurring in the background. In the case of a new configuration file, you are prompted to run the Discovery Wizard when the file is finally activated. For an existing stream, SharePlex Manager updates the replication streams associated with the source instance automatically once the file is successfully activated.
Caution
Advanced activation options are highly sensitive and should only be set under the direction of Quest Support.
To deactivate a configuration file:
1
Click the Active/Inactive status of the configuration file you want to deactivate.
2
In the Actions pop-up menu, select Deactivate.
At least one configuration file must be active for replication processing to occur on the SharePlex instance. Also, if you have made system changes since activating the current file and want to refresh your configuration, open the Actions pop-up menu for the currently active file and select Reactivate.
Renaming, Removing, and Copying Configuration Files
1
To rename, remove, or a copy a configuration file, click the Active/Inactive status of the configuration file you want to manage.
2
In the Actions pop-up menu, select one of the following:
•
Select Rename to rename the file.
This opens the Configuration File Rename window which prompts you to specify a new name for the file.
•
Select Remove to delete the file from the configuration directory of the SharePlex instance.
•
Select Copy to create a copy of the file.
This opens the Configuration File Copy window which prompts you to specify a unique name for the copied file.
Uploading Configuration Files

You can use SharePlex Manager to upload a configuration directory of a SharePlex instance.

To upload a configuration file:
1
Click Upload Configuration File.
2
Browse for the file you want to upload.
3
(Optional) Specify a name for the copy of the file you want to upload.
If you do not specify a name, the name of the original file is used.
4
Click Upload.
Editing Configuration Files

You can edit the contents of a configuration file directly within SharePlex Manager.

To edit a configuration file:
1
Click the name of the configuration you want to edit.
This opens the file in the SharePlex Configuration File Property window.
2
Click Edit.
This opens the file in a text editor.
Note
For active configuration files, SharePlex Manager displays additional information, such as the activation id, total number of objects, total objects replicating, total objects not replicating and the log file location.
3
Edit the file as needed.
Caution
When editing a configuration file, be careful to use proper SharePlex syntax for routing specifications and datasource parameters. SharePlex Manager will not activate improperly formatted configuration files.
4
Click Save.
Creating Configuration Files

You can create configuration files directly within SharePlex Manager.

To create a configuration file:
1
Click Create New Configuration File.
SharePlex Manager prompts you to specify a name for the new file.
2
Specify a unique name for the file and click Create New.
This opens the new file in a text editor which displays a pre-loaded configuration file template. The template includes a properly formatted default datasource parameter and a sample routing specification.
3
Using the default template as a guide, specify your own datasource parameter and routing specifications.
Caution
When creating a configuration file, be careful to use proper SharePlex syntax. SharePlex Manager will not activate improperly formatted configuration files.
4
Click Save.
The new configuration is saved to the configuration directory of the SharePlex instance.

Setting Parameters

SharePlex parameters control and tune various aspects of replication. SharePlex is designed to operate optimally with the default settings. In general, you should not change a parameter’s value except in the following circumstances:

•
your replication strategy requires it
•
you are following a documented SharePlex procedure
•
you are instructed to do so by Quest Support

With the Parameter Management console in SharePlex manager, users with proper security rights can view the parameter settings for each SharePlex instance in their monitoring environment and modify their values as needed.

Note
See your SharePlex documentation for more information on SharePlex parameters

The Parameter Console displays the following information for each parameter:

Value
Description
Parameter
The name of the parameter in SharePlex
Value
The current value of the parameter
Default Value
The default value of the parameter
Units
The unit measurement type of the parameter value
Set At
The point at which a change to the parameter value effect. Options include:
•
Live - the change takes effect immediately
•
COP Restart - the change takes effect after the sp_cop is restarted
•
Process Restart - the change take effect after the affected SharePlex process restarts (Typically this option applies to Capture, Read, Export, Import and Post processes).
Classification
The configuration level of the parameter. Options include:
•
General - these are external parameters that are user-configurable
•
Restricted - these are internal parameters that should only be modified under the guidance of Quest Support.
Description
A brief description of the parameter
To change a parameter:
1
In the Replication Overview window, click Administration.
2
Click Manage SharePlex Parameters.
Note
This option is deactivated if you do not have configuration rights on any replication stream, or if you have not yet run the Discovery Wizard and added any replication streams to your monitoring environment
This opens the Parameter Management console, which displays parameters based on the selected instance and module. If you want to view process-based parameters, you must also specify the queue or data source.
When you open the console, the Instance field display the first instance that you discovered and added to your monitoring environment.
3
In the Instance field, select the instance you want.
4
In the Module field, select the SharePlex module that the parameters you want to view are applied.
The list of available modules varies depending on whether the selected instance is a source or target instance.
5
If you selected a process module (Capture, Read, Export, Import or Post), do one of the following:
•
For Export, Import and Post processes, select the queue that the process belongs to in Queue field.
•
For Capture and Read processes, select the data source of the process in the Datasource field.
Note
You can also open the Parameter Management console directly from Process Detail views. When opened from a Process Detail view, the Instance and Module fields in the Parameter Management console default to the particular process. For more information, see the section, “Instance Detail” on page 60.
6
The Parameter Console displays a list of all the parameters that apply to the selected instance, module, and data source or queue (for process-based parameters).
7
Click the Edit icon for the parameter you want to change.
This opens the Edit SharePlex Parameter window.
8
In the Value field, enter a valid value.
The value you specify must be in the correct units and within the supported range for the selected parameter. If you enter an invalid value, SharePlex Manger displays an error message after you click OK.
Note
Most SharePlex parameters require a non-null value. However, you can set a null value for certain parameters that are defined in string units by leaving the Value field blank. When this is the case, SharePlex Manager displays a warning symbol (red exclamation point) which can be disregarded.
9
If you are changing the Process Restart value of a process-based Set At parameter, do one of the following:
•
Select the Restart process now option if you want the change to take effect immediately.
•
Deselect the Restart process now option if you want the change to take effect the next time you restart the Foglight server.
Note
If you are changing a parameter that requires COP to be restarted, SharePlex Manager displays an alert message reminding you that you must use sp_ctrl to restart COP manually for the change to take effect.
If you are changing the value of a restricted parameter, SharePlex Manager displays a warning message.
Caution
Do not change the value of a restricted parameter unless instructed to do so by Quest Technical Support.
10
Click OK.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating