Add Custom Form Type

You can create a custom form using the Form Builder. To create a custom form type for your application:

1. Click the Add Form button on the Forms page. 
2. The New Form pop-up will be displayed, where you can fill in the following fields:
   1. Caption: enter a unique name for the custom form.
   2. Caption Plural: enter the plural version of the custom form’s name. 
   3. Form Type: choose “Custom” in the picklist. If you want to add a data form to auto-populate form sections, see Set up a Data Form.  
   4. Show on Intake: toggle to display the custom form on the New Case form, so users can add records of your custom form type when they submit a case. 
   5. Show on Portal: toggle to display the custom form on your application's external portal, so portal reporters can add records of your custom form type when they submit a case.
   6. Automatic translation: toggle to display the “Automatic Translation” field property for text fields in the Form Builder. If you turn on “Automatic Translation” for a text field, the Translation Copilot will automatically generate translations for text in a different language than your application's default language when the custom form is initially submitted. This option will only be available if the Translation Copilot has been activated for your application.
3. Click the Save button to proceed to the Form Builder, where you can add fields, tabs, sections, and data form sections to the custom form. Refer to the next tabs in this article for details on adding elements to your custom form. 
   1. The “Case” field will be added to the custom form by default, as each custom form record must be associated to a case. 
   2. When you are finished adding elements to the form, you can publish the form, so users can create records with your new custom form type (see the "Publish" tab of this article for details).

Fields

Users will enter information into custom form records using fields, such as text boxes and radio buttons. You can add and set up fields on a custom form to choose the types of information or data that users can provide in a custom form record. See a description of all field types you can add to a custom form in the Custom Form Field Types section of this article.

Add a Field

To add a field to a custom form:

1. Make sure to open the custom form in the Form Builder and set the Form Builder in edit mode. 
   1. If you just added the custom form type following the steps in the last tab, the custom form will already be in edit mode and you can proceed to the next step.
   2. If you want to add fields to a custom form that has already been published, you can put the custom form back into edit mode by clicking the Edit button on the Form Builder.
2. Click the + Insert Fieldssection or the right arrow icon to open the Field Type sidebar. The Field Type sidebar contains all available components you can add to the form. 
   1. All field groups are at the top of the sidebar's list, which contain multiple fields in a section. All individual fields are organized below the field groups list. See details on adding field groups to a record type in the "Field Groups" tab of this article.
   2. The Custom Form Field Types section of this article describes all available field types and their additional properties.
3. Use the “Search field type…” search bar to find a specific data type in the list. To add a field type to your form, click and hold the field type in the Field Type sidebar, drag it to the Form Builder, and let go of your cursor over the + Insert Fields section. 
4. The Field Type pop-up will be displayed, where you can fill in the field's properties. The properties of a field control how users can interact with and enter information into the field. All fields will have the following options, but there will be additional properties available for some field types, see the Custom Form Field Types section of this article for details. 
   1. Name: enter the name you want the system to use to refer to the field. The field's name will be shown on grids and reports.
   2. Caption: enter text to appear beside the field on the form. Adding a caption is optional. If you enter a caption, the caption text will be displayed on the custom form instead of the “Name” text.
      1. For example, you can enter a concise "Name" for the field to show in grids and reports, such as “Interviewers”. Then, you can phrase the “Caption” text as a question to help users filling in the form, such as “Who interviewed the parties?”.
   3. Input method: select if the field’s value can be entered by users or calculated. Choose one of the following options:
      1. Editable: users can enter and edit the field's value when adding or editing the form. 
      2. Submit-Only: users can enter a value in the field but cannot edit it after the form is submitted.
      3. Computed: the system will evaluate an expression to calculate the field's value when a user saves the form. Users will not be able to edit the field. For comprehensive information on writing expressions for computed fields in Case IQ, see Case IQ Expression Language.
   4. Required: choose if users must complete the field before they can submit the form.
   5. Show on intake: choose if the field should be displayed when a user is creating a new record of this custom form type.
      1. For example, if you add a field to a custom form called "Interview" and set "Show on Intake" to "On", the field will appear on the New Interview Form when a user wants to add an interview record. 
      2. By default, "Show on Intake" is set to "Off", meaning that the field will not be available on the form when adding a new record. 
   6. Show on portal: choose if the field should be displayed on your application’s external portal (the Report Online form). If you do not see the "Show on Portal" toggle, check if the custom form is set to show on portal (see the "Edit Form's Properties" tab of this article for details).
   7. Restrict edit: choose if editing the field should be restricted, except for users with “Save Restricted Fields” or “Create Restricted Fields” permissions for the custom form type. You can restrict a maximum of 20 fields in your application. "Restrict edit" is not available for information boxes, sections, or data form sections.
   8. Sub text: enter guidance text to display under the field. You can include URLs in sub text, for which Case IQ will automatically create a link. Make sure to include “http://” or “https://” in the link. In the screenshot below, the field’s sub text is highlighted in purple. 
   9. Help text: enter discrete guidance text, which will only be displayed when the user hovers their cursor over a question mark icon beside the field. See an example highlighted in pink in the screenshot below.
