M230: Auto Executing Complicated Data Processing (ECMAScript)

 

By placing a [Script Task] in the middle of the Workflow diagram, data editing by ECMA Script is possible. You can automate processing of string editing for example, by calculating the working hours between "Start time" and "Finish time", or automatically adding the day of the week information to the 'Operation date'. (You can achieve more complex processing than by using [Update Data].)

1. Usage Example of Script Task

1. Data Assignment

Automatic assignment of date or numbers which are generated by ECMAScript

2. Data Editing

Editing the entered values and strings, and then assigning them as new data.

• "ECMA Script" is a scripting language that is standardized based on the common parts of JavaScript and JScript

2. Methods available in Script Task

a. Available JavaScript

Many Methods defined in "ECMAScript 2024"

b. Available Java class

Java class Methods that update/refer business data, etc.

R2300: Functions available in Script Task

3. Setting Script Task

1. Register the ECMA Code

Enter the processing code, such as Data reference, Data processing, Data assignment, etc.

• Basic knowledge of JavaScript and Java will be needed
• Assignment or updating of Business data is performed collectively after the completion of script processing
• Updating and assignment will not be performed in the event of an error (Proceeds to the next Step)
• You can also specify different destinations in the event of an error or successful processing. (Error Boundary Event)
• Processing time of the Script is limited to a maximum of 30 seconds (but will vary slightly according to the load condition)
• HTTP requests must be up to 10 per one automatic Task
• Script Engine GraalJS (Nashorn Compatible Mode) Discontinued (April 2024)

//// == Data Retrieving ==
var dataA = engine.findDataByVarName("q_example_field_name") + ""; // Retrieving data by given Field Name
var dataB = engine.findDataByName("Data B") + ""; // Retrieving data with the name of "Data B"
// convert java.lang.String → javascript string

//// == Calculating ==
var newData = dataA + dataB;

//// == Data Updating ==
engine.setDataByVarName("q_example_field_name", newData ); // Data Updating

R2301: Script Data Retrieving / Assignment
R2252: OAuth Token Getting Procedure
BPMN Icons: Script Task

---

X. Blog Articles

• 2018-05-09: Using Log Output for Debugging of Script Task
• 2018-07-17: Sending a Text Message in the Middle of Workflow Using SMS – Script Task version

X. Business Apps

• PayPal Billing App
• Customer Master Data Sync App
• Answer Drafting Flow
• Catalogue Request Correspondence Flow
• Translation Request Flow
• Daily Report-weather record
• Inquiry Handling App
• Invoice Issuance-Sampling Check
• Employee Information Acceptance
• Boss Evaluation by Ballot
• Common Password Request

Z. More Info: Script Execution Engine

a. GraalJS Engine

[Script Step] is processed with "Rhino", the JavaScript engine (Server-side)

b. Feature of GraalJS

Workflow App designers can set an automatic processing script not only by "ECMAScript" (JavaScript) but also by "Java methods". (Scripting Java). For example, if you generate an object in a format such as new java.lang.String ("kyoto") , it is possible to use methods of Java String class, such as replaceFirst () .

c. Retrieving Data on Workflow

To retrieve Business data, such as "Billing Date" or "Estimated Price", make use of a special method of engine.findDataByVarName("♦Field Name♦"). As it calls as a Java instance, an explicit type conversion like var text = engine.findDataByVarName("♦Field Name♦") + ""; is recommended when you handle as a JavaScript string/object.

d. Update Data on Workflow

To update Data on Workflow with the value calculated at a Script Step, make use of a special method engine.setDataByVarName("♦Field Name♦","♦NEW VALUE♦"). (You must explicitly describe "java.math.BigDecimal" to return the result of the calculation in the script to the Workflow side, for there exists only "number type" in ECMA/JavaScript type for numerical values.)

e. Function and Sample Codes Useful for your Business

number Math.random(); // Random Number (0.00 to 0.99)

