The users can perform consistency checks on synchronized data.

Integrity Check

Integrity Check refers to ProSync's consistency check.

It checks whether data consistency matches for specific tables in the source and target DBs being synchronized, and if it does not, the users can check or correct the result of the consistency check.

Integrity Check area

Setting Create Check and Thread

• The users can create a job to check for consistency, and set the thread count to be used by the job.

• The users can search among the created jobs by filtering by specific instance, check status, and check name.

• The left side shows the items used for filtering, which can be removed from filtering via the x button to the right of each filter tag or reset with the Filtering Reset button. These items can be specified via the filter button on the right.

• The numbers to the right of the filtering item indicate the number of jobs of that status.

• Refresh: Updates the status as the job progresses.

• Delete details: Checks and deletes the details of a registered job.

• This is the table where the users can see the list with all filtering applied.

• Select the desired entry in the table for the Job's behavior, or for deleting and editing.

When searching the Integrity Check table, the users can utilize these filters to perform more sophisticated searches.

• The users can see a list of Streams - Instances that belong to the Diagram specified in the Diagram Filter in the header of the page.

• Select the Instances the users want to select/clear by the filtering criteria. Select Stream if the users want to select/clear all instances in a Stream, or Diagram if the users want to select/clear all instances in the current Diagram.

All of the status types available on the Integrity Check page.

This feature allows the users to check the result of the Integrity Check execution. The users can check and download the Result Report item when the users right-click the mouse by selecting multiple jobs to check.

• The name of each job for which the users want to view the Result Report.

• The users can download each Result Report as a csv file and manage it.

• It has a name like Integrity_Report_[Job Name].csv.

The users can download and manage the Result Report, which has a name like Integrity_Report_[Job Name].csv.

1. Start the Excel Program

2. File > Import at the top of the menu

3. Select a CSV file and open the file

4. Select Delimited and UTF-8

1. Delimiters - Select Treat commas, spaces, and consecutive delimiters as one \ Text qualifiers - select '"' (double quotes)

1. Finish

The above steps should be followed to open the file so that the users can check the data without any corruption or delimiters.

DDL area

The users can set DDL synchronization options.

ADD DDL

• The users can set DDL synchronization options for synchronization tables.

Search and delete/edit

• The users can search by filtering the items the users want to search for.

• The users can remove and edit DDL options.

• A list of options to exclude from synchronization during DDL.

• A list of options to include in synchronization during DDL.

• By default, ALTER TABLE, TRUNCATE TABLE DDL synchronization is performed for the synchronization table (DEFAULT).

Exclude Set and Include Set appear to be separate options, but in the ProSync engine they are written as a single string and are applied in the order they are written.

Therefore, the Rule Sequence entry exists to distinguish the order in which the options are applied.

In the above example, the ALL Range and DEFAULT Range of the Exclude Set are checked for ALTER TABLE.

In this case, the Rule Sequence has priority because the ALTER TABLE in the DEFAULT range of the Include set is lower, and the ALTER TABLE in the ALL range of the Exclude Set is not synchronized.

The users can set additional DDL options.

This is the area where the users can check the resource indicators used by ProSync during synchronization, such as Memory and CPU usage, Transaction and DML count, and TSN Gap accumulated as synchronization progresses, per Stream belonging to the selected Diagram.

The Replication Diagram page only shows information from {current time}-6 minutes to {current time}-2 minutes for the selected Stream, and the users can go to the detailed view area by clicking the EnLarge button in the upper right corner of each chart area.

The users can view the memory and CPU usage used by ProSync. This chart only shows information from the Apply process.

1. Stream registration entry points

Upon initial login, the users will see the Replication Diagram page.

At this point, the users can register a stream through the Stream Registration button in the top right corner.

2. Stream registration modal screen

Below is the modal first screen of the Stream installation, click the Next button to proceed to the next step.

3. Enter stream information

Enter the name the users want to register as a stream, the SRC DB to register, and the information of the TAR DB.

Check the connection of each DB based on the information created in Stream Information, and check the cluster status and number of nodes.

If any DB fails to connect, the users cannot proceed to the next step.

If each SRC/TAR DB is a cluster, the users need to enter additional information because the information about the remaining nodes are required. At this point, the users don't need to enter the Monitoring User Name and Password again, as the previously entered information is fixed.

And it is mandatory to perform a Connection Check for each Node.

When the users press the Connection Check button, the users should see a green Confirm text to indicate success, and all Connection Checks should be executed and successful for each Node.

Enter the Agent Process information that the users want to connect to the Stream the users want to register.

