$(document).ready(function(){highlight();});

Exporting a process

<< Click to Display Table of Contents >>

Navigation:  From Studio to Cloud >

Exporting a process

Overview

Using the Export Process option, Bizagi will publish the automated processes and create a file ready to be installed in any of the Bizagi Cloud's environments provided in the subscription. Please bear in mind the following:

 

Exporting the application does not require an internet connection. However, to upload an exported package to a Bizagi Cloud environment, an internet connection is imperative.

You can export an application regardless of the number of environments that the application has been previously deployed to.

Bizagi Cloud will include every Bizagi Connector added to the Bizagi Suite project in the exporting application. Nonetheless, developed libraries (Components Library) are supported in On-Premise developments.

Your target environment version does not have to be the same as your Bizagi Studio version. However, we strongly suggest that the target environment is in the same or a lower version than Bizagi Studio.

It is strictly required that objects in the Development Environment are not deleted (when being used in production already), and that you always create new versions of processes whenever you need to make adjustments to processes.

We recommend scheduling and performing package Deployment during non-working hours. This promotes any contingency measure towards restoring a version, should the Deployment results not be as expected.

 

When processes are critical, and depending on the nature of the changes incoming from development (i.e. it is strictly needed to test existing instances), you can choose to use an alternative environment. This can be used to perform rigorous testing and user acceptance tests, specifically focused on the existing production cases (live Process instances). This means that you should create a temporary environment beforehand for the sole purpose of testing the final deployment into production. By doing this, you have a way to check whether any changes or additional information are required for Deployment. When using such an environment, please make sure that the SMTP Server, any configured interfaces, any ECMs or data providers, the set emails for your users, or any other settings do not trigger your production settings.

 

Required profile

The user creating the package from Studio needs to:

1. Know how about the concepts involved in a Deployment of a project in Bizagi.

2. Have an understanding of the implementation:. This means knowing about the processes' purposes, data model, versions, integrations, security settings, environment settings management (i.e policy, alarms, parameter entity values), and general workings.

 

Export Process

To create a package go to the seventh step of Bizagi Studio's Process Wizard, and select the Export .bex file option.

This option creates a .bex file, of the selected processes. Users can choose which processes to take to Cloud. If any process is still under development it should be left out of the selection. Only choose the ones ready to be tested.

 

export_1

 

Select processes in the main panel

In the window displayed expand the Application to see all processes and their versions: Choose the processes (with the versions) that are ready to be taken to the cloud.

Bizagi will run validations within its dependencies engine in order to detect objects which are being used by the processes chosen. Through these validations, objects like entities, forms, and rules are included automatically into the exporting application. Similarly, Bizagi will identify objects in the Development Environment which are not being used by the processes and which are not selected to be deployed. These will not be taken into the exporting application.

 

However, it is possible to decide manually whether any additional objects should be included, as well when the deployment of the processes is executed. This option is especially useful if you wish to include objects such as entity queries, which are not necessarily related to a process. For all process versions chosen, right-click to access additional dependencies with the Define process dependencies option.

 

Export1_patchA

 

Choosing objects within the Relate objects window will force their inclusion in the package generated. For example, if an entity is not part of the process the dependencies engine will not detect it and will not include it in the package. However, of you need the entity taken within the package, this window allows you to force its inclusion.

 

Entities

Click the Entities tab to choose the entities (master or parameter) that you want to be related in the package for the chosen process.

 

RelateObjects_Entities

 

Query forms

Click the Query forms tab to choose the queries (Application or Entity level queries) that you want to be related in the package for the chosen process. In the image below, the entity query called Ticket Response Query is marked as a related object and will be forced to deploy in the package.

 

RelateObjects_QueryForms

 

Business Rules

Click on Business Rules tab to include the rules (scripting or boolean) and functions that you want to be related in the package for the chosen process. In the image below, the Business rule called AssignStatus is marked as a related object.

 

Bear in mind that all Library Rules Are automatically included in the generated package.

 

RelateObjects_BusinessRules

 

 

 

Select advanced items

In the Advanced option there are additional objects that can be included.

 

AdvancedOptions

 

OPTION

WHEN TO USE IT?

Include environment parameter values

Values given per environments. We recommend making sure that all parameter values (such as the SMTP server, interfaces URL, etc.) correspond to their environment configuration.

Include user jobs

If your project uses custom jobs, make sure this option is chosen.

Include organization

Choose organization's items to be included in the package..

Include authentication options.

This option includes the authentication definition for this project. These options can also be managed through the Environment Console per Environment.

Include records of parameter entities managed in production

Include parameter entities's values managed in production the first time a package is created to deploy the values entered in the Development Environment.

 

Include Experience components

You can select Experience components via the Experience components option. These components are highly uncoupled and can be deployed without considering their necessary relationships or their components. Therefore, when deploying these unrelated objects, it is necessary to explicitly select every related experience object that you wish to deploy.

 

advanced_components

 

 

 

It is strongly recommended to manually check all objects you wish to deploy.

The table below lists experience objects and suggests the ones that should be individually selected for the deployment to be completed.

 

 

Object

Variant

Related objects

Collections (shown in My Stuff)

Indirect Collections

Every related context.

Direct Collections

Related entity.

Their context.

The process related if an Add button is configured.

The stakeholders and their related contexts if an Add button is configured.

Every entity used within the visibility expression (if used in an Add Button configuration).

Actions

Process

The related process.

Every related context.

Every entity used within the visibility expression (if used).

The entity where the action is defined.

The processes where the action can be launched from.

Form

The entity where the action is defined..

Every related context.

Every entity used within the visibility expression (if used).

The processes where the action can be launched from.

Expression

The related expression.

The entity where the action is defined.

Every related context.

Every entity used within the visibility expression (if used).

The processes where the action can be launched from.

Contexts

All but the "Always available" context

The related stakeholder

Searches


The related stakeholder.

The entity to search (this will deploy the search form as well).

The related contexts.

Relevant to me


The related stakeholder.

The related process.

The related context.

Triggers

Process

The entity where the trigger has been defined.

Every entity needed to correctly run the condition expression.

The related process, to be launched.

Expression

The entity where the trigger has been defined.

Every entity needed to correctly run the condition expression and the trigger expression.

Constructors

Process

The entity where the constructor has been defined.

The process related.

Every related context.

Every entity used within the visibility expression (If used).

Form

The entity where the constructor has been defined.

The expression related.

Every related context.

Every entity used within the visibility expression (If used).

 

note_pin

Please be aware that the use of the sentences getValueAsCollection and getXPath within an expression does not ensure that the attributes included in such sentenced will be included in the package. It is, necessary to add the following sentence in your expressions whenever an attribute of an entity is not being taken into your deployment.

 

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

 

Export

Export option generates the package with all selected objects and process versions and creates a .bex file.

Bizagi will prompt the user to choose a folder to save the generated file.

 

The generated package is ready to be uploaded to Bizagi Cloud. You can use the Tasks after export options to review your generated application and evaluate whether you need to generate a new one.

 

AfterExport

 

Tasks after export allow you to view information contained in the package, classified by entities and allows you to see which ones have their information exported completely or partially.

Refer to the Importing an application to Bizagi Cloud to upload the package in Bizagi Cloud.