Client Scripts

Client scripts allow the system to run JS scripts in the browser when the client-side events happen, for example:

form loading;
form submitting;
field value changing.

Client scripts are used to configure forms, form fields, and field values while the client uses the form. Their abilities:

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

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

Also, client logic can be implemented within the widget client script:

General client-side classes are: SimpleForm, SimpleList, and SimpleUser. To get more information about client-side classes, please check our API reference.

The client script form configuration

The client script can be configured via the SimpleOne administrative interface.

Required role: admin.

To configure a script, please 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	Description
Name	Client-side script name.
Table	A table on which form the script will be executed.
Type	The script type: onLoad – it starts when the system displays the form for the first time before users will enter data. Generally, onLoad scripts perform manipulations on the client-side with the current form or set default record values; onChange – it starts when the specified field in the form is changed; onSubmit – this client-side script can cancel form submitting by returning false; onCellEdit - this client-side script starts at the moment when some cell is to edit. oldvalue - the old value for the cell that was edited; newValue - the new value for the cell that was edited; table - the table name of the cell being edited (for example, sys_db_table); sysId - the ID of the record relevant to the cell being edited; callback - if this variable is equated to FALSE, then subsequent scripts will not run; otherwise, they will execute.
Views	Specify a form view on which the client script should be run. You can specify more than one view. If no view is specified, then this client script will be executed on all the views if there are any.
Condition	Specify a trigger condition for this client script that must be met so that the script runs. Use the Condition Builder to build complex AND/OR filters. Conditions work jointly with values from the Type field; they are applicable only for the onLoad or onChange client-side scripts.
Description	A detailed description of script actions.
Messages	Write a message you want to show to a user when a client script is performed.
Active	When set to TRUE, the script is active; otherwise, it is not.
Inherited	When set to TRUE, the script will be applied not only for the table specified in the Table field but also for all its child tables.
Order	Defines the order of the client script execution. If there are several client scripts, they will be executed in the ascending order.
Script	This field contains a client-side script.

Client-Side API

In the client-side scripts, you can use methods that are provided by Client-Side API.

Script Debugging

Special Features

Use callback functions to work with SimpleRecord objects:

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

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

current.slm_commitment.agreement.service_id

in client-side script it will be looks like:

const commitmentID = s_form.getValue('slm_commitment');
if (commitmentID) {
  const commitment = new SimpleRecord('slm_commitment');
  commitment.get(commitmentID, () => {
    const agreement = new SimpleRecord('agreement');
    agreement.get(commitment.agreement, () => {
      const service = new SimpleRecord('sys_cmdb_ci_service');
      service.get(agreement.service_id, () => {
        s_form.setValue('service_id', agreement.service_id, service.name);
      });
    });
  });
} else {
  s_form.clearValue('service_id');
}

Page tree

Client Scripts

The client script form configuration

Client-Side API

Script Debugging

Special Features