Information about the installed agents can be found in the prs_instance.map file in the $PRS_HOME/config path.

The users can see the header of the list and the Delete button in each list.

The Delete button in the header resets the input and list count for all lists, and the Delete button in each list deletes the corresponding list.

Select the Diagram for which the users want to register the Stream.

Create New Replication Diagram

• Select when the users want to create a new diagram.

• Enter the name of the diagram the users want to create.

Insert into an Existing Replication Diagram

• Select to select a diagram that is already registered.

• Select the Diagram the users want to register.

If Stream registration was successful, the users'll see this screen.

Click the Next button to proceed with the Instance installation and registration. If the users don't want to, they can stop the step by clicking Cancel or the modal's top-right X button, but since the basic unit of synchronization in ProSync is the Instance, it is recommended that the users complete the Instance installation (registration) after registering the Stream.

If the Stream registration fails, the users can go back to the previous step via the Prev button and edit the information to register again.

Below is an example of a Stream registration failure.

After successful Stream registration, the users can see the successful registration on the main screen as shown below.

However, Diagram and Stream exist to understand the configuration and flow of synchronization, so if the users do not install and register an instance, the Status is Empty and synchronization does not proceed.

Instances must be installed in order for the synchronization to proceed and the status to be known.

The users can monitor and manage Instances, the smallest unit of synchronization.

Instance Management components

Instance Management is organized into the following main sections.

Instance List Checks the list of registered Instances.

Parameter Setting Parameter settings for the selected Instance.

Provides the ability to monitor and manage selected instances. Views a larger area of data if the view Instance List is inactive.

The users can see the visual flow of synchronization organized into one Replication Diagram.

The Replication Diagram is organized into the following main sections.

Checks the list of registered diagrams.

Provides a synchronization flow graph for the corresponding diagram.

About the Guide

Issued date: 2025.03.01 Software version: ProSync Manager v4.4 Guide version: v1.0.0

This guide is for database developers who use ProSync Manager, ProSync's web monitoring program provided by TmaxTibero® (Tibero), and describes the basics of using ProSync Manager.

Required Knowledge

• Database Understanding of the basic concepts of databases and how a Relational Database Management System (RDBMS) works

• Basic Unix-based operating system command Understanding of platform-specific usage of $SHELL and checking system requirements.

These are the copyright notices for ProSync Manager manual.

Tmax Tower, 45 Jeongjail-ro, Bundang-gu, Seongnam-si, Gyeonggi-do, Republic of Korea

Tel : +82-1544-8629

E-Mail : gitbook@tibero.com

The contents of this software (ProSync Manager) manual and the program are protected by copyright laws and international convention. The contents of this manual and the programs described herein are available only under a license agreement with TmaxTibero Co., Ltd. and may be distributed or reproduced only within the scope of the license agreement.

No part of this document may be transmitted, copied, deployed, or reproduced in any form or by any means, electronic, mechanical, or optical, without the prior written consent of TmaxTibero Co., Ltd. Nothing in this software document and agreement constitutes a transfer of intellectual property rights regardless of whether or not such rights are registered) or any rights to TmaxTibero trademarks, logos, or any other brand features.

This document is for information purposes only. The company assumes no direct or indirect responsibilities for the contents of this document, and does not guarantee that the information contained in this document satisfies certain legal or commercial conditions. The information contained in this document is subject to change without prior notice due to product upgrades or updates. The company assumes no liability for any errors in this document.

Pretendard and Roboto are applied and SIL Open Font License.

Details can be found in the following directory located within the product.

${PRSMGR_HOME}/license/LICENSE_FONT.txt

Some modules or files of this product are subject to the terms of the following licenses.

• Apache License 2.0

• BSD-2-Clause-FreeBSD

• Common Development and Distribution License (CDDL) 1.0

• Eclipse Public License (EPL) 1.0

Details can be found in the following directory located within the product.

${PRSMGR_HOME}/license/LICENSE.txt

The guide contains 9 chapters.

Global Navigation Bar (GNB)

It consists of a menu that provides access to all the features provided by ProSync Manager. The details are covered in the GNB chapter.

Page Header

This is the header part of each page, where the users can see the name of the page where they are currently on and execute the functions that depend on each page.

All Pages depend on the Diagram, so use the Diagram Filter in the Page Header to change the Diagram information the users want to see on the Page.

Page Content

This is the Content of each page, where the users can see the features offered by the page where they are on.

Glossary Describes the terms used in ProSync Manager.

Monitoring User Describes the user used for monitoring in ProSync Manager.

Constraints Describes the constraints in ProSync Manager.

Mapping area

