Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Rules are the best way to add dynamics to your forms, make validation rules conditional or customise form UI behaviour


Available rules

Table of Contents


Excerpt
Action type

Apply

...

CSS

...

on

...

a

...

field

Applies CSS styles on a given field, based on the condition set

Apply

...

Filter

...

on

...

a

...

field

You can apply specific filters on "select"-type fields.

This is especially powerful, when your fields are backed by smart fields, web-service or database fields.

Your filter is applied ON THE DATASET this field relies on. Which means, the filter is applied on the source dataset

Few examples:

...

...

field

Conditionally hides the field and the "wrapping" container (if given)

Hide

...

container

Allows you to hide by CSS selector

Lookup

...

and

...

set

...

DB

...

value

Helps you to have a lookup against the query you create from your database

Lookup

...

and

...

set

...

WS

...

value

Allows you to make a request to a webservice and set the received values back to the form's fields

Lookup

...

and

...

set

...

JIRA

...

issue

...

data

Allows you to request issue details from your Jira (by issue key) and set the received values back to the

Lookup

...

and

...

set

...

Insight

...

object

...

data

Same as with Jira issue data, but allows you to query Insight data storage

Lookup

...

and

...

set

...

value

This rule allows you to lookup the data from another ConfiForms form and set received data back to the form's fields

Run

...

custom

...

JavaScript

ConfiForms can execute a custom JavaScript function via ConfiForms Field Definition Rules, and your function can expect the following variables to be present

  • formName - is the "form" with HTML field elements. This allows you to access fields very easily via AJS.$(formName).find('#i_FIELD_NAME')
  • formId - is the "div" element in HTML holding the whole form and fields. This allows you to access fields very easily via AJS.$('#' + formId).find('#i_FIELD_NAME')

which means your function can have a signature like:

Code Block
function myfunction(formName, formId) {
}

See demo: Using ConfiForms Field Definition rules with JavaScript action to get and set field values

Set

...

expression

Same as set value, but you can set expression (Supported math operators, formulas and functions), which will be calculated for you

Set field readonly

Sets field as readonly, setting reverse condition will do the opposite. Please note that you will need 2 rules to set/unset the readonly status - you cannot have one (as with hide/show, for example)

Please also note that not all the fields can be set as readonly -  dropdowns are ALREADY readonly, and setting the as readonly makes no sense and no impact. 

Also, not all the fields are supported (work in progress). 

Set

...

form

...

title

Rule to help you to changes form's title

Set field label

Sets label text for the field

Set

...

value

Set's value to the fields. Please be aware, that internal value for the field is expected. See ConfiForms Field Types

Set

...

value

...

if

...

empty

Same as above, but has additional check applied to ensure the value is set ONLY when the field has not value set

Set

...

submit

...

button

...

label

Changes label on submit form button

Show

...

field

Conditionally shows the field and the "wrapping" container (if given)

Show container

The opposite what "Hide container" does, and allows you to show elements matching the CSS selector you put

Reset

...

value

Resets the field value

Validate

...

if

...

exists

...

in

...

other

...

Form

Useful action type to check if the record matching configured condition / filter exists in the other form

Validate

...

uniqueness

On form submit, the action checks if the record is unique within a dataset. Uniqueness criteria is calculated based on the fields given

Validate

...

on

...

delete

This action is executed on "record delete", and could prevent the record being deleted based on the condition you set

Validation

...

rule

Validates record(conditionally)

Validation

...

rule

...

(dataset)

Validates current record against the rows in the dataset, For example, when you want to ensure the max number of records stored in the dataset