Checklists

Checklists Module

The Checklists module allows users to create and manage checklists for maintenance activities. Each checklist can contain sections and questions that guide users through inspections or maintenance work.


1. Checklists Overview

The Checklists page displays the available checklists and provides options to search, filter, create, import, and manage checklists.

Checklists Overview

1.1 Checklists Page Options

OptionDescription
Search checklistsSearch for an existing checklist by name.
StatusFilter checklists based on their status.
TagFilter checklists using tags.
Import CSVImport checklist data from a CSV file.
Manage tagsManage the tags used for checklists.
+ New checklistCreate a new checklist.

2. Creating a New Checklist

To create a new checklist:

  1. Open the Checklists module.
  2. Click + New checklist in the top-right corner.
  3. The New checklist pop-up window is displayed.
  4. Enter the required checklist information.
  5. Configure the customer scope, tags, and site availability.
  6. Click Create checklist.

New Checklist


2.1 New Checklist Form

The New checklist pop-up contains the following fields:

New Checklist Form

SectionFieldDescription
GeneralName *Enter a clear and descriptive name for the checklist.
GeneralDescriptionEnter additional information about the checklist.
Customer ScopeAll customers (shared)Make the checklist available to all customers, or select a specific customer.
TagsCreate new tagCreate a tag to organize the checklist.
Site AvailabilityAvailable at all sitesMake the checklist available at all sites.
ActionsCancelClose the pop-up without creating the checklist.
ActionsCreate checklistCreate the checklist using the entered information.

2.2 Name

The Name field is required and is used to identify the checklist.

For example:

HVAC Preventive Maintenance

Enter a clear and descriptive name so users can easily identify the checklist.


2.3 Description

The Description field allows the user to provide additional information about the checklist.

For example:

Checklist for inspecting and maintaining HVAC equipment.

2.4 Customer Scope

The Customer Scope section controls which customers can access the checklist.

The user can leave the selection as All customers (shared) to share the checklist with every customer or select a specific customer.


2.5 Tags

The Tags section allows the user to organize the checklist using tags.

To create a new tag:

  1. Click + Create new tag.
  2. Enter the required tag information.
  3. Create the tag and associate it with the checklist.

2.6 Site Availability

The Site Availability section controls where the checklist is available.

When Available at all sites is selected, the checklist is available across all sites.


2.7 Create Checklist

After entering the required information:

  1. Verify the Name.
  2. Review the Description, if provided.
  3. Select the required Customer Scope.
  4. Configure the Tags, if required.
  5. Review the Site Availability.
  6. Click Create checklist.

The checklist is created and appears in the Checklists module, where it can be selected and configured.


3. Configuring the Checklist

After creating the checklist, select it from the checklist list to open its details.

The Build tab allows the user to add sections and questions.


3.1 Add a Section

The checklist can be organized into multiple sections.

To add a section:

  1. Open the required checklist.
  2. Go to the Build tab.
  3. Click Add section.
  4. Configure the section as required.
  5. Add questions to the section.

Multiple sections can be added to the same checklist.


3.2 Add Questions

After creating a section, questions can be added to the section.

The Add a Question section provides the following question types:

Add a Question

Question TypeDescription
TextAllows the user to enter a text response.
NumberAllows the user to enter a numeric response.
Yes / NoAllows the user to select Yes or No.
Pass / FailAllows the user to record whether an item passed or failed.
ConditionAllows the user to record a condition.
Working / Not WorkingAllows the user to indicate whether an item is working.
Single selectAllows the user to select one option.
Multi selectAllows the user to select multiple options.
DateAllows the user to select a date.
RatingAllows the user to provide a rating.
InstructionAllows the user to add instructions to the checklist.

3.3 Configure Questions

Each question can be configured according to the selected question type.

Depending on the question type, the user can configure the available options and settings.

Configure Questions

For example:

  • Add answer options for Single select.
  • Add multiple answer options for Multi select.
  • Configure the required settings for the question.
  • Add conditions where applicable.
  • Enable additional options such as comments, images, or voice notes when available.

3.4 Question Settings

Depending on the question type, the user can configure additional settings.

Question Settings

SettingDescription
RequiredMakes the question mandatory.
ScoredEnables scoring for the question.
Require commentRequires a comment when answering the question.
Require imageRequires an image when answering the question.
Require voice noteRequires a voice note when answering the question.
Add optionAdds another answer option to a selection question.
Add conditionAdds a condition to the question.

