Client-side 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-side 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.
The client-side 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, fill in the fields and click Save.
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:
|
| View | 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. |
| 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. |
| Script | This field contains a client-side script. |
| Updated by | This field contains information about the person who has updated the script. This field is filled automatically and always read-only. |
Client-side API
In the client-side scripts, you can use methods that are provided by client-side API (SimpleForm class).