The users can check the Mapping Rule in the list of synchronization tables.

Mapping Rule confirmation area and Edit

• The users can view or edit the Mapping Rule applied to the table selected from the list of synchronized tables below.

• As selecting multiple tables, the users can flip through them in order.

• The users can search by filtering the items the users want to search for.

• This is a list of tables registered in the synchronization table, and select the one the users want to check the detailed mapping rule.

The users can check the details of the Mapping Rule settings.

Set up a Target Schema and Table to set up a Mapping Rule based on the Source Table.

Set up Column Mapping.

Set up Skip Rule.

Parameter Setting modal

In the header of the Instance Management page, the users can set the engine parameters for the Streams that correspond to the Stream filter and the Instances that belong to it.

Select Stream or Instance, Process

• Select the target Stream, Instance, or Process the users want to set up.

• When selecting a Stream, the value is common to all Instances under it.

• Select the type of the parameter the users want to set.

• In this case, for Static parameters, the Instance must be restarted after the value change for the changed value to take effect.

• The users can save the parameter settings to a .csv file, or load a .csv file to set the values.

• The users can check and set the parameter corresponding to the selected Stream / Instance, Process, and Type.

Replication Diagram

The largest logical organizational unit in ProSync Manager and is used to visually understand the ProSync synchronization configuration. A Diagram can be composed of multiple Streams.

Stream

Stream refers to the flow of data synchronization from one SRC DB to one TAR DB in ProSync.

For bidirectional synchronization, a separate Stream is configured for each direction, so a total of two Streams are used.

A Stream can be composed of multiple Instances and supports per-stream operations (Start, Stop, Resume, Pause).

Instance

The smallest unit of synchronization that ProSync Manager manages.

The users can group tables to be synchronized in one Stream and organize them into multiple Instances.

Supports per-instance operations (Start, Stop, Resume, Pause).

This is the user required for each SRC DB and TAR DB to use ProSync Manager's features at the stream level.

The database that stores the meta information for ProSync Manager is called Repo DB.

Each User can be assigned a role In ProSync Manager.

After installation and registration are complete, the Monitoring main screen looks like this

The prosyncmanager script can start, stop, and check the status and version of ProSync Manager.

The ProSync Manager manages ProSync through communication with the Agent.

Therefore, when using ProSync Manager, the users must ensure that the Agent Processes of all ProSyncs the users want to manage are up and running, and that the users register the Agent Processes in the appropriate places where the users want to manage them.

Since it is a database that stores meta information of ProSync Manager, if the DB is not working properly, ProSync Manager may not be managed properly.

These are the required system requirements that the users must check before installing and running ProSync Manager.

This is the required environment configuration and settings the users need to make before installing ProSync Manager.

The GNB is organized into four areas.

ProSync Manager logo

This is the logo of ProSync Manager, and clicking on it will take the users to the main screen (Replication Diagram page).

Page menu

This is the menu the users can navigate to for each page. Each page is described in detail in the chapter that corresponds to that page.

The users can check a simple event list when an event occurs for a registered diagram.

If no new events have occurred, the users'll see a bell icon and an empty list.

The users can check the Event List for new events with a red dot on the bell icon.

Depending on the status of the event, it can be categorized into All, Running, Warning, Long Tx, Error, and Paused tabs, and the number of the corresponding status appears on the tab.

Select the event the users want to view from the list and the users'll be taken to the page, where the users can view the event details.

The role of the currently logged in User is displayed, and the User-specific features Drop Box appears when the area is selected.

• The users can view and edit the user's information.

• However, the users can change the user's role to Admin ⇒ User without the root account, but the users cannot change it to User ⇒ Admin. (Root account is assigned when installing ProSync Manager, so it cannot be changed).

• The users can change the password for that user.

• Log out: Logs the user out.

Instance List area

This is the area where the users can see a list of registered Instances.

Status change

The users can intervene in the Status of the selected Instance.

• Start: Starts all processes in this instance.

• Stop: Stops all processes in the instance.

• Paused : Pauses all processes in this instance.

• Resume : Resumes all processes in this instance.

This feature allows the users to search by the name of an instance.

• The users can clear the selected Instances.

• The default work for deletion is to remove the registration from the web, but check the box if the users want it to also be removed from the engine's prs_instance.map. The checkbox is only active if the Instance's Status is Stopped.

To use ProSync Manager, access a web browser and log in.

At the login screen, enter the user ID and password, then click the Login button. After successful login, the users will be taken to the Replication Diagram page

When ProSync Manager is installed, it creates an account with administrator privileges by default; the default username and password for the administrator account is admin/admin, which can be changed in the install.cfg during the installation process.