//////// == Calculating ==
var myrand = Math.floor( Math.random() * 5 ) ; // 0 or 1 or 2 or 3 or 4

//// == Updating ==
engine.setDataByVarName("♦Field Name♦", new java.math.BigDecimal(myrand) );

[/accordion_item][accordion_item title="number dateObj.getTime(); // Elapsed time in milliseconds (since 1970-1-1, 0:00 UTC)"]

//// == Retrieving ==
var timestart = engine.findDataByVarName("♦Field Name♦"); // Datetime type：Case Start time
var timesent = engine.findDataByVarName("♦Field Name♦"); // Datetime type：Reply e-mail transmission time

//// == Calculating ==
var conciergesec = timesent.getTime() - timestart.getTime();
var conciergehour = new java.math.BigDecimal( Math.floor( conciergesec / (1000 * 60 * 60) )); // Math.floor Rounding

//// == Updating ==
engine.setDataByVarName("♦Field Name♦",conciergehour);

var daystart = timestart.getDay(); // Memo of day of the week of inquiry occurrence
if (daystart == 0) engine.setDataByVarName("♦Field Name♦","Sunday");
if (daystart == 1) engine.setDataByVarName("♦Field Name♦","Monday");
if (daystart == 2) engine.setDataByVarName("♦Field Name♦","Tuesday");
if (daystart == 3) engine.setDataByVarName("♦Field Name♦","Wednessday");
if (daystart == 4) engine.setDataByVarName("♦Field Name♦","Thursday");
if (daystart == 5) engine.setDataByVarName("♦Field Name♦","Friday");
if (daystart == 6) engine.setDataByVarName("♦Field Name♦","Saturday");

//// == Retrieving ==
var ym = engine.findDataByVarName("♦Field Name♦"); //Date type （YM）

//// == Calculating ==
var date = new com.questetra.bpms.util.AddableDate(ym.getTime()); //YM -> YMD
date = date.getFirstDateInMonth().addDays(24); //25th day

//// == Updating ==
engine.setDataByVarName("♦Field Name♦", date);

string stringObj.charAt(number intindex); // N-th character (Leftmost is 0-th)

//// == Retrieving ==
var mynumber = engine.findDataByVarName("♦Field Name♦") + ""; 

//// == Calculating ==
if( mynumber.length == 13 ){
 var mysum = 0;
 for( i=1; i<13; i++){
 mysum += parseInt( mynumber.charAt(i) ) * (i % 2 + 1);
 }
 var checkdigitnum = 9 - mysum % 9;
 var typedcd = parseInt( mynumber.charAt(0) );

//// == Updating ==
 if( typedcd == checkdigitnum ){
 engine.setDataByVarName("♦Field Name♦", "OK" ); 
 } else {
 engine.setDataByVarName("♦Field Name♦", "ERROR" ); 
 }
}

string JSON.parse(String text); // Data retrieving from JSON

//// == Retrieving ==
var weatherjson = JSON.parse(engine.findDataByVarName("♦Field Name♦")); // In assumption of already obtained in an Intermediate Event, etc.

//// == Calculating ==
var mydesc = weatherjson.list[0].weather[0].description;
var mytemp = new java.math.BigDecimal(weatherjson.list[0].temp.max - 273.15); 

//// == Updating ==
engine.setDataByVarName("♦Field Name♦", mydesc );
engine.setDataByVarName("♦Field Name♦", mytemp );

string stringObj.replace(string regexp_or_patternstr, string newsubstr); // Substitution of String (Regular Expression)

//// == Retrieving ==
var fromaddr = engine.findDataByVarName("♦Field Name♦") + "";
var inq = engine.findDataByVarName("♦Field Name♦") + "";

//// == Calculating ==
var inquirywithmark = inq.replace(/(^.*$)/gm, "> "+"$1"); // Greater-than sign as quotation

//// == Updating ==
engine.setDataByVarName("♦Field Name♦", fromaddr + '\n' + inquirywithmark ); 

string[] StringObj.split(String regex_or_separator) // Splitting of Strings

