Generate a package from Studio

<< Click to Display Table of Contents >>

Navigation:  Low-code Process Automation > Studio Cloud - Authoring environment > Deployment  > How to generate a deployment package >

Generate a package from Studio

Overview

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.

 

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.

 

ExportOption1

 

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

 

ExportOption2

 

A window appears with the Deployment wizard.

 

ExportWindow

 

Bizagi allows you to save the configuration used during the export process. In the main Export window, click Save Configuration to generate a .json file.

 

SaveConfiguration

 

You can reuse this configuration in future exports by clicking Load Configuration, located next to the Save Configuration button.

 

LoadConfiguration

 

You will see its user interface present the following:

 

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.

 

RelatedObjects

 

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.

 

ExperienceTab

 

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.

 

AdvancedTab

 

note_pin

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.

 

Triggers tab: In this tab, you can select the previously configured triggers to be included in the deployment to the target environment. These can be email triggers or cloud file storage triggers. You can choose triggers by Trigger type node or by each individual trigger.

 

TriggersTab

 

Matrix tab: This tab shows a complete and detailed view of the Experience Matrix to be exported. Additionally, the configuration can be temporarily saved in JSON format and continue working on the configuration later, making the export experience a more efficient and flexible process. Inside each Matrix, you can find the different Personas and related Business Objects and you must select the Experience Matrix level in order to export.

 

MatrixTab

 

Some tools inside this tab allow you to search and manipulate the displayed information like the following:

 

oThe search option allows the user to filter the content of the Matrix and quickly find the desired information for migration.

oThe expand or collapse buttons allow users to view the content of Matrices in an easier way, where they can choose which information to collapse or expand.

oThe checkbox allows the user to select or deselect all Matrices from the list at once. This feature saves time and improves the efficiency of the export process.

 

Agents tab: This tab allows selecting the AI Agents to export along with their metadata, such as catalogs and artifacts related or used by the agent.

 

AIAgentsTab

 

note_pin

The status of the artifacts to export must be Available.

 

AI in Process tab: This tab allows exporting the metadata associated with the AI tools that support processes configured in Bizagi.

 

AIinProcessTab

 

Enterprise Knowledge tab: This tab allows exporting Enterprise Knowledge metadata from Bizagi, including categories, database knowledge catalogs, and the artifacts used by each catalog.

 

EnterpriseKnowledgeTab

 

note_pin

If the package metadata is corrupted or inconsistent, the import process will detect it and report the issue.

 

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

 

DescriptionTab

 

 

Click 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.

 

Password

 

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_nnnn_dd_mm_yyyy_cc].bex

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.

 

ExportSuccess

 

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.

 

PackageVisualizer

 

To visualize elements from the project that are not included in the generated package, enable the Objects not included in package option.

 

note_pin

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


Last Updated 7/14/2026 4:22:55 PM