If the users have forgotten the password, they can check the ID of the administrator account by placing the mouse cursor on the Info icon of Forgot Password.

As that account is authorized to change other users' passwords, contact the owner of the account to change the password.

When the users unzip the ProSync Manager deployment file, the following structure is shown.

Below are descriptions of the main files and directories found in the above structure.

• ResetPassword.sh This file initializes the password for the Root user used in ProSync Manager.

When the users dynamically add a synchronization table from the , the users can view its progress and history on that tab.

ProSync Manager supports the following platforms and operating systems.

Provides an overview of the terms and concepts used in ProSync Manager.

Describes the login screen.

Describes registering Diagrams and Streams.

Describes installing and registering Instance.

This section describes the Monitoring main screen after installation and registration are completed.

Instance Info area

This is the area where the users can check the information of the selected Instance in the Instance list.

Instance Info

The users can view the details of that instance.

The users can view the processes, status, and query monitoring belonging to the instance.

The users can modify the Diff SET criteria and values via the Edit button next to the Diff SET entry.

It can be set based on TSN or TIME, with values from 100 to 100000000 for TSN and from 1 Min to 100 Hours for TIME.

This modal allows the users to see which query statements are being applied by Apply, or have finished applying.

The Schedule feature is available only in ProSync Manager and allows the users to schedule changes to the state of an instance in ProSync.

The users can set the time period from the current time up to one week, and it can be repeated on a weekly basis.

Because the Instance resumes to synchronize at the set time and pauses to pause synchronization, the Instance must be in the Pause state before the start of the schedule for the Scheduler to work properly, and if the Resume fails, the subsequent Pause actions will not be executed.

On the Scheduler page, the users'll find two tabs of information.

The users can see which DCR options are set for that instance.

• The users can set additional DCR options. In this case, the target is a table that has been added to the list of synchronized tables.

• The users can search by filtering the items the users want to search for.

Monitoring User is a user that must exist in both SRC DB and TAR DB in order to use synchronization monitoring and other features in ProSync Manager.

This is required when making a connection to ensure that the DB information entered during Stream registration is correct. This is required to check the cluster status to get additional information from the DB.

This is required to retrieve the SRC Current Time and Last Commit Time, which are metrics that allow the users to check if synchronization is working properly on each instance.

This is required to retrieve Schema, Table, and Column information that exists in each DB when adding a dynamic synchronization table.

Describes the process of installing ProSync Manager.

Describes the server configuration for ProSync Manager.

Describes the usage of the scripts available in ProSync Manager.

1. Instance installation entry point

The users can view the Instance Management page by selecting the Instance Management tab.

At this point, the users can install and register an instance through the Instance Installation button on the top right.

2. Instance installation modal screen

The modal first screen of the Instance installation.

The users can choose between two methods.

• Instance Installation

  • Select when the users want to install a new instance.

• Instance Registration

Select the tab that corresponds to the desired method to confirm.

After successfully installing and registering the Instance, the users can see that it is registered on the main screen as shown below.

The users can manage which users can run or use ProSync Manager, and this page is not accessible to users in the User Role.

User Role

Refer to the Glossary.

Users area

Add Users

• The users can be added to manage and use ProSync Manager.

Filtering area

• The users can search among the created Users by filtering by a specific Role and User Name.

• The left side shows the items used for filtering, which can be removed from filtering via the x button to the right of each filter tag or reset with the Filtering Reset button. These items can be specified via the filter button on the right..

• The registered users can be deleted and edited.

• This is the table where the users can check the list with all filtering applied.

1. Add User

Enter the user information to register.

The users can check the header of the list and the Delete button in each list.

The Delete button in the header resets the input and list count for all lists, and the Delete button in each list deletes the corresponding list.

1. Set Password

Set the password for the user to add.

At this point, the users can check the conditions for setting the password via the info icon in the password field, and see which conditions are met and which are not.

The users can edit the registered user information.

In this case, the email address cannot be editted but the user's password can be changed.

Sync Table List area

The users can check a list of tables that are synchronized for this instance.

Add Table button

• A modal appears that allows the users to dynamically add synchronization tables.

Schema List

• The users can check the schema of a table that is registered as a synchronized table.

• The users can filter Schema list to check a list of synchronized tables.

• The users can search by filtering the items the users want to search for.

• The users can remove it from the synchronization table.

The users can check a list of tables that are registered as synchronized tables.

Select the Schema and Table in each DB that the users want to set the synchronization target table.

The users can set up Column Mapping for a synchronized table.

