This documentation is about a version that is out of support, here is the latest documentation version.

How about downloading a newer, supported version?

Bonita User Application

This pages describes Bonita User Application: its values, how to access it, and how to customize it.


Bonita User Application allows anyone with the User profile to start process instances, follow up open cases, and execute tasks through filling out and submitting forms.
Its generic task list aggregates all processes and provides filtering capabilities, to let the user define in what order to execute the tasks for more efficiency.


This application is a generic example provided by Bonita. It is embedded in the Runtime and can be used as is.
But it can also be downloaded from Bonita Studio to be part of your automation project and be totally customized.
If you do not need this application at runtime, you can delete it from the Super Administrator or Administrator Application, or any custom application granting this right.

Access during Development and Testing phases

To access the application:

  1. Open Bonita Studio

  2. Click on the Applications icon of the coolbar. The default application is the Application Directory. You will be logged in as the default user of the deployed organization.
    This default user can be changed by opening the organization editor.
    By default, in our provided ACME organization, the default user is Walter Bates, logged as "walter.bates", with password "bpm".

  3. In the Application Directory, select Bonita User Application

You are now logged in the Bonita User Application.

To access its content:

  1. From the Bonita Administrator Application menu, click on "Applications"

  2. On the "Bonita User Application" row, click on the "…​" View application details icon

Access in Non-Production and Production environments

To deploy the applications into a bundle or the Cloud, you can use Bonita Continuous Delivery's CLI (for Enterprise, Performance, Efficiency, and Teamwork editions, and using BCD). Alternatively, you can deploy an application by importing all its components in the following order:

  • Organization then profiles

  • API extensions then pages, layout, themes

  • Business Data Model then processes

  • Application descriptor

Once deployed, log into Bonita and navigate to the application through the Application Directory.

Create your own User application from ours

Creating your user application based on Bonita User Application means that you can change some of its existing pages, its navigation, its logo, its layout and/or its graphical theme and make those changes visible in the application descriptor.

Import it in Bonita Studio

From Bonita Studio Welcome page Resources tile, click on "Import Bonita User Application".

Get application from Studio

You can also get it from our Admin Application GitHub repository.
There are two ways to get the .bos file. You can either get it from the Releases on the right or by cloning the repository of your choice and building it using maven.
Building the repository will create a .bos file in the target folder. You can import this one into the development environment.
Using this method is also useful if you want to get an older version of an application or if you need a weekly version with a potential bugfix.
After validation, the application is imported or cloned; you can view its content in the project explorer, deploy it, and open it.

Change the existing pages

  1. In the studio’s Project Explorer, select the page to customize.

    • All pages previously created using Google Web Toolkit framework have been recreated with Bonita UI Designer. They can be customized in the UI Designer. They come with the User Application you have download from Bonita Studio. You will see them in the Project Explorer.

    • All pages previously created in other, more recent technologies, have been wrapped as custom pages. They cannot be customized in the UI Designer. Since they cannot be imported in a .bos archive, they do not come with the User Application you have downloaded. Instead, they come as provided resources. You can find them in the "Resources" tab of the application.

  2. Double-click on the page. It opens in the UI Designer. You can start editing the page.

  3. Save it when you are done. Save it as another page if you need to keep Bonita’s original page for further use.

Saving in the UI Designer makes the new page available in Bonita Studio.

Change its navigation menu

  1. Get all the application’s pages available:

    • If you have created new pages in the UI Designer and saved them, they are ready to be used in an application menu.

    • If you have created new pages in another IDE, go to the Resources menu option of the Administrator application, and Install your pages. At deployment time, since these external resources are not part of the project, make sure you also deploy them.

  2. In Bonita Studio, go to the "Project Explorer" on the left and double click on the "bonita-user-application.xml" application descriptor.

  3. In the editor, change the order in the menu, remove the pages you do not need, add other Bonita provided pages, and/or add yours, either in the menu or as orphan pages.
    Orphan pages are not visible in the menu, but accessed through the navigation from another page, like a case details page is accessed through a case list.

Make sure Bonita provided "details" pages are always used as orphan pages, as they need some parameters (usually just an ID) to be passed in the URL by a list or another page to show any content.

Changing an application logo can only be done in Bonita Super Administrator or Administrator applications, and not in Bonita Studio.
It should be done upon deployment in a Non-Production or Production environment.

  1. Create the new logo. Supported formats/extensions are: png, jpg, jpeg, gif, bmp, wbmp, tga. Maximum size: 100 KB

  2. Go to the application details: Applications icon in the coolbar > "Administrator application > "Applications" menu > "…​" icon for Bonita User application.

  3. Click on the "Upload new picture" button below the current logo

  4. Select the new logo

The new logo is applied.

Change its layout

Bonita default layout is made to adapt to a mobile screen size.

  1. Create a new layout and make it available like a page (UI Designer or Resources if created in another IDE)

  2. In the Look & Feel section of the application descriptor, clear the current layout content

  3. Start typing the name of the layout

  4. Select the new one from the autocomplete list

  5. Save the application descriptor

The new layout is applied.

Change its theme

  1. Create a new theme

  2. Go to the Administrator application > Resources

  3. Install the new theme

  4. Go back to the application descriptor

  5. In the Look & Feel section, clear the current theme content

  6. Start typing the name of the theme

  7. Select the new one from the autocomplete list

  8. Save the application descriptor

The new layout is applied. At deployment time, since these external resources are not part of the project, make sure you also deploy them.

Once a page has been customized, or when the Administrator application has been customized, it is no longer supported.
But you can reach one of our Professional Services team member to help you develop or maintain it. You can do so on the Customer Service Center.

Login and sign out

To know more, go to the dedicated page.

Language selection

To know more, go to the dedicated page.

Navigation between applications

To know more, go to the dedicated page.