Versions Compared

Key

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

...

Simply click and drag the type of field (1️⃣) you wish onto the form… once the field is on your form (2️⃣) you can click the Green Cog (3️⃣) to configure more details of the field:

...

Add New Form Template - Form Designer - Field Settings

The field settings will vary depending on the type of fields but the Text Field is a good example which covers most of the settings available. A Preview is shown at the top of the Field Setting screen so you can see the effect of your changes in real time.

...

Display Section

Label - This is the label displayed alongside the field on your forms.

Placeholder - Faded text which can be shown inside an empty field as a “tip” to users on how to complete it.

Description - Help text which is shown underneath your field and can be used to explain to users how the field should be completed.

Tooltip - Text here causes a small ? icon to be shown beside your field and hovering over it will let users see additional help text or tips.

Width/Size/Label Position - These are all related to the layout and formatting of the field label and control.

Prefix/Suffix - These allow you to add a cosmetic prefix or suffix to the field. For example a common usage might be used for Length (m, cm, mm) or weight (kg, g, mg).

Disabled - When enabled the field will not by default allow for any values to be input. Disabled status can be set as default but then Conditional Logic can be used to enable it when a specific condition is met.

Hidden - When enabled the field is not visible on the form. Again this is useful in combination with Conditional Logic if you wish your field not to be shown unless certain criteria are met.

Calculated Field - When enabled the value of the field is determined using a Calculated Value Template (which will then appear within Data section below).

Data Section

...

Default Value - This is the default value the field will have when the Form is first opened or cleared by a user.

Calculated Value Template (if Calculated Field mode is enabled) - This allows you to set the template used to calculate the value. Templates for Calculated Values follow the same syntax as all other templates within AgileCase (see AgileCase Template Syntax for more on the syntax to use here). This allows you to include both complex logic as well as formulas to set the value of your field.

Refresh On - This determines if the calculate value is refreshed whenever any field on the form is changed or just when the Form is opened (thereby allowing it to be overriden). More refresh options will be added in future.

Validation

...

Required - field must be completed before the form can be submitted.

Min/Max options - various options for forcing the user to complete the field to min/max length of content.

Custom Error Message - custom message shown to the user when any validation fails.

API

...

Property Name - This is the ‘internal name’ of the field within AgileCase. The most common usage of this name is within Templates and Reports, ensuring that you can change the label of fields without having to also update any Templates which use it. It also means that the name within template can be shorter and simpler. Once property name is set it becomes ‘locked’ and you need to specifically ‘unlock’ it in order to change it. This locking behaviour ensures you are aware that changing the property name may require you to also update it within any templates where it is used.

Conditional Logic

Conditional Logic is a big topic covered in the follow section.

Conditional Logic

d