Note |
---|
Draft Documentation - In Progress. |
Table of Contents |
---|
Overview of Form Templates
...
By default forms submitted like this will simply appear in your Team Inbox, however using Automation rules you can decide on other actions like Creating /new Work Items, Updating existing Work Items and more!
Published - Private Form
...
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 Types
There are numerous different field types you can choose from - including Sections and Tabs which allow you to group parts of your form into specific layouts or split them over a few tabs. Here is a brief explanation of the different types:
Basic
Text Field - the most basic field which just collects text on a single line.
Text Area - a multi-line variant of text field.
Date / Time - specifically for accepting Dates and Times with specific UI and control over date time format and validation.
Options - for collecting values from a fixed list of options. Can be further configured to display as a Dropdown, Checkbox List or Radio Buttons layout.
Numeric - specifically designed for users to enter numbers providing specific validation options. Can be further configured to accept currency numbers with specific support for currency symbols and validation options.
Layout
Tabs - Allows you to add a ‘tab strip’ to your form so longer forms can be split over multiple tabs. When you have a Tab strip on your form Conditional Logic (see: https://agilecase.atlassian.net/wiki/spaces/ACV2/pages/2580217866/Form+Templates#Conditional-Logic-in-Form-Templates ) allows you to show/hide tabs based on other values on your form.
Sections - Allows you to group multiple fields on a Form with a heading and other formatting such as indenting and help text. Sections are also useful for Grouping a large number of fields which you need to then hide/show using Conditional Logic.
Button - Allows you to add buttons to your form. An extra button can allow you users to submit the form at convenient places in the flow of the form to save their progress. It can also be used to change to text shown to the user making it clearer the actions taken after a form is submitted. Currently “Submit Form” is the only action supported by the button but we will be adding more options in future such as “Clear”, “Validate” and more.
File Upload - Allows you to upload files to be linked and versions directly within your forms.
Advanced
Template Button - This button allows users to create a Document or Email from a specific template directly from within your Form. It is great when your Workflow required users to create or review documents after completing data within a form - it means they do not need to leave the screen to do so. The Template Button will save the current Forms progress before rendering the template and allowing users to immediately review it before sending (in the case of an Email).
Work Item Chooser (a.k.a Container Chooser) - allows you to search by Name and Link other Work Items (Cases, Contacts, etc.) to your form. For example you could have a field like “Nominated Person” and then your Work Item Chooser can be set to filter so it only allows user.
User Chooser - allows you to search by Name and Link a User to the Work Item. Involvement mode allows this to update the Involvements of the Work Item - so for example you can set the ‘Case Handler’/'Owner'/'Complaints Handler' Involvements from within a Form.
Signature Button - Signature Button allows the currently logged in to “Click to Sign” which logs their Username, Login IP, Browser Signature and other session info to create an electronic trail of who completed the form.
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Enhanced Signature Button - The signature button will soon be extended to allow:
Watch our release notes for details of when this is released: Release Notes |
Integration Button - Integration Buttons allow you to integrate with external services such as Stripe, Zapier, Legl Payments, Yoti Identity Verification and many more coming soon. Typically an integration button will allow you to map specific fields from your Work Item (or current Form) to the inputs of the external service and then return the response of that service which may cause other fields to be updated. It may also redirect the user to the external provider.
For example, a typical use case with Stripe would be to redirect your user to make a payment using Stripe Checkout and then ‘save’ the confirmed payment status back to your Work Item.
Note: You must previously configured your Integration within the Integrations settings before you will see the option for that Integration Button. See Integrations for more details.
HTML Content - HTML content outputs custom HTML, Javascript and CSS. It is useful to display well formatted notes or guidance to your users and also can include AgileCase Template Syntax meaning you can output content from anywhere else in you Work Item and make the content fully dynamic if required.
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.
...
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 overridenoverridden). More refresh options will be added in future.
...
Conditional Logic is a big topic covered in the follow section.
Conditional Logic
...
in Form Templates
Conditional Logic allows you to specify different Form behaviour based on the data entered in your form or any data associated with your Work Item like. For example you could enable/disable/hide/show fields or sections depending on the values set within your form.
When you are looking at the layout of your form any fields with Conditional Logic will display a Orange Book icon and hovering over that icon will display a tooltip with a text description of the logic.
...
Conditional are added/removed by clicking the appropriate Add/Delete button and they can be reordered so they take the correct precedence (the last rule to be true will ‘win’).
...
Each condition is very simple following a IF <trigger field name> <operator> <value> THEN <action> <affected fields list> pattern.
The default behaviour is that if the condition is not met, then the opposite action will be performed. For example if the first condition in the example is not met then the “textField” field would be hidden. In some complex scenarios you may wish that not to happen so you can instead control the behaviour with your own alternative rules - then you can use the “If condition is not met do not inverse action” option to override it.
Publishing a Form Template
Once you are happy with the content, layout and logic of your form template you can optionally publish the template using the Publish tab:
...
Attaching you Form Template as a Work Type Custom Field Group
Step 1: Create a custom field group based on a Form
A more common use case for Form Templates is to attach them to Work Type configuration as Custom Fields. To attach your Form template to a Work Type you should use the Custom Field settings where you can provide this information.
...
Here you can give either the same or alternative name to the Custom Field Group and also decide if it should be displayed as a singular form, or as a multi-row table where multiple different instances of the form are created over time and stored in a table.
...
You can also set the permissions for the Custom Field Group.
Step 2: Edit your Work Type Page Layout to display the Custom Field Group
After you have attached your form as a Custom Field group you need to decide where on your Work Type Pages and Layout it is displayed. This is done using the Work Type Page Layout settings and adding a Custom FIeld Block: Work Types | Custom Fields Block.
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|