erwin Evolve 2023.1.0 - User Guide

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 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.

To update meta model for models already configured for Advanced Workflow:

1. Start Evolve Designer.

2. Click a model. For example, EDGEWorkflow.

3. Click Erwin Demo.

An Evolve Designer window opens.

You will receive the below error message when you click on 'Update Meta Model & Themes'. To fix this error, you need to first update meta model.

To update meta model:

1. Expand Erwin Demo > Object Pages.

2. Right-click cwworkflowitem and click Delete.

3. Click Update Meta Model & Themes.

4. Click Save.

5. Click Dynamic Site.

Deleting an index page without unlinking it from the menu leads to an error. To fix this error, follow below steps:

To delete “z_custom_layout_configuration” index page and unlink from menu:

1. Expand Erwin Demo > Index Pages.

2. Right-click z_custom_layout_configuration and click Delete.

3. Expand Menu > Configuration.

4. Right-click Custom Layout Configuration and click Delete.

   

5. Click Save.

6. Click Dynamic Site.

Evolve Workflow Configuration

Workflow configuration is now a part of Administration, alongside Pool/Swimlane Configuration and it enables you to create and customize workflows.

To create a workflow:

1. Open the browser and login to erwin Evolve Web.

2. Click a model. For example, EDGEWorkflow.

3. Click Administration.

4. Click Configure Workflow.

5. Click the Object Type drop-down list box and select the required object type.

Add scenario

When you click add_scenario, a scenario is created and a request is sent for approvals.

To add Scenarios:

1. Click the add_scenario icon.

   

2. In the Name box, specify the name of the Scenario.

   

3. In the Order box, specify the order of the Scenario.

   

4. Click the Property for document list drop-down list box and select the required option.

   

Graphical View

You can view the workflow process in a graphical format in the Graphical View section.

To add step via the Graphical View:

1. Click the add_step icon.

   

    

2. In the Name box, specify the name of the step.

   

3. In the Order box, specify the order of the step.

    

   

Input Configuration

You can create custom approval form with fields, such as Name, Email and Description.

To add form_input:

1. Click the add_form_input icon.

   

2. Complete each of the following settings:

To save the workflow configuration, click the Save Configuration icon.

To add an index page in erwin Evolve Web for the workflow

1. Start Evolve Designer.

2. Click a model. For example, EDGEWorkflow.

3. Click Erwin Demo.

An Evolve Designer window opens.

4. Expand Erwin Demo.

   

5. Right-click the Index Pages node and click Add Index Page For Object Type.

   

6. Select the required object type for which you want to configure workflow. For example, Architecture Enabler.

   

   An index page (index_architecture_enablers) is added at the end of index pages.

   

7. Click index_architecture_enablers.

   In the Page Name box, change the page name if required. For example, index_architecture_enablers_workflow.

   

8. Expand index_architecture_enablers_workflow > Architecture Enabler.

   

9. Right-click Layout List (Simple) and then, select Switch Layout > Casewise > Workflow.

   

    

   The Layout List (Simple) nodes changes to Layout Workflow.

   

10. Click the Layout Workflow node.

11. In the ObjectType Scriptname box, specify the script name of the object type. For example, application.

12. In the Scenario Name box, specify the name of the application that you use while configuring workflow in your erwin Evolve site.

    

13. Right-click on the Menu node and click Add Menu Link.

    

14. Expand Menu node.

15. Right-click Menu Link and select Add Index Page Link > Custom Pages.

    

16. Select the index page that you created. For example, index_architecture_enablers_workflow.

17. Click Save.

18. Click Dynamic Site.

To publish the workflow to the server, click the Publish icon.

To refresh the workflow configuration, click the Refresh Configuration icon.

Page Review Workflow

The Page Review Workflow is part of the Share functionality in Evolve.

If Workflow is enabled, a user can choose to share the page with a Role. All members of the Role are then assigned Tasks prompting them to review the page - or object - and they must confirm they have reviewed it before the Task is considered complete.

In addition, the user who shared the page is also assigned a Task - with the Task marked as 'My Requests' - and this allows them to view which users have reviewed the page.

Only once all members of the Role have confirmed they have reviewed the page is the Task marked as 'Completed'.

What do you want to do?

Confirm you have reviewed an Object Page

See who has reviewed a page you shared

