Custom Page seed Project
This project is designed to help developers start a new implementation of custom page for Bonita BPM. It contains an empty Custom Page source and test code structure based on AngularJS, build scripts to run unit tests and end to end tests with Jasmine and Protractor, along with a lightweight application server to run the page, and a script to build a deployable Custom Page zip file for the Bonita PortaL
The deployable zip format follows the following structure:
. ├── index.[html | groovy] ├── page.properties //contains name, display name & description of the page └── resources/ //contains all needed resources
The following software/libraries must be installed
- node.js + npm
npm i -g bower
npm i -g gulp
npm i -g karma
To install node.js with npm on GNU/Linux: How to install node.js on GNU/Linux.
Before starting development, install dependencies in your project with:
$ npm install
To run the development server launch:
$ npm run dev
This automatically starts the Jasmine tests, which run in background with up to date source code.
All the files will be automatically concatenated and minified. Same goes for the css files.
The custom page metadata is located in the file
To generate a deployable Bonita BPM Portal custom page zip file, launch:
$ npm run build
All available project commands
npm run devcreates a local server with livereload and opens your default browser.
npm run buildcreates a target folder with production ready js / css files and a custom page zip file in the target dir.
npm run e2elaunches the e2e test suite
npm testlaunches the unit test suite
Deploying the page on the portal
- Login in Bonita BPM Portal as an administrator
- In the Configuration menu, open the Custom Pages section
- Add the generated custom page
- The page can be either displayed in the portal by adding it to the menu of a custom profile, or be displayed in an Application
For more information on Bonita BPM check the documentation.