Using the Visual Checklist Designer

The Visual Checklist Designer allows you to create, edit, and delete checklist sections, questions, and answers, all from one page. This tool offers an alternative to using the Checklist Design Loader or the traditional checklist design options. It also prevents the need to manage a separate object record for each modification to the checklist, such as adding dependencies, questions, and reference documents. An Admin can configure which fields are required or optional in each Section, Question, and Available Answer section.

The Visual Checklist Designer is the default view when you create and save a new Checklist Design record or select a Checklist Design record from the object record list page.

The Visual Checklist Designer contains various options for assembling a checklist specific to your needs:

The top right corner of the Visual Checklist Designer contains the following options:

  • Language: Allows you to add or manage translations for the Checklist Design.
  • Reorder Sections: Opens a new page that allows you to manually reorder the sections of the checklist.
  • View Record Detail Page: Returns you to the Checklist Design record detail page.
  • Preview Design: Opens a preview of the checklist.

Left Navigation Pane

The left navigation pane shows all sections within your checklist. Each section displays as a link that directs you to the section and its related content. Click the Add Section button to add Introduction and Question sections to the checklist.

Main Area

The middle of the page contains editing options for your Question and Introduction sections. When you first access the Visual Checklist Designer, a default Question Section displays with a blank question you can edit.

Designing Introduction & Question Sections

Introduction and Question sections provide many options for designing your checklist. For example, you can create headers for your checklist or include a variety of question types, such as text, multiple choice, and date selection questions. You can also edit an Introduction Section by clicking the section itself in the middle of the page. You can configure optional fields from the Checklist Types page to display on the checklist. See below for information on designing each type of section.

How to Create a Section

To create a new section:

  1. Click the Add Section button in the left navigation pane.
  2. In the Create Section window, select Question Section or Introduction Section from the Section Design Type drop-down.
  3. Optional: If you select Question Section, enter a Name for the section.
  4. Optional: If you select Introduction Section, enter a Name and Header for the section.
  5. Click Create.

How to Design an Introduction Section

The standard field available for an Introduction Section is the Header. The Header displays at the top of the checklist at all times. Choose a header that applies to the type of checklist you’re creating. An optional Description field may display in the Create Section dialog if configured from the Checklist Types page.

How to Design a Question Section

When you create a Question section, it includes a blank question by default. To design the question:

  1. Select the question type: Text, Date, Number, Multiple Choice, Dropdown, or Checkbox.
  2. Type your question in the Enter a question field.
  3. Optional: If you selected Multiple Choice, Dropdown, or Checkbox, you can add multiple answer choices for these question types.
  4. Click Save. Vault saves your new question to the Question section.

The Additional Configuration panel allows you to add other settings around the question for the respondent to complete. The following options display without expanding the Additional Configuration panel:

  • Required: Marks this question as required on the checklist for the respondent.
  • Reference Document: Allows you to add a reference document to the question for the checklist respondent to view.

If you expand the Additional Configuration panel, the following fields display:

  • Attachments: Allows respondents to upload attachments to the question.
  • Comments: Allows or requires respondents to add comments to the question.
  • Maximum Selectable Answers: Allows you to enter the maximum number of answers a respondent can select. This field displays only if you select the Checkbox question type.

Click the Actions menu next to an Answer field to display the following optional fields. These fields, included in the Actions menu, display only if configured from the Checklist Types page:

  • Documents Allowed: Allows respondents to add a single document to the answer.
  • Documents Required: Requires respondents to add one or multiple documents to the answer.

Additional optional fields may display in the Additional Configuration panel if configured from the Checklist Types page, such as Help Text, Score, and Decimal Places.

How to Add Library Questions

When creating or editing a question, you can add questions from the question library to your checklist. The available questions are pre-filtered based on the selected question type in the Visual Checklist Designer. Once added, Vault copies all values from the library question to the checklist question, such as multiple-choice answers, reference documents, and field selections. However, you can edit these values as they are not tied to the library question. This functionality also applies to dependent questions.