5. When you have finished selecting the field's properties, click Save on the pop-up. The field will now appear on the Form Builder. 
   1. If you added a picklist or picklist multiple field, you can now add the options that users will be able to select in the field, see the "Picklists" tab of this article for details.

Edit a Field

After adding a field to your custom form, you can change the field's properties while the custom form is in edit mode. If you are working on a custom form that has already been published, you can put the custom form back into edit mode by opening the form in the Form Builder and clicking the Edit button.

To update a field’s properties, click the field on the Form Builder. The sidebar will load the properties of the field, where you can adjust its settings as needed. Click the Save button at the bottom of the sidebar. Your changes to the field will be published for your application's users when you publish the custom form, see the "Publish" tab of this article for details. 

Move a Field

You can change the order of fields on the form while the custom form is in edit mode. Click and hold a field, move your cursor to another location, then let go of your cursor to place the field.

If your form has more than one tab, you can move a field to another tab by dragging the field to the tab name and dropping the field on the Form Builder.

Delete a Field

You can delete a field on the Form Builder using either of the following methods. Deleted fields will not appear on custom form records or in search results, but any data that users entered in the field will not be deleted in the Case IQ system.

1. Hover your cursor over the field on the Form Builder and click the Delete icon.
2. Click the field on the Form Builder, then click the Delete button on the left sidebar.

Restore a Deleted Field

If you delete a field after the custom form was published, you can quickly add it back to the form using the following steps:

1. Click the + Insert Fields section or the right arrow icon to open the Field Type sidebar. 
2. Click the “Deleted Fields” tab on the Field Type sidebar. 
3. Click and hold a deleted field in the sidebar, drag it to the Form Builder, and let go of your cursor to drop the field in place. 
4. You can adjust the field's properties in the Field Type pop-up if needed.
5. Click Save on the pop-up and the field will be back on the custom form.

Add a Display Rule to a Field

You can specify criteria for when a field will be displayed based on the values a user enters in other fields on the custom form. To create display rules for a field:

1. Click the field on the Form Builder to load its properties on the sidebar. We will refer to this field as the "dependent field". In the video example below, the dependent field for the display rule is the "Corrective action taken" field.
2. Click the “Rules” tab in the sidebar, then click the Add Display Rule button.
3. In the Add Display Rule pop-up, you can set up criteria to tell the system to show the dependent field when another field on the form is set to a certain value. A criteria statement contains three parts: 1) a field, 2) an operator, and 3) a value. In the  "Search fields..." dropdown, select a field on the form for the criteria. We will refer to this field as the "parent field". 
   1. In the video example below, we created two criteria for the display rule, selecting "Substantiated?" and "Allegation description" as the parent fields.
4. Another dropdown will be displayed beside the "Search fields..." dropdown after selecting a parent field. In the dropdown, select an operator for the criteria. The operator tells the system how to compare the parent field to the value in your criteria statement. 
   1. For example, if you select "Contains" as the operator, the system will show the dependent field when the parent field contains the value in your criteria.
   2. If you select "Is Empty" or "Is Not Empty" as the operator, you do not need to select a value for the criteria, as the system will show the dependent field when the parent field is empty or not empty respectively.
   3. In the video below, the operator for the first criteria is "Is", which tells the system to display the dependent field when the parent field is set to the value in the display rule.
5. One or more additional fields will be displayed beside the operator dropdown. Enter or select a value for the parent field in these fields. The system will look for this value in the parent field when determining whether to show or hide the dependent field.
   1. The input method to select the value depends on the parent field's type. For example, if you choose a radio button field, you can select the value using radio buttons.
   2. In the video below, the value for the first criteria is "Yes". This criteria tells the system that the dependent field should be displayed on the form when the "Substantiated?" field is set to "Yes".
