In both AWS and Azure environments the Repstance virtual machine is delivered with preconfigured Web UI Application, which is used to fully maintain and monitor Repstance Server using web browser. 

This method can be used instead or along with the CLI or REST API commands. Any configuration changes that were performed via Web UI will be also available through the CLI or REST API commands and vice versa.

8.1 Connecting to Repstance Web UI

To connect to the Web UI using the HTTPS protocol open the following address in web browser:

where <RepstanceDNS> is the “Public DNS” of Repstance Instance. If “Public DNS” is not configured for the instance, the “Private IP” address should be used instead. The default port number is 3000.

The username is “repstance”. The default password in the AWS environment is the Instance ID and the VM Id in the Azure environment.

The following example shows how to find Web UI connectivity parameters in the AWS environment.

So, the link to the Web UI and the default credentials for this example will be the following:

The “Repstance DNS” and the port number can be changed by editing “proxy_url” and “proxy_port” entries in the /opt/repstance/ui/config.json file.

The password is stored in the /opt/repstance/conf/repstance.conf file (“token” entry) and can be changed by editing the “token” entry.

8.2 How to work in Web UI

Repstance Web UI is an alternative way to configure, perform and maintain all the commands and processes described in chapter 7. Commands to be used.

All the functionality is allocated onto three tabs, which are:

• Database Configuration
• Process Configuration
• Wizard

The start page of Repstance Web UI is “Process Configuration”. It displays general information about all existing Repstance Processes, created by any available way – using Web UI, repcli or REST API (see chapter 8.2.2 Process Configuration for more information).

If there are no any existing Repstance Processes yet, then Wizard mode will be suggested (see chapter 8.2.3 Wizard mode for the details).

8.2.1 Database Configuration

The Database Configuration form is to configure both Source and Target Databases, which are used by Repstance’s Processes. As a part of database configuration, the following commands can be executed:

• Prepare database. This command is used to “prepare” either Source or Target database, by meaning that some replication functionality needs to be enabled and the Repstance’s objects to support the replication need to be installed.

Note: Both Source and Target Databases must be configured before running any replication process

• Remove database. This command is used to remove any replication functionality and Repstance’s objects, which are installed by running the “prepare” command.
• Validate database. The command is used to check if the database has all necessary Repstance’s objects and can be safety used by Repstance’s Processes.

More details on these commands are described in chapter 5. How to use Repstance.

The “Database Configuration” is located on the top panel and opens the “Database Maintenance” form.

The form contains the following group of items:

1. Identify if the Database is “Source” or “Target”, or both.
2. Select type of the database engine. The following database types can be selected for a Source Database:
   • Oracle
   • MS SQL Server

The following database types can be selected for a Target Database:

• Oracle
• MS SQL Server
• MySQL
• PostgreSQL
• Redshift
• Snowflake

Note: MySQL, PostgreSQL, Redshift and Snowflake are supported in Repstance Advanced Edition only.

1. The database parameters. Depending on selected database type the different set of inputs to be displayed.
2. This link is used to generate JSON for “prepare”, “validate” and “remove” commands, which is valid JSON for appropriate REST API command (see chapter 3.3 REST API for more details).
3. The buttons to execute “prepare”, “validate” or “remove” commands. Once the command is executed the status is provided.

In order to configure Oracle Database select “Oracle” under “Database Type” and enable “Source” or “Target” or both flags under “Database”:

• Connection Type – There are two possible connection types – EZCONNECT and TNS. Depending on which one is chosen, there will be a different set of possible parameters.
• Createlogdirs – The parameter determines if the ONLINELOG_DIR and ARCHIVELOG_DIR Oracle directories should be created.

Note: The ONLINELOG_DIR and ARCHIVELOG_DIR directories are used if the Capture Process is configured to extract changes in the “DirectLog” mode only (see chapter 7.4.3 Overview of Data Capturing Methods for Oracle Database for the details).

If EZCONNECT connection type is selected the following connectivity parameters should be provided:

• Server – Host name or IP address of the database server
• Port – Database port number
• DB – Name of either container or pluggable database. Valid only for Source Database and for any Oracle versions 12c-19c but excluding RDS instances.
• Service Name – Database service name or SID
• Tablespace – Name of the tablespace that the Repstance’s objects are to be installed in. The default is the USERS tablespace if no alternative has been specified.
• Username – Database User name
• Password – Database User password

If TNS connection type is selected the following connectivity parameters should be provided:

• DB – Name of either container or pluggable database. Valid only for Source Database and for any Oracle versions 12c-19c but excluding RDS instances.
• TNS Name – Name of the TNS alias
• Tablespace – Name of the tablespace that the Repstance’s objects are to be installed in. The default is the USERS tablespace if no alternative has been specified.
• Username – Database User name
• Password – Database User password

Note: In order to use TNS connection type the “TNS Service Name” must be configured in the Repstance machine (see the details how the TNS method configuration https://docs.oracle.com/en/database/oracle/oracle-database/19/ntcli/specifying-connection-by-configuring-tnsnames.ora-file.html#GUID-D039649B-3A41-4BC8-BC29-EB1F9B0B6792).

8.2.1.2 MS SQL Server Database Configuration

In order to configure MS SQL Server Database select “MS SQL Server” under “Database Type”and enable “Source” or “Target” or both flags under “Database”:

The following parameters should be provided:

• Server– Host name or IP address of the database server
• Port– Database port number
• DB– Database name to be connected to
• Username– Database User name
• Password– Database User password
• Housekeeping – This parameter determines how the CDC data will be cleaned up. The possible values are:
• 0 – data will be cleaned up by an SQL Server job only,
• 1 – install Repstance job to clean up data only after extraction and keep SQL Server cleanup job, which is a time based CDC setting,
• 2 – install Repstance job and remove SQL Server cleanup job, data will be cleaned up only by the Repstance job.

8.2.1.3 MySQL Database Configuration

In order to configure MySQL Database select “MySQL” under “Database Type”. The database can be configured as Target Database only.

Note – MySQL database is supported in the Repstance Advanced Edition only.

The following parameters should be provided:

• Server– Host name or IP address of the database server
• Port– Database port number
• DB– Database name to be connected to
• Username– Database User name
• Password– Database User password

8.2.1.4 PostgreSQL Database Configuration

In order to configure PostgreSQL Database select “PostgreSQL” under “Database Type”. The database can be configured as Target Database only.

Note – PostgreSQL database is supported in the Repstance Advanced Edition only.

The following parameters should be provided:

• Server– Host name or IP address of the database server
• Port– Database port number
• DB– Database name to be connected to
• Username– Database User name
• Password– Database User password

8.2.1.5 Redshift Database Configuration

In order to configure Redshift Database select “Redshift” under “Database Type”. The database can be configured as Target Database only.

Note – Redshift Database is supported in the Repstance Advanced Edition only.

The following specific parameters should be provided:

• Server– Host name or IP address of the database server
• Port– Database port number
• DB– Database name to be connected to
• Username– Database User name
• Password– Database User password

8.2.1.6 Snowflake Database Configuration

In order to configure Snowflake Database select “Snowflake” under “Database Type”. The database can be configured as Target Database only.

Note – Snowflake Database is supported in the Repstance Advanced Edition only.

The following specific parameters are to be provided:

• Account – Account name
• Warehouse – Warehouse name
• Region – Region name
• DB – Database name
• Username – Database User name
• Password – Database User password

How to find “Snowflake Account” and “Snowflake Region” is described in chapter 7.1.7 Prepare Snowflake as Target Database.

8.2.2 Process Configuration

The “Process Configuration” tab is used to create, manage and control Repstance replication Processes. It displays details on the Processes created by any available method – using repcli, REST API or via Web UI and the items to maintain the Processes, which are:

• “Run All” – Start all Processes
• “Stop All” – Stop all Processes
• “Run All Captures” – Run All Capture Processes
• “Stop All Captures” – Stop All Capture Processes
• “+ Add Process” on the Capture Tab – Added Capture Process
• “Run All Applies” – Run All Apply Processes
• “Stop All Applies” – Stop All Apply Processes
• “+ Add Process” on the Apply Tab – Added Apply Process

Each existing Process has individual control items which are to run, stop, modify, validate and remove the Process.

Execution details of these commands are described in chapter 7.15 Control Repstance Processes.

8.2.2.1 Create Capture Process

In order to create new Capture Process click “Add Process” button on “Capture Processes” tab:

The “Capture Process Configuration” form is opened:

On the top the following parameters should be provided:

• Debug level– Level of debugging of Capture Process.
• Autostart – Determines if the Process must be run automatically.

Database Settings Tab

Under “Database Settings” select the Database Type. Depending on which one is chosen, there will be a different set of possible parameters.

Database Settings for Oracle Database

For the Oracle database type the following parameters should be provided:

• Connection Type – There are two possible connection types: EZCONNECT and TNS. Depending on which one is chosen, there will be a different set of possible parameters.
• ID – The Capture Process id.
• Name – Name of the Capture Process.
• Server – Host name or IP address of the database server.
• Port – Database port.
• DB – Name of either container or pluggable database. Valid only for Source Database and for any Oracle versions 12c-19c but excluding RDS instances.
• Service Name – Database service name or SID.
• Tablespace – Name of the tablespace that the Repstance’s objects are to be installed in. The default is the USERS tablespace if no alternative has been specified.
• Username – Database User name.
• Password – Database User password.
• Capture Source – Used to define Data Capturing Method (see chapter 7.4.3 Overview of Data Capturing Methods for Oracle Database). The possible values are:
  • LogMiner – use LogMiner method to capture the data (default value),
  • RedoMiner – use Direct Log Mining method to capture the data,
  • ASMMiner – use Direct Log Mining for Redo Logs located on the ASM device.

If the RedoMiner or ASMMiner is selected the addition parameter is to be provided:

• Mine Archivelogs Only parameter determines if the Process must process Archived Redo Logs only.

If the ASMMiner is selected the ASM credentials parameters must be provided:

• ASM User – ASM User name
• ASM Password – ASM User password
• ASM Service Name – ASM service name or SID

Database Settings for MSSQL Server Database

For MS SQL Server database the following connection parameters should be provided:

• ID – The Capture Process id
• Name – Name of the Capture Process
• Server – Host name or IP address of the database server
• Port – Database port
• DB – Name of the database
• Username – Database User name
• Password – Database User password

Replication Objects

Under “Replication Objects” tab the details of the tables to be included in the replication should be provided:

• DML Include – Mask of the DML objects to be captured.
• DML Exclude –Mask of the DML objects to be skipped by the Capture Process.
• DDL Include – Mask of the DDL objects to be captured.
• DDL Exclude – Mask of the DDL objects to be skipped by the Capture Process.
• Load Include – Mask of the objects to be included into the Initial Load along with the load option. The following load methods are currently supported:
  • A – preserve the data (default value),
  • T – use truncate statement to clean up the data,
  • D – use delete statement to clean up the data,
  • C – create table if it doesn’t exist,
  • R – recreate table if it already exists.
• DDL Exclude – Mask of the objects to be skipped during Initial Load.
• Object Mapping and Possible Data Transformation Rule – This section is to provide the transformation rules (see chapter 7.4.6 Objects Mapping and Possible Transforms for the details).

Advanced Settings

Under “Advanced Settings” tab the additional Capture parameters can be provided:

Clicking “Preview” button displays the report of the tables to be replicated and loaded along with the details on the tables’ mapping and data transformations, so the Capture Process configuration can be validated before to create it:

Clicking “Add Process” button creates the Capture Process and exits the form.

8.2.2.2 Create Apply Process

In order to create new “Apply Process” click “Add Process” button under “Apply Processes” tab:

The “Apply Process Configuration” form is opened:

Under “Database Settings” the following parameters should be provided:

• Debug level – Level of Apply Process debugging.
• Autostart – Determines if the Apply Process must be run automatically.
• Repuser – Determines if the Apply Process must represent itself as SQL Server replication process (valid for MS SQL Server database only).
• ID – The Apply Process id.
• Capture Process name – Name of the Capture Process which is providing the data to be used.
• Server, Port, DB, Username and Password are to provide DB connectivity details and might be different depending on selected database type.
• DDL Processing – Determines if DDL must be processed based on the user statement or generated based on the dictionary changes. The possible values are:

➢native – to process DDL based on the user statement (default value),

➢dictionary – to generate DDL based on the dictionary changes.

• Batchmode – This parameter is to specify transaction processing method. If the parameter is enabled the Apply Process combines and processes set of transactions in a single transaction.
• Initial Commit Rate – Determines the number of records to be inserted in one transaction at the Initial Load stage. If the value is 0 (default) the table is loaded in a single transaction.
• Data filter – The set of the parameters to determine objects’ filtering (see chapter 7.9.7 Objects Filtering for the details).

8.2.2.3 Modify, Delete and Validate Processes

In order to modify, validate or delete existing Capture or Apply Process click on the “…” button and select the action:

Clicking “Edit” button opens the same form, which is used to create the Process, so the Process parameters can be modified there. “Edit” is the analog of “alter” command (see chapters 7.5 Alter Capture Process and 7.10 Alter Apply Process for details). 

“Delete” is used to remove the Process (see chapters 6. HOW TO REMOVE REPSTANCE, 7.8 Remove Capture Process and 7.14 Remove Apply Process for more details). 

“Validate” is used to verify if the process has been configured properly (see chapters 7.7 Validate Capture Process and 7.12 Validate Apply Process for the details).

8.2.2.4 Processes Monitoring and Maintenance

The dashboard displays general information about the Processes such as process state, name of the Process and connectivity details:

To view the detailed information about the Process, click “Show more”:

8.2.3 Wizard Mode

The Wizard Mode passes user through all the necessary steps to configure data replication between two databases. It makes the configuration process much easy and fast to implement. These steps are:

• Prepare Source Database. This step is to validate if the Source Database meets the requirements to run the Capture Process and if it doesn't to configure the Database.
• Prepare Capture Process. This step is to create the Capture Process and define list of the tables to be migrated and replicated along with the transformation rules.
• Prepare Target Database. This step is to validate if the Target Database is ready for the replication and if it is not to configure it.
• Prepare Apply Process. This step is to create the Apply Process and provide data processing settings.

Wizard Mode is automatically run at the first login or by clicking “Wizard” tab:

At the first step Wizard Process verifies if the Source Database is ready for the replication. It requires the Source Database details to be provided. The set of the details depends on the selected database type.

If the Source Database is not ready for replication, Wizard Process offers to prepare the database, see chapter 8.2.1 Database Configuration for the details.

Once the Source Database has been successfully prepared, Wizard Process moves on the next step, which is to prepare Capture Process.

Wizard Process populates the database connection settings from the previous form. The settings can be changed if required.

It is necessary to provide name of the Capture Process (Name parameter) and the tables to be included into the DML/DDL replication (DML Include, DML Exclude and DDL Include, DDL Exclude parameters).

If the Source Database is Oracle the Capturing method (Capture Source parameter) should be provided (see chapter 8.2.2.1 Create Capture Process for the details).

On the next form select the tables, which require being loaded before the replication along with the loading option (see chapter 7.4.5 Initial Load for the details):

The next form is used to configure Transformation Rules (see chapter 7.4.7 Transformation Rules and Triggering Order):

Press “Next” to view the report of the tables to be included into the replication along with the transformation details:

Press “Back” if anything needs to be adjusted or “Next” to complete the Capture Process configuration.

On the next form click “Yes”, if Capture Process needs to start immediately.

The next step is to configure the Target Database. At this step Wizard Process validates the Target Database and prepares it, if required (see chapter 8.2.1 Database Configuration for details).

Depending on the database type the different set of the parameters should be provided (see chapter 8.2.1 Database Configuration for the details).

Clicking “Next” validates Target Database and prepares it, if required, and moves to the Apply Process configuration step:

Repstance fills out database settings and the Capture Process name from the previous forms, which can be changed if desired.

It is recommended to use Dictionary value for the DDL processing parameter if the Source and Target Databases are of different types, otherwise the Native value to be preferable.

The Initial Load Commit rate and the Data Filter parameters are described in chapter 8.2.2.2 Create Apply Process.

On the next form click “Yes” to run the Process immediate.