Declare the interface in Bonita

This page defines the steps to declare your interface and display it in Bonita.

Declare the interface in Bonita application descriptor

The Bonita application descriptor is a file that let you describe all your applications.

To declare a Bonita UI Builder interface in it, edit it in Studio using the source tab. In this tab, you will be able to declare your application built and packaged with Bonita UI Builder, using auto-completion with an applicationLink XML tag.

Application Descriptor Editor

In this example, the General Overview application is declared with the tag:

     <applicationLink token="appLink" version="1.0" profile="User" state="ACTIVATED">
         <displayName>General Overview</displayName>
     </applicationLink>

There are fewer properties to set for an application link than for a legacy application, but the displayName is still mandatory.

The token property’s value must be identical to the value of the slug key found in the JSON export of your application. For example, if your application name is Awesome application, its slug should be awesome-application.

Two applications cannot share the same slug. To resolve this, you can modify one of the applications:

  1. Directly edit the JSON file:

    • Change the value of the exportedApplication.slug key.

    • Change the value of the exportedApplication.name key.

    • Note that exportedApplication.slug should be derived from exportedApplication.name by replacing spaces and special characters with hyphens.

  2. Use the Bonita UI Builder:

    • Change the application name through the Bonita UI Builder interface.

As you can see on the screenshot above, both UI Designer applications (declared with an application tag) and UI Builder applications (declared with an applicationLink tag) can coexist on the application descriptor and on the same runtime.

Once your application descriptor is done, don’t forget to deploy it by clicking the deploy button in the Studio.