6. If the display rule should be dependent on more than one parent field, you can add another by clicking the + Criteria button. Then, repeat steps 3 to 5 to choose the parent field, operator, and value for the criteria.
7. If you add more criteria to the display rule, you can use the “All/Or" toggle below the criteria to set whether the form must meet all or one of the criteria on your list.  
   1. By selecting “All”, the dependent field will be displayed only if all criteria are met.
   2. Choosing “Or” means that the dependent field will be displayed even if only one of your criteria is met.
   3. In the video below, we chose "And", meaning that the dependent field will be displayed if both the "Substantiated?" field is set to "Yes" and "Allegation description" field is not empty, meaning that a user has begun typing in the "Allegation description" field.
8. When you have completed setting up criteria, click the Save button on the Display Rule pop-up. A connector icon will appear beside the field.

After saving one display rule for a field, you can add more display rules to show the field in multiple different situations. Click Add Display Rule again, set up another display rule in the Add Display Rule pop-up, and click Save. There will now be an "And/Or" toggle under the display rules. If you select "And", the field will not be displayed unless all of your display rules are met. If you choose "Or", the section will be displayed if it meets one of your display rules.

Picklists

Add a Picklist Option

After adding a picklist field to your custom form, you can set the options to display in the picklist dropdown menu using the following steps. Any picklists created in the Form Builder will be populated in the Picklists page in Settings (see Configure a Picklist and Picklist Option).

1. Click the picklist field on the Form Builder to open the field’s properties on the sidebar.  
2. Click the Values tab on the sidebar.
3. In the “Value” field, type a picklist option to show in the picklist dropdown menu, then hit Enter or Return on your keyboard. 
   1. You can also paste a list in the "Value" field. Copy a list, then paste the list in the Value field and click the Add button. Case IQ can add up to 100 values at once. If you need to include more than 100 values in the picklist, you can copy and paste values in the "Value" field multiple times.
4. In the “Sequence” field, you can indicate the position in the picklist menu in which the option should appear by entering a number. If you do not add a sequence number, the options will be sorted alphanumerically.
5. If your custom form and picklist field are available on your application's portal, you will see an additional “External” checkbox in the field properties sidebar. You can check the “External” checkbox to show a picklist option on the application's portal so that portal users can see the option in the picklist dropdown.
6. Click the Add button to add the option to the picklist.

Edit or Delete a Picklist Option

After adding a picklist option, you will only be able to change the picklist option's "Sequence" or "External" properties. You cannot update the “Value” field of a picklist option for data integrity purposes. If you made an error typing in a picklist option's “Value” field, delete the picklist option, then add a new option with the correct “Value”.

To edit or delete a picklist option:

1. Click the picklist field on the Form Builder to open the field’s properties on the sidebar.  
2. Click the Values tab on the sidebar.
3. Select the picklist option in the Values tab's grid that you want to change. 
4. You can now edit or delete the picklist option.
   1. To edit the picklist option, adjust the "Sequence" field or "External" checkbox and click the Save button for the option, which will be located above the grid in the sidebar.
   2. If you made an error in a picklist option's “Value” field, click the Delete button for the option. See the previous section in this article tab, "Add a Picklist Option", for details on adding a picklist option as a replacement.

Set Up a Dependent Picklist

You can create a "child picklist" on your custom form, in which the options displayed in the dropdown menu will be dependent on the option a user selects in an earlier picklist on the form. See the steps below to create a child picklist and read more on parent and child picklists in Configure a Picklist and Picklist Option: Parent and Child Picklists.

1. Click the picklist field you want to make a child picklist on the Form Builder. This will open the picklist’s properties on the sidebar.  
2. On the Properties tab, click the “Dependent” toggle. 
3. A dropdown menu will appear under the “Dependent” toggle, where you can select the parent picklist. All available picklists on the custom form will be displayed in this dropdown. 
4. Click the sidebar’s Save button.
5. Click the Value tab. The parent picklist will now be displayed above the “Value” and “Sequence” fields. 
6. Select a value from the parent picklist. Then, enter the values that should appear in the child picklist when that parent value is selected. 
   1. In the example below, when a user selects “Harassment” in the “Allegation” picklist, the following options will be displayed in the “Allegation sub type” picklist: Age, Disability, Gender, Marital status, Bullying, Sexual, Religious, National origin, Sexual orientation, and Cyber.
7. Click the Add button to create the child picklist values. You can review the picklist values and their parent values in the tab’s grid.
8. Click the sidebar’s Save button to save all picklist values for the child picklist.

Field Groups

A field group is a linked group of fields that capture multiple attributes about one person or location. For example, the "Location" field group contains fields for street address, city, state, country, and zip code. You can add, edit, rearrange, and delete field groups just like individual fields.

Add a Field Group

To add a field group to a custom form:

1. Make sure to open the custom form in the Form Builder and set the Form Builder in edit mode. 
2. Click the + Insert Fields section or the right arrow icon to open the Field Type sidebar. All field groups are at the top of the sidebar's list. The Custom Form Field Groups section of this article describes all available field groups and the fields they contain.
3. Click and hold a field group in the Field Type sidebar, drag it to the Form Builder, and let go of your cursor over the + Insert Fields section. 
4. In the field group pop-up, fill in the following fields: 
   1. Caption: type in the text to display in the field group header.
   2. Show on intake: choose if the field group should be displayed when a user is creating a new record of this custom form type.
      1. For example, if you add a field group to a custom form called "Interview" and set "Show on Intake" to "On", the group will appear on the New Interview Form when a user wants to add an interview record. 
      2. By default, "Show on Intake" is set to "Off", meaning that the field group will not be available on the form when adding a new record. 
      3. If you want to show any of the group's fields on intake, set the field group to show on intake. Then, you can choose the specific fields you want to show on intake by editing each field's properties in the group.
   3. Show on portal: choose if the field group should be displayed on your application’s external portal (the Report Online form). If you do not see the "Show on Portal" toggle, check if the custom form is set to show on portal (see the "Edit Form's Properties" tab of this article for details).
   4. Help text: enter discrete guidance text, which will only be displayed when the user hovers their cursor over a question mark icon beside the field group.
5. When you have finished selecting the field group's properties, click Save on the pop-up. The field group will now appear on the Form Builder. You can now edit the properties of each field in the group separately, just like any other field. See the "Fields" tab of this article for details.

Edit a Field Group

After adding a field group to a custom form, you can change the field group's properties while the record type is in edit mode. To update a field group’s properties, click the field group on the Form Builder. The sidebar will load the properties of the field group, where you can edit the field group's caption, change the intake channels for which it will be displayed, or create display rules (see the "Add a Display Rule to a Field group" section in this article tab below for details). Click the Save button at the bottom of the sidebar. Your changes to the field group will be published for your application's users when you publish the record type, see the "Publish" tab of this article for details. 

Move a Field Group

While the custom form is in edit mode, you can change the order of field groups on the form and the fields within the group. You can even move other fields on the custom form into the group. However, you cannot move fields originally part of the group out of the section. 

To move the entire field group, click and hold the group, move your cursor to another location, then let go of your cursor to place the field group. You can rearrange its fields in the same way by dragging and dropping them within the group. If your form has more than one tab, you can move a field group to another tab by dragging the group to the tab name and dropping the field on the Form Builder.

Delete a Field Group

You can delete a field group on the Form Builder using either of the following methods. Deleted field groups will not appear on records or in search results, but any data that users entered in the group's fields will not be deleted in the Case IQ system. You cannot restore a group or its fields after deleting a field group.

• Hover your cursor over the field group on the Form Builder and click the Delete icon.
• Click the field group on the Form Builder, then click the Delete button on the left sidebar.

Add a Display Rule to a Field Group

You can specify criteria for when a field group will be displayed based on the values a user enters in other fields on the custom form. A field group's display rules will be applied to all fields in the section. You can add more display rules to a group's fields, but the group's rules will take priority. To create display rules for a field group:

1. Click the field group on the Form Builder to load its properties on the sidebar.
2. Click the “Rules” tab in the sidebar, then click the Add Display Rule button.
3. In the Add Display Rule pop-up, you can set up criteria to tell the system to show the field group when a field on the custom form is set to a certain value. A criteria statement contains three parts: 1) a field, 2) an operator, and 3) a value. In the "Search fields..." dropdown, select a field on the record type for the criteria. 
   1. In the video example below, we created two criteria for the display rule and selected "Allegation type" as the field for both.
4. Another dropdown will be displayed beside the "Search fields..." dropdown after selecting a field. In the dropdown, select an operator for the criteria. The operator tells the system how to compare the field to the value in your criteria statement. 
   1. For example, if you select "Contains" as the operator, the system will show the field group when the field contains the value in your criteria.
   2. If you select "Is Empty" or "Is Not Empty" as the operator, you do not need to select a value for the criteria, as the system will show the field group when the field is empty or not empty respectively.
   3. In the video below, the operator for both criteria is "Is", which tells the system to display the field group when the field is set to the value in the display rule.
5. One or more additional fields will be displayed beside the operator dropdown. Enter or select a value for the criteria field in these fields. The system will look for this value in the field when determining whether to show or hide the field group.
   1. The input method to select the value depends on the criteria field's type. For example, if you choose a radio button field, you can select the value using radio buttons.
   2. In the video below, we chose a different value for each criteria: "Discrimination" and "Harassment". The first criteria tells the system that the field group should be displayed on the allegation when the "Allegation type" field is set to "Discrimination" while the second criteria says to display the group when the "Allegation type" field is "Harassment".
