Checklist
Overview
The Checklist module is designed to help users manage, assign, and track checklists for various commissioning and construction-related activities. It supports categorization by test types, scenarios, and zones, and allows for assignment and status tracking.
Key Concepts
-
Checklist: A record representing a set of tasks or checks to be performed.
-
Checklist Line: An individual item or point within a checklist.
-
Test Type & Scenario: Used to categorize and filter checklists.
-
Assigned To/By: Tracks responsibility for checklist completion.
-
Status: Indicates the progress of the checklist (Draft, In Progress, Completed, Cancelled).
Main Pages
1. Checklists List
-
Purpose: View, filter, and manage all checklists.
-
Key Fields:
-
Code: Unique identifier for the checklist.
-
Description: Brief summary of the checklist.
-
Assigned To: User responsible for the checklist.
-
Status: Current status (Draft, In Progress, Completed, Cancelled).
-
Due Date: Deadline for completion.
-
Test Type/Scenario/Zone: Categorization fields.
-
Related RecordId: Links to another record in the system.
-
-
Actions:
-
Open Related Record: Opens the record linked in the Related RecordId field.
-
2. Checklist Card
-
Purpose: View and edit details of a single checklist.
-
Sections:
-
General: Main details (description, assignment, status, due date, categorization).
-
Summary: Rich text field for detailed notes or instructions.
-
Checklist Lines: List of individual points to be checked.
-
FactBoxes: Show related deviations and attached documents.
-
-
Actions:
-
Open Related Record: Opens the linked record for more context.
-
3. Checklist Lines
-
Purpose: Manage the individual points or tasks within a checklist.
-
Key Fields:
-
Number/Point: Identifiers for the checklist line.
-
Description: What is to be checked.
-
Status: Passed, Failed, N/A.
-
Comment/Value: Additional notes or measurement results.
-
Component No./Description: Link to a construction component.
-
System/Built Space Description: Contextual information from related records.
-
-
Actions:
-
Deviations: Open and manage deviations related to this checklist line.
-
4. Checklist Activities
-
Purpose: Dashboard showing counts of checklists by status (Draft, In Progress, Completed, Cancelled) for the current user.
-
Drilldown: Click on a cue to see the filtered list of checklists.
How to Use
Creating a Checklist
-
Go to Checklists and select New.
-
Fill in the required fields: Description, Assigned To, Due Date, Test Type, etc.
-
Add checklist lines in the Checklist Card under the Checklist Lines section.
-
Optionally, link the checklist to another record using the Related RecordId field.
Assigning and Tracking
-
Assign checklists to users or agents using the Assigned To and Assigned To Agent fields.
-
Track progress using the Status field.
-
Use the Checklist Activities dashboard to monitor your assigned checklists.
Working with Checklist Lines
-
For each checklist, add lines specifying what needs to be checked.
-
Update the Status and Comment/Value as work progresses.
-
Record deviations if issues are found.
Linking to Other Records
-
Use the Related RecordId field to link a checklist to another record (e.g., a building zone, component, or document).
-
Use the Open Related Record action to quickly navigate to the linked record.
Field Descriptions
|
Field |
Description |
|---|---|
|
Code |
Unique identifier for the checklist |
|
Description |
Brief summary of the checklist |
|
Summary |
Rich text field for detailed notes |
|
Test Type Code |
Categorizes the checklist by test type |
|
Test Scenario Code |
Further categorizes by scenario |
|
Test Zone Code |
Specifies the zone for the test |
|
Due Date |
Deadline for checklist completion |
|
Status |
Progress status (Draft, In Progress, Completed, Cancelled) |
|
Assigned By |
User who created or assigned the checklist |
|
Assigned To |
User responsible for completing the checklist |
|
Assigned To Agent |
Construction agent responsible |
|
Related RecordId |
Links the checklist to another record in the system |
|
Table No./Caption |
Shows the table number and caption of the related record |
Tips
-
Use filters on the Checklists list to quickly find checklists by status, assignment, or due date.
-
Use the Checklist Activities dashboard for a quick overview of your workload.
-
Always update the status of checklist lines as you work to ensure accurate tracking.
Security & Permissions
-
Only users with appropriate permissions can create, edit, or assign checklists.
-
Assignment fields are validated against user and agent tables.
Troubleshooting
-
If you cannot see or edit a checklist, check your permissions and assignment.
-
If the Related RecordId is not set, ensure you are linking to a valid record.