3.5 Edit a Question

If changes are required, an existing question can be edited.

Edit a Question

To edit a question:

  1. Select the required question.
  2. Modify the question or its configuration.
  3. Update the required options or settings.
  4. Save the changes.

The updated question remains within the checklist section.


3.6 Delete a Question

If a question is no longer required, it can be deleted.

Delete a Question

To delete a question:

  1. Locate the question that needs to be removed.
  2. Click the Delete option.
  3. Confirm the deletion, if prompted.

The question is removed from the checklist.


4. Save and Publish the Checklist

After configuring the checklist, the checklist is saved as a Draft until it is published.

Save as Draft

4.1 Draft Status

Before publishing, the checklist remains saved as Draft.

The user can continue to review, edit, add questions, or delete questions while the checklist is in Draft status.


4.2 Publish Checklist

To publish the checklist:

  1. Complete the checklist configuration.
  2. Review the sections and questions.
  3. Make any required edits or changes.
  4. Click Publish.
  5. The checklist is published and its status changes from Draft to Published.

4.3 Draft and Published Status

StatusDescription
DraftThe checklist is saved but has not yet been published.
PublishedThe checklist has been published and is available for use.

Draft Status


4.4 Checklist Publishing Workflow

Create Checklist
      ↓
Configure Sections
      ↓
Add Questions
      ↓
Configure Questions
      ↓
Save Checklist
      ↓
Draft
      ↓
Review / Edit
      ↓
Click Publish
      ↓
Published

5. Duplicate Checklist

The Duplicate option allows the user to create a duplicate copy of an existing checklist.

Duplicate a Checklist

To duplicate a checklist:

  1. Open the required checklist.
  2. Click the Duplicate button.
  3. A duplicate copy of the checklist is created.
  4. The duplicated checklist can then be edited or configured as required.

5.1 Duplicate Checklist Workflow

Open Checklist
      ↓
Click Duplicate
      ↓
Checklist Duplicated
      ↓
Edit / Configure if Required

6. Preview Checklist

The Preview option allows the user to view the checklist before using it.

Preview Checklist

To preview the checklist:

  1. Open the required checklist.
  2. Click the Preview tab.
  3. Review the checklist and its questions.
  4. Verify that the checklist is configured as expected.

7. Checklist History

The History option allows the user to view the history of the checklist.

Checklist History

The history displays the changes and activities performed on the checklist, allowing the user to review the details of previous updates.

To view the checklist history:

  1. Open the required checklist.
  2. Click the History tab.
  3. Review the available history records.
  4. View the details of the changes and activities recorded for the checklist.

7.1 Preview and History Workflow

Open Checklist
      ↓
   ┌───────────┐
   ↓           ↓
Preview      History
   ↓           ↓
View        View Checklist
Checklist   History Details

8. Import Checklist Using CSV

The Import CSV option allows the user to create one or more checklist templates using a CSV file.

When the user clicks Import CSV, the Import checklists pop-up is displayed.

Import Checklists


8.1 Download Template CSV

The Download template CSV option provides a CSV template that can be used to prepare checklist information for import.

To download and prepare the template:

  1. Click Import CSV.
  2. The Import checklists pop-up is displayed.
  3. Click Download template CSV.

Download Template CSV

  1. The CSV template is downloaded.
  2. Open the downloaded CSV file.
  3. Enter or edit the checklist information according to the template format.
  4. Save the CSV file.

Download Template CSV

Download Template CSV

The CSV file can contain information for one or more checklist templates.


8.2 Upload CSV

After preparing the CSV file, it can be uploaded to the system.

Upload CSV

To upload the CSV:

  1. Open the Import checklists pop-up.
  2. Click Click to upload CSV.
  3. Select the prepared CSV file.

Alternatively, the CSV file can be dragged and dropped into the upload area.

  1. The system reads the CSV file.
  2. Review the imported checklist information.
  3. Click Import to import the checklist templates.

Upload CSV


8.3 Imported Checklist Status

After the CSV file is uploaded and imported, the checklist templates are saved as Drafts.

Multiple checklist templates can be imported at the same time.

Each imported checklist is initially saved with Draft status.

The imported checklists can then be reviewed and published.


8.4 Publish Imported Checklists

