Database Design Documentation
How can we help?
Full Site Search

Javascript Workflow Engine

All forms can trigger Ragic's server-side Javascript workflow engine to execute complex business logic, such as calculating costs and posting inventory balances. Basically, any complex business logic that you would like to execute but cannot be covered by Ragic's existing functions can be covered by server-side scripting.

The scripting engine is based on the standard Nashorn Java Scripting Engine that's included in the Java platform. Nashorn supports ECMAScript 5.1, so it would be wise to avoid ECMAScript 6 syntax.

What does Javascript Workflow do?

Ragic's spreadsheet design interface can handle most of your data management work, such as creating, editing, and querying records without much problem. On the other hand, manual data maintenance can be a bit time-consuming and routine after a while. This is the time when Ragic users will start thinking of ways to automate these processes.

Inside Ragic, there is a pretty powerful scripting engine where you can write Javascript that runs on the server-side, to retrieve data you have on your spreadsheet, make modifications, or even create many records with one click. Typical usage includes updating inventory, creating a new record based on another (creating a sales order from a quote, creating a contact from a sales lead), or doing record validation based on database data.

There are 5 main ways to run your Javascript workflow:

  1. Action Button
  2. Post-workflow
  3. Pre-workflow
  4. Daily workflow
  5. Approval workflow

And there is a Global Workflow where you can place common Javascript function definitions shared by more than one of your workflow scripts.

Action Button

This is the most common and cleanest way to run Javascript workflow, and generally our first recommendation. You can write your script in the installed sheet scope of your sheet, and configure an action button to execute the script when the user clicks on the button that will be displayed in the "Actions" panel on the lower right side.

To add an installed sheet scope script, just right-click on a sheet, and choose Javascript Workflow:

And choose installed sheet scope from the top dropdown:

You can then go to the form page of your sheet design, add an Action Button of the type JS Workflow, and refer to the Javascript function that you have written.

Note that you can pass the record id of the current record by using {id} in the argument for the function call like:


Of course, we will talk more about how to write these functions in the following sections.


Post-workflows are executed immediately after a record is saved. With post-workflow, it's very convenient to automate changes that you would like to make on the record that you just saved that cannot be done with formulas. Or you can make modifications to records on other related sheets, like updating inventory balance.

To add a post-workflow, just right-click on a sheet, and choose Javascript Workflow:

And choose Post-workflow from the top dropdown.

A typical post-workflow would look something like this:

var recordId = param.getNewNodeId(key_field_id_of_form);

var query = db.getAPIQuery(path_to_form);

var record = query.getAPIEntry(id);

// do what you would like to do with the record retrieved

See our API references and other sections of this document for the list of things that you can do.

Also, please note that post-workflow will not be executed if you modify entries on the listing page.


Pre-workflows are executed before a record is saved, so it can be used as a way of validation to check the data entered against data in the database. Generally, most validation can be done with our front-end regular expression checks, or the unique checkbox for free text fields. But for more complex backend checks, sometimes pre-workflow will be needed.

To add a pre-workflow, just right-click on a sheet, and choose Javascript Workflow:

And choose Pre-workflow from the top dropdown.

There is a simple example:

Suppose we have a list,

and we want to ensure the price we want to save is not negative.


* Key Field: 1000004

* Field Name Field Id

* - - - - - - - - - - - --------

* ID : 1000001

* Price : 1000002

* Name : 1000003

* Available ? : 1000005


