REST API extension with SQL dataSource

1 Build instructions
1.1 Setup your IDE
1.2 Retrieving the project from GitHub
1.3 Building the project

2 Installation instructions
2.1 Retrieve the binaries
2.2 Setting up the database
2.3 Setting up the datasource
2.4 Deploying the resources in Bonita BPM Portal
2.5 Running the sample application

Build instructions

If you want to modify and build the project, you may follow these instructions. Otherwise, you can work directly with the binaries available in the releases.

Setup your IDE

These instructions apply to a Eclipse Mars (4.5). You should be able to adapt them easily to other version of Eclipse or to any other Java/Groovy IDE.

Go in Help > Install New Software...
Click on Add... button to add Groovy-Eclipse repository.
Define a name for the repository, e.g.: Groovy Eclipse
Define the repository URL. For Eclipse Mars (4.5): http://dist.springsource.org/snapshot/GRECLIPSE/e4.5/
In the Work with drop down list select Groovy Eclipse - http://dist.springsource.org/snapshot/GRECLIPSE/e4.5
Select following features to install:
- Extra Groovy compilers -> Extra compiler 2.4
- Groovy-Eclipse -> Groovy-Eclipse Feature
- m2e Configurator for Groovy-Eclipse
Install (click Next button twice, accept license and click Finish button) and restart Eclipse
Go to Help > Eclipse Marketplace...
Search for Spock Plugin and install it

Retrieving the project from GitHub

Clone the project

git clone git@github.com:Bonitasoft-Community/rest-api-sql-data-source.git

Import the project in Eclipse

In Eclipse go to File -> Import... menu
In Maven select Existing Maven Projects and click Next
Click on Browse button and go to the project checkout folder
Click Finish

You can now edit the project.

Building the project

Make sure you are in the project folder:

cd rest-api-sql-data-source

Build the project with Maven:

mvn clean install

Retrieve the generated REST API extension zip: target/rest-api-sql-datasource.zip

Installation instructions

Retrieve the binaries

You can either retrieve the binaries from the releases and unzip them or start from the built project (see build instructions).

Configure REST API authorization

Edit custom-permissions-mapping.properties file located in <BONITA_HOME>/client/tenants/1/conf/ directory.
Add a the following permission on a new line at the end of the file: profile|User=[demoPermission]

Setting up the database

Create a PostgreSQL database named demo owned by user bonita with password bpm.
Run the createExample.sql script to create the table and populate it with sample data.

Setting up the data source

These instructions apply to a standard Tomcat H2 bundle.

Edit the conf/Catalina/localhost/bonita.xml file and add a new data source:

<Resource name="demoDS"
              auth="Container"
              type="javax.sql.DataSource"
              maxActive="10"
              minIdle="1"
              maxWait="10000"
              initialSize="3"
              removeAbandoned="true"
              logAbandoned="true"
              username="bonita"
              password="bpm"
              driverClassName="org.postgresql.Driver"
              url="jdbc:postgresql://localhost:5432/demo"/>

Add the PostgreSQL jdbc driver jar in the lib/bonita folder
Restart Tomcat

Deploying the resources in Bonita BPM Portal

Log in with a user with Administrator profile in Bonita BPM Portal
Import the REST API Extension file: rest-api-sql-datasource.zip
Import the sample viewer page page-apiExtensionDatasourceViewer.zip
Import the living application application.xml

Running the sample application

Log in with a user with Administrator profile in Bonita BPM Portal
Navigate to this URL (port number may vary): http://localhost:8080/bonita/apps/sqlDemo/example/

AliYousuf / rest-api-sql-data-source