Additional options in Replication configuration

<< Click to Display Table of Contents >>

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

Additional options in Replication configuration


The following advanced configuration options are presented through the Systems module in order to define settings for replicated entities such as: Define filters for the records in the external data source tables, specify if a column (field) at the source will be disregarded, etc.




Locate the system set for Replication, by clicking in the Systems module on the left panel


Test Provider

To verify that the provider was properly configured and make sure the connection is successful, the provider can be tested from Bizagi Studio.

This test requires using IIS, and can be done before proceeding to configure the replicated or virtual entities.

It will diagnose if the connection to the external source can be established successfully.


To do this, select the provider and right-click to choose the Test Provider option (or click the button in the standard menu bar as shown).




In the opened window, select the Start Test button.

A provider that is properly configured, will show all the operations with an OK result status.





The Test provider feature requires that the IIS (Internet Information Services) is used as the web server for the Bizagi project.

The IIS should be up and running (IIS Installation), and the project's web application folder should have security settings that allow anonymous authentication.

Given the above, the Test provider option requires direct access to a local on-premises IIS (Internet Information Services) and is not available in Studio Collaboration Services.


Failed provider test message triggered, when the IIS the conditions alerted above are not met, should read: "The web application is not available...".


Remove entity from Replication

Replicated entities present an option to stop synchronization with the external data source.

The Remove entity from Replication option does not delete the entity from the data model itself; it deselects the entity from the Replication feature and integration (so that this mechanism is no longer used).  



This feature is available for the Development environment when the Schema and Entity has not been yet deployed to a Production Environment.




Once an entity is removed from Replication Schema it still can be used, and the values of that entity used up until that moment would remain the same.


Add entity to Replication

You may choose to add a Parameter Entity created after setting up Replication in Bizagi.


To include a new Parameter Entity in a Replication Schema, use the Add Entity to Data Replication option.




Through this option, you would include an entity as was done using the Advanced Configuration.

Remember to map your entity's attributes to the source's column.


Replicate Now

Replicated entities present an option to enforce a synchronization immediately (instead of waiting for the scheduled job to commence).

This is useful for an initial import or to test the Replication setup.


This option is found by right-clicking a given replicated entity:




Remove attribute from Replication

Replicated entities present an option to remove attributes from the Replication Schema (usually automatically included by the Replication Wizard method).

The removed attribute would still exist in the entity and can be used in the Process, but it would no longer be synchronized with the external data source.




The Remove attribute from Replication option is useful to make sure that the data we are replicating and synchronizing through the Replication Schema, is the proper and necessary information (and unnecessary information is not updated)


This aids in keeping up good performance in data-level integrations. This option is used for columns that reference other external tables which are not being used in Bizagi.


Add attribute to Replication

Replicated entities present an option to include additional attributes in their configuration (usually when the table's structure in the external data source has been changed after the initial setup has been done, and the Replication is already working).




This option would require the following.

1. The new attribute must first be created in the Parameter Entity in Bizagi.

2. The attribute must then be added to the Replication, and mapped to the external source column in order to match the source.


Through this option, you would include an entity as was done using the Advanced Configuration.


Delete Replication Schedule

To delete any object in Bizagi, it is necessary to previously check that it is not being currently used (referenced) by other objects.


This means that to delete a Replication Schedule, you will need to first make sure it does not include any replicated entities in its definition.

Otherwise, Bizagi will display the dependencies with this schedule:  




Set a filter for a replicated entity

When setting up Replication through the Wizard, you may initially define a filter for each of your replicated entities.

This is applicable when running your processes in a .NET platform.

Using filters is a business-oriented option to avoid integration considering some records at the source which may be of no interest in Bizagi (e.g, synchronizing only a given set of values from a CustomerType source).


To review or edit this filter, or when setting the Replication through the advanced options (that is, when setting a manual configuration at the External Systems module), you may do so through the Entities module.




Right-click the replicated Parameter entity and select its Advanced properties.

Under the Source Filter tab, review or edit the applied filter.




Notice that you may use the Test Source Filter option to test this filter and obtain the values from the source:



Data Providers in Production

To guarantee a correct performance in all environments for a Bizagi project, integration settings already working in a Production environment will have the following consideration:

Once a project using Replication has been deployed to Production, it will not be possible to delete the Data Providers used by Processes.


Management of the values for these Data Providers in the Test or the Production Environment needs to be done directly through the Management Console options (managed for each environment separately).


To view more information about management in such environments, refer to Bizagi Management Console.



Due to their nature, values for Replicated entities are managed remotely, not from the Work Portal.