6. If the display rule should be dependent on more than one field, you can add another by clicking the + Criteria button. Then, repeat steps 3 to 5 to choose the field, operator, and value for the criteria.
7. If you add more criteria to the display rule, you can use the “All/Or" toggle below the criteria to set whether the record must meet all or one of the criteria on your list. 
   1. By selecting “All”, the field group will be displayed only if all criteria are met.
   2. Choosing “Or” means that the field group will be displayed even if only one of your criteria is met.
   3. In the video below, we chose "Or", meaning that the field group will be displayed if the "Allegation type" field is set to either "Discrimination" or "Harassment". 
8. When you have completed setting up criteria, click the Save button on the Display Rule pop-up. A connector icon will appear beside the group and all its fields.

After saving one display rule for a field group, you can add more display rules to show the group in multiple different situations. Click Add Display Rule again, set up another display rule in the Add Display Rule pop-up, and click Save. There will now be an "And/Or" toggle under the display rules. If you select "And", the group will not be displayed unless all of your display rules are met. If you choose "Or", the group will be displayed if it meets one of your display rules.

Sections

Organizing your custom form into sections can make long records easier to read. You can also create complex, dynamic custom forms by adding display rules for when to show sections. 

Add a Section

To add a section:

1. While the custom form is in edit mode, open the Field Type sidebar and find the “Section” element. 
2. Drag the “Section” element to the Form Builder. 
3. In the New Section pop-up, fill in the following fields:
   1. Caption: type in the text to display in the section header.
   2. Show on intake: choose if the section should be displayed when a user is creating a new record of this custom form type. By default, "Show on Intake" is set to "Off", meaning that the section will not be available on the form when adding a new record. 
   3. Show on portal: choose if the section should be displayed on your application’s external portal (the Report Online form). If you do not see the "Show on Portal" toggle, check if the custom form is set to show on portal (see the "Edit Form's Properties" tab of this article for details).
4. Click Save to create the section. 

The section will contain its own + Insert Fields button, where you can move or add fields.

Edit a Section

To update a section's properties, click the section on the Form Builder. The sidebar will load the properties of the section, where you can edit the section's caption, change the intake channels for which it will be displayed, or create display rules (see the "Add a Display Rule to a Section" section below in this article tab for details). Click the Save button at the bottom of the sidebar. Your changes to the section will be published for your application's users when you publish the custom form, see the "Publish" tab of this article for details. 

Move a Section

Similar to fields, you can rearrange the order of the section while the custom form is in edit mode. Click and hold the section, then drag it to a new location. If your form has more than one tab, you can move a section to another tab by dragging the section to the tab name and dropping the section on the Form Builder.

Delete a Section

You can delete a section if you would like to remove the section and all its fields from the custom form. You can use either of the following methods:

1. Hover your cursor over the section on the Form Builder and click the Delete icon.
2. Click the section on the Form Builder, then click the Delete button on the left sidebar.

Add a Display Rule to a Section

You can specify criteria for when a section will be displayed based on the values a user enters in fields on the custom form. A section's display rules will be applied to all fields in the section. You can add more display rules to a section’s fields, but the section’s rules will take priority. To create display rules for a section:

1. Click the section on the Form Builder to load its properties on the sidebar.
2. Click the “Rules” tab in the sidebar, then click the Add Display Rule button.
3. In the Add Display Rule pop-up, you can set up criteria to tell the system to show the section when a field on the form is set to a certain value. A criteria statement contains three parts: 1) a field, 2) an operator, and 3) a value. In the  "Search fields..." dropdown, select a field on the record type for the criteria. 
   1. In the video example below, we selected "Multiple allegations?" as the field.
4. Another dropdown will be displayed beside the "Search fields..." dropdown after selecting a field. In the dropdown, select an operator for the criteria. The operator tells the system how to compare the field to the value in your criteria statement. 
   1. For example, if you select "Contains" as the operator, the system will show the section when the field contains the value in your criteria.
   2. If you select "Is Empty" or "Is Not Empty" as the operator, you do not need to select a value for the criteria, as the system will show the section when the field is empty or not empty respectively.
   3. In the video below, the operator is "Is", which tells the system to display the section when the field is set to the value in the display rule.
5. One or more additional fields will be displayed beside the operator dropdown. Enter or select a value for the criteria field with these fields. The system will look for this value in the field when determining whether to show or hide the section.
   1. The input method to select the value depends on the field's type. For example, if you choose a radio button field, you can select the value using radio buttons.
   2. In the video below, the value is a checked checkbox, as "Multiple allegations?" is a checkbox field. This display rule tells the system that the section should be displayed on the form when the "Multiple allegations?" field is checked.