Working with Tasks

Tasks are an integral part of Evolve Workflow and are assigned to users in the following two instances:

• When users are set as an Approver of Page or Object Instance as part of the Review and Approval workflow, they will receive Tasks when users edit data that they must approve.

• When users share a page with a Role, all members of the Role are assigned Tasks to prompt them to review the page.

Depending on how a Workflow is configured, when Tasks are assigned, users may receive an Email notification as well.

What do you want to do?

Create an approval request/task:

To create an approval request/task:

1. Open the browser and login to erwin Evolve Web.

2. Click a model. For example, EDGEWorkflow.

3. Click Workflow.

4. Click New Application.

   

   An application form appears.

5. Enter details in the required fields. Fields marked with asterisk are mandatory.

Attachments Notification Message

Depending on the scenario, the following messages appear when you upload an attachment to the approval form:

File types supported for attachments:

The file types supported for attachments are as follows:

• BMP

• JPG

• PNG

• TXT

• CSV

• PDF

• XML

• JSON

• DOC

• DOCX

• PPT

• PPTX

• XLS

• XLSX

6. Click Submit to submit the form or click Save For Later to save the form.

Once the form is submitted, you will be notified that the form has been submitted and sent to the reviewer for approval.

To view the approval request/task:

1. Under ADMIN, click My Profile.

   

   The My Profile screen appears.

2. Under Application Request, click My Request.

   

   The My Request screen appears.

To review tasks raised by the requestor:

1. Login to erwin Evolve Web with reviewer.

2. Click Tasks.

3. Select the application form that you want to review.

4. Click Assign to Me.

5. Click Take Action.

An application form opens.

6. If you are reviewer 1, enter the review comments in the First Review Comments box and click Validate.

7. If you are reviewer 2, enter the review comments in the Second Review Comments box and click Validate.

Once you click Validate, you will be notified that “Your Action was successfully submitted. Requested User will be Notified”.

To send the application form back to the user:

1. If you are reviewer 1, enter the review comments in the First Review Comments box and click ReSubmit.

2. If you are reviewer 2, enter the review comments in the Second Review Comments box and click ReSubmit.

You will be notified that “Your Action was successfully submitted. Requested User will be Notified”.

To reject tasks raised by requestors:

1. If you are reviewer 1, enter the review comments in the First Review Comments box and click Rejected.

2. If you are reviewer 2, enter the review comments in the Second Review Comments box and click Rejected.

You will be notified that “Your Action was successfully submitted. Requested User will be Notified”.

View your pending Tasks

To view your pending Tasks:

1. In your Evolve Site, click the Tasks menu.

The sub-menu lists up to five Tasks that are unread.

2. Click on a Task to go directly to it, or click See all tasks to view all your Tasks.

By default the My Tasks page is shown so the pending Tasks are displayed.

3. Select a Task to view its details.

Review and approve/reject data change requests by another user

If you are in an Approver Role for a Page or Object Instance, or you are a User assigned as an Object Instance Approver, you are assigned Tasks to review the changes and then accept or reject changes made by other users.

To review and approve or reject data change requests:

1. View your Task from the Tasks menu or by following thelink in the notification email.

2. The page shows you all the changes made by the user, including the previous and new values.

3. Go through Review each change and choose whether to Accept or Reject it.

Alternatively, you can use the Accept All or Reject All buttons.

4. Once you have Approved or Rejected all the changes, click the Submit review button.

The changes are submitted, and your Task is marked as 'completed'. A notification email with the results of the review is sent to the user who made the changes.

Before you submit, you can enter comments in the comments text box. These will be visible to the user so they can understand why you rejected or approved their change request.

Confirm you have reviewed a shared page

If a user has shared a page with a Role, all members of that Role must confirm they have reviewed the page.

To confirm you have reviewed a shared page:

1. Navigate to the Task by using the Tasks menu in your Evolve Site, or by following the link provided in the notification email.

2. Click on Take Action button to navigate to the page to be reviewed.

3. Once you have reviewed the page, click the Confirm you have reviewed this page button.

The Task is complete.

View pending Tasks you initiated

If you initiated a Task, either by a data change request, or by sharing a page for review, you can view the details of the Task while it is still incomplete.

To view pending Tasks you initiated:

1. Use the Tasks menu to See all tasks.

