Client Scripts

Client scripts are used to execute JS scripts in the browser when the client-side events happen, for example:

form loading
form submission
field value change.

Client scripts allow configuring forms, form fields, and field values while the client uses the form. They can execute the following actions:

make the field hidden or visible.
make the field read-only.
make the field mandatory or non-mandatory.
set the value in one field, based on the value in another field.
change the parameters in the choice list.
show the message based on the field value.

Client-side scripts are used to execute JavaScript scenarios on the client-side. A client script may be either a record of the Client Script (sys_script_client) table, or it can be executed within some UI Action when its Client parameter is equal to true.

Client logic can also be implemented within the client script widget:

The general client-side classes are: SimpleForm, SimpleList, and SimpleUser. To get more information about client-side classes, please check our Client-Side API article.

Creating a client script

You can create client scripts using the SimpleOne agent interface.

Required role: admin.

To create a new script, complete the steps below:

Navigate to System Definition → Client Script.
Click New and fill in the fields.
Click Save or Save and Exit to apply changes.

Client script form fields

Name	Mandatory	Description
Name	Y	Define the client-side script name.
Table	Y	Specify a table on which form the script will be executed.
Type	Y	Specify the script type. Available options: onLoad – the script starts when the system displays the form for the first time before users enter data. Generally, onLoad scripts perform manipulations on the client side with the current form or default record values set. onChange – the script starts when the specified field on the form has been changed. onSubmit – the client script can cancel form submission by returning 'false'. onCellEdit – the client script starts when a cell has been edited. oldValue – the old value of the cell that will be edited. newValue – the new value for the cell that will be inserted. table – the table name of the cell that will be edited (for example, sys_db_table). sysId – the ID of the record relevant to the cell that will be edited. callback – if the variable is set to false, then subsequent scripts will not run; otherwise, they will be executed.
Column	Y	Select the column from the specified table, the change or editing of which starts the script. The field appears when the Type field is onChange or onCellEdit.
Views	N	Specify the form view on which the client script should run. You can specify more than one view. If no view is specified, the client script will be executed on all views if there are any.
Condition	N	Specify the trigger conditions for the client script to run. Use the Condition Builder to build complex AND/OR filters. Conditions work jointly with the values from the Type field. They are applicable only to the onLoad or onChange client scripts. An empty condition always returns true.
Description	N	Type in a detailed description of the script actions.
Active	N	Select this checkbox to make the script active.
Inherited	N	Select this checkbox to apply the script not only to the table specified in the Table field, but also to all its child tables.
Order	N	Define the order of the client script execution. If there are several client scripts, they will be executed in the ascending order.
Script	N	Type a client-side script to execute.

Special Features

Use callback functions to work with SimpleRecord Client-Side objects:

const record = new SimpleRecord('task');
record.get('159644860216948298', () => {
    console.log(record.number); // TSK0000123
});

Dot-walking is not available for the Reference type fields. You can use the callback function sequence as a workaround.
For example, instead of server-side dot-walking:

current.caller.company.phone

in a client script, it will look like:

const callerID = s_form.getValue('caller');
let callersCompanyPhone = '';
if (callerID) {
    const user = new SimpleRecord('user');
    user.get(callerID, () => {
        const company = new SimpleRecord('org_company');
        company.get(user.company, () => {
            if (company.next()) {
                callersCompanyPhone = company.phone;
            }
        });
    });
}

It is not recommended to use native JS methods and properties manipulating the Document Object Model in the client script widget. For example, using properties such as Element.innerHTML or Element.outerHTML in client scripts may cause malfunctions.

To avoid errors, please use the methods provided and supported by the vendor instead. See the example below for clarity.

// Not Recommended
document.querySelector(".article-body").innerHTML = s_widget.getFieldValue('body');
// Recommended
s_widget.addTemplate('body', s_widget.getFieldValue('body'));

REM Client Scripts

To add a client script to a record extended model, complete the steps below:

Navigate to Record Extended Model (REM) → Model Client Scripts.
Click New and fill in the fields.
Click Save or Save and Exit to apply changes.

Model client script form fields

Field	Mandatory	Description
Name	Y	Define the model client script name.
Container	Y	Specify a reference to a previously created model.
Type	Y	Specify the script type. Available options: onLoad – the script starts when the system displays the form for the first time before users enter data. Generally, onLoad scripts perform manipulations on the client side with the current form or default record values set. onChange – the script starts when the specified field on the form has been changed. onSubmit – the model client script can cancel form submission by returning 'false'.
Description	N	Type a detailed description of the script actions.
Active	N	When set to 'true', the script is active; otherwise, it is not.
Order	N	Define the order of the model client script execution. If there are several model client scripts, they will be executed in the ascending order.
Script	N	Type a model client script to execute.

A model can have a script executed after insertion of a record with the current model. The script is defined in the After insert script filed of the model. See this section of the Record Extended Model article to learn more.

Page tree

Client Scripts

Creating a client script

Special Features

REM Client Scripts