After importing the CSV:

  1. The checklist templates are created.
  2. The imported checklists are saved as Drafts.
  3. Review the imported checklist details.
  4. Make any required changes.
  5. Select the checklist or checklists to be published.
  6. Click Publish.
  7. The selected checklist or checklists are published.

Multiple checklists can be published at the same time.

Upload CSV


8.5 CSV Import Structure

The Import checklists pop-up displays the CSV columns required for importing checklist templates.

CSV ColumnDescription
template_nameGroups rows into one checklist template.
template_descriptionDescription of the checklist template.
section_titleGroups items into sections.
item_labelThe question or instruction text.
item_typeDefines the type of checklist item, such as text, number, yes/no, pass/fail, multiple choice, checkbox, date, rating, or instruction.
requiredDefines whether the item is required.
item_descriptionHelper text displayed below the item label.
optionsOptions used for multiple-choice or checkbox items.
weightMaximum points the question is worth.
correct_answerDefines the correct answer for scored questions.
option_pointsDefines the points assigned to the available options.

9. Checklist Management

After a checklist has been created, the user can manage the checklist using the available actions.

The main checklist management options are:

  • Build
  • Preview
  • History
  • Publish
  • Duplicate
  • Edit
  • Delete

The user can configure the checklist, review it, view its history, duplicate it, and publish it as required.


10. Complete Checklist Workflow

The complete checklist creation and management workflow is:

Open Checklists
      ↓
      ┌─────────────────────────┐
      ↓                         ↓
+ New checklist             Import CSV
      ↓                         ↓
New Checklist              Download Template CSV
      ↓                         ↓
Enter Checklist Details     Edit CSV
      ↓                         ↓
Create checklist            Upload CSV
      ↓                         ↓
Draft                       Import
      ↓                         ↓
Add Section                 Draft
      ↓                         ↓
Add Questions               Review / Edit
      ↓                         ↓
Select Question Type        Select Checklist / Checklists
      ↓                         ↓
Configure Questions         Publish
      ↓                         ↓
Edit / Delete               Published
      ↓
Review
      ↓
Publish
      ↓
Published

10.1 Standard Checklist Workflow

+ New checklist
      ↓
New Checklist
      ↓
Enter Checklist Details
      ↓
Create checklist
      ↓
Draft
      ↓
Add Section
      ↓
Add Question
      ↓
Select Question Type
      ↓
Configure Question
      ↓
Edit / Delete if Required
      ↓
Review
      ↓
Publish
      ↓
Published

10.2 Imported Checklist Workflow

Import CSV
      ↓
Download Template CSV
      ↓
Edit CSV
      ↓
Upload CSV
      ↓
Import
      ↓
Draft
      ↓
Review / Edit
      ↓
Select Checklist / Checklists
      ↓
Publish
      ↓
Published

10.3 Checklist Management Workflow

Preview Workflow

Open Checklist
      ↓
Preview
      ↓
View Checklist
      ↓
Review Questions

History Workflow

Open Checklist
      ↓
History
      ↓
View Checklist History
      ↓
Review Changes and Activities

Duplicate Workflow

Open Checklist
      ↓
Duplicate
      ↓
Checklist Duplicated
      ↓
Edit / Configure
      ↓
Review
      ↓
Publish

11. Final Checklist Module Workflow

The complete end-to-end workflow for the Checklists module is:

Open Checklists
      ↓
      ┌───────────────────────────────┐
      ↓                               ↓
Create New Checklist              Import CSV
      ↓                               ↓
Enter Checklist Details           Download Template CSV
      ↓                               ↓
Create Checklist                  Edit CSV
      ↓                               ↓
Draft                             Upload CSV
      ↓                               ↓
Add Section                       Import
      ↓                               ↓
Add Question                      Draft
      ↓                               ↓
Select Question Type              Review / Edit
      ↓                               ↓
Configure Question                Select Checklist / Checklists
      ↓                               ↓
Edit / Delete if Required         Publish
      ↓                               ↓
Review                            Published
      ↓
Preview / History
      ↓
Publish
      ↓
Published

Final Status Flow

Create Checklist
      ↓
Draft
      ↓
Configure
      ↓
Review
      ↓
Publish
      ↓
Published

Final CSV Flow

Import CSV
      ↓
Download Template
      ↓
Edit CSV
      ↓
Upload CSV
      ↓
Import
      ↓
Draft
      ↓
Review / Edit
      ↓
Publish One or More Checklists
      ↓
Published