2. Click the My Requests sub-menu.

All Tasks you initiated are displayed.

3. On the Task you want to check:

• Click Show Assignees on page sharing Tasks to see who has reviewed the page.

• Click Show Approvers on data change request Tasks to see the list of Approvers.

Cancel a pending Task you initiated

If you initiated a Task, you can cancel it at any time before the Task is completed.

To cancel a Task you initiated:

1. Use the Tasks menu to See all tasks.

2. Click the My Requests sub-menu.

All Tasks you initiated are displayed.

3. Click the Trashcan icon next to the Task that you want to cancel.

The Task is deleted and is removed from all Assignees' and Approvers' Task lists.

View completed Tasks

To view your completed Tasks:

1. In your Evolve Site, click the Tasks menu.

2. On the sub-menu, click See all tasks to view all your Tasks.

3. Select My Tasks or My Requests in the sub-menu to see Tasks that have been assigned to you, or ones that you initiated by sharing a page with a Role.

By default, the My Tasks page is active so the pending Tasks are displayed.

4. Click the Completed filter to view just completed Tasks.

Additionally filter the list by time (from now) using the 1 Month, 3 Months and 1 Year filters.

View Notifications

If you are involved in a Task, you receive notifications in your Evolve Site when the task related activity is performed.

These notifications can be accessed using the Notifications link in the main Site menu.

If new notifications exist, they are highlighted in the menu.

To view your notifications:

1. Click the Notifications menu.

Click Older and Newer  to move through the pages of notifications.

Click 1 Month, 3 Months, 1 Year or All  to specify the duration of notifications displayed.

Delete a Notification

To delete a notification:

1. Click the Notifications menu.

2. Use the pagination and date filtering controls to locate the notification you want to delete.

3. Click the trashcan icon at the top-right of the notification.

Transfer a Task

When a task is assigned to you as 'My Tasks', you can either assign it to yourself, or transfer it to another user.

To transfer a task: 

By default the 'My Tasks' page is active and displays the pending Tasks.

The Action/Transfer options will display.

A list of users to whom the task could be potentially delegated is displayed.

1. In your Evolve site, click on the Task menu.

2. From the sub-menu, click See All Tasks to view all tasks.

3. Select My Tasks, to view the tasks assigned to you.

4. Select and open the task you wish to transfer.

5. Select the Transfer Task option.

6. Select the user that you wish to transfer the task to, and you will be presented with the option to add a brief message explaining the reason for the transfer.

7. Click on Submit button.

You will be notified that “The task was delegated to the selected user”.

All references to the task are removed from the original user's profile and they are no longer associated with it.

The task is added to the transferred user's My Tasks' list.

The task's history is now updated to display the task transfer.

Request an Object be validated

If your Site is configured to support Object Validation requests, you can make a request on any page showing a supported Object Type.

To request an object be validated:

1. On a supported Object Page, click the Create Task button.

2. In the Validators section, select all the people you want to validate the object.

Use the Filter box to type people's names to find them in the list.

3. In the Message field, optionally enter a message explaining why you want the object validated, or note any information that may be of use to the validators.

4. Click Submit.

Comment on a Task requiring action

If you have a pending task to action, you can add a comment to your response.

To add a comment to a response:

A Comment field will display.

1. Navigate to the relevant Task using the Tasks menu in your Evolve Site, or by following a link in the Task email.

2. Click on Add Comment (located next to the Submit button).

3. Enter your comments or any information for the requester.

4. Click Submit. Your comments will be attached to your response.

Comments sent from the Assigner will be stored in the Task's history and are only visible to the original Requester and associated Assignees.

Change Calendar Due Date

If you have created a task that requires actioning, the Server Configuration automatically sets its Due Date Interval to three days. This date can be changed using the Date Picker.

To customize a task's due date:

1. When creating a Task Request, click on the Change Due Date button (located next to the Submit  button).

2. A date field will display.

3. Click on the field or calendar icon and the Date Picker will display enabling you to select a custom date from the calendar.

4. Review your change, and then click on Submit.

View Object Validation Status

If an Object has a pending validation request, it is possible to view the status of this request on its Object Page.

To view the status of an Object's validation requests:

1. In your Evolve site, open up the desired Object Page.

The status message will display at the top of the Page sub-menu.