Agreement Builder

The following statuses are available when creating or managing agreements in the Agreement Builder:

The agreement has been created but not yet published. Not visible to workers.

The agreement is published and available in worker profiles.

The agreement is no longer active and not visible from worker profiles.

Statuses shown to each user type reflect whether they need to act or are waiting on someone else.

This user type can complete the agreement; action is needed from them.

One other user type needs to act. Displays as 'Awaiting [user type]' as appropriate.

Multiple other user types can complete it but the current user cannot.

The agreement has been fully submitted.

There are buttons available on every component in the Agreement Builder on hover.

Edit - Opens the edit modal window.

Move: - Moves the component to a different location.

Paste below - Pastes a copied component below this one. This button appears after a component has been copied.

Copy - Copies the component or group of components.

Remove - Deletes the selected component.

The Display tab has several options you can use to enhance the information given to the worker:

See the preview at the bottom of the editor to see how the component will look to the user.

The Data tab is key for fields where multiple options are given to the user, such as:

Input your options into the label boxes. You can add additional rows or remove existing rows as required.

In the Validation tab, you can set a field as required. The user will not be able to submit the agreement without completing this field.

The Conditional tab is available for all fields. Use it when additional information is required; for example, when a worker gives a specific response to a radio button or survey question.

Best used when additional information is required, for example, when a worker gives a specific response to a radio button or survey question.

A Content component provides static content such as contextual language, headers, or media. Use it to provide instructions that do not require input from the user.

A Text Field can be used for short and general text input.

The Email component carries special input validation, ensuring the entered data is in a valid email format.

A Text Area is a multi-line input field that allows for longer text. The number of rows can be selected in the edit window.

The Phone Number field carries an editable input mask to force the user to enter data in a phone number format.

Use a Number field whenever a field should be limited to a number value type.

The Date/Time field opens a calendar with a date and time picker. It can be configured to show only a date or only a time if required.

A Check Box can be checked or left unchecked. It is often used as a required field; this can be set in the Validation Tab.

Select boxes allow the user to select one or more options in a checkbox-style format. Set the values within the Data Tab.

The Select component displays a list of values in a dropdown list where users can select one value. Set the values within the Data Tab.

A Radio component allows users to select a single option from a list. It can be used in conjunction with a conditional field if you require additional information from the worker.

The Survey component works similarly to Radio buttons, but you can set multiple questions with the same answer values.

The Signature component allows the end-user to digitally sign using either their finger on a touch-enabled device or the mouse pointer. When the form is submitted, the signature pad is converted into an image.

Add an HTML Element to display a single HTML element in a form. This is useful for quickly inserting and configuring HTML in your form.

A common use case is to add vertical space between components by entering <br> into the content box. This component can then be copied and placed wherever needed.

The Columns component groups other components into configurable columns. Use it to display multiple components inline and save vertical space on a form. Columns collapse when the form is rendered on a mobile device.

Field Sets allow you to group multiple fields together in a form. They help organise related fields visually and logically, making it easier to manage and present complex forms. Field Sets can be used to group fields under a common heading or section.

Panels are used to organise and group other form components into their own section. They help structure forms by visually separating different sections or categories of information.

The Table component arranges and presents form fields in a table-like layout. It is particularly useful for forms that require a clear, organised presentation of fields that benefit from a tabular structure.

The Tabs component groups different sets of fields into separate tabs, each of which opens a group of components. Only one tab is displayed at a time.

The Well component is designed to help with layout and visual separation within a form, making components inside the Well more user-friendly and visually appealing. Helpful for managing sections within the builder – you can group items and move them around the agreement altogether.