name
string / 必須 / 一意
| Field name
Alfanumeric + underscore + dash This attribute represents the name of the form field. |
type
string / 必須
| Field type
Other attributes might only be available for some field types. 値:
enum |
label
string
| Field label
Free text A friendly name/label for the field. Note: if not set, the field name is used as label, but not when type is html. Since 6.0.3: Supports placeholders for dynamic labels (e.g., Label: $(fieldname)). |
placeholder
string
| In-field help value
Free text Some form fields allow an in-field hint value. Since 6.0.3: Supports placeholders for dynamic hints (e.g., Enter password (min $(minLength) chars)). |
help
string
| Field help message
Free text Some fields require additional help information. This help message will be shown below the field. Since 6.0.3: Supports placeholders for dynamic help text (e.g., This field depends on $(fieldname)). |
values
array
| A list of values
To manually populate an enum field |
default
many
| Default value
The type of the value depends on the field type.
Can be string,boolean, number, array or object. When using multiple, the default must be an array.
When using an enum field, you can use the following special values: __auto__: select the first__none__: select none__all__: select all (if multiple is true) For yaml fields, the default can be any valid YAML structure (object or array). For list fields, the default must be an array of objects matching the referenced subform’s fields. Use it to pre-populate the list with existing rows on form load. |
evalDefault
boolean
バージョン 4.0.5 で追加 | Evaluates default value
A default can be treated as javascript and can thus hold expressions like '$(other_field)'.toUpperCase() or Math.PI or new Date().toISOString() 既定値:
false |
expression
string
| A javascript expression.
Valid javascript By default this javascript is evaluated on the server side and limited to predefined functions (for security). However in combination with runLocal, the evaluation is ran in the browsers sandbox and allows the full javascript power. An html field always evaluates its expression in the browser, as with runLocal: true: it never runs on the server. When used in an enum field, the expression must return a flat array or array of flat objects, to make it presentable in a dropdown box.
An expression supports placeholders: $(fieldname) is replaced by the value of that field before the expression runs.
On the server, the predefined functions are called as fn.<name>(...), for example fn.fnTime(). tip: use the alias local (type=’expression’,runLocal=true,hide=true,output=false)
tip: use the alias local_out (type=’expression’,runLocal=true,hide=true)
tip: use the alias credential (type=’expression’,runLocal=true,hide=true,asCredential=true) |
runLocal
boolean
| Run an expression locally
When running expressions, by default they are run remotely on the server.
But remote expressions are limited to predefined functions.
To unleash more javascript power, use this property.
The code will be evaluated in the sandbox of the browser, offloading the server, saving api-calls and making it more secure. 既定値:
false |
refresh
boolean|string
| Allow a manual or auto refresh
A query or expression is by default run once (if it doesn’t contain any dependencies).
Sometimes a refresh would be handy.
Set this property to true to allow a refresh, or set 5s for example to allow auto refresh. 既定値:
false |
dbConfig
string, array or object
| A database connection
When you want to query data from a database, you will need the proper connection information.
Name a database of Connections > Databases : it connects with the credential of type database it names (the database type, server, database and login).
Since 7.5.0 : a name that is no database is looked up as a credential of type database, as older forms do, so they keep working unchanged.
Legacy was to pass an object (name and type) ; it still works, its name a database or a credential.
Since version 5.0.2 you can just specify the name. The type is fetched from the credential (mysql, mssql, postgres, oracle or mongodb). In case of no type set, mysql is assumed.
Additionally you can set an array of names, to use multiple databases with a single query. The result will be a join of the results.
Doubles will not be removed automatically. |
query
string
| The query to select data from a database
A valid sql query This is typically a classic SELECT statement.
However, in the case of mongodb, the query is slightly different. See the examples.
A query supports placeholders: $(fieldname) is replaced by the value of that field before the query runs. Every $(...) value is escaped for the database engine before it is pasted into the query: single quotes are doubled, backslashes are doubled too on mysql (postgres, mssql and oracle keep them as they are), and on mongodb the value is escaped as the body of a JSON string. An object or array value is pasted as json, escaped the same way.
This protects a quoted placeholder (where name='$(name)') only: an unquoted one (limit $(n)) is pasted as plain text, so quote your placeholders. |
jq
string
バージョン 6.1.4 で追加 | Transform database query results with jq
A valid jq expression Apply a jq expression to transform the result of a query (with dbConfig).
jq is a post-processor applied server-side, after the query returns, to filter, map or reshape the result.
It only applies to query results: on an expression, server-side or local (runLocal: true), jq is ignored. |
multiple
boolean
| Allow multiple selection
When you want to select multiple items from a dropdown box, set this property to true. The field’s value is then a list of the selected items. 既定値:
false |
valueColumn
string
| The column of a selected item that needs to exported as extravar
When you select an item in an enum field, by default the first column is used to send as extravar.
By setting this property, you can change it to another field.
This setting is ignored when outputObject is true. new in v4.0.20: setting valueColumn to “*” will export all columns 既定値:
first column |
placeholderColumn
string
| The column of a selected item that is used in a placeholder
When you select an item in an enum field and later on you use this field as a placeholder, by default the first column is used as a value.
By setting this property you change the column to be used.
NOTE: this property is somewhat out-of-date since the introduction of the dot-notation.
See examples below. New in v4.0.20: setting placeholderColumn to “*” will output the entire record, instead of a single column. 既定値:
first column |
dependencyFn
string
バージョン 4.0.0 で追加 | The dependency logical function
This attribute represents the logical function between multiple dependencies. |
dependencies
list / elements=object
| Show/hide this field based on the values or other fields
Reference to other formfields and their values Each dependency element is either an object with the following 2 attributes: name: holds the fieldname.values: a list of valid values for the referenced field. Or with the following 2 attributes: name: holds the fieldname.isValid: a boolean to check if the referenced is validated or not. Use in combination with attribute dependencyFn. |
filterColumns
array
| The list of columns that you can filter on
By default the previewColumn or first visible column is used to filter on.
With this property you can filter on the columns you want. |
output
boolean
バージョン 6.2.0 で追加 | Include field value as extravar
Form fields are by default sent as extravars.
Set to false to exclude a field from the extravar output. 既定値:
true |
model
string or array
| Extravar modelling
An dot-based string notation of an object, or an array of these By default, a field is sent as a root-extravar.
If you want model the output of the extravars, you can specify a dot-notation of how this field should be modelled. |
asCredential
boolean
| Send credential as extravar
Use the value of this field to search for a credential with the same name
and send that credential (with user and password) hidden to the playbook as extravar. Since 4.0.16, you can use this in combination with the credentials form-property. 既定値:
false |
outputObject
boolean
| Output the selection of a enum-field as a full object.
When selecting from an enum-field (dropdown), either the first column or
the column defined in valueColumn is sent as an extravar.
If you want the full selected record, use the property. New in v4.0.20: valueColumn: “*” has the same behavior, and will output all columns 既定値:
false |
noLog
boolean
バージョン 2.2.3 で追加 | Disable backend logging
Disables logging in the backend, to hide passwords for example. 既定値:
false |
required
boolean
| Required field
Makes the field required. 既定値:
false |
validIf
object
バージョン 2.2.4 で追加 | An field based validation (field must be true)
Enforces a validation where a referencing (expression) field must be true. This field requires an object with 2 attributes: field: The name of the referencing fielddescription: A validation message to show when the validation is not met. (Since 5.0.1: Supports placeholders for dynamic messages) |
validIfNot
object
バージョン 2.2.4 で追加 | An field based validation (field must be false)
Enforces a validation where a referencing (expression) field must be false. This field requires an object with 2 attributes: field: The name of the referencing fielddescription: A validation message to show when the validation is not met. (Since 5.0.1: Supports placeholders for dynamic messages) |
ignoreIncomplete
boolean
| Allow form submit on non-evaluated placeholders
When an expression-based field has placeholders,
the default form behaviour is not to allow form submit until all placeholders are resolved. When this attribute is true, the form does not wait for placeholder completion for this field. 既定値:
false |
icon
string
| Field icon
Free fontawesome 6 icon Some formfields can hold a nice looking icon. The icon name is a free fontawesome 6 icon. You can find more information at www.fontawesome.com |
group
string
| The field group name
Free text With this attribute you can group fields together.
When all fields in a group are hidden (due to dependencies), the group is also hidden. |
line
string
バージョン 4.0.3 で追加 | The field line name
Free text With this attribute you can group fields in a single line together.
Use together with the width parameter to set the width, if not, the width is auto. |
width
string
バージョン 4.0.3 で追加 | The field width
A valid Bootstrap Column width With this attribute you can set the width of a field.
Use together wit the line parameter to put fields on 1 line. see https://getbootstrap.com/ 選択肢: - col-1
- col-2
- col-3
- col-4
- col-5
- col-6
- col-7
- col-8
- col-9
- col-10
- col-11
- col-12
|
sticky
boolean
| Make a dropdown box permanently visible
A enum field is by default a dropdown box. However, you can change that behavior by setting this property.
The dropbox looses it reactivity and becomes a fixed table. 既定値:
false |
horizontal
boolean
バージョン 4.0.3 で追加 | Converts a dropdown box to a horizontal selector
A enum field is by default a dropdown box. However, you can change that behavior by setting this property.
The unselected values are on the left and the selected values on the right. This works in combiniation with sticky.
PctColumns are disabled, due to the space it consumes horizontally. 既定値:
false |
columns
array
| The list of columns visible in the dropdown/table
For an enum field: all properties are shown by default. Use this property to choose which columns are visible in the dropdown.
For a list field: all scalar subform fields are shown by default. Use this property to pick which subform fields render as columns in the list table (missing names soft-fail and render as empty columns). |
pctColumns
array
| The list of columns that should visualized as a percentage-bar
By default all properties are show with its regular value.
With a percentage it can be nice to visualize it as a graphical bar.
The assumption is that the value is an integer between 0 and 100. |
previewColumn
string
| The column of the selected item(s) that is shown in the dropdown-preview
When you select an item in an enum field, by default the first column is used as a preview.
By setting this property you change the column to be used. 既定値:
first column |