erwin Evolve 2020.2.1 - User Guide

Review and Approval Workflow

Review and Approval Workflow

The Review and Approval workflow enables you to manage data quality by forcing changes to your model to be approved before they are committed to the repository.

The process covers all changes made to existing data, including the creation of new objects or the deletion of existing objects, as well as changes to associations data.

The workflow does not cover the following:

•Questionnaires

•Social features - Comments, Ratings and Favorites

Who Approves What?

The Review and Approval Workflow has two levels, which can be combined in your Site:

•Page level

•Object Instance level

Page Level Review and Approval

Page Level Review and Approval works by linking a Role to Index Pages and Object Pages in your Site.

Any changes to the data made via these pages, whether creating new objects, editing existing objects or deleting objects, must be reviewed and approved by members of the Role before those changes are applied.

Role members can approve or reject all, or merely some, of the proposed changes.

See how the Page level process works in detail

These steps assume there are no Object Instance level Approvers which would take precedence over the Page level approval process.

The Page Level process works as follows:

          1. A User (who is not a member of the Approver Role) uses one of the associated Pages to create, edit or delete an object

          2. All members of the Approver Role linked to that Page are assigned a new Task informing them of the changes and prompting them to review them

oIf Evolve Workflow is configured to use SMTP, an email is sent to the Role members notifying them of the Task, including a direct link to the Task in the Site.

oThe User is also able to view their change request - and can even delete it, discarding their changes, as long as it has not already been approved.

oIf the change request relates to the deletion of an object, that object is highlighted with a strike-through wherever it appears in the Site and the UI makes it clear the object is 'marked for deletion'. It cannot be edited while it is in this state.

          3. Any one of the Approver Role members reviews the changes and either approves or rejects them

•The Approver can accept some of the changes and reject others.

•The Task is cleared when one of the Approver Role members approves or rejects the changes.

•The Approver can enter comments explaining their decision which the User can see.

          4. The approved changes are submitted to the repository and any rejected changes are discarded

          5. The Task is marked as 'Completed'

          6. A notification is sent to the person who made the changes informing them whether they have been approved or rejected

•If Evolve Workflow is configured to use SMTP, the notification is sent via email as well.

•The User can also see the outcome of the Task, including any comments, by viewing the Task in the Site.

Object Instance Level Review and Approval

Object Instance Review and Approval works by linking a Role or User to a specific object instance in your model. If another user edits or deletes the object, then it must be approved before the change is committed to the repository.

See how the Object Instance level process works in detail:

          1. A User (who is not an Approver for the object) edits or deletes a governed object

          2. All Approvers linked to that object, whether individual Users or in a Role, are assigned a new Task informing them of the changes and prompting them to review

•If Evolve Workflow is configured to use SMTP, an email is sent to the Approvers notifying them of the Task, including a direct link to the Task in the Site.

•The User who made the change is also able to view their change request - and can even delete it, discarding their changes, as long as it has not already been approved.

•If the change request relates to the deletion of an object, that object is highlighted with a strike-through wherever it appears in the Site and the UI makes it clear the object is 'marked for deletion'. It cannot be edited while it is in this state.

          3. Any one of the Approvers reviews the changes and either approves or rejects them

•The Approver can accept some of the changes and reject others.

•The Task is cleared when one of the Approver Role members approves or rejects the changes.

•The Approver can enter comments explaining their decision which the User can see.

          4. The approved changes are submitted to the repository and any rejected changes are discarded

          5. The Task is marked as 'Completed'

          6. A notification is sent to the person who made the changes informing them whether they have been approved or rejected

•If Evolve Workflow is configured to use SMTP, the notification is sent via email as well.

•The User can also see the outcome of the Task, including any comments, by viewing the Task in the Site.

Precedence

If you combine Page level approval with Object Instance level approval, there is an order of precedence to determine who must approve what.

The rules are detailed as follows:

•If an object has both levels of approval, then the Object Instance level takes precedence.

•If a user who is in a Page level approval Role edits an object on one of their governed pages, but the object has Object Instance level approvers (Users or Roles) - then the Object Instance approvers take precedence.

What do you want to do?

