Useful apis and script to start BPD in IBM BPM

When a bpd is created In the overview instance name, to get instanceID

“Customer Process:” + tw.system.process.instanceId

To start a bpd using service

tw.local.inputValues=new tw.object.Map();
tw.local.inputValues.put('idjRequest', tw.local.idjRequest); //BPD input variable.var name in bpd
tw.local.instanceID = tw.system.startProcessByName('CustomerProcess',tw.local.inputValues,true).id;
    var id = [1];
    if (tw.local.instanceID != null && tw.local.instanceID != '') {
        id= tw.local.instanceID.split(".");
    tw.local.response = id[1];"Exit Service by triggering BPM Instance ID:- " + " " + tw.local.instanceID);

To call the service”+requestdata

To get the current instance ID

In your script:

tw.local.instanceid =;
var id = [1];
if(tw.local.instanceid !=null &&tw.local.instanceid !=’’){
tw.local.instanceid = id[1];

To terminate a bpm instance:


API to get logged in user name:

API to get all the teams user is in:


Script to check whether there is any active instance for a specific unique field in request using search column api. Here my unique id which Im searching is loanRef"----Validate Loan Reference existence for loan ref----" + tw.local.loanRef);
var col1 = new TWSearchColumn(); = TWSearchColumn.ProcessInstanceColumns.ID;
col1.type = TWSearchColumn.Types.ProcessInstance;

var col2 = new TWSearchColumn(); = TWSearchColumn.ProcessColumns.Name;
col2.type = TWSearchColumn.Types.Process;

var col3 = new TWSearchColumn(); = TWSearchColumn.ProcessInstanceColumns.Status;
col3.type = TWSearchColumn.Types.ProcessInstance;

var searchCondition = new TWSearchCondition();

var mySearchCol2 = new TWSearchColumn();
mySearchCol2.type = TWSearchColumn.Types.BusinessData; = "loanRef";
searchCondition.column = mySearchCol2;

searchCondition.operator = TWSearchCondition.Operations.Equals;
searchCondition.value = tw.local.loanRef;

// Search Ordering
var order1 = new TWSearchOrdering();
order1.column = col2;
order1.order = TWSearchOrdering.Orders.Descending;

// Create search object and set values
var search = new TWSearch();

search.columns = [col1, col2, col3];
search.organizedBy = TWSearch.OrganizeByTypes.ProcessInstance; //Task;
search.conditions = new Array(searchCondition);

// EXECUTE THE SEARCH IN THE CONTEXT OF USER change the limit of 20 as desired
var results = search.execute();'***print results length:- '+results.rows.length);

tw.local.results = new tw.object.listOf.BusinessReport();

if (results != null && results.rows != null && results.rows.length > 0) {"Results not null and row length = " + results.rows.length);
    for (var i = 0; i < results.rows.length; i++) {
        var task = new tw.object.BusinessReport(); = results.rows[i].values[0]; = results.rows[i].values[1];
        task.status = results.rows[i].values[2];
        tw.local.results[i] = task;"Instance Id: " + results.rows[i].values[0]);"Process Name: " + results.rows[i].values[1]);"Status: " + results.rows[i].values[2]);
    } //for
} //if
var len = tw.local.results.listLength;
if (tw.local.results != null && len > 0) {
    for (var i = 0; i < len; i++) {
        if (tw.local.results[i].status != "Completed") {
            tw.local.response = true;
  "***Ref exists for PIID: " + tw.local.results[i].id);
        } else {
            tw.local.response = false;
  "***Ref does NOT exists in BPM database***");
} else {
    tw.local.response = false;"**Ref does NOT exists and executed in else loop ***");
}"Response Sent for IDJ: " + tw.local.response);

Doing rest calls from IBM BPM

In any real time project there would be a basic need to do some rest calls to external system apis , let it is be GET,POST,PUT etc. So it is important for Bpm developers to know how we can implement this.
To achieve this we can use available toolkit like Rest-Utilities , Kolban toolkit etc.