//////// == Retrieving ==
var csv_text = engine.findDataByVarName("♦Field Name♦"); // In assumption of CSV data (four columns) of String type multiple lines
// ex)
// Nakagyo-ku, Kyoto-shi, Kyoto-pref, Japan
// Malibu, Los Angeles County, California, USA

//// == Calculating ==
var csvObj = new String( csv_text ); // String Object (JavaScript)
var tmpTable = new com.questetra.bpms.core.model.formdata.ListArray(); // Table type data
var lineArray = csvObj.split("\n"); // Split per each line, storing in array String[] 
for (var i=0; i < lineArray.length; i++){
 var tmpRow = new com.questetra.bpms.core.model.formdata.ListArray.ListRow(); // Added row (horizontal row)
var cellstrArray = lineArray[i].split(","); // Split at each comma, and Store to array
tmpRow.addCol( cellstrArray[0] );
 tmpRow.addCol( cellstrArray[1] );
 tmpRow.addCol( cellstrArray[2] );
 tmpRow.addCol( cellstrArray[3] );
 tmpTable.addRow( tmpRow ); // Add Row 
}

//// == Updating ==
engine.setDataByVarName("♦Field Name♦", tmpTable );

String ListArrayObj.get(int row, int col); // Strings inside Table type Data

//// ==  Retrieving ==
// mytable: com.questetra.bpms.core.model.formdata.ListArray
var mytable = engine.findDataByVarName("♦Field Name♦"); // Retrieving Table type Data

//// == Calculating ==
var i=0;
var n = mytable.size();
var texttsv = "";
for (i=0; i < n; i++){
 texttsv += mytable.get(i, 0) + "\t";
 texttsv += mytable.get(i, 1) + "\t";
 texttsv += mytable.get(i, 3) + "\t";
 texttsv += mytable.get(i, 4) + "\n";
}

//// == Updating ==
engine.setDataByVarName("♦Field Name♦", texttsv ); 

QuserView quserDao.findByEmail(string email); // Search on BPMS User

//// == Retrieving ==
var quserEmail = engine.findDataByVarName("♦Field Name♦") + ""; // In assumption that "[e-mail]" is stored to the Strings data

//// == Calculating ==
// com.questetra.bpms.core.event.scripttask.QuserDaoWrapper
var quser = quserDao.findByEmail(quserEmail);

//// == Updating ==
engine.setDataByVarName("♦Field Name♦", quser);

List<ItemView> itemDao.findAll(String fileName, boolean isSharedFile); // Strings in Options

//// == Retrieving ==
optionsList = itemDao.findAll("value-display-list.xml", true); // M319 Options-XML

//// == Calculating ==
optionsNum = optionsList.size();
var value_id_list = "";
var display_label_list = "";
for (i=0; i < optionsNum; i++){
 value_id_list += optionsList.get(i).getValue() + "\n";
 display_label_list += optionsList.get(i).getDisplay() + "\n";
}

//// == Updating ==
engine.setDataByVarName("♦Field Name♦", value_id_list);
engine.setDataByVarName("♦Field Name♦", display_label_list);

List<ItemView> itemDao.findAll(String fileName, boolean isSharedFile); // Assignment of Options into Table Type Data

//// == Retrieving ==
optionsList = itemDao.findAll("value-display-list.xml", true); // M319 Options-XML

//// == Calculating ==
var tmpTable = new com.questetra.bpms.core.model.formdata.ListArray(); // Table type data
optionsNum = optionsList.size();
for (i=0; i < optionsNum; i++){
 var tmpRow = new com.questetra.bpms.core.model.formdata.ListArray.ListRow(); // Added row (horizontal row)
tmpRow.addCol( optionsList.get(i).getValue() );
 tmpRow.addCol( optionsList.get(i).getDisplay() );
 tmpTable.addRow( tmpRow ); // Add row
}

//// == Updating ==
engine.setDataByVarName("♦Field Name♦", tmpTable );