Vacation Management Living Application

About

This is an official Living Application example for Bonita BPM >7.5.0

This example demonstrates the following concepts:

• Living Application

• Forms and pages built using the UI Designer

• Process using BDM and contracts

• REST API extensions

Installation

1. Start Bonita BPM Studio 7.5.0 or later

2. Download the application bundle

3. Extract the bundle to a temporary folder

4. Import the .bos file in your Bonita BPM Studio. It contains 5 diagrams: Example-NewVacationRequest, Example-ModifyPendingVacationRequest, Example-CancelVacationRequest, Example-InitiateVacationAvailable and Example-RemoveAllBusinessData. Each diagram includes a single process definition. It also includes business data model definition, default process configuration, application page and definition (i.e. application user interface definition). Important: importing the .bos file will ask you to override your existing business data model.

5. Open the Example-InitiateVacationAvailable diagram and run the process (click on "Run" button in a Bonita BPM Studio). This process will initialize a business data that store vacation available counter for each Bonita BPM user declared in the default test environment (ACME organization).

6. You can now deploy and run the "New Vacation Request", "Modify Pending Vacation Request" and "Cancel Vacation Request" processes by clicking on "Run" button in Bonita BPM Studio. Note that vacation request approval need to be performed by requester (walter.bates) manager (helen.kelly) so you might want to logout and login back with helen.kelly/bpm user. If you want to create (or cancel) several vacation requests, do not click again on "Run" button. Instead click on the "Portal" button and in "User" view go to to "Processes" tab select the process and click on "Start" button.

7. You can now deploy the living application that give user an overview of all created vacation request.

   1. First you need to deploy a REST API extension:

      1. In the Portal, switch to "administrator" view. Use drop down list on top right corner to switch from "user" to "Administrator".

      2. Go to "Resources".

      3. Click on "Add" button.

      4. Select the rest-api-extension.zip file.

      5. Click on "Next" button.

      6. Click on "Confirm" button.

      7. Read more about REST API extension in Bonita BPM official documentation.

   2. Next you need to export and then deploy the application page:

      1. Open the UI Designer using the "UI Designer" button in the Studio toolbar.

      2. In "Pages" tab, click on the "Export" button on the right hand side of "ExampleVacationManagement" page. This will download a zip package of the page on your computer.

      3. In the Portal, go in "administrator" view → "Resources".

      4. Click on "Add" button.

      5. Select the page-ExampleVacationManagement.zip file previously downloaded.

      6. Click on "Next" button.

      7. Click on "Confirm" button.

      8. Read more about pages on the Bonita BPM official documentation.

8. You are now ready to export from Studio and then deploy in the Portal the application definition that will use the previously deployed page:

   1. In Studio menu click on "Development" → "Application Descriptor" → "Export…​".

   2. Select "Application_Data.xml ../apps/tahiti" from the list.

   3. Click on "Export" button and select any temporary folder to save the file.

   4. Now in the Portal switch to "administrator" view.

   5. Go to "Applications" tab.

   6. Click on "Import" button.

   7. Select the Application_Data.xml file.

   8. Click on "Import" button.

   9. Click on "Close" button.

   10. For more information refer to applications in Bonita BPM official documentation.

9. Run the Vacation Management application by accessing to this URL (the port number may vary): http://localhost:8080/bonita/apps/tahiti. You can find the URL of the application in the Portal "administrator view" → "Applications".

Screenshots

Vacation Management Living Application

Vacation Management Living Application - Vacation request to cancel

New Vacation Request process

New Vacation Request process - Vacation request creation form

New Vacation Request process - Vacation request review form

Modify Pending Vacation Request process

Cancel Vacation Request process

Cancel Vacation Request process - Vacation request canceled review form

Initiate Vacation Available process

Remove all business data process

Compatibility

This example has been created and built with Bonita BPM 7.5.0 Community Edition.

It should be compatible with any newer version as well as Subscription edition.

Known limitations

None so far.

Issues

Reports issues and improvement requests on GitHub tracker.