In this blog I will show you how we can achieve this using Kolban one. I won’t be importing the whole toolkit but I will just add the JAR file to server which is used for doing rest calls so that I reduce the size of my process application.

You can get the Jar file from my git project here

Once you download this Jar file to local, you need to upload this to bpm server


The idea here is to create a service using this JAR file , so that when ever there is a need to implement rest call, we can just use that service.

I have created a Integration service. Then since we need to call a Jar I have taken Java Integration from the palette to my diagram. Then in the definition section where we have Java class we need to select this JAR file and then we need to select the Method which we need to call from this JAR .In this Jar we have only doRest method so I have selected.


In the image we can see that the method is expecting 6 parameters which we can see in the Data Mapping. Since these method is expecting these values I have created 6 input variables and then did the bindings and then as output I have created one variable as responseText

Now the service is ready and when ever there is a need to do rest call you can use this Execute Rest call service

I will show an example how we can do a POST call using the service which we created.First I need to create the variables which are necessary to be passed to the service.Here command is nothing but type of call .So it is “POST”. Next URL variable is created. Content variable is created to pass the data to that call in body and Header Map is the variable to pass headers.


Then we need to take a nested service and bind Execute Rest Call service . I need to pass headers to the service which I will pass in the scriptrestheaders

Then bind the input variables to the service. I don’t have userId and password , so I will ignore that. Also bind the output variable.


If you need to parse your response you can do that by adding script after the nested service and pass it as output variables like reponseCode ,responseMessage etc

In this blog I have used bpm 8.5.6 . Even in the higher versions we can implement this similarly with/without minor modifications.

This way we can easily implement rest calls from bpm

Please do comment if you have any questions . Hope this helps someone and have a good day!


Inserting and Retrieving records in to database(sql) using IBM BPM

In this blog I will show you how we can insert a record in to sql table and also retrieving the record from table.

Inserting data into database :

First we need to start with creating the service. Here we need to create Integration service.The values which we need to insert in to table will be obtained as an input to service.

Here I have only single complex object as input to service, but we can even have multiple input variables as input.Coming to the diagram , first the sql query needs to be written. For that I have used server scriptlet and I’ve binded that to sql variable. So that we can use that for bindings later.


Here I have used internal DB so there is no need of any schema for CRUD operations . But if we are connecting to external sql server we need to have db schema.

NOTE :  As a good practice DB schema needs to created as an epv variable and can be referenced in the service. So that any change in the schema details needs updation just at one place.

<# var schema = String(tw.epv.MHV_CONSTANT.INFLIGHT_DB_SCHEMA_NAME) + "." + String(tw.epv.MHV_CONSTANT.INFLIGHT_DB_GROUP); #>

INSERT INTO <#= schema #>.H_EmployeeDetails (*,*,*) VALUES (?,?,?)

Then we need  to initialize parameters as List of  SQL Parameter type as we need to pass that as input to SQL Execute Statement nested service.Then in this parameters we need to have initialization for all the values that we pass in our SQL query.

tw.local.parameters = new tw.object.listOf.SQLParameter();

tw.local.parameters[0] = new tw.object.SQLParameter();
tw.local.parameters[0].value = tw.local.employeeDetails.employeeId;
tw.local.parameters[0].mode = "IN";

tw.local.parameters[1] = new tw.object.SQLParameter();
tw.local.parameters[1].value =;
tw.local.parameters[1].mode = "IN";

tw.local.parameters[2] = new tw.object.SQLParameter();
tw.local.parameters[2].value =;
tw.local.parameters[2].mode = "IN";


Then we need to have the SQL Execute Statement Nested service. Then  we need to do the necessary bindings


Now the service is ready for the insertion of data in to sql table.

Retrieving data from database :

