Common Settings
Task Fields have a series of general settings which define their details and behavior. Below are the common settings you will see on most Task Fields:
Label¶
| Type | String |
The "name" or "title" of the field which is usually drawn above or next to the input.
Task¶
| Type | Selection |
The Task to which the Task Field is assigned. The Task Field will be seen when the web form for this task is rendered.
Type¶
| Type | Selection |
See the Task Field Types pages.
Required¶
| Type | Bool |
Whether or not a value is required in the field for the web form to be submitted and accepted.
Required == Bold Label
When a Task Field is rendered into a web form, the label is rendered as bold font when Required is set to TRUE.
Help Text¶
| Type | String |
Small, hint-type text under the field which can be used to expand on the question being asked
Placeholder¶
| Type | Multi-Line String |
An example of the input desired for the field.
Display Order¶
| Type | Integer |
A numerical value which is used to sort the Task Fields before they are rendered. Use this settings to reorder Task Fields within a Task.
The fields are sorted top-to-bottom starting with the lowest number
Field Slug¶
| Type | Slug |
A unique "key" for the field which is used to store submitted values. The slug gets used as the key for the answer values in the API.
The value used in the slug is limited to letters, numbers, underscores and hyphens.
When creating a new Task Field, the Field Slug gets generated and filled in automatically based on what you enter in the Label setting.