For model forms, a set of rules can be defined that specify an initial state of the model form and a change in its behavior and values on it in accordance with data and events that take place on the form. This set of rules is defined in a GUI Rule model and it applies to a selected model form when it is used. GUI Rules can for example be used to hide or show input controls, to enter values or to enable controls in accordance with change or input on the form. When a GUI Rule is created, the design form applies to the specified model. Field Specific rules can be specified as well as Events on fields. Events are associated with Actions on fields. In other words, if a certain event takes place in a field, actions can be carried out on other fields.

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title

Description

Details

Model Type *

The selected model type that the GUI Rule applies to.

Field Name: type
Type: String
Format: uri

Name *

The name of the GUI Rule. Default: Default

Field Name: name
Type: String
Default: Default

Show Metadata Information

Do not display Metadata Information

Field Name: show_meta_data_info
Type: Boolean

Filter Fields

These values will need to be supplied for this non-default GUI Rule to be fetched.

Field Name: filter_fields.[n]
Type: Array

Field *

The name of the field to use as a filter.

Field Name: filter_fields.[n].field
Type: String
Choices: [""]

Value *

The value of the field to use as a filter.

Field Name: filter_fields.[n].value
Type: String

Field Specific

If required for fields in the selected Model Type, use the Field Specific form to set properties and values for a field when the model form is first rendered.

Field Name: field_specific.[n]
Type: Array

Field *

The selected field to which initial properties are applied.

Field Name: field_specific.[n].field
Type: String
Choices: [""]

Property *

The selected property of the field when the model for is first rendered. The field can be disabled, take custom values, hidden, change type or take a value.

Field Name: field_specific.[n].property
Type: String
Choices: ["Disabled", "Allow Custom Values", "Embed in Parent", "Hidden", "Required", "Replace", "Replace on Demand", "Type", "Choices", "Value", "Title", "Description", "Scrollbars", "Summary", "Password Complexity", "No Choice Title"]

Source

The source of the value. If the Source is GUI, Value is a reference to values in the GUI. If the Source is API, Value will source its value from an API call.

Field Name: field_specific.[n].source
Type: String
Choices: ["GUI", "API"]

Scope of parameter search

Parameters can be used in the Value field of the actions as follows [fieldname]. This will then replace the parameter (everything including the square brackets with the value of the 'fieldname' field). The scope determines where in the form the rule will search for 'fieldname'. In some cases the rule must be limited to fields within the same object (in this case use Local). In other cases the rule must search the entire form (in this case use Global).

Field Name: field_specific.[n].scope
Type: String
Choices: ["Global", "Up", "Local"]

Value

The value of the field when the model is first rendered and the property is to take a value.

Field Name: field_specific.[n].value
Type: String

Value is translatable?

Value is translatable.

Field Name: field_specific.[n].value_translatable
Type: Boolean

API Request Type

The API Request can be called to a specific type. Leading and Trailing slashes are automatically removed and not required. (E.g data/ProvisioningWorkflow or [device_type:scope==global]).

Field Name: field_specific.[n].request_type
Type: String
Format: uri

Type Modifier

Modify the request type to list choices, properties, operations or other operation.

Field Name: field_specific.[n].type_modifier
Type: String
Choices: ["", "choices", "properties", "operations"]

Request Parameter Value Pairs

API Requests' input in the form of parameter and value pairs. parameter=hierarchy and value=[hierarchy] will result in input ?hierarchy=[hierarchy]

Field Name: request_parameters.[n]
Type: Array

Parameter

The parameter to be passed to the API.

Field Name: field_specific.[n].request_parameters.[n].parameter
Type: String

Value

The value of the parameter to be passed to the API.

Field Name: field_specific.[n].request_parameters.[n].value
Type: String

Events

The list of events on selected fields and the resulting actions.

Field Name: events.[n]
Type: Array

Description

A description of the event.

Field Name: events.[n].description
Type: String

Conditions

These conditions must all evaluate to TRUE for the actions to be implemented.

Field Name: conditions.[n]
Type: Array

Field

The selected field for which an event is specified.

Field Name: events.[n].conditions.[n].field
Type: String
Choices: [""]

Property *

The property of the field that applies to the event Condition. The field can be disabled, hidden or take a value.

Field Name: events.[n].conditions.[n].property
Type: String
Choices: ["Disabled", "Hidden", "Required", "Value", "Is Add Form", "Is Edit and Replay"]

Condition

The event condition that is to hold for the Value field property. The condition applies if the field property is Value and tests with the Value of the field.

Field Name: events.[n].conditions.[n].condition
Type: String
Choices: ["Equals", "Not Equals", "In", "Not In", "Changes", "Empty"]

Value

The value that the Condition tests the field value with if the Condition is Changes, Empty, Equals and Not Equals.

Field Name: events.[n].conditions.[n].value
Type: String

Values

If the Condition is In or Not In, then the Values list the items to test the condition against.

Field Name: value_list.[n]
Type: Array

Scope of parameter search

Parameters can be used in the Value field of the actions as follows {fieldname}. This will then replace the parameter (everything including the curly brackets with the value of the 'fieldname' field). The scope determines where in the form the rule will search for 'fieldname'. In some cases the rule must be limited to fields within the same object (in this case use Local). In other cases the rule must search the entire form (in this case use Global).

Field Name: events.[n].conditions.[n].scope
Type: String
Choices: ["Global", "Up", "Local"]

Actions

The list of actions that apply to fields if the Event condition resolves to True.

Field Name: actions.[n]
Type: Array

Field

The field upon which the action is carried out.

Field Name: events.[n].actions.[n].field
Type: String
Choices: [""]

Property *

The property of the field that is affected by the action.

Field Name: events.[n].actions.[n].property
Type: String
Choices: ["Disabled", "Embed in Parent", "Hidden", "Required", "Replace", "Replace on Demand", "Apply GUI Rules", "Choices", "Value", "Type", "Title", "Description", "Scrollbars", "Password Complexity", "No Choice Title"]

Source

The source of the value. If the Source is GUI, Value is a reference to values in the GUI. If the Source is API, Value will source its value from an API call.

Field Name: events.[n].actions.[n].source
Type: String
Choices: ["GUI", "API"]

Scope of parameter search

Field Name: events.[n].actions.[n].scope
Type: String
Choices: ["Global", "Up", "Local"]

Value

Use the Value input to specify the value of the selected Property.

Field Name: events.[n].actions.[n].value
Type: String

Value is translatable?

Value is translatable.

Field Name: events.[n].actions.[n].value_translatable
Type: Boolean

API Request Type

The API Request can be called to a specific type. Leading and Trailing slashes are automatically removed and not required. (E.g data/ProvisioningWorkflow or [device_type:scope==global]).

Field Name: events.[n].actions.[n].request_type
Type: String
Format: uri

Type Modifier

Modify the request type to list choices, properties, operations or other operation.

Field Name: events.[n].actions.[n].type_modifier
Type: String
Choices: ["", "choices", "properties", "operations"]

Request Parameter Value Pairs

API Requests' input in the form of parameter and value pairs. parameter=hierarchy and value=[hierarchy] will result in input ?hierarchy=[hierarchy]

Field Name: request_parameters.[n]
Type: Array

Parameter

The parameter to be passed to the API.

Field Name: events.[n].actions.[n].request_parameters.[n].parameter
Type: String

Value

The value of the parameter to be passed to the API.

Field Name: events.[n].actions.[n].request_parameters.[n].value
Type: String

Model: data/GUIRule

Model Details