To create a new library question:

  1. Create a new question or edit an existing one.
  2. Click the Add Question From Library icon in the Enter a question field.
  3. In the Search: Library Question dialog, use the search field or Filters to locate and select a library question. The Filters drop-down defaults to the question type on the checklist. Change the question type if needed.
  4. Click Add.
  5. Vault populates the checklist question with the library question’s details, including fields and their values. Edit the question as needed and click Save.

Save Questions to the Library

The Visual Checklist Designer also allows you to save checklist questions to the library. Vault copies all fields and their values on the checklist question, such as answers, reference documents, and help text, to the library when performing this function. If a question contains dependent questions, the dependencies are not saved to the library.

When editing a question, click the drop-down on the Save button. Then, click Add to Library. A green banner displays on the screen notifying you the question was added successfully.

Creating Dependencies

The Visual Checklist Designer allows you to create dependent sections and questions without the need to create a Dependency Design record. Checklists with dependencies allow respondents to follow multiple paths to completing a checklist, and removes non-pertinent questions based on their selections. For example, answering Yes to a Yes/No question could expose a series of follow-up questions, whereas answering No would not show the irrelevant questions.

Dependencies are split between dependent sections or questions and controlling questions. For example, section A contains questions Q1, Q2, and Q3. If Q2 and Q3 are assigned as dependent on Q1, Q1 becomes the controlling question. The same rule applies if section B is assigned as dependent on Q1 in section A. Section B becomes dependent on the controlling question in section A.

Dependencies

To configure a dependency:

  1. Select the Dependency checkbox on a Multiple Choice or Dropdown question type.
  2. Select Add Dependent Question or Add Dependent Section under the Answer fields.
  3. Select the dependent question or dependent section from the Add Dependent Question or Add Dependent Section dropdown.
  4. Click Save. The dependent section or question will display under the controlling question.

Dependency Hierarchy

Dependent sections and questions follow a specific hierarchy:

  • Section Hierarchy: At the section level, any dependent sections will align under the section with the controlling question. For example, if question Q1 in section A is controlling of section B and C, both sections will display under section A with a single indention in the left panel.

  • Question Hierarchy: Dependent and controlling questions must be within the same section. Each dependent question displays under the controlling question with its corresponding level (L1, L2, L3). For example, section A contains questions Q1, Q2, and Q3. If Q2 is assigned as a dependent of Q1, Q2 will display as an L1 dependent question and change to Q1.1. Likewise, if Q3 is assigned as dependent on Q2 (which is now Q1.1), Q3 will display as an L2 dependent question and change to Q1.1.1. If section A contains Q4 and Q5, they will change to Q2 and Q3 respectively. Furthermore, if Q4 and Q5 are assigned as dependent on Q1, they will change to Q1.2 and Q1.3 and display after Q1.1 in the L1 dependent questions.

  • Answer Hierarchy: The answer hierarchy controls the order of the dependent questions and dependent sections. For example, Q1 contains answers A, B, and C. If a dependent question is added to answer B, it will display as Q1.1 in the L1 dependent questions. Then, if a dependent question is added to answer A, it will display as Q1.1 and move answer B’s dependent question to Q1.2.

Vault automatically reorders dependent questions and sections based on this hierarchy:

  • Section Reorder: Each section is reordered by their hierarchy. For example, if section A is in 7th place and section B is in 2nd place in the left pane, section B will automatically move to 8th place if it becomes dependent on a question in section A. The same rule applies to dependent questions.

    In addition, the hierarchy of questions can control the order of sections. For example, if section B is dependent on the controlling question Q1 in section A, and section C is dependent on Q2 in section A, section B will display before section C in the left pane.

    The hierarchy of answers can also control the order of sections. For example, if section Y is dependent on answer A of the controlling question Q1 in section X, and section Z is dependent on answer B of Q1, section Y will display before section Z in the left pane.

  • Question Reorder: The same rule applies to questions. For example, section A contains Q1, Q2, Q3, and Q4. If Q2 and Q3 are assigned as dependent on Q1, they will move to the L1 dependent questions as Q1.1 and Q1.2 and Q4 will change to Q2.

    If Dependent sections exist on a Checklist Design record and don’t follow the order mentioned above, a warning dialog window will display when viewing the checklist in the Visual Checklist Designer. The warning will state that the checklist’s sections will be reordered. Upon confirmation, Vault will then automatically reorder these sections after the Visual Checklist Designer is launched. If you click Cancel on the warning dialog window, you will be returned to the Checklist Design record detail page.