Coming to retrieving data from table, It is similar to insertion but we need to mention the returnType , how we are expecting the result. It may be some business object type, XMLElement, NameValuePair etc., If it is other than business object type then we need to parse that response before sending that as output. I will show both the ways

  1. If return type is set as business Object type then results and output variable should also be of same business object type.retrieveinput.png

Initializing the params is same.We need to initialize the input variable here

tw.local.parameters = new tw.object.listOf.SQLParameter();

tw.local.parameters[0] = new tw.object.SQLParameter();
tw.local.parameters[0].value = tw.local.empId;
tw.local.parameters[0].mode = "IN";


So we will have the response in results variable. Then you need to assign that to your output variable.It can done in the Post-execution Assignment.

tw.local.employeeData = tw.local.results[0]

2.If the return type is of type XMLElement , please check here

Please do comment if you have any questions . Hope this helps someone and have a good day!

Script to Parse XML in IBM BPM

We use XML parsing a lot during database calls. For retrieving data from a table it may return result of type “XMLElement”. In such cases we need to parse that in to an business object . Here I will show the same.

In my retrieve data integration service Im expecting result of type EmployeeDetails

Then in the Sql Excute nested service the return type is “XMLElement”

This above will return result of below type

This needs to be parsed as Business object to be sent as output


Parsing Script

