Skip to content
This repository has been archived by the owner. It is now read-only.
Seed project to build Bonita Custom Pages
JavaScript HTML CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
test
.editorconfig
.gitignore
.jshintrc
README.md
gulpfile.js
karma.conf.js
package.json

README.md

Custom Page seed Project

⚠️ This project is now archived. It has been deprecated in favor of UI Designer page + REST API extension ⚠️

About

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

Requirements

The following software/libraries must be installed

  • node.js + npm
  • bower: npm i -g bower
  • gulp: npm i -g gulp
  • karma: npm i -g karma

To install node.js with npm on GNU/Linux: How to install node.js on GNU/Linux.

Development

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 JavaScript files that you create must be referenced in index.html.

All the files will be automatically concatenated and minified. Same goes for the css files.

The custom page metadata is located in the file src/page.properties.

Build

To generate a deployable Bonita BPM Portal custom page zip file, launch:

$ npm run build

All available project commands

  • npm run dev creates a local server with livereload and opens your default browser.
  • npm run build creates a target folder with production ready js / css files and a custom page zip file in the target dir.
  • npm run e2e launches the e2e test suite
  • npm test launches the unit test suite

Deploying the page on the portal

  1. Login in Bonita BPM Portal as an administrator
  2. In the Configuration menu, open the Custom Pages section
  3. Add the generated custom page
  4. 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.

You can’t perform that action at this time.