Managing Checklist Translations

The Language drop-down offers tools to translate your checklist into another language. Each available language corresponds to a Checklist Design Translation record for the Checklist Design. If your Vault contains no Checklist Design Translation records, the base language and Manage Languages are the only options available in the drop-down. Languages with a Checklist Design Translation record in the Obsolete state are not available for selection.

Manage Languages allows you to add and remove languages for the checklist. Adding a language creates a new Checklist Design Translation record for the selected language. You can only add languages available in your Vault. Removing a language deletes all of its translations, including its Checklist Design Translation record. You cannot remove a language in the Obsolete or Approved state.

Once you switch to a new language, click Translate to add or edit the translations for the checklist name, sections, questions, and answers. You can also upload a translated Question Design Reference Document in the new language to reference document fields. In Translate mode, the left side of the screen shows text in the original language, while the right side allows you to edit text in the new language. Only sections, questions, and answers configured to display from the Checklist Types page are available for editing. A green check mark displays next to the section title in the left navigation pane when all fields on the right side contain a saved translation value. If elements of the checklist, such as questions, answers, and sections, are already translated when you switch to a new language, the translations display on screen before you click Translate.

Limitations

The Visual Checklist Designer includes the following constraints:

  • Custom fields and custom object types are not supported.
  • You cannot delete a controlling question or dependent questions and sections. You must first unlink all the dependent questions or sections. To unlink a dependency, return to the controlling question and unselect the Dependency checkbox.
  • The Visual Designer option is not available under the Actions menu for aggregate checklists.
  • You can only configure up to three levels of dependent questions. For example, if Q1.1 is dependent on Q1, Q1.1.1 is dependent on Q1.1, and Q1.1.1.1 is dependent on Q1.1.1, that is three levels of dependency.
  • The Add Dependent Section button is disabled after three (3) levels of dependent sections are created. This applies when creating a dependent section after a third-level dependent question.

The following permissions control your ability to manage sections and questions, including reference documents and dependent questions and answers, using the Visual Checklist Designer:

  • Objects: Read on the Checklist Design object and its related fields
  • Objects: Read, Edit, Create, and Delete permission on all fields and object types within the following objects:
    • Section Design
    • Question Design
    • Available Answer Design
    • Question Design Reference Document
    • Dependency Design

The Objects: Read and Create permissions on the following objects following permissions control your ability to add library questions to your checklist and save checklist questions to the library:

  • Library Question
  • Answer Library Design
  • Library Question Reference Document

If a user only has Read permission on the Question Design Reference Document and Dependency Design objects or any of their related fields, an error will occur if they attempt to create, edit, or delete a record from these objects.

The following permissions are required on the following objects to manage translations in the Visual Checklist Designer:

  • Checklist Design Translation
    • Read, Create, Delete
    • Read on the Language field
  • Checklist Field Translation
    • Read, Create, Edit, and Delete
    • Read and Edit on all fields in the object

View Mode Behavior

If a user has no access to the following objects or any of their fields, View mode is displayed and all elements in the checklist are hidden to the user:

  • Section Design
  • Question Design
  • Available Answer Design
  • Dependency Design
  • Question Design Reference Document

If a user is granted only Read permission to the following objects, or the Checklist Design record is not in Draft, the Visual Checklist Designer displays in View mode and the user cannot make changes to any sections, questions, or answers:

  • Section Design
  • Question Design
  • Available Answer Design