By default, ProSync assumes that the columns in the source table and the columns in the target table have the same properties.

If there are attributes that don't match, such as different column names, or if there are columns to exclude from synchronization, the users can specify them explicitly at that stage.

The users can set a synchronization to skip depending on the value of one of the synchronization tables.

By default, ProSync synchronizes over all column values.

If there are values to skip based on columns in the synchronization, the users can set a condition with a comparison statement at that step.

If the data exists in a table in Source, the users can set whether it is initially loaded or not.

The users can set DCR options to resolve conflicts in data during ProSync two-way synchronization. For more information, refer to the "ProSync manual".

1. Installation parameter configuration

Open the install.cfg file in $PRSMGR_HOME to set the parameter values required to install ProSync Manager.

Each parameter is separated by a newline, and only one equals sign (=) is entered between the parameter name and the value, with no spaces.

ROOT_ID=admin
ROOT_PW=admin

SERVER_IP=localhost
SERVER_PORT=8080

REPODB_IP=localhost
REPODB_PORT=13852
REPODB_USERNAME=repo_user
REPODB_PASSWORD=password
REPODB_DBNAME=prosyncmanager
REPODB_DOCKERNAME=prosyncmanager

# set at the same time when mounting the repodb volume
#REPODB_PATH=$PRSMGR_HOME/repodb/data
#REPODB_LOG_PATH=$PRSMGR_HOME/repodb/log

# for repoDB management
REPODB_SUPERUSER_NAME=prsmgr_superuser
REPODB_SUPERUSER_PASSWORD=prsmgr_password

# for repoDB shared buffers(B, kB, MB, GB, TB)
# 0 is the setting that makes it determined based on the value according to the system memory.
REPODB_SHARED_BUFFERS=0

# if you need, enable and type the path to jar
# JDBC_ORACLE=/path/to/ojdbc.jar
# Optional: if the Oracle database uses a character set not included in the JDBC driver, add orai18n jar (e.g., KO16MSWIN949)
# JDBC_ORACLE_I18N=/path/to/orai18n.jar

The following describes each parameter.

After setting the parameters, execute the install.sh script to perform the installation.

The install.sh script can be executed as below.

The following describes the procedure for selecting options during installation.

Here's an example of the installation.

If an error occurs during installation, it prints the part or statement where the error occurred and the associated error message to a log file for debugging purposes and aborts the installation.

Details about the error can be found in the install.log file.

Connect to the URL resolved at the bottom of the install log and verify that the users are prompted with a , and that the users are logged in with the ID/PW the users set in install.cfg.

The users can check the event status of ProSync events that occurred on a per-diagram basis.

Events area

Setting Email Notification

• The users can set up email alerts for events that occur.

• Event notifications are based on notifications via email, and the protocol used is the SMTP protocol.

• The users can set a time period to see events that occurred during that time period.

• Custom allows users to set the time period they want to search for, and in addition to the current time period, users can choose from 1 day, 1 week, 2 weeks, 1 month, 3 months, 6 months, and 1 year ago.

• The users can search for events that have occurred by filtering by specific Instance and Event Status.

• The left side shows the items used for filtering, which can be removed from filtering via the x button to the right of each filter tag or reset with the Filtering Reset button. These items can be specified via the filter button on the right.

• The users can control the history of an event by deleting it by setting the interval in which the users want to delete it.

This is a table where the users can see a list of events with both the Event Search period and filtering applied.

The users can utilize these filters when searching the Event table for more sophisticated searches.

• The users can see a list of Streams - Instances that belong to the Diagram specified in the Diagram Filter in the header of the page.

• Select the Instances the users want to select/clear by the filtering criteria. Select Stream if the users want to select/clear all instances in a Stream, or Diagram if the users want to select/clear all instances in the current Diagram.

• All of the status types available on the Events page.

• The Label, which is resolved to a level such as 'All', is the parent status for common grouping of statuses, and the Intended Status is the status that is actually checked and used.

The users can set the time period for which the users want to delete event history.

ProSync Manager requires the users to set up the settings for SMTP in the UI and then send emails through that server.

The users should contact the mail server administrator for SMTP configuration details, as they may vary depending on the environment in which ProSync Manager is running. In particular, if the users want to send mail via SSL/TLS protocol, the server must be able to communicate in both directions.

Before setting up Email Notification, the users need to set up the SMTP protocol.

Set and delete event alarms via email.

A. Enter Basic Info

B. Set Notification Conditions

Set the status the users want to track with Email Alarm and the duration of the status.

C. Set Notification Targets

Set the users the users want to receive this email alert.