Set up Approver Roles and Users, and assign them to the pages or objects they must approve

Work with Tasks

Setup Approval Workflow Roles and Users

Setup Approval Workflow Roles and Users

This page explains how to set up approvers for the Page level and Object Instance level Review and Approval workflows.

Set up Page level Approver Roles

To ensure consistent data governance, you should ensure you assign Approval Roles to all pages on your Site where the data you want to govern can be changed - for example on Object Pages, Index Pages using Tables, and so on.

To specify which Roles approve which pages:

          1. In your Evolve Site, browse to the Roles administration page

          2. Click the Role you want to edit

The Role page is displayed

          3. Click the Edit button

          4. In the page sub-menu, click Approve Views

          5. The page lists all the pages the Role is the Approver for

          6. Click the Associate button at the top-right of the CW View (approves) box

          7. Click inside the text box, or start typing the name of the page you want Role members to approve

          8. Select the page from the list

The page appears in the box

          9. Click the Save button

          10. In the pop-out Changes window, click the Submit changes button.

The page is added to the list of pages Role members approve.

Set up Object Instance level Approvers

Both Users and Roles can be assigned as Approvers at Object Instance level.

The simplest way to assign Users or Roles to object instances is using Object Explorer or Model Explorer.

You can do this by selecting an object and associating it to a CW User or CW Role, or by selecting a CW User or CW Role and associating it to an object.

When assigning Object Instance Approvers:

Associate objects to Roles using 'Any Object (is approved by role) CW Role' or 'CW Role (role approves) Any Object' depending on whether your focus is the object or the Role.

Associate objects to Users using 'Any Object (is approved by user) CW User' or 'CW User (user approves) Any Object' depending on whether your focus is the object or the User.

Object Validation Workflow

Object Validation Workflow

The Object Validation workflow enables users to request that an object be validated by one or more nominated users.

Each nominated user then receives a Task prompting them to review the object, and then either approve it for validationor reject the request.

The workflow remains active until all users have responded to their tasks. If all users approve the validation request, the object is marked as validated.

The validation is recorded using three Property Types of the object, one for recording if it is validated or not, one to record the date/time of the validation, and one to record the names of the users who approved it. You can use the standard Validated and Validated Date Property Types for the first two of these.

See how the Object Validation process works in detail

The Object Validation process works as follows:

          1. A User views an Object Page on the Site and decides they would like to have that object approved for validation.

          2. The User clicks the Create Task button on the page and chooses one or more Users they would like to validate the content.

          They can optionally enter a message or a comment about the object which the nominated Users can view.

          3. Each nominated User is assigned a new Task asking them to review the object data and either Approve or Reject it.

•The workflow remains open until all nominated Users have either Approved or Rejected the object.

•When a nominated User responds to their Task, the User who requested the validation is sent a notification informing them of the response.

•The object is only considered validated if all Users Approve it.

•When the Task is completed, the User who requested the validation is sent a final summary notification including all the response outcomes.

          4. If all nominated Users Approve the validation request, the object is marked as validated, the date/time of the approval is logged, and the names of all the Users who                     approved it are recorded. All this data is captured on the object itself.

What do you want to do?

Set up the Object Validation workflow on your Site

Request an object be validated

Set Up the Object Validation Workflow

Set Up the Object Validation Workflow

This page explains how to configure your Site to use the Object Validation workflow.

Required Metadata

In order to use the Object Validation workflow, you must choose which Object Types from your Model you want the process to be applied to.

The workflow can work with the standard validation properties on objects, or with your own custom properties you may want to use - but the meta data must be identical on each Object Type.

Users will not be able to request object validation on any Object Page where the Object Type is not configured correctly.

The Object Validation workflow requires two Property Types on each Object Type, plus an optional third property:

•A Check Box property - which is set to True when the object is approved for validation

•A Date/Time property - which is set with the date/time when the Task is completed and the validation request is approved

•A Multi-Line Text property (optional)- which is used to list the names of the Users who were requested to validate the object.

Configure your Site to Enable Object Validation

To configure your Site to enable Object Validation:

          1. In Evolve Designer, select the Deployments > Model node

          2. Complete each of the following settings:

          3. Save and Publish your Site.