| Page Properties | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Ressourcesyuuvis® RAD - Client-side Form Scripting (parts will be taken over and be available with the next version 2.3 RemarksMartin B. is working on it together with Manuel and Stevan ... |
...
Note: When field data changes are made using a script (i.e., without user action) when loading the form, the Save option is not available. In contrast, you can disable fields to protect against user changes.
Script Scope
The relevant object is given to each client script under the name 'scope.' This object provides the API so the scripts can access the object fields and their properties.
Properties of 'scope'
Name | Description |
|---|---|
| api | Supplies access to the plug-in API, with 'session' (user information), 'dms' (object details, search via DMS-Service), 'http' (connection to any service), 'config', 'util' (helper functions) and 'agent' properties. |
| data | Supplies all object fields defined in the object or process activity. The fields offer read-only access using the technical name. Available for release 2017-09-27 (3.22.x) or later. |
| model | Supplies the flattened form model and all object fields defined on the form. The fields can be accessed with the technical name. The form groups cannot be accessed in this way. |
| situation | Supplies the current form model situation. Scripts can respond to the relevant situation. Possible values are 'CREATE' (create), 'SEARCH' (search) and 'EDIT' (edit index data). |
| objectId | Supplies the ID of the current DMS object if available (available since version 6.4). |
scope.data
this section has to be validated
Even when not defined in the form (object forms as well as process task forms), you can access object field data or process variables by using this part of the scope. Use the technical name of the object type field or process model variable to read its value, as shown in the following example.
...
| language | java |
|---|---|
| title | Evaluate on data |
| linenumbers | true |
| collapse | true |
...
A value of a system property of an object can be read using scope.data['system:<property name>']. These system properties are available here:
Name | Description |
|---|---|
| system:objectId | unique ID of the object |
| system:objectTypeID | technical name of the object-type, e.g. 'tenMytenant:customer' |
| system:baseTypeId | specifies whether an object is of type 'folder' or 'document' |
| system:createdBy | the title of the user that created the object in the format <name>,<surname> (<loginname>) |
| system:lastModificationDate | the date and time of last modification in the forma 'yyyy-mm-ddThh-mm-ss.xxxZ' |
| system:lastModifiedBy | the title of the last user that edited the object in the format <name>,<surname> (<loginname>) |
| system:versionNumber | current version number of the object |
| system:tenant | the tenant name as used when created |
| system:traceId | trace Id of the object (todo: write about the meaning) |
| system:parentId | this ID is given if a document object is filed into a folder. |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
variablename = scope.data['system:objectId'] |
scope.situation
For object types, you can create a default form to be used for the situations CREATE, EDIT and SEARCH. In each situation, any included scripts are active.
If a general form is used, but different data management is necessary, it is possible to check which situation is given.
For example, how to deactivate a form script to be used in the situation 'SEARCH.'
...
This section describes how to access all form elements of objects or processes.
Field properties
The following table describes object field properties that can be accessed with 'scope.model'.
Column "Binding"
- RO (ReadOnly): ReadOnly properties can only be read. Changes to the values of RO properties do not affect the interface.
- RW (ReadWrite): ReadWrite properties can also be written. Changes to the values of RW properties affect the interface.
Each field has the following properties:
| Name | Description | Binding |
|---|---|---|
| name | The normalized name of the fields. Normalized means the simple field name is lower case. The name must not contain special characters except one ':'. This name is used to map the fields to the 'model.' | RO* |
| label | The display name of the type in the current user locale. Used as a field identifier. | RO |
| description | A field description. Can be used in tooltips for example. | RO |
| type | Describes the data type of the field. The possible values here are documented in the description of field data types. Other field attributes may exist, depending on the data type. | RO |
| readonly | If the readonly property is set to 'true,' the user cannot change the field value. | RW** |
| required | Flags a field as mandatory. If this property is set, the user must make an entry. | RW |
| value | The current value of the field. | RW |
| cardinality | In case of 'multi' instead of 'single' (equal 'undefined') a list of values can be maintained. A JavaScript array is then always expected in 'value.' Not every data type supports the 'multiselect' property. | RO |
*RO (ReadOnly): ReadOnly properties can only be read. Value changes of RO properties do not affect the interface. **RW (ReadWrite): ReadWrite properties can also be written. Value changes of RW properties affect the interface. | ||
The following example validates dynamic field properties for required fields and write permissions.
...
Name | Description | JavaScript data type | Multi-selection |
|---|---|---|---|
| STRING | Any text. See also datatype: STRING. | String | Yes |
| NUMBER | Number and floating point number. See also datatype: NUMBER. | Number | Yes |
| BOOLEAN | Simple 'on/off' or 'true/false' value. | Boolean | No |
| DATETIME | A date or a date with time value. See also datatype: DATETIME. | Date | Yes |
| TABLE | A table with values. See also datatype: TABLE. | Object Array Properties of each object are defined by the column elements of the table. | No |
Data type-specific properties
...
| Name | Description | Binding |
|---|---|---|
| maxlen | The maximum number of characters permitted as a value in this field. | RO |
| minlen | The minimum number of characters permitted as a value in this field. | RO |
| classification | If available, a specific type of text field is described.
| RO |
*RO (ReadOnly): ReadOnly properties can only be read. Changes to values of RO properties do not affect the interface. **RW (ReadWrite): ReadWrite properties can also be written. Changes to values of RW properties affect the interface. | ||
| Info | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
Read on
|