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.
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.
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:
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).
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:
Note: Both Source and Target Databases must be configured before running any replication process
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:
The following database types can be selected for a Target Database:
Note: MySQL, PostgreSQL, Redshift and Snowflake are supported in Repstance Advanced Edition only.
In order to configure Oracle Database select “Oracle” under “Database Type” and enable “Source” or “Target” or both flags under “Database”:
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:
If TNS connection type is selected the following connectivity parameters should be provided:
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).
220.127.116.11 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:
18.104.22.168 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:
22.214.171.124 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:
126.96.36.199 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:
188.8.131.52 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:
How to find “Snowflake Account” and “Snowflake Region” is described in chapter 7.1.7 Prepare Snowflake as Target Database.
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:
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.
184.108.40.206 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:
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:
If the RedoMiner or ASMMiner is selected the addition parameter is to be provided:
If the ASMMiner is selected the ASM credentials parameters must be provided:
Database Settings for MSSQL Server Database
For MS SQL Server database the following connection parameters should be provided:
Under “Replication Objects” tab the details of the tables to be included in the replication should be provided:
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.
220.127.116.11 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:
➢native – to process DDL based on the user statement (default value),
➢dictionary – to generate DDL based on the dictionary changes.
18.104.22.168 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).
22.214.171.124 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”:
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:
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 126.96.36.199 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 188.8.131.52 Create Apply Process.
On the next form click “Yes” to run the Process immediate.