Using the Replication Wizard

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Process wizard > Data Modeling > Connecting to external data sources > Data Replication >

Using the Replication Wizard


Bizagi presents a Replication Wizard to assist in the definition and settings for the connection  to an external SQL Server or Oracle database (and automatically create any necessary components).

View more information about Replication.


The following article illustrates how to set Replication in Bizagi by using the Wizard. If you require to connect to an external data source which is not in a SQL Server or Oracle database, refer to Using advanced Replication configuration (Standard option).


Using the Wizard

To launch the Replication Wizard, go to the second step of the Process Wizard in Bizagi Studio (Model data).




While designing the Process data model, you will find an option to include in the Diagram replicated entities that will be created as Parameter-type entities.




Before using the Replication Wizard, it is recommended to review the supported data types for the built-in connection of Bizagi to SQL Server or Oracle databases.


What you need to do

Configuring Replication through the Wizard is done by:


1. Specifying details for the external System's information (set as a reference System in the Bizagi project).

2. Specifying details for the Data Provider (the connection information to the external data source).

3. Selecting which tables or views to replicate.

4. Defining optional filters for the tables or views to replicate.

5. Defining a Replication Schema.


Once the schema is defined, we also run an initial import for these tables or views, so that we can verify that the integration was properly set (checkpoint).



In the following example, we will replicate the following tables from a Northwind database (in SQL Server): Territories and Region.

Both of these tables will be automatically created in Bizagi as Parameter Entities.


To illustrate this configuration, we will part launch the Replicate Entities Wizard from the Process Model diagram presented in the Data model step.


1. Define the information for the system where the external data source is.

In the System window, Select New from the Select System drop-down list.


Enter a reference name (System Name) to the external system. This reference will represent the external system in your Bizagi project.

In subsequent Replication settings, you will have the option of choosing existing systems (configured previously) from the Select System drop-down list.

Enter the Display Name and Description, and Click Next.




2. Enter details for the Data Provider.
In the Provider window, select New from the Select Provider drop-down list. In subsequent Replication settings, you will have the option of choosing existing systems (configured previously) from the Select System drop-down list.

Enter the Provider Name, which must be a unique name you will give to this specific Data Provider (needed when you register more than 1 external data source in your project).




Then, if your external data source is in a SQL Server database, enter the following information:

Database Server: The name of the Database Server containing the SQL Server instance.

Database Name: The name of the Database where the tables or views to replicate are.

Authentication: The authentication method used for accessing the Database. You can choose between SQL Server Authentication or Windows authentication. You don't need to provide the Database User and Password if you select Windows authentication.

Database User: A login account to access that Database. Note that this account requires read access to the tables or views for replication.

Database Password: The password for the login account.



Windows authentication and Oracle databases are not supported for Bizagi Automation cloud service.


Otherwise, if your external data source is in an Oracle database, input the following information:

Net Service Name: The connection string to your Oracle instance's service. This is specified as "databaseServer:port/serviceName".

Notice that the default port for Oracle instances is usually 1521.

Schema: The name of the user schema.

Database Password: The password for the user schema.


Click Next.




3. Select which tables or views to replicate.


Once you have defined the connection details to your external data source, Bizagi will search and show the available tables and views at the source.

Expand the TABLES node to display a list of tables on the external data source, and mark the table(s) to replicate.


In our example, we will mark the Region and Territories.

Click Next.



When selecting more than one table or view, Bizagi will automatically create their relationship (reference attributes), if these tables have an existing relationship explicitly defined at the source.





Primary keys of tables are selected automatically as business keys. When selecting a view for Data Replication, you do not need to mark that view, but to make sure you select which column or columns will make up the business key definition (those which define uniquely each record in it).




4. Define filters for the tables or views to replicate (optional).

As an optional step, and applicable when running your processes in a .NET platform, once you have selected the tables or views to replicate, you may choose to define a filter so that Bizagi disregards certain records.


For example, you may set that you want to disregard Regions having NULL descriptions (Region filter: RegionDescription is not NULL).


If you do, you may test the filter using the Test Source Filter button.

Click Next.



Remember that this option must be used carefully when the source has a very big number of record, as the query and the outcome may take time.




5. Define a Replication Schema.


In the next window, define the schema that a scheduled job will follow to execute the Replication (information synchronization).

Select New from the Schedule drop-down list, and enter a Name, Display Name and meaningful Description. In subsequent Replication settings, you may choose an existing Schedule (configured previously) in the Schedule drop-down list.




Click on the Schedule Properties tab.




Specify the periodicity and frequency with which the information will be replicated  (synchronized from the data source into Bizagi), according to the options presented below:


Schedule option


Enable Schedule for this Replication

Mark this option for Bizagi to execute the data replication from the external source.


Mark Daily, Weekly or Monthly to define how frequently  Bizagi will execute the Replication schema.

Every [...] day(s)

This modifier further defines the interval selected in the above-mentioned Periodicity option as follows.

Daily option: Enter the number of days between repetitions of the execution. Its default value is 1.

Weekly option: Enter the number of weeks between repetitions of the execution. Also, specify on which weekdays this schema will be executed.

Monthly option: Enter the number of months between repetitions of the execution. Additionally, select the day of the month in which this schema will be executed.

Daily frequency

Define if the execution happens once a day (and at which time), or if it should be executed every certain time (minutes or hours).


Set a starting date for this schema to begin its execution.

Schedule properties description


Mark the Data Replicate now option to immediately execute the Replication (information synchronization).

If the Data Replicate now option is unmarked, take into account that the Replication will be executed as defined in the Schedule Properties and this requires that the Scheduler service for your project is started up and running (restarting it is recommended).

To view more information about restarting the Scheduler, refer to Bizagi Management Console and its options.


Click Next.

Finally, click Close when this configuration has been successfully completed.




Verifying Replication (Checkpoint)

Once Replication is set, you may choose to verify that its execution synchronizes the values for the given replicated Parameter Entities.


There are two ways to do this: using the options in the Systems modules, or through the displayed entities information (Entities module).

Options presented in the Systems modules are useful for a Production or Test Environment.

Options presented in the Entities module will serve as a checkpoint while configuring Replication (in the Development Environment).


To view how to verify that the Replication was set up or is running properly, refer to Verifying Replication.