Request a review
In an organisation, a version is approved by others, never by its author alone. You choose the approvers, say in one sentence what the version decides, set how many approvals are needed and by when, and send. The version is In review until the verdicts come in.
On this page
Before you start
- An organisation diagram you can edit (Contributor, Editor or Owner of its workspace). See Roles and permissions.
- The version to review is the current one. Save it first if you made changes. See Save and restore versions.
- Your approvers can open the diagram. A member of the organisation reviews with their own role; a guest gets review access until the due date.
Ask for the review
- Open the review
Open the diagram, then in the Share menu select Open comments and review. In the review panel, select Ask for a review. The form says: Ask colleagues to review this version. They comment on elements and views, then approve or request changes.
- Choose the approvers
The workspace's editors are proposed first. Use Add a person or a group… to find a colleague or a directory group, or Or a role… to ask everyone with a workspace role. To ask someone outside the organisation, tick External reviewer (advisory opinion) and choose Review access until.
- Say what is decided
In What is decided, in one sentence, write the decision, for example: Claims intake moves behind the API gateway. It is required: your approvers read it first. Why (optional) and Impact (optional) help them decide faster.
- Set the approvals and the due date
In Approvals needed, choose how many approvals conclude the review; the list starts at your organisation's minimum. In Due, choose the date by which you need the verdicts.
- Send
Tick Send to the reviewers now, then select Ask for a review. Without the tick, the review is kept as a draft: send it later with Submit v14 for review.
iyedy says Review started and sent to the reviewers. The version's stamp is In review, and the footer reads You asked for this review: … with the names of your approvers.
Approvals and the quorum
The review concludes Approved once the approvals needed are given by distinct people, and Changes requested as soon as one approver requests changes. You, the author, give no verdict: the review is four eyes. A guest's verdict is an advisory opinion unless your organisation counts it.
After the verdicts
- Changes requested. Update the diagram, answer the comments, then select Resubmit v15. The new version is reviewed again and earlier verdicts are cleared.
- You change the diagram during the review. The change makes a new version; iyedy tells you to resubmit it so that approvers review that version.
- Withdraw. Withdraw closes the review: Withdraw this review? Reviewers stop being asked.
- Keep a record. Export the Review pack (PDF): see Create a review pack.
The review policy
An owner or a security administrator sets what a review asks for in the organisation: Organisation… in the account menu, then Rules, then Review policy.
| Setting | What it does |
|---|---|
| Approvals needed | The approvals counted before a diagram is Approved. |
| Required reviewers | Roles or groups added to every review; five at most. |
| The author may approve their own diagram | Only while fewer than two people hold a seat. |
| An external reviewer's opinion counts | Otherwise it is advisory: shown, never counted. |
| An open HIGH finding asks for a condition or an accepted risk | No plain approval while a HIGH finding is open. |
| A diagram's status may be set by hand | Otherwise only the review gives In review, Changes requested and Approved. |
If it doesn't work
“No eligible approver in …” or “The rule asks for … approvers; only … can review this diagram.”
Not enough people can review this diagram under your organisation's rule. The message names who can name an approver or change the rule: ask them, or add approvers who can open the diagram.
“A review is already open on this diagram: give your verdict there.”
A diagram has one open review at a time. Open it from the review panel, or withdraw it first if it is yours.
“This person is not a member of the organisation: invite them first.”
Invite them to the organisation, or tick External reviewer (advisory opinion) to ask them as a guest. See Invite and manage members.
More cases: Review troubleshooting.
Was this page helpful?Your answer is anonymous and counts only if you accepted measurement.
What went wrong?
Don't write personal data.