Generate a package from Studio

<< Click to Display Table of Contents >>

Navigation:  Automation Server > Deployment  > Advanced Deployment > How to generate a deployment package >

Generate a package from Studio


Use this tool to generate the initial package of objects you want to deploy from your Development environment. This step of the deployment is done in Bizagi Studio.


You can either export individually the processes or components, or export the full project.


What you need to do

Before you start, make sure your processes are ready and that they don't need additional changes to be deployed.  This is step is located in the seventh step of the Process Wizard, clicking the Export Process option.




You can also select the Advanced option located in the Deployment section of the Export/Import menu.




A window appears with the Advanced deployment wizard.




You will see its user interface present the following:

Database: Shows the database and its database server, to which the executable was configured.

Processes Tab: Displays all processes and their versions. You should select those you want to include. When you right click a process version and select Define process dependencies a window appears where you can select the dependencies you want to force-include in your deployment. Keep in mind that only the selected processes are deployed, those which are not selected are not deployed even when they are related with other selected objects. Select the Entities, Query forms or Business Rules that you want to relate from the list. When a selected entity does not have attributes, it will not be included in the deployment.




Experience tab: Select the experience components you want to deploy. Keep in mind that experience elements are highly uncoupled and can be deployed without considering their necessary relation or component to work properly. For more information refer to Relate Objects.




Advanced tab: Select the objects you wish to include in the deployment. Among these objects you can select the themes you've made with the Theme Builder, Environment parameters, authentication options and user properties.





When you choose to include environment parameters make sure that these parameter values, such as the SMTP server and interfaces URL, correspond to their environment configuration. When you deploy the package with these settings the target environment's parameters will be overwritten.

If you check the Authentication options, the authentication configured in the target environment will be overridden. Do not use this option unless you are sure to change the authentication options with the configuration of your source environment.


Description tab: Add the information you consider relevant for this package such as the included processes, their versions, entities and other relevant changes.




Click on the Export button. If you selected the add password option AddPassword, a window will appear asking for the password to be assigned to the package, it must comply with the mentioned conditions. When a package with a password is generated, it is encrypted.




This generates the package with your selected objects and process versions and save it as a local .bex file.

We recommend saving the packages with the following format to have a record of the deployments:



App: abbreviated name of the application(Optional).

nnnn: abbreviated name of the project.

dd: day of the deployment.

mm: month of the deployment.

yyyy: year of the deployment.

cc: number of deployment of the day.


A window appears informing that the export was successful and it shows a summary of your export file.




You can check the contents of the export package by clicking the View Package button or using the package visualizer. See Review the content of a package.





When a parameter entity managed in production is considered in the deployment package, all of its attributes and relations are included, even unused ones.


It is important to review the deployment logs, in case any error occurred during the exportation of the package.


Export the full project

You can export all the components of the project in one deployment package. To do that, go to the Export / Import tab in Bizagi Studio. Then click the Project button:




Select a path where to save the BEX file and click OK.


You can use this BEX with the full project in the following scenarios:

You want to easily deploy the full project. See how to apply a deployment package.

You want to create a copy of a Bizagi Studio project. For example, you can create a new project (empty) an import all the components included in this package. You can import the package using the Bizagi executable.



Importing the project only works by exporting the full project with this feature. If the BEX file is generated with other features like microdeployment or Sharing processes, you cannot recreate the project.


For support purposes, you can share the BEX file to the Bizagi support team, so they can diagnose issues. This BEX file does not contain any critical data, only the metadata of your project. That means that information registered in entities is not part of this deployment package.