Chat now with support
Chat with Support

SharePlex 8.6.6 - Preinstallation Checklist

How to create a configuration file

To configure SharePlex to replicate data, you create a configuration file. This is an ASCII text file in which you specify:

  • The data that you want SharePlex to replicate, including any filtering or partitioning of rows or columns
  • The target name and type
  • The system (and database if applicable) to which the data must be delivered.

Only a SharePlex Administrator or operator has the authority to create a configuration file.

When your configuration file is completed and the SharePlex environment is set up to support your replication objectives, you activate the configuration with the activate config command to begin replication. For more information, see Activate replication in your production environment.

Create a configuration file

You can create a configuration file by hand or, if your data structure supports it, you can automate the creation of a configuration file. For more information, see Build a configuration file using a script.

Create the configuration file on the system from which data is to be replicated, typically the source system, but strategies such as active-active replication require configuration files on more than one system.

To create a configuration file

  1. Run sp_ctrl from the bin sub-directory of the SharePlex product directory.
  2. In sp_ctrl, issue the create config command.

    sp_ctrl> create config config_name

    This command opens a file in the default text editor that is set for the operating system. Note: You can change the default editor that sp_ctrl uses. For more information, see Set a default editor for sp_ctrl.

  3. Complete the configuration file. For more information, see Structure of a configuration file.

    Important! All configurations must reside in the config sub-directory of the SharePlex variable-data directory. Configuration files outside this directory cannot be activated. SharePlex places configurations in this directory by default when you create them through the sp_ctrl interface with the create config command. If you create the configuration directly through a text editor, make certain to save it to the config sub-directory.

Structure of a configuration file

A basic configuration file looks like the following:

# comment: basic SharePlex configuration file


#source specification

target specification

routing map










The basic components of a configuration file are as follows. For advanced configuration options, see Additional configuration options

Component Description Syntax examples
# Comments Lines that describe the file or provide other information about the contents to viewers, but are not used by SharePlex. Precede each comment line with a pound (#) sign. Comments may be entered anywhere in the configuration file. # This is a comment.
Datasource specification

Syntax that specifies the source database. This component must always be the first non-commented line of a configuration file. It has the following syntax elements, all on the same line with no spaces:


Source specification

The fully qualified name of a supported source object, in the form of owner.object, or a wildcard substitution that specifies multiple source objects.

See Use Wildcards to specify multiple objects for more information about using wildcards.



Target specification

The target to which the replicated data is applied. Targets supported by SharePlex are:

  • A table in a relational database, or a wildcard substitution for multiple tables.
  • An Oracle sequence (or wildcard specification).
  • A file that contains XML or SQL records.
  • A JMS queue or topic.
  • A Kafka topic.
  • A change-history table that maintains a record of all changes made to a source table (also known as change data capture)

For more information, see Target specifications in a configuration file.







Routing map

One or more routes that send the data to the system that contains the target object specified with the target specification. A route consists of the following:







Compound routing map:


Additional configuration options

The following are additional configuration options that can be added to the configuration file:

Option Where to look
Prevent INSERTs, UPDATEs, or DELETEs from being replicated, or prevent sequences and materialized views from being replicated Filter DML operations
Map a source column to a target column Map source and target columns
Define a key for SharePlex to use Define a unique key
Divide, parallelize, and filter data to meet specific requirements Configure partitioned replication
Divide and parallelize data for increased control and throughput Configure named queues
Related Documents