The project Design Reviews page is the central location for all project stakeholders to perform and manage structured reviews of a Workspace design project. The interface allows the creation, access and management of Design Review instances by any Workspace member, which in turn can be assigned to other Workspace members as Reviewers. The Design Review creator (the ‘Initiator) can add attachments and formalized Checklist items, and has full control over the Design Review completion/approval process.
Create, configure, manage and conclude Project Design Reviews assessed by specified Workspace Members.
Completed project Design Reviews help to identify design issues, provide a traceable compliance record, and ensure that the design meets company requirements and standards. Design projects support multiple Design Reviews, which can be created at any time through the project’s development such as prior to its Release, or when passing the design to another team or contractor/manufacturer.
If your organization requires an advanced enterprise-level approach to design reviews, Altium 365’s Workspace Processes offer highly configurable, formalized Workflows that tightly control user activities such as approval reviews, project creation and interaction with PLM systems. See Processes & Workflows for more information.
The Design Review process, as outlined here, is available as a defined process workflow that can be duplicated and modified to suit your specific needs. See Creating a Custom Design Review below for details.
Creating Reviews
In the Workspace Web Viewer, project Design Review instances are created and accessed from the project's Design Reviews page. The review will apply to the currently open project (in its current state) and be available to all Workspace members who have access to the project itself. Note that only Workspace members (and not Workspace Guests) can participate in Design Reviews – see the below slideshow for more information.
See the Admin Checklists page for information on managing Design Review Checklists.
A new Design Review instance also can be invoked from:
-
the
menu in the Workspace project’s Design view. Note that the menu also includes options to Edit or Clone the current project.
-
the
menu in the Workspace project’s Releases view.
-
Altium Designer’s project Share dialog when Design Review is selected and the project has no active (In Progress) reviews. Otherwise, the dialog will present a tiled list of the project’s active Design Reviews.
See Support for Design Reviews for information related to Altium Designer.
Note that a created Design Review can be canceled by the review Initiator (or a Workspace administrator) from the review tile's
menu.
Design Reviews also include the direct ability to open a comparison of the snapshot’s Schematic, PCB and BOM documents with those of previous project Commit events. Select a SCH/PCB/BOM document tab entry to see a comparison summary of its changes since the most recent Commit event, and click the Open Compare command to access that design data comparison. Use the Compare to Commit <date> menu options to select another Commit event for the comparisons. View a representative BOM comparison and Schematic comparison for this example.
See the Design Data Comparisons page for information on performing design document comparisons.
Review Design Snapshot
The Design Snapshot view corresponds to the state of the project design when the Design Review instance was created and offers the features available in the normal WIP design view, including full document navigation, net highlighting, cross-probing, and commenting.
Along with the ability to inspect the design in its review state, the snapshot view also provides a dedicated Design Review pane that summarizes the current review status, provides access to the comparisons (see above), and allows the actioning of the review’s Checklist items.
The Design Snapshot's Design Review pane includes review status information and provides access to the Checklist items.
In the Design Snapshot view, placed Comments and their assignment to user Tasks are directly associated with the Design Review. The review will include only those Comments and Tasks, and not show any existing Comments/Tasks from the source WIP design. A placed Design Review Comment will include a From: <design review> entry that links to the review Overview.
Design Snapshot Comments and any associated Tasks directly apply to the Design Review.
Design Review Tasks
The Design Review Tasks view includes general task requests created from Comments placed in the Design Snapshot view and Initiator/Reviewer tasks generated by the Design Review process. Design Review Tasks also are available through both the Projects Tasks and Workspace Tasks views.
Comment Tasks, which are associated with a specific project (snapshot) document, can be managed and progressed by all Workspace members who have access to the project. Select a Task tile to open the Information pane and access its details (Status, Assignee, Priority, etc), add a further comment, or cross-probe to the comment in the design view (Show in Design).
See Working with Tasks for more information.
Tasks associated with the Design Review appear in the review's own Tasks view and also show in the main Project Tasks view.
A Design Review instance automatically creates associated process Tasks for both Reviewers and Initiators. These update and progress to completion with the Design Review process but also can be directly managed and progressed through the Tasks view by their Assignee (the task’s assigned Initiator or Reviewer). Select a Task tile to open the Information pane and access its details along with the Activity view mode.
See Completing Reviews from the Tasks Page below for related information.
Completing Reviews
Workspace members who have been assigned as Reviewers are requested to evaluate the design within the stated review scope, complete any Checklist items, and finally accept or reject the results via the
option. During this process, Reviewers can inspect changes through BOM/Schematic/PCB comparisons, add/save/complete Checklist items, and place review Comments and associated Tasks.
A Reviewers contribution to the Design Review is completed when their assessment is registered as Approve or Reject in the Review pane, where their name (under Reviewers in the Overview) will be highlighted in green and marked accordingly.
Finalizing Reviews
A Design Review is finalized and moved to a closed read-only state by the review Initiator by selecting a Completed, Rejected or Cancelled state from the
button menu. Only the review’s Initiator or a Workspace Administrator can finalize a Design Review. This is not dependent on the assigned Reviewers having completed their review process, and therefore can occur at any time.
The expected course of events would be for design Reviewers to have completed the review Checklist, dealt with any review Comments/Tasks, and submitted their review assessment as Approve or Reject (see above). The Design Review Initiator then moves the review to a finalized closed state.
Design Reviews also are represented in a WIP project’s Tasks view as individual tasks for both the review’s Initiator and its nominated Reviewers, and can in fact be completed by resolving these tasks. See more information in the collapsible section below.
Completing Reviews from the Tasks Page
While reviews are normally conducted through the review instance in the Design Review's Overview page, they can be progressed to a closed state in the project Tasks page by resolving the review's associated tasks – for access, open the Design Review Tasks page, the Projects Tasks page or the Workspace Tasks page. From these views the Design Review flow can be performed by advancing these Design Review tasks to a Resolved state.
The process of completing a Design Review from the Tasks page involves each Workspace member associated with the review (Initiator and Reviewers), who submit an assessment in their assigned tasks. Note that a review's Checklist is not accessible when using this approach to complete a Design Review.
Creating a Custom Design Review
Related page: Defining a Process Workflow
While the Design Review feature is coded to provide a specific set of capabilities and options, its procedural flow and additional options are determined by its Process Workflow. The related process – Design Review – is available to Workspace administrators through the Admin – Processes page, where it can be modified and saved as an alternative design review process.
You also can create a new custom process from scratch by applying the dedicated design review elements used by this workflow (as available under the Project Activities theme).
The custom design review example shown here provides the review Initiator with a choice of two review type paths – Schematic and PCB – which are each assigned to users in their related Workspace Groups. The results from each review type are received and summarized by the review Initiator, which closes the design review with a Completed or Unacceptable status.
An example of a custom workflow definition (DRplus) that becomes available as an alternative process for the Design Review feature.
To create a new custom process workflow for the Design Review feature, choose the Project Activities theme tab on the Workspace Admin - Processes page and select the
button to open the Process Workflow Editor. A process is created by diagrammatically arranging the required Start, Task and Branching elements, and also adding branching decision logic and variable-based controls to user-access Forms.
See the below images for an overview of the main Forms used in the above design review process example – the images reflect the view when editing or creating a workfow (Admin - Proceses page).
When complete and enabled on the Admin - Processes page, the custom process will be available for selection when invoking a new Design Review instance. The review UI will adopt the command options and flow structure defined by the custom process., as shown below for the example process.