Design Review
IRI: https://w3id.org/altium/cdm/design/DesignReview
GRID: grid:workspace:{workspace-id}:design:design-review/{id}
A structured assessment of a design project, carried out by assigned Reviewers on a fixed snapshot of its design and concluded by the Initiator's decision, which leaves a traceable record of the review.
In the product
- Design Reviews (primary)
Diagram
---
config:
layout: elk
class:
hideEmptyMembersBox: true
---
classDiagram
direction LR
class des_DesignReview["Design Review"]
style des_DesignReview fill:#93c47d,stroke:#607f51,color:#14181f,stroke-width:2.5px
click des_DesignReview href "../../classes/des_DesignReview/"
des_DesignReview --> "1" des_Project : project
click des_Project href "../../classes/des_Project/"
class des_Project["Hardware Project"]
style des_Project fill:#93c47d,stroke:#607f51,color:#14181f,stroke-width:1px
des_DesignReview --> "0..1" des_ProjectRelease : review context
click des_ProjectRelease href "../../classes/des_ProjectRelease/"
class des_ProjectRelease["Hardware Project Release"]
style des_ProjectRelease fill:#93c47d,stroke:#607f51,color:#14181f,stroke-width:1px
des_DesignReview --> "1" plt_WorkspaceUser : initiator
click plt_WorkspaceUser href "../../classes/plt_WorkspaceUser/"
class plt_WorkspaceUser["Workspace User"]
style plt_WorkspaceUser fill:#cccccc,stroke:#858585,color:#14181f,stroke-width:1px
des_DesignReview --> "*" plt_WorkspaceUser : reviewers
click plt_WorkspaceUser href "../../classes/plt_WorkspaceUser/"
class plt_WorkspaceUser["Workspace User"]
style plt_WorkspaceUser fill:#cccccc,stroke:#858585,color:#14181f,stroke-width:1px
des_DesignReview --> "0..1" cus_Workflow : workflow
click cus_Workflow href "../../classes/cus_Workflow/"
class cus_Workflow["Workflow"]
style cus_Workflow fill:#a2c4c9,stroke:#697f83,color:#14181f,stroke-width:1px
des_DesignReview --> "*" col_Task : tasks
click col_Task href "../../classes/col_Task/"
class col_Task["Task"]
style col_Task fill:#6fa8dc,stroke:#486d8f,color:#14181f,stroke-width:1px
des_DesignReview --> "*" col_CommentThread : comment threads
click col_CommentThread href "../../classes/col_CommentThread/"
class col_CommentThread["Comment Thread"]
style col_CommentThread fill:#6fa8dc,stroke:#486d8f,color:#14181f,stroke-width:1px
des_DesignReview --> "1" des_DesignReviewStatus : status
click des_DesignReviewStatus href "../../enums/des_DesignReviewStatus/"
class des_DesignReviewStatus["Design Review Status"]
style des_DesignReviewStatus fill:#93c47d,stroke:#607f51,color:#14181f,stroke-width:1px
des_DesignReview : id
class ins_DesignInsight["Design Insight"]
style ins_DesignInsight fill:#a64d79,stroke:#6c324f,color:#ffffff,stroke-width:1px
ins_DesignInsight --> "1" des_DesignReview: design review
click ins_DesignInsight href "../../classes/ins_DesignInsight/"
Inheritance
Fields
| Name | Cardinality | Type | Description | Inheritance |
|---|---|---|---|---|
| id | 1 |
GRID | Globally unique identifier across the whole platform. | Entity |
| project | 1 |
Hardware Project | The design project under review. | direct |
| review context | 0..1 |
Hardware Project Release | The project release under review, when the review context is a release. Absent when the review applies to a snapshot of the work-in-progress design or to a project commit, which are not modelled yet. | direct |
| initiator | 1 |
Workspace User | The Workspace member who created the review. Only the Initiator or a Workspace administrator can finalize it. | direct |
| reviewers | * |
Workspace User | The Workspace members asked to review the design. Each must have access to the project, and a review task is created for each of them. | direct |
| workflow | 0..1 |
Workflow | The process workflow that the review follows: the built-in Design Review process or a custom design review process. | direct |
| tasks | * |
Task | Tasks of the review: the process tasks created for the Initiator and the Reviewers, and tasks raised from comments placed on the design snapshot. | direct |
| comment threads | * |
Comment Thread | Comment threads placed on the design snapshot of the review, including those about checklist items. | direct |
| status | 1 |
Design Review Status | The state of the review, from In Progress to its closed state. | direct |