JavaScript API List

This function allows you to access variables passed into this JavaScript Block based on 'VarName', which corresponds to their mapped variable name.

i.e. InputJSVarName in the example above

This function allows you to set the value of output to be created by this JavaScript Block based on 'VarName', which corresponds to their mapped variable name.

i.e. OutputJSVarName in the example above

Makes an asynchronous request & acts as a wrapper around axios. Returns the axios response object.

Link to axios library

This function returns an array of URLs which users can paste into a browser to download uploaded files or reports. The array returned will have a length corresponding to the number of files associated with the 'fileName' or 'reportName'. The URLs within the returned array can be accessed using index notation.

Only REPORT or FILE variables can be passed into this function.

This function returns an array of all E-Sign pages that were instantiated during the current assessment. The array of details includes pageID, current e-signature status, report name and link to signed document, and original document variable name.  Below is an example:

{

 page: "ESIGN2",

 status: "Completed",

 signedDocuments: [{

   name: "NDA.pdf",

   file: "link_to_file",

 }],

 original: 'FILE1',

}

api.env('environmentVariableName')

string, number, array, undefined

This function allows you to access environment variable values based on 'environmentVariableName'.

Sample code:

const identfierName = api.env('environmentVariableName');

api.setVariable('outputJSValue', identifierName);

Definitions:

identifierName  is the name of the identifier to call the JS API to retrieve the unique environment variable value. You are free to rename this as necessary.

environmentVariableName is the unique name of the environment variable you have created. Please ensure that the environment variable name in the JS snippet is wrapped in ‘ ‘.

OutputJSValue is the output JS value that will be transferred into a Checkbox variable from the JS block. You are free to rename this as necessary but will need to reference this correctly in the JS block.

input is an object for which the keys correspond to the JS variable names that have been mapped to input variables.

In the example above, input.InputJSVarName will allow you to access the variable CheckboxVarName 

input only contains variables passed in via the mapping interface, and does NOT reference any of the fields in the current Form page

output is an object that allows you to bind variables created within the JS file, to Checkbox variables that can be used later.

In the example above, output.OutputJSVarName = "hello" will set the value of the created variable TXT197 to "hello".

This is only available in the submit event context

form is a set of APIs to interact with the Form itself. Full list of methods can be found below.

E.g. form.SetValue("TXT13", "new value!")

axios is a popular HTTP client provided for convenience

Link to library

lodash is a popular utility library provided for convenience

Link to library

validator is a popular input validation library provided for convenience

Link to library

Required in submit function

done() tells the engine that the javascript execution is finished when in the submit function, to allow for any asynchronous calls.

The onLoad event callback is triggered on the initial load of the Form page.

Useful for prepopulating fields based on previous variables.

The submit event callback is triggered when the user successfully submits the form (passing all validation).

The output api is only available in this event callback context

'change:TXT13': async () => {}

'change:NAME': async () => {}

The change event callback is triggered after a field is changed.

Useful to perform custom validation or highly dynamic form customisation.

string, number, undefined

Returns current value of the field "FieldRefName".

object

Returns an object of current form fields, with their Variable name as the keys.

Shows the field "TXT13"

Hides the field "NUM14"

Sets the value of the field "TXT13" to "Hello"

Sets the options of the RADIO or DROPDOWN field to ["A", "B"]

Generates an error pop-up on the top right of the screen saying "Global error notification"