6. If the display rule should be dependent on more than one field, you can add another by clicking the + Criteria button. Then, repeat steps 3 to 5 to choose the field, operator, and value for the criteria.
7. If you add more criteria to the display rule, you can use the “All/Or" toggle below the criteria to set whether the form must meet all or one of the criteria on your list.  
   1. By selecting “All”, the section will be displayed only if all criteria are met.
   2. Choosing “Or” means that the section will be displayed even if only one of your criteria is met.
8. When you have completed setting up criteria, click the Save button on the Display Rule pop-up.

After saving one display rule for the section, you can add more display rules to show the section in multiple different situations. Click Add Display Rule again, set up another display rule in the Add Display Rule pop-up, and click Save. An "And/Or" toggle will now be shown under the display rules, which you can use to set if the section will be displayed if all or any of your display rules are met.

Tabs

You can organize long and complex custom forms by adding tabs, which will appear at the top of the form when a user adds or edits a record of your custom form type. Users can click through the tabs to see additional fields. You can add up to 6 tabs to a custom form.

Add a Tab

To add tabs to a custom form:

1. Click the + Add Tab button on the Form Builder while the custom form is in edit mode. 
   1. Any fields and sections currently on the custom form will be added to the first tab. If you add any additional tabs after that, they will be empty.
2. In the New Tab pop-up, fill in the following fields:
   1. Caption: type in the text to display in the tab header.
   2. Show on intake: choose if the tab should be displayed when a user is creating a new record of this custom form type. By default, "Show on Intake" is set to "Off", meaning that the tab will not be available on the form when adding a new record. 
   3. Show on portal: choose if the tab should be displayed on your application’s external portal (the Report Online form). If you do not see the "Show on Portal" toggle, check if the custom form is set to show on portal (see the "Edit Form's Properties" tab of this article for details).
3. Click the Save button to create the tab.

Edit or Delete a Tab

To edit a tab's properties or delete a tab, click the tab on the Form Builder. The tab’s properties will appear on the sidebar, where you can edit the tab’s caption, change the intake channels for which it will be displayed, or create display rules (see the "Add a Display Rule to a Tab" section below in this article tab for details). Your changes to the tab will be published for your application's users when you publish the custom form, see the "Publish" tab of this article for details. 

If you need to permanently delete the tab, click the Delete button at the bottom of the sidebar. When you delete a tab, its fields and sections will be deleted too. Fields that have not been published will be permanently deleted.

Move a Tab

You can reorder tabs just like fields. Click and hold the tab caption, then move your cursor to the left or right. Let go of your cursor when the tab is in the desired position.

Add a Display Rule to a Tab

You can specify criteria for when a tab will be displayed based on the values a user enters in fields on the custom form. To create display rules for a tab:

1. Click the tab caption to load its properties in the sidebar.
2. Click the “Rules” tab in the sidebar, then click the Add Display Rule button.
3. In the Add Display Rule pop-up, you can set up criteria to tell the system to show the tab when a field on the form is set to a certain value. A criteria statement contains three parts: 1) a field, 2) an operator, and 3) a value. In the  "Search fields..." dropdown, select a field on the record type for the criteria. 
   1. In the video example below, we selected "Allegation description" as the field.
4. Another dropdown will be displayed beside the "Search fields..." dropdown after selecting a field. In the dropdown, select an operator for the criteria. The operator tells the system how to compare the field to the value in your criteria statement. 
   1. For example, if you select "Contains" as the operator, the system will show the tab when the field contains the value in your criteria.
   2. If you select "Is Empty" or "Is Not Empty" as the operator, you do not need to select a value for the criteria, as the system will show the tab when the field is empty or not empty respectively.
   3. In the example below, the “Analysis” tab will be displayed when the "Allegation description" field is not empty, meaning that a user has begun typing in the "Allegation description" field.
5. One or more additional fields will be displayed beside the operator dropdown. Enter or select a value for the criteria field in these fields. The system will look for this value in the field when determining whether to show or hide the tab.
   1. The input method to select the value depends on the field's type. For example, if you choose a radio button field, you can select the value using radio buttons.
6. If the display rule should be dependent on more than one field, you can add another by clicking the + Criteria button. Then, repeat steps 3 to 5 to choose the field, operator, and value for the criteria.
7. If you add more criteria to the display rule, you can use the “All/Or" toggle below the criteria to set whether the form must meet all or one of the criteria on your list.  
   1. By selecting “All”, the tab will be displayed only if all criteria are met.
   2. Choosing “Or” means that the tab will be displayed even if only one of your criteria is met.