function log(str) {

// set status 'INVALID' or 'ERROR' to cancel the saving.




function ifThePriceIsNegative() {

// get the price we trying to save.

var newPrice = param.getNewValue(1000002);

// change the newPrice string to integer.

if(parseInt(newPrice) < 0) {

return true;



// if the price is negative, don't save it.

if(ifThePriceIsNegative()) {

log('Price is negative !!');


And now we try to save a negative price, we would get

It is noteworthy that we couldn't use entry.getFieldValue while writing the pre-workflow in Ragic (since Ragic hasn't saved it). Try to use the param to get the old value and the new value instead.

Daily Workflow

The daily workflow runs on a daily basis. It's useful for doing modifications that need to be refreshed every day. Like updating the results of the formulas based on the current date.

To add a daily workflow, just right-click on a tab, and choose Global Javascript Workflow:

And choose Daily Workflow at the first top dropdown.

By default, the daily workflow runs at 19:00 UTC. You can change the execution time and time zone in Company Setting:

1. Go to Account Setup

2. Click Company Setting

3. Select Company Local Time Zone and Daily Workflow Execution Time and save.

If your Company Setting does not have Company Local Time Zone and Daily Workflow Execution Time, please contact us to update it for you.

Approval Workflow

Approval Workflows are executed immediately after an approval is created/approved/rejected/canceled/finished.

To add a post-workflow, just right-click on a sheet, and choose Javascript Workflow:

And choose Approval Workflow from the top dropdown.

You can get the record id by:

var recordId = approvalParam.getEntryRootNodeId();

approvalParam is a predefined variable in the approval workflow scope.

And you can fetch the approval action by:

var action = approvalParam.getApprovalAction();

After you get the above data, you can customize your requirements like this:

var query = db.getAPIQuery(path_to_form);

var entry = query.getAPIEntry(recordId);

if (action === 'CANCEL') {

entry.setFieldValue(STATUS_FIELD, "approval is canceled!");

}else if (action === 'FINISH') {

entry.setFieldValue(STATUS_FIELD, "approval is completed!");

}else if (action === 'CREATE') {

entry.setFieldValue(STATUS_FIELD, "approval is created!");

}else if (action === 'REJECT') {

entry.setFieldValue(STATUS_FIELD, "approval is rejected!");

}else {

entry.setFieldValue(STATUS_FIELD, "approval is approved!");


Global Workflow

The global workflow is where you can write Javascript workflow modules that other workflow functions can reference. It will not be executed by itself but can be referenced in any type of workflow listed above. It's a great place to put scripts that you might need to duplicate across multiple sheets otherwise.

To add a global workflow, just right-click on a tab, and choose Global Javascript Workflow:

Get Record

There are two different ways to get the current record that the user is viewing (for action buttons) or the record that the user has just saved (for pre-workflow and post-workflow).

Action Button

The form page action button works by configuring an action button to call a function you defined in the install sheet scope. When you define the function that the action button calls, you can pass a parameter {id} which is the id of the record where you click the action button to function in the workflow.

You can see the example at Action Button workflow.


You can get the record id by:

var recordId = param.getNewNodeId(key_field_id_of_form);

param is a predefined variable, you can use it in pre-workflow and post-workflow.

After you get the record id, this is how you get the record (entry):

var query = db.getAPIQuery(path_to_form);

var entry = query.getAPIEntry(id);


For post-workflow, you can use either the above method just like with pre-workflow. But also there is a convenient method to retrieve the record that was just saved:

var entry=param.getUpdatedEntry();

If there are masked fields on the form page, you will get masked values by default. You can get unmasked values by:

var query = db.getAPIQuery(path_to_form);


query.setIgnoreAllMasks(true); // Unmask all masked fields.

var entry = query.getAPIEntry(id);

You can use query.addIgnoreMaskDomain(fieldId_of_the_masked_field) instead of query.setIgnoreAllMasks(true) to unmask only specific fields.

There is more introduction about how to update records in the following section.

If you would like to filter out multiple records, please refer to the section on filtering.

Querying for a set of records

If you want to get more than one record by filtering:

var query = db.getAPIQuery("/workflow-demo/1");

query.addFilter(1000002, '=', 'Green');

query.addFilter(1000008, '=', '2017');

var results = query.getAPIResultList();

for (var i = 0; i < results.length; i++) {

var entry = results[i];

// ...


You can add filters to query by addFilter(fieldId, operator, value), and call getAPIResultList() to get the list of records.

Here's the list of operands that you can use:

Operand Name Operand Value
Equals =
Regular Expression regex
Greater or equals
Less or equals <=
Less <</td>
Contains like

Please note that when you filter by date or date time, they will need to be in the following format: yyyy/MM/dd or yyyy/MM/dd HH:mm:ss

You can also use a full-text search as a query filter by calling setFullTextSearch(String queryTerm) instead of addFilter().

Updating Records

Link to example

Let's start with a simple example that retrieves the current record as an object, updates its value with a button, and then saves it back to the database. Here is what the demo form looks like:

We would like to design some buttons that will change the value of our status field with the click of a button executing simple server-side Javascript workflow. Here's the code behind the button:


* AP_Name:wfdemo

* Key Field: 1000013

* Name ID

* - - - - - - - - - - - --------

* No. : 1000011

* Status : 1000012


function setStatus(recordId, status) {

var STATUS_FIELD = 1000012; //field id of the status field

var query = db.getAPIQuery("/workflow-demo/2"); //get the query object for a sheet with path to sheet

var entry = query.getAPIEntry(recordId); //get the record object for the current record

//set the status value for the current record to the object

if (status) {

entry.setFieldValue(STATUS_FIELD, status);


else {//for switching

var newStatus = entry.getFieldValue(STATUS_FIELD) == 'On' ? 'Off' : 'On'; //get the current value of a field

entry.setFieldValue(STATUS_FIELD, newStatus);


//save the record back to the database;


When writing Javascript workflow, the variable db is predefined. You can refer to it anywhere. Generally, we call the method getAPIQuery(pathName) to retrieve the query object for a sheet.

Then you can retrieve a record with its record id on the sheet object with getAPIEntry(recordId), and call setFieldValue(fieldId,value) to set the value to a field, or getFieldValue(fieldId) to retrieve value from a record.

Please note that when adding date values, it must be in one of the following formats:


yyyy/MM/dd HH:mm:ss


If you're retrieving a value from a multiple selection field, where there may be multiple values, use getFieldValues(fieldId) to retrieve all the values in an array. You can also call setFieldValue(fieldId,value,true) with an extra true argument at the end to specify that you're "adding" an option to the current list of values, not overwriting the existing ones. Note that these operations are only suitable for multiple selection fields.

If you want to copy a multiple selection field value and overwrite the value in another multiple selection field, you couldn't just use getFieldValues(fieldId) and setFieldValue(fieldId,value,true). Here's the code that you can refer to:

var multipleSelectionFieldValue = entry.getFieldValues(1013251); // 1013251 is a mutiple selection field

var targetMultipleSelectionField = "";

for (var i = 0; i < multipleSelectionFieldValue.length; i++) {

if (i == 0) {

targetMultipleSelectionField = targetMultipleSelectionField + multipleSelectionFieldValue[i];


else {

targetMultipleSelectionField = targetMultipleSelectionField + "|" + multipleSelectionFieldValue[i];



entry.setFieldValue(1013252, targetMultipleSelectionField, false); // 1013251 is another mutiple selection field

Please note that you need to retrieve every option and format those options with a vertical bar character (|) like what you will do while importing existing data from Excel or CSV files.

If you're setting values to a file upload field, you can use setFieldFile(int fieldId, String fileName, String fileContent) to create a file with the fileName and with the fileContent you provided. Ragic will then save this file to this field so that the file is available for download on the user interface.

After you're done, just call save() on the record object to save it back to the database.

Creating Records

Creating records is very similar to updating records. Instead of calling query.getAPIEntry(), call query.insertAPIEntry() instead. Like getAPIEntry(), it will also return a record where you can setFieldValue to add field values. The record will be created after calling

A simple modification of the record update demo like this will create a new record instead:


* AP_Name:wfdemo

* Key Field: 1000013

* Name ID

* - - - - - - - - - - - --------

* No. : 1000011

* Status : 1000012


function setStatus(recordId, status) {

var STATUS_FIELD = 1000012; //field id of the status field

var query = db.getAPIQuery("/workflow-demo/2"); //get the query object for a sheet with the path to sheet

var entry = query.insertAPIEntry(); //create a new record object

//create the new record to the database;



Link to example

If you have subtables in a sheet, you can also use our API to retrieve data from it or make edits like the following example. The form looks like this:

The workflow will walk through each row in the subtable, and find the total amount for this year (according to the date field in the subtable), the total for the year with the most amount, and identify which year has the highest total. This is designed as a post-workflow, so the three read-only fields will be filled by workflow after the record is saved.


* AP_Name:wfdemo

* Key Field: 1000006

* Date subtable key: 1000007

* Field Name Field Id

* - - - - - - - - - - - --------

* No. : 1000001

* Name : 1000002

* Date : 1000003

* Amout : 1000004

* Total of This Year : 1000010

* Maximal Total of Year : 1000009

* Year of Maximal Total : 1000008


var KEY_FIELD = 1000006;

var AMOUNT_SUBTABLE_ID = 1000007;

var DATE_FIELD = 1000003;

var AMOUNT_FIELD = 1000004;

var MAX_YEAR_FIELD = 1000008;

var MAX_TOTAL_FIELD = 1000009;

var THIS_YEAR_TOTAL_FIELD = 1000010;

var query = db.getAPIQuery("/workflow-demo/1");

var entry = query.getAPIEntry(param.getNewNodeId(KEY_FIELD));

var subtableSize = entry.getSubtableSize(AMOUNT_SUBTABLE_ID);

var yearTotal = {}

for (var i = 0; i < subtableSize; i++) {

var year = parseInt(entry.getSubtableFieldValue(AMOUNT_SUBTABLE_ID, i, DATE_FIELD).substr(0, 4));

var amount = parseInt(entry.getSubtableFieldValue(AMOUNT_SUBTABLE_ID, i, AMOUNT_FIELD));

if (year in yearTotal) {

yearTotal[year] += amount;

} else {

yearTotal[year] = amount;



var maxYear;

for (var year in yearTotal) {

if (!maxYear || yearTotal[maxYear] < yearTotal[year]) {

maxYear = year;



entry.setFieldValue(MAX_YEAR_FIELD, maxYear);

entry.setFieldValue(MAX_TOTAL_FIELD, yearTotal[maxYear]);

entry.setFieldValue(THIS_YEAR_TOTAL_FIELD, yearTotal[new Date().getFullYear()]);;

The basic idea is to use getSubtableSize(subtableId) to get the number of rows for a record, and use getSubtableFieldValue(subtableId,subtableRowIndex,subtableFieldId) to retrieve their values. You should be able to find subtable id, and field id information in the auto-generated comments when you start editing workflow scripts.

You can also use setSubtableFieldValue(subtableFieldId,subtableRootNodeId,value) to set values to a subtable. The subtableRootNodeId is used to specify which subtable row that you're referring to. To find a subtableRootNodeId for an existing subtable row, you can use the following call getSubtableRootNodeId(subtableId,subtableRowIndex) which will return an integer containing the subtableRootNodeId.

If you need to add a row to the subtable, you can use a negative subtableRootNodeId like -100, this way all values set to the same negative subtableRootNodeId will be applied to the same new subtable row, and values set to a different negative subtableRootNodeId like -101 will create a different row in the subtable with this different set of values.

Pre-workflow and Post-workflow

If you want to get values in pre-workflow and post-workflow, try following this example:

var list = param.getSubtableEntry(AMOUNT_SUBTABLE_ID);

var arr = list.toArray();


for (var i = 0; i < arr.length; i++) {

response.setMessage('Date : '+arr[i].getNewValue(DATE_FIELD)+', Amount : '+arr[i].getNewValue(AMOUNT_FIELD)+'\r\n');


Copying records

Link to example: Copy From and Copy To

Copying records is one of the most common workflow programs we encounter. We have written a pretty simple function to simplify this type of operation. Let's say we would like to see a record on this sheet:

With the click of the button, generate a record on this sheet:

Here is the code for this action button:


* AP_Name:wfdemo

* Key Field: 1000022

* S1 subtable key: 1000023

* T1 subtable key: 1000029

* Field name Field ID

* - - - - - - - - - - - --------

* A : 1000014

* C : 1000015

* B : 1000016

* D : 1000017

* S1 : 1000018

* S2 : 1000019

* S3 : 1000020

* S4 : 1000021

* T1 : 1000024

* T2 : 1000025

* T3 : 1000026


function copyEntry(nodeId) {






1000030:1000014, // A

1000031:1000015, // C

1000032:1000018, // S1

1000033:1000020 // S3




Here you can see we can do the copy with one simple function call to entryCopier. entryCopier takes a JSON string as its parameter. Just put down the source sheet, target sheet, the record that we're copying, and most importantly, which field should be mapped to which field. When the mapping is complete, you can create action buttons to copy records from one sheet to another very easily.

Let's take a look at another example.

Here, we want to copy Lin from "CopyFrom" to "CopyTo" and set the status to new. In addition, we'd also like to record the created date (please disregard the use of $DATE field for this example).


* field name field id

* - - - - - - - - - - - --------

* From-ID : 1000001

* From-Name : 1000002

* To-ID : 1000004

* To-Name : 1000005

* Status : 1000007

* RegisterDate : 1000008


function copyEntry(nodeId) {






// to : from





//get the rootNodeId of the entry we copied before.

var newEntryRootNodeId = response.getRootNodeId();

//we need to create an ApiQuery to search the '/entrycopier/2'

var toApiQuery = db.getAPIQuery('/entrycopier/2');

//get the entry we copied before

var newEntry = toApiQuery.getAPIEntry(newEntryRootNodeId);

newEntry.setFieldValue(1000007, "New");

var current = new Date();

newEntry.setFieldValue(1000008, current.getFullYear()+'/' + (current.getMonth()+1) + '/' + current.getDate());;


Next, set up the Action Button and save it.

Then, simply click the Action Button to display the result.

Checking user access right

You can do some conditional processing based on which groups the user who will be executing the script is in. A user can be in multiple user groups, so usually, we can do a user.isInGroup(groupName) call to determine if the user is or is not in this user group. A typical use would be as follows, the following code is designed to be a pre-workflow, but a user object and isInGroup call can be used in all types of workflow except daily workflow which is triggered by the system.

if(!user.isInGroup('SYSAdmin')){//check if the user is a SYSAdmin

response.setStatus('INVALID');//if they are not, do not save the record

response.setMessage('You do not have the access right to do this.');//and display a message


Sending e-mail notifications

Sometimes you would like to send e-mail notifications based on a set of conditions, or you would like to really customize your notification message content. You can write server-side Javascript workflow for this purpose. Here is the script that you will use to send out an e-mail, it's really simple:

//omitted...retrieve record object first

var name=entry.getFieldValue(1001426);

var email=entry.getFieldValue(1001428);

var title=entry.getFieldValue(1001386);


email, //to

null, //cc

'', //reply to

'Acme, Inc.', //displayed from


'Hi '+name+',

we have received your sales order '+

'and will be processing your order very soon.


'You can see your order details at



Best Regards,

Sophia, Sales Manager

Acme, Inc.'


//mailer.attach(myURL); //you can use .attach to attach content from a URL


Note that if you would like to send an e-mail to multiple recipients, just separate each e-mail address with commas.

For attachments, you can use mailer.attach(myURL); to attach a record on Ragic by using the record's URL. For example, here is a record URL on Ragic (always ignore URL after the hash) :

Here is its HTML printer-friendly URL:

Here is its Excel version URL:

You can also use a Mail Merge URL like this, the cid being the id of the Mail Merge, you can get the cid in the URL when trying to download the Mail Merge document:

We do enforce some limitations on how many e-mails you can send. So send reasonably! If you have some questions on e-mail sending quota, send us an e-mail at

Creating and cancelling Approval

You could start or cancel a record’s approval by adding the post-workflow script to your sheet.

First, we set the approval step in design mode.

and now set the approval detail in the post workflow

function autoStartApprover() {

var signers = [];




















is the parameter format you should provide.

stepIndex :

Used to know which approval step to set, starting from zero.

approver :

Used to know who could sign this approval step.

stepName :

Used to set approval step name.

Your approval would not be created if there was something wrong in the parameter format or if the approvers you provided didn't follow the rule you set in the design mode.

In this example, if you give the second step parameter like the following:






If that's the case, it would fail since was not in the HR group.

We also provide 3 special formats for deciding your approvers dynamically according to your company tree.

You could see this for further information.

$DS :

The approver will be set to the user's direct supervisor.

$SS :

The approver will be set to the user's supervisor's supervisor.

$DSL :

The approver will be set as the supervisor of the previous approver.

The parameter format is like






You don't have to provide a non-empty stepName while using these special formats.

Note: If the user in a special format didn't follow the rule you set in the design mode, this approver would not be created.

Sending mobile app notifications

Other than e-mail notifications, you can also send a mobile app notification. It will be sent to the user if the iOS app or Android app has been installed on his mobile device. The e-mail refers to the user's e-mail address registered in your Ragic account. For example:

mailer.sendAppNotification("","test mobile notification");

If you would like the user to be redirected to the specified record when clicking on this notification. You should provide a path to the form that you would like to redirect to (ex: /forms/1 ) and the record id. The call should look like this:

mailer.sendAppNotification("","test mobile notification","/forms/1",12);

Approver and other information on a record

You can first issue the following command to the query object you get from db.getAPIQuery to include full record info:


and then you can get the approval information for a record like this:

entry.getFieldValue('_approve_status');//getting status of current approval

entry.getFieldValue('_approve_next');//getting the next person who should sign this record

entry.getFieldValue('_create_date');//getting the create date of the record

entry.getFieldValue('_create_user');//getting the create user e-mail of the record

The approval status will be F is approved, REJ for rejected, and P for processing.

Display message

You can display a message in a pop-up like this. Please note that the message will only show when the response status is "WARN". By default, the message inside the response object will not be displayed since it's usually not helpful to end users.




In this section, we will have an example to show how to use setLimitSize and setLimitFrom. In this example, we have 20 entries total and want to take 6 for each count and show the message.


* Field Name Field Id

* - - - - - - - - - - - --------

* ID : 1000009

* Money : 1000010


function limitFromExample() {

var apiQuery = db.getAPIQuery('/entrycopier/3');

// remember the offset

var fromNumber = 0;


// take 6 for each count


var resultList = apiQuery.getAPIResultList();

while(resultList.length > 0) {

var msg = '';

for(var i = 0;i < resultList.length; i++) {

var entry = resultList[i];

msg += entry.getFieldValue(1000009);

if(i != resultList.length -1) msg += ',';



// update offset

fromNumber += resultList.length;

// refresh apiQuery

apiQuery = db.getAPIQuery('/entrycopier/3');



resultList = apiQuery.getAPIResultList();






Send HTTP request

You can send an HTTP GET/POST/DELETE/PUT request to an URL and get returned result:

util.getURL(String urlstring)

util.postURL(String urlstring,String postBody)

util.deleteURL(String urlstring)

util.putURL(String urlstring,String putBody)

The variable util is predefined.

If you need to ignore SSL certificate validation for your current HTTP request, you can add the following code before sending the request:


Also, you can call util.setHeader(String name,String value) to set HTTP headers. util.removeHeader(String name) to remove headers.

API references

Pre-defined system global variables listed here can be accessed directly without defining them.


getAPIResult()Get first entry when iterate over the query
getAPIResultList()Get array of entries of the query
getAPIEntry(int rootNodeId)Get entry by node ID
getKeyFieldId()Retrieve the key field id of the sheet this query is on.
getFieldIdByName(String fieldName)Get the field id of a specified name. If there is more than one field of the same name, the first independent field id will be returned.
insertAPIEntry()Insert a new entry to the query, and the method returns the new entry
addFilter(int fieldId, String operand, String value)Filtering entries by specified condition
setIfIgnoreFixedFilter(boolean ifIgnoreFixedFilter)Set if ignore the fixed filter from target sheet
setOrder(int orderField, int orderDir)Sort entries of the query by specified field field id and order direction, parameter orderDir is set to 1 if sort ascending, set to 2 if sort descending, set to 3 if secondary sort ascending, and set to 4 if secondary sort descending.
deleteEntry(int nodeId)Delete entry by node ID
deleteEntryToRecycleBin(int nodeId)Delete entry by node ID to recycle bin
setLimitSize(int limitSize)By default ScriptAPIQuery returns 1000 records per query, you can use setLimitSize to change the number of records returned per query. However, we do not recommend returning too many records per query because it may take too much memory and have bad performance implications. We recommend using the next method setLimitFrom to do paging instead.
setLimitFrom(int limitFrom)This method is for paging through all the records on a ScriptAPIQuery. Setting a limitFrom will tell ScriptAPIQuery to start returning records from an offset so that you can page through all the records of ScriptAPIQuery because ScriptAPIQuery returns 1000 records per query by default. You should check for the next page if the number of records returned equals the returned list size.
setGetUserNameAsSelectUserValue(boolean b)When set to false, the query will retrieve the user's email for select user fields instead of the user's user name.

Here's the list of operands that you can use:

Operand Name Operand Value
Equals =
Regular Expression regex
Greater or equals
Less or equals <=
Less <</td>
Contains like

Please note that when you filter by date or date time, they will need to be in the following format: yyyy/MM/dd or yyyy/MM/dd HH:mm:ss

You can also use a full-text search as a query filter by calling setFullTextSearch(String queryTerm) instead of addFilter().

db.getAPIQuery records

getFieldValue(int fieldId)Get value of the field by field id. Subtable fields not included.
getFieldIdByName(String fieldName)Get the field id of a specified name. If there is more than one field of the same name, the first independent field id will be returned.
getKeyFieldId()Retrieve the key field id of this sheet.
getFieldValueByName(String fieldName)Get value of the field by field name. Subtable fields not included. If there is more than one field of the same name, the first field value will be returned.
getFieldValues(int fieldId)Get all the field values from a multiple select field as an array. Subtable fields not included.
getRootNodeId()Get root node ID of the entry
getRootfieldId()Get root field id of the entry
getSubtableSize(int subtableRootfieldId)Get the size of the subtable, specified by the root field id of the subtable.
getSubtableRootNodeId(int subtableRootfieldId, int rowNumber)Get the root node ID of the subtable, specified by its root field id and row number in the subtable.
getJSON()Get a JSON representation of the whole record.
setFieldValue(int fieldId, String value)Set value to specified field. For subtable fields, you need to use setSubtableFieldValue();
setFieldValue(int fieldId, String value, boolean appendValue)Set value to a field which is a multiple select field, parameter appendValue need to be true. For subtable fields, you need to use setSubtableFieldValue();
setFieldFile(int fieldId, String fileName, String fileContent)For file upload or graphics field only. A file of the fileName you provided and the fileContent you provided will be created as a file upload and saved to the specified field. For subtable fields, you need to use setSubtableFieldFile();
setSubtableFieldValue(int fieldId, int subtableRootNodeId,String value)Set value to subtable field, you can get parameter subtableRootNodeId by method getSubtableRootNodeId.
setSubtableFieldValue(int fieldId, int subtableRootNodeId, String value, boolean appendValue)Set value to subtable field which is a multiple select field, parameter appendValue need to be true
deleteSubtableRowByRowNumber(int subtableRootfieldId, int rowNumber)Delete the subtable row by its root field id and row number in the subtable.
deleteSubtableRowAll(int subtableRootfieldId)Delete every row in specified subtable
deleteSubtableRow(int subtableRootfieldId, int subtableRootNodeId)Delete subtable row by root field id and the root node ID of subtable
loadAllLinkAndLoad()Load value of all loaded fields in a link and load configuration in the entry.
recalculateAllFormulas()Recalculate every field that contains formula in the entry.
recalculateFormula(int fieldId)Recalculate formula of specified field.
Note: If two or more fields share the same fieldId, please use recalculateFormula(int fieldId, String cellName) instead.
recalculateFormula(int fieldId, String cellName)Recalculates formula of a specified field using with cellName parameter determining the field’s cell location (such as A1, C2, H21, etc). This method is used on sheets with two or more fields with the same fieldId.
loadAllDefaultValues(ScriptUser user)Load value of every field that is set with a default value, parameter user is predefined.
loadDefaultValue(int fieldId, ScriptUser user)Load default value of specified field, parameter user is predefined.
lock()Lock the entry
unlock()Unlock the entry
save()Save a entry
setCreateHistory(boolean createHistory)Set if the entry need to create history
isCreateHistory()Whether the entry is set to create history
setIfExecuteWorkflow(boolean executeWorkflow)Set if executing the workflow (pre-workflow and post-workflow) of the entry is needed
setIgnoreEmptyCheck(boolean ignoreEmptyCheck)Set if checking not empty fields would be ignored
setRecalParentFormula(boolean recalParentFormula)If this sheet is created by a subtable of another sheet, or is referenced by another sheet, which means, this sheet has the parent sheet, then you can call this method to set if you want to recalculate the parent sheet or not.
setIfDoLnls(boolean)Loaded values syncing will be triggered on the other sheet if that sheet links to this sheet, the source sheet. You should always add this method to the source sheet to trigger syncing on the other sheet.


getStatus()Gets the status of the response. Either SUCCESS, WARN, CONFIRM, INVALID, ERROR
setStatus(String status)Sets the status of the response. Either SUCCESS, WARN, CONFIRM, INVALID, ERROR
setMessage(String plainMessage)Sets a message for display when script executed. This function can be called several times and all messages that have been set will show at the same time.
numOfMessages()Returns the number of messages that has been set.
setOpenURL(String url)Installed sheet scope only. Redirects the user to the URL specified after saving the edit.
setOpenURLInNewTab(boolean b)Configure whether the browser opens a new tab when opening an URL. Defaults to true.


getEmail()Get user's email address
getUserName()Get user's full name
isInGroup(String groupName)Returns if the user is in this group with the name of groupName


compose(String to,String cc,String from,String fromPersonal,String subject,String content)Compose an e-mail message for sending out. The to and cc parameter can contain multiple e-mail addresses. They just need to be separated by commas.
send()Send out the message that was just composed.
sendAsync()Send out the message that was just composed asynchronously. Note that sendAsync can only be called once per script execution.
attach(String url)Attach a file to the message. The URL should be a full URL with https://
setSendRaw(boolean b)Set if the content should not be converted to HTML. Set this to true when your content is already in HTML.
sendAppNotification(String email,String message)Send a mobile app notification to this user if the user has installed a Ragic iOS app or Android app.
sendAppNotification(String email,String message,String pathToForm,int nodeId)Send a mobile app notification to this user if the user has installed a Ragic iOS app or Android app. The user will be redirected to the specified record when clicking on this notification. "pathToForm" should be in the format "/forms/1", not including the account name, including the tab folder and sheet index.


getURL(String urlstring)Calls an URL with GET method
postURL(String urlstring,String postBody)Calls an URL with POST method.
deleteURL(String urlstring)Calls an URL with DELETE method.
putURL(String urlstring,String putBody)Calls an URL with PUT method.
setHeader(String name,String value)Sets an HTTP header that will be used in subsequent URL calls.
ignoreSSL()Ignore SSL certificate validation for your current HTTP request
removeHeader(String name)Removes an HTTP header from being used in subsequent URL calls.
logWorkflowError(String text)Records a string text log message in the workflow log that you can find in the database maintenance page.


getUserName(String email)Get the full name of a user specified by the e-mail address.
getUserEmail(String userName)Get the email address for the specified user name.
reset()Purge all account-related cache when the script and reloads the page finishes executing.
getTimeZoneOffset()Get time zone offset of this account in milliseconds.
getTimeZoneOffsetInHours()Get time zone offset of this account in hours.


This is the user request object submitted by the user before the request is saved to the database. Especially helpful when writing pre-workflow scripts

getUpdatedEntry()Post-workflow only. Returns the record that was just created or updated.
getNewNodeId(int fieldId)Returns the node ID (int) of given field after new value being written.
getOldNodeId(int fieldId)Returns the node ID (int) of given field before new value being written.
getNewValue(int fieldId)Returns the value of given field after new value being written.
getOldValue(int fieldId)Returns the value of given field before new value being written.
getNewValues(int fieldId)Similar to getNewValue, but can access multiple values at the same time, which is useful when dealing with multiple-selection fields.
getOldValues(int fieldId)Similar to getOldValue, but can access multiple values at the same time, which is useful when dealing with multiple-selection fields.
getSubtableEntry(int fieldId)Returns a list of params that can manipulate each record in the subtable.
isCreateNew()Return if the entry is newly created.


create(String[] wfSigner)

Post-workflow only.

wfSigner is an array with specific JSON format objects in it.


'stepIndex' : what step in the approval - start from 0,

'approver' : approver's email

'stepName' : approver's name or title


The example for "single approver in a step" :

wfSigner push({





Note that wfSigner should satisfy the approval you set in design mode.

Say, if there is only one candidate "" in step 2 in design mode, you should give a json with approver: and stepIndex : 1 .

cancel()Post-workflow only. Cancel the approval in the entry.


getEntryRootNodeId()Get root node ID of the entry
getApprovalAction()Gets the action of the approval. Either CREATE, APPROVE, FINISH, CANCEL, REJECT

Top of Page Table of Contents

Start Ragic for Free

Sign up with Google