if(tw.local.results != null && tw.local.results.childNodes && tw.local.results.childNodes.length > 0 ){
    var firstelement = tw.local.results.childNodes.item(0);
     tw.local.employeeData = new tw.object.EmployeeDetails();
     tw.local.employeeData.employeeId = firstelement.xpath("record/column[@name='EMPID']")[0].getText(); = firstelement.xpath("record/column[@name='EMPLOYEENAME']")[0].getText(); = firstelement.xpath("record/column[@name='PLACE']")[0].getText(); = firstelement.xpath("record/column[@name='PHONE']")[0].getText();
     tw.local.employeeData.designation = firstelement.xpath("record/column[@name='DESIGNATION']")[0].getText();
     tw.local.employeeData.department = firstelement.xpath("record/column[@name='DEPARTMENT']")[0].getText();
     tw.local.employeeData.qualification = firstelement.xpath("record/column[@name='QUALIFICATION']")[0].getText();
     tw.local.employeeData.address = firstelement.xpath("record/column[@name='ADDRESS']")[0].getText();

This results in below output variable

 Same way we can parse for other return types such as NameValuePair etc.

Please do comment if you have any questions . Hope this helps someone and have a good day!

Auto Conversion of BPM TwObject to Json and Json to TwObject

Mostly in any development project we are using json for the data interchanging. Let it be with in the application or calling any external application. It is no difference in BPM .If there is any need to call external system it would be easy to use json rather than Tw objects,XML and vice versa for external systems to call BPM.

If you are using BPM 8.6 version there is an JSAPI  available for conversion of TWObject to JSON

Check Here

toJSONString( boolean formatted) Returns the JSON representation of the object

tw.local.json =;

But this api may not work for the lower BPM versions. Moreover there is no JSAPI available to convert JSON object to TWObject.

To solve this problem we can use BPM JSON helper toolkit to convert TWObjects to JSON and JSON to TwObjects and it is based on json2.js To keep our Process App size down,instead of entire helper kit we can just add 2 files to server as dependencies.


Can be downloaded here : Git Download


Once we add these files now we can easily do what we required.

To convert TwObject to Json we need to call function convertTwToJSON(object) which is in Utils.js file

tw.local.json = BPMJSON.convertTwToJSON(;

Similarly to convert JSON to Twobject we use the below function = BPMJSON.convertJSONToTw(tw.local.json);

Below is one sample example:

Initially I’m creating two integration services


Here json variable is the output variable and data is the input variable to that service


Here data is the output variable and json is the input variable to this service.
Then Ive created a simple human service so that I will call these services.


Human service Diagram



Human service output

Here on click of convert to json the , JSONConvertor service is called and it returned the json. Same way we can use the json and convert to UI and directly bind that to UI.

NOTE : The point to be noted while converting json to Twobject , the output Tw object should exactly match with json structure or else it will throw an error.

This way we can easily work with Json even for complex business objects in bpm.

Hope it helps someone !

Connecting to MongoDB service on bluemix using Node JS application and inserting data

In this blog,I will show you how to connect to Compose for MongoDB service on bluemix from our Node js application and then how to insert some data in to a collection.
First thing is that we need to create a new Compose for Mongo DB service On Bluemix.


In the credentials you will have uri which is important and you need only that to connect from your node application


Once you have  these you can start with your Node js application.
You require mongodb npm package to connect to this.So you need to import this module other than the default modules.
We need to use MongoClient constructor to connect to mongodb

var express = require('express');
var router = express.Router();
var bodyParser = require('body-parser');
var MongoClient = require('mongodb').MongoClient;
var collectionName = "";
var options = {
  mongos: {
    ssl: true,
    sslValidate: false,
var mongo=process.env.VCAP_SERVICES;
var port = process.env.PORT || 3030;
var conn_str = "";
var mongoDbConn;

As I told earlier ,we need mongo uri to connect.We can directly hardcode that in our code or else we can bind a custom provided service(cups) to your bluemix application and access that value using VCAP_SERVICES.Second option is the best one as dont need any hardcoding.
So here we need to bind that service to our application on bluemix. In above code mongo is directly accessing that service. Now we need to capture the uri value from that and connect to mongo using the MongoClient which is done below

if (mongo) {
  var env = JSON.parse(mongo);
  if (env['user-provided']) {
    mongo = env['user-provided'][0]['credentials'];
    if (mongo.uri) {
      conn_str = mongo.uri;

      MongoClient.connect(conn_str, options, function (err, db) {
        if (err) {
          res.send("Mongo DB with conn ${conn_str} has error ${err}");
        } else {
          mongoDbConn = db;

    } else {
      console.log("No mongo found");
  } else {
    console.log('No mongo found');
} else {
  console.log('No mongo found');

You can also directly hardcode your value for mongo.uri value if required.
So once you have your mongo connection,you don’t need to connect every time when you need to add some data or insert anything using rest call .You just need to use mongoDbConn .
In below example I will show you a POST call which will insert data in to a collection using mongoDbConn'/insertnewevent', function (req, res) {
  var eventdetails = req.body;
  var data = { "customer": "harish", "transactionID":"3405123","transdate":"11/06/17"};
  var collectionName = "logdetails";

  if (mongoDbConn) {
    // list messages
    mongoDbConn.collection(collectionName).insert(data, function (err, cursor) {
      if (err) {
        res.send('mongodb message list failed');
      } else {
        res.send("Inserted the event successfully and reference ID is " + data._id);

So this way can easily connect to your MongoDB on bluemix service from your node js application.
Note:You can combine all the 3 code snippets in order and it will work.
If you face any issues in connecting you can comment here.
Hope it helps someone!

Creating new database and user in mongodb on bluemix using Mongo CLI on windows

One we have Compose for Mongodb service on bluemix we want to create different users and add the permission levels according to database.Creating users directly from bluemix GUI is not possible.We need to use Mongo CLI for this.
On MAC,it is quite easy but on Windows it is difficult and we need to install SSL enabled mongodb to connect to mongodb on bluemix.

The software can be downloaded from the following link

Once the software is installed , open CLI and go to folder where mongodb is installed.
Then to connect to mongodb we need to paste uri_cli which is the ssl uri which u will find in credentials


Then you will be connected to mongodb service on bluemix


Now to see the available databases ,


To create a new database
To create a new user and assign a role to the user use the following command

    user: "UserName",
    pwd: "Password",
    roles: [
       { role: "readWrite", db: "testdb" }


This way we can easily create user and assign permissions.To list the users use command >show users

Hope it helps someone!