8. When you have completed setting up criteria, click the Save button on the Display Rule pop-up.

After saving one display rule for the tab, you can add more display rules to show the tab in multiple different situations. Click Add Display Rule again, set up another display rule in the Add Display Rule pop-up, and click Save. An "And/Or" toggle will now be shown under the display rules, which you can use to set if the tab will be displayed if all or any of your display rules are met.

Data Form Sections

You can add a data form section to a custom form so users can look up information and populate the data form’s fields. 

To add a data form section to a custom form:

1. While the custom form is in edit mode, open the Field Type sidebar and find the “Data Form Section” element. 
2. Drag the “Data Form Section” element to the Form Builder page. 
3. In the New Data Form Section pop-up, fill in the following fields:
   1. Caption: type in text to display in the data form section header on the custom form. 
   2. Data form: choose the data form template you want to add to the custom form.
   3. Show on intake: choose if the data form section should be displayed when a user is creating a new record of this custom form type. By default, "Show on Intake" is set to "Off", meaning that the section and its fields will not be available on the form when adding a new record. 
      1. If you want to show any of the data form’s fields on intake, set the section to show on intake. Then, you can choose the specific fields you want to show on intake by editing each field's properties in the data form section.
   4. Show on portal: choose if the data form section should be displayed on your application’s external portal. You can set this independently from the data form template. 
      1. If you choose to hide a data form template for the portal but show its data form section on a standard form for the portal, portal reporters will see the section’s fields on the Report Online form but will not be able to auto-populate the section. The data form section will be editable on the Report Online form, even if you set it as “Read Only” for the internal version of the record's form. This means that a portal reporter can manually enter data into the data form section’s fields but will not see the data form’s entries.
      2. If you want to show any of the data form’s fields on the portal, set the section to show on the portal. Then, you can choose the specific fields you want to show on the portal by editing each field's properties in the data form section.
   5. Help text: enter any guidance text for the data form. Help text will be displayed when the user hovers their cursor over a question mark icon beside the section.
4. Click Save to create the data form section. The fields of the data form template you selected will be added to the custom form and they will be available for users when you publish the custom form.

If you click a data form section field, you can edit its properties like any other form field. There will be two additional field properties for data form fields:

• Read Only: by default, data form section fields will not be editable, meaning that the field can only be auto-populated and users cannot change the field’s value. If you turn off “Read Only”, users can change the data form section field’s value.
• Mapped field: choose the data form field to auto-populate in the section’s field. Your “Mapped Field” selection tells Case IQ what data it should put in the field when a user auto-populates the data form section.

A field’s name or caption on the data form section does not need to match the data form template field to which it is mapped. The “Mapped Field” dropdown will list all fields on the data form template with the same data type as the field you are editing. In the example below, the “Address” field in the data form section is a textbox, so the options in the “Mapped Field” dropdown are the textbox fields on the data form template. You can map the same data form field to multiple fields in the data form section.

You can move a field into the data form section or out of it by clicking and holding a field, moving your cursor to another location, then letting go of your cursor to place the field. If you move a data form section field out of the section, its “Mapped Field” value will be removed. You can also move other fields into a data form section. Case IQ will add the “Mapped Field” property for the field, but it will be blank by default.

You can also delete data form section fields like any other form field by clicking the Delete button beside the field or on the left sidebar. Deleting fields in the data form section will remove the field for the custom form but will not affect the data form template or its entries.

Edit Form's Properties

You can edit a form’s properties, such as its name or whether to show it on intake. While the custom form is in edit mode, click the Edit icon beside the custom form's caption. You can edit the following properties of custom forms:

• Caption: enter a unique name of the custom form.
• Caption plural: enter the plural version of the custom form’s name.
• Show on intake: toggle to allow users to add records of your custom form type when they submit a case.
• Show on portal: toggle to allow users of your application’s external portal to add records of your custom form type when they submit a case.
• Automatic translation: toggle to display the “Automatic Translation” field property for text fields on your custom form. If you turn on “Automatic Translation” for a text field, the Translation Copilot will automatically generate translations for text in a different language than your application's default language when the custom form is initially submitted. This option will only be available if the Translation Copilot has been activated for your application.
• Sequence: choose the order in which the form will be displayed on the internal case intake form and portal form. For example, if you enter “2”, it will be the second form displayed on the New Case and Report Online forms.  
• Rules tab: set the criteria for when Case IQ should show the option to add a custom form on the case’s page, see the next section in this article tab, "Add a Display Rule to a Custom Form", for details.

