Design Reviews

Overview

The Design Review module is used to register, track, and resolve design review activities and issues during construction and commissioning projects. It supports assignment, status tracking, linking to related records, rich text summaries, and structured checklists for systematic review.

Key Concepts

• Design Review: A record representing a review of design documents, drawings, or specifications, including issues, assignments, and status.

• Checklist: Structured review points for each design review, ensuring all critical aspects are evaluated.

• Status: The current state of the design review (Draft, In Progress, Completed, Cancelled).

• Assignment: Design reviews can be assigned to users or agents for action.

• Related Record: Design reviews can be linked to other records (e.g., checklists, components) for context.

• Rich Text Summary: The summary field supports rich text formatting for detailed notes.

Main Pages

1. Design Review List

• Purpose: View, filter, and manage all design reviews.

• Key Fields:

  • Code: Unique identifier for the design review.

  • Description: Brief summary of the review.

  • Assigned To: User responsible for the review.

  • Status: Current status (Draft, In Progress, Completed, Cancelled).

  • Due Date: Deadline for review completion.

  • Related RecordId: Links to another record in the system.

  • Last Modified: Timestamp of last modification.

• Actions:

  • Open Related Record: Opens the record linked in the Related RecordId field.

2. Design Review Card

• Purpose: View and edit details of a single design review.

• Sections:

  • General: Main details (description, assignment, status, due date, related record).

  • Summary: Rich text field for detailed notes or instructions.

  • Checklist: List of review points (see below).

  • FactBoxes: Show attached documents and system links.

• Actions:

  • Open Related Record: Opens the linked record for more context.

3. Design Review Checklist

• Purpose: Manage the individual review points for each design review.

• Key Fields:

  • BOD: Basis of Design review.

  • Specification: Specification review.

  • Schedule Meets Requirements: Boolean indicating if schedule is met.

  • Drawing Meets Requirements: Boolean indicating if drawing is met.

  • Details Meets Requirements: Boolean indicating if details are met.

  • Sequence of Operation Meets Requirements: Boolean indicating if sequence is met.

  • Description of Resolution: Text field for documenting resolution of any deviations.

How to Use

Creating a Design Review

1. Go to Design Review List and select New.

2. Fill in the required fields: Description, Assigned To, Due Date, etc.

3. Optionally, link the design review to another record using the Related RecordId field.

4. Enter a detailed summary in the Summary rich text field.

5. Add checklist items in the Checklist section of the card page.

Assigning and Tracking

• Assign design reviews to users or agents using the Assigned To and Assigned To Agent fields.

• Track progress using the Status field.

• Use filters on the list page to monitor your assigned reviews.

Working with the Checklist

• For each design review, add checklist lines specifying what needs to be reviewed.

• Update the Boolean fields as you review each aspect.

• Record any issues and their resolutions in the Description of Resolution field.

Linking to Other Records

• Use the Related RecordId field to link a design review to another record (e.g., a checklist, component, or document).

• The Table No. and Table Caption fields are automatically updated based on the related record.

Field Descriptions

Status Values

• Draft: Design review is being prepared.

• In Progress: Review is ongoing.

• Completed: Review is finished.

• Cancelled: Review is cancelled.

Tips

• Use filters on the Design Review List to quickly find reviews by status, assignment, or due date.

• Use the Checklist to ensure all critical aspects are reviewed and documented.

• Always update the status and summary fields as work progresses for accurate tracking.

Security & Permissions

• Only users with appropriate permissions can create, edit, or assign design reviews.

• Assignment fields are validated against user and agent tables.

Troubleshooting

• If you cannot see or edit a design review, check your permissions and assignment.

• If the Related RecordId is not set, ensure you are linking to a valid record.