Checkbox
Setting properties
When you drag and drop a Checkbox field into the Canvas, the Properties window is displayed.
Click a section heading to expand or collapse the section. Enter values into the fields as follows:
- BASIC ATTRIBUTES
- Name—Enter a name for the field. This will be displayed as a label for the field on the published form.
- Width—Select the number of columns the field spans. The field can span up to six columns, depending on the settings (see Changing the Number of Columns in a Tab in Working with Tabs).
- Values—There are only two values for a checkbox: On (the box is checked) and Off (the box is not checked). You cannot add or remove either of these values, but you can change the label beside each value. Click on the label (On and Off by default) to activate the text field, then type the name you want to use in the field (for example, "True" or "False").
- HELP TEXT AND INSTRUCTIONS
- Mouseover Text—Enter the text to be displayed when a cursor hovers over the field or the field name. Text is limited to 100 characters.
- Help Text and Instructions—Help text and instructions can be as detailed as you like and are displayed above the field on the published form.
- Show on Create & Edit—Select whether to show the help text and instructions on the Create and Edit pages of an issue:
- Always—The text and instructions are always visible to the agent or customer.
- If field is shown—Display the text and instructions only if the field is visible to the agent or customer.
- If row is shown—Display the text and instructions only if the row in which the field appears is visible to the agent or customer.
- Details—Select whether to show the help text and instructions on the Details page of an issue.
- Never—The text and instructions are never visible to the agent or customer.
- Always—The text and instructions are always visible to the agent or customer.
- If field is shown—Display the text and instructions only if the field is visible to the agent or customer.
- Rich Text Mode checkbox—Check the box to use the Rich Text Editor to edit the instructions. The editor provides a variety of text formatting options, including font options and HTML options such as inserting an image from a file or the clipboard, linking to a URL. Leave the box unchecked to use plain text for the help text and instructions. The box is checked by default.
- Text Input field—Enter the help text or instructions into the input field.
- Show on Create & Edit—Select whether to show the help text and instructions on the Create and Edit pages of an issue:
- PERMISSIONS AND ACCESS—View or set the default permissions for a custom field.
For each field, you can set up separate sets of permissions for agents and customers for this workspace. These are called "Agent Default" and "Customer Default" settings.
To set permissions for a field:
- Click a cell in the table corresponding to one of the permissions listed below, such as "Optional".
This will apply the permission to all statuses at once (Open, Resolved, Closed). The selected cell is color-coded green (see the Agent Default example in the screenshot below).- Hidden—Users cannot view the field
- Read Only—Users can view but not edit the field
- Optional—Users can view and edit the field, but are not required to populate the field
Required— Users can view and edit the field, and are required to populate the field
- To set separate permissions per status (advanced permissions):
- Click Toggle advanced below Agent Default or Customer Default to view all of the statuses.
Then click the cell corresponding to the permission and status (see the Customer Default example in the screenshot below).
- To reset advanced permissions to the initial (basic) settings, click Toggle advanced .
This will reset the permissions to Optional for Agent Default or Hidden for Customer Default.
To remove custom permission from a user role:
Mouse over the role (listed above the Agent Default or Customer Default permissions), then click the Remove button.
The custom permissions are removed from the role and the name of the role displays with a strikethrough (for example, Role Name). Once you save the changes, the role name will no longer display on the window.
If you decide not to remove the role and have not yet saved your changes, you can mouse over the role and click the Undo button.
- CANCEL/SAVE buttons—To cancel the edits made to the field, click the Cancel button below the Properties window. Cancel does not add field to the form in Properties window if the field is introduced for first time and it is not saved before. To save the edits, click the Save button. Save does not publish the field addition/edit to the production version of the form. The changes to the form do not become visible to the user until the form has been published.
Defining permissions per role
To define field permissions with greater granularity, you can customize them for a specific role by editing the Role Properties. Once you have done so, if you return to the Form Designer, the customized roles are listed as exceptions to the default permissions.
Editing, moving, or deleting the field
To edit the field properties, from the Form Designer, hover over the field and click on the edit icon.
To move the field, from the Form Designer, hover over the field, click on the move icon, hold down the mouse button, and drag the field to the location in which you want it displayed.
To delete the field, from the Form Designer, hover over the field and click on the trash can icon. Deletion is not permitted if a field is part of some other feature (such as a field dependency). In those instances, the relationship between the field and the other feature must first be severed before the field can be deleted.
Changing the field name
You can change the field name from the Form Designer without going into the Properties window. To do so, click in the field name from the Form Designer. The name is highlighted. Type the new name into the field.