Automating build of artifacts outside the Studio
Learn how to build processes and other artifacts developed in Bonita Studio, but without the need to open and interact with Bonita Studio. This allows to automate builds through scripts or any automation tooling.
This way of building artifacts is deprecated. Use Bonita Continuous Delivery add-on instead.
For Enterprise, Performance, Efficiency, and Teamwork editions only.
Bonita includes a Workspace API, in the form of the script
BonitaStudioBuilder, to build a .bar file from a process and/or a .zip file from a REST API extension in a repository. It accesses the build features of Bonita Studio in the background.
This is intended to be used in a continuous integration and testing environment.
Bonita Studio must be installed but must not be running. You must use a dedicated Bonita Studio for continuous integration.
This is because the Bonita Studio
workspace directory should be removed before running the
(For continuous integration, it is best practice to clean the files before and after a build.)
BonitaStudioBuilder, you need the following:
Bonita Studio (the same version as the Bonita repository). This must be a dedicated Bonita Studio and repository used only for your
BonitaStudioBuilder, because the tool removes the content of the repository.
A window manager
After Bonita Studio is installed, the
BonitaStudioBuilder scripts are in the
There are scripts for Windows (
.bat), Linux (
.sh), and MacOS (
Pass configuration information to the
BonitaStudioBuilder script as system properties, using the following arguments:
The parent folder of the repository storing the process. Typically, this is the trunk folder. It can also be a folder in tags if you want to point to a restore point in the repository.
You cannot use a remote repository folder. A process to be built must be manually checked out before running the script.
The folder where the generated bar and zip files will be stored.
The list of the processes in the repository for which bar files are required.
For each process, specify the process identifier and, optionally, the version.
If you do not specify the version, the latest version is used.
If enabled, bar files are built for the latest version of each process in the repository.
If enabled, zip files are built and installed in maven repository for all REST API extensions in the repository.
If enabled, bar files are built for the latest version of each process in the repository and zip files are built and installed in maven repository for all REST API extensions.
If enabled, you can point the
repoPath argument to a repository of an older version than the version of the running Bonita Studio.
The processes in the older version repository will be automatically migrated to the current version.
The environment with which the bar files will be built.
The environment defines the process configuration, including dependencies.
If you do not specify an environment, the exported bar file will not contain the dependencies.
All the specified processes are built for the same environment.
If you want to build for different environments, you need to run the script once for each environment.
Optional Maven profiles (comma separated list of profile id) to activate when building the REST API extensions projects.
If enabled, do not make a copy of the project to build.
To run the script:
Check out the project to a directory in the Studio path.
Delete the content of the
workspacedirectory in your Bonita Studio installation.
Run the script. For example:
./BonitaStudioBuilder.sh -repoPath=/home/myBonitaRepoCheckedOut -outputFolder=/home/bonita/myArtefacts -buildAll -migrate -environment=Qualification -profile=qa
When the script runs, information is logged in
From the zip file, a REST API extension can be deployed manually using Bonita Portal. You can also deploy a REST API extension using the REST API.
A REST API extension is a maven project stored in a Studio repository. You can find them in the studio workspace:
workspace/yourRepositoryName/restAPIExtensions/yourRestAPIProject. From there you can simply use maven cli or a CI job to build, test or packake your REST API Extension.