Relate Objects

<< Click to Display Table of Contents >>

Navigation:  Bizagi Engine > Bizagi system administration > Deployment of processes and new versions > Previous considerations and requirements >

Relate Objects

When deploying Processes to a Test or Production environment, Bizagi will run validations within its dependencies engine in order to detect those objects which are being used by the Processes about to be deployed.


Through these validations, such objects like entities, forms, rules, etc., are published automatically into the target environment.


Similarly, Bizagi will identify those same objects in the Development environment which are not being used by the Processes to be deployed.

These will not be taken into the target environment by default.


However, it is possible to decide manually if any additional objects should be included as well when the deployment of the Processes is executed.

This option is especially useful to include objects such as entity queries, which are not necessarily related to a Process itself.


Defining Related Objects

When planning and launching a deployment, it is possible for those technical profiles (executing the deployment) to detect objects that are not explicitly used by a Process; and to manually include these objects through the same option (present in a deployment's configuration).




For example, when deploying a Process, you may want to specify that this deployment takes along a specific query form (or entity query) into your target environment (Test, Production).

You may do so by using the Relate Object option to mark that the particular query form relates to a Process.


Objects to relate

To relate objects, click on the Relate Objects option from the Deployment Wizard.

Within the configuration window, you may relate: Entities, Query forms, or Business Rules (includes functions).



Click on the first Entities tab in order to mark those entities (Master or Parameter type) which you want to relate to the given Process.




Query forms

Click on the Query forms tab in order to mark those queries (Application or Entity level queries) which you want to relate to the given Process.




In the image above, the Entity query called Ticket Response Query is marked as a related object.


Business Rules

Click on the Business Rules tab in order to mark those rules (scripting or Boolean type) and functions which you want to relate to the given Process.




In the image above, the Business rule called AssignStatus (at the level of the Application entity) is marked as a related object. Bear in mind that any Library rule defined is automatically taken into account when deploying.


Entity Components

Click on the Add deployment Components link in order to display the entities whose components can be deployed.




Check the components you want to be part of the deployment. Bear in mind that only entities with valid components are listed. The valid elements are:








In the image below, the Entity query called Customer has multiple objects eligible for deployment.





Please be aware that the use of the sentence getValueAsCollection within an expression does not assure that the attribute will be taken in account when deploying experience components. It is, therefore, necessary to add the following line in your expression in case any attribute of an entity is not being taken into your deployed environment.


CHelper.usingAttrib("Entity Name","Attribute Name");