Add a Display Rule to a Custom Form

You can choose for what cases users will be able to add records of your custom form type based on the case’s fields. If you create display criteria for a custom form, users will only see the option to add custom form records for cases that meet your criteria. 

For example, suppose your application contains an “Interview” custom form type. Using display rules, you can ensure users are only able to add “Interview” records for cases with a specific “Case Type”. You can set the “Interview” custom form’s display rules to only show the option to add “Interview” records to a case when the “Case Type” field is set to “Investigation”. 

If you update a case's details so it no longer meets your custom form's display rules, any existing custom form records will be retained and you will still be able to access them. However, as the case will no longer meet the display rule's criteria, you will not be able to add more custom form records of that type to the case.

To create display rules for a custom form:

1. While the custom form is in edit mode, click the Edit icon beside the custom form's caption.
2. Click the “Rules” tab in the sidebar, then click the Add Display Rule button.
3. In the Add Display Rule pop-up, you can set up criteria to tell the system to show the option to add records of this custom form type when a field on the case is set to a certain value. A criteria statement contains three parts: 1) a field, 2) an operator, and 3) a value. In the "Search fields..." dropdown, select a case field for the criteria. 
   1. In the video example below, we create a display rule for an "Allegation" custom form. We created two criteria for the display rule and selected "Case Type" as the field for both.
4. Another dropdown will be displayed beside the "Search fields..." dropdown after selecting a field. In the dropdown, select an operator for the criteria. The operator tells the system how to compare the field to the value in your criteria statement. 
   1. For example, if you select "Contains" as the operator, the system will show the option to add records of this custom form type when the field contains the value in your criteria.
   2. If you select "Is Empty" or "Is Not Empty" as the operator, you do not need to select a value for the criteria, as the system will show the option when the field is empty or not empty respectively.
   3. In the video below, the operator for both criteria is "Is", which tells the system to display the option when the field is set to the value in the display rule.
5. One or more additional fields will be displayed beside the operator dropdown. Enter or select a value for the criteria field in these fields. The system will look for this value in the field when determining whether to show or hide the option to add records of this custom form type.
   1. The input method to select the value depends on the field's type. For example, if you choose a radio button field, you can select the value using radio buttons.
   2. In the video below, we chose a different value for each criteria: "Investigation" and "Complaint". The first criteria tells the system that the option to add an "Allegation" record should be displayed on the case when the "Case Type" field is set to "Investigation" while the second criteria says to display the option when the "Case Type" field is "Complaint".
6. If the display rule should be dependent on more than one field, you can add another case field by clicking the + Criteria button. Then, repeat steps 3 to 5 to choose the case field, operator, and value for the criteria.
7. If you add more criteria to the display rule, you can use the “All/Or" toggle below the criteria to set whether the case must meet all or one of the criteria on your list. 
   1. By selecting “All”, the option to add a record of the custom form type will be displayed only if a case meets all criteria.
   2. Choosing “Or” means that the option to add a custom form record will be displayed even if the case only meets one of your criteria.
   3. In the video below, we chose "Or", meaning that the option will be displayed if the "Case Type" field is set to either "Investigation" or "Complaint". 
8. When you have completed setting up criteria, click the Save button on the Add Display Rule pop-up.

You can add multiple display rules for a custom form to set multiple different situations in which the option to add a custom form record should be displayed. Click Add Display Rule again, set up another display rule in the Add Display Rule pop-up, and click Save. An "And/Or" toggle will now be shown under the display rules, which you can use to set if users can add a custom form record if all or any of your display rules are met.

Publish

Publishing your new custom form will make the custom form type available for your users. If you previously published your custom form, you can make changes to the custom form in the Form Builder, then publish it again to make your changes available for your users.

To publish your custom form, click the Publish button on the Form Builder. Click Confirm on the "Publish changes?" pop-up to proceed. When you initially publish a new custom form type, Case IQ will add user role permissions to create, edit, delete, and view records of your custom form type. No user roles will have access to the new custom form yet, as you must manually grant permissions on a User Role’s page (see Manage a User Role for details on adjusting user role permissions). Case IQ will not update user role permissions when you publish changes to an existing custom form type.

Deactivate or Activate

When you deactivate a custom form, users cannot add new or view custom form records. To set a custom form type to “Inactive” status, load the custom form in the Form Builder, click the Form Builder’s Options () button, and select the “Deactivate” option. You can set an inactive custom form back to “Active” status by clicking the Publish button. Reactivating a custom form will restore all records of this type in the application.