Chat now with support
Chat with Support

erwin Evolve 2023.1.0 - User Guide

erwin Evolve 2023.1.0 User Help Guide Legal Notices Getting Started Creating Sites and Pages Data Layout Options Filtering Data Property Groups Data Visualizations Displaying Diagrams Using Web Modeler Automatic Diagrams (Diagram Designer) Navigating your Site Enhanced erwin Evolve Plugins Workflow Explained Social Interaction Features Questionnaires Reference Configuration and Administration Customizing Your Site Troubleshooting Upgrading

Set Up the Object Validation Workflow

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

Icon

Description automatically generated

These instructions assume you have already enabled Workflow in Evolve.

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.

If you create custom Property Types to use, they must have matching Scriptnames for each Object Type.

Configure Site to Enable Object Validation

To configure your Site to enable Object Validation:

  1. In evolve designer, select the Deployments > Model node.

Graphical user interface

Description automatically generated

  1. Complete each of the following settings:

Setting

Description

Validation Workflow Active Object Types

Enter the Scriptnames of each Object Type you want to enable the Object Validation workflow for. Separate using commas.

Use Default Validation Property Types

Select this option if you want to use the standard Validated and Validated Date properties for the Workflow Validated and Workflow Timestamp properties below.

Choosing this option completes the next two fields automatically.

Validation Workflow Validated Property Type

If you want to use a custom property to record if the object is validated or not, enter the Scriptname of the Check Box Property Type you want to use.

Validation Workflow Timestamp Property Type

If you want to use a custom property to record the validated date, enter the Scriptname of the Date/Time Property Type you want to use.

Validation Workflow Validated By Property Type

Optional

If you want to record the names of the users who validated the object, enter the Scriptname of the Multi-Line Text Property Type you want to use for this purpose.

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

Diagram

Description automatically generated with low confidence

  1. Click Erwin Demo.

A picture containing company name

Description automatically generated

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.

A picture containing text

Description automatically generated

To update meta model:

  1. Expand Erwin Demo > Object Pages.

Table

Description automatically generated with low confidence

  1. Right-click cwworkflowitem and click Delete.

  1. Click Update Meta Model & Themes.

  2. Click Save.

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

Text

Description automatically generated with medium confidence

  1. Right-click z_custom_layout_configuration and click Delete.

Text

Description automatically generated

  1. Expand Menu > Configuration.

Graphical user interface, application

Description automatically generated

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

    Graphical user interface, application

Description automatically generated

  2. Click Save.

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

 

Icon

Description automatically generated

Workflow configuration is available to Subscribed users only. For access, contact Sales & Support.

 

Icon

Description automatically generated

You must have Administrator rights to create or configure workflows.

To create a workflow:

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

  2. Click a model. For example, EDGEWorkflow.

Graphical user interface, application

Description automatically generated

 

  1. Click Administration.

Graphical user interface, text, website

Description automatically generated

  1. Click Configure Workflow.

A picture containing text

Description automatically generated

 

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

Graphical user interface, text, application

Description automatically generated

Icon

Description automatically generated

CwRole is used by Workflow Engine, which can be triggered directly from the erwin Evolve home page.

Add scenario

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

 

Icon

Description automatically generated

Users with Administrator rights can create multiple Scenarios.

To add Scenarios:

  1. Click the add_scenario icon.

    Text

Description automatically generated

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

    Graphical user interface, text, application

Description automatically generated

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

    Shape, rectangle

Description automatically generated

Icon

Description automatically generated

Use up or down arrow to change the order of the Scenario.

 

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

    Diagram

Description automatically generated

     

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

    Graphical user interface, text, application

Description automatically generated

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

     

    Shape, rectangle

Description automatically generated

Icon

Description automatically generated

Use up or down arrow to change the order of the step.

 

Icon

Description automatically generated

To restrict the reviewer from unintentionally modifying the document, you can configure the document to be read-only before sending it for review. Select the Document Section in ReadOnly check box.

A picture containing chart

Description automatically generated

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:

Section

Property

Description

Additional Information

Input Configuration

label

Specifies the label of input

 

Order

Specifies the order of input

 

Type

Specifies the type of input

property: Indicates an input type

objectType: Indicates a input's object type

association: Indicates a relationship between two objects

message: Indicates a generic message of input

request-name: Indicates the name of workflow creator

Scriptname

Specifies the script name of the property

Available when Type is set to property.

Click the Scriptname drop-down list box and select the required option.

Object Type

Specifies the input object type

Available when Type is set to objectType.

Click the Object Type drop-down list box and select the required option.

Scriptname to use in other property value

Specifies the scriptname of the object Type or request name

Available when Type is set to objectType or request-name

Association Type

Specifies the association type of input

Available when Type is set to association.

Click the Association Type drop-down list box and select the required option.

Informative Message

Specifies an informative message about input

Available when Type is set to message

Read Only

Specifies whether the input is read-only

Available when type is set to property, objectType, association or request-name

Mandatory

Specifies whether the input is mandatory

Available when Type is set to property, objectType, association or request-name

Hidden

Specifies whether the input is hidden

Available when Type is set to property, objectType, association or request-name

Value

Specifies a value of the input type

Available when Type is set to property, objectType, association or request-name

Filter

Specifies the Filter option to filter input value

  1. Click Add New

  2. Click the Property drop-down list box and select the required option

  3. Click the Operator drop-down list box and select the required option

  4. Use Value or drop-down list to specify the property value

Step Mapping Configuration

Label

Specifies the label of the step mapping

 

 

Order

Specifies the order of the step mapping

 

 

Step Name

Specifies the name of the step

 

 

Read Only

Specifies whether the step is read only

 

 

Hidden

Specifies whether the step is hidden for all users

 

 

Mandatory

Specifies whether the step is mandatory

 

 

CW User

Specifies the casewise user of mapping

 

 

Mapped to the creator of the workflow

Specifies whether the creator of the workflow is mapped

 

 

Cw Role

Specifies the role of casewise user

Available only when Mapped to the creator of the workflow is not selected and while configuring Review 1 and Review 2

 

Filter

Specifies the Filter option to filter the value for custom form types

  1. Click Add Filter

  2. Click Property drop-down list box and select the required option

  3. Click Operator drop-down list box and select the required option

  4. Use Value or drop-down list to specify the property value

Add Buttons and Next Steps

Label

Specifies the name of buttons and steps

 

 

Order

Specifies the order of buttons and steps

 

 

Step Name

Specifies the name of the step

 

 

Enable Notification

Specifies the notification of new task

 

 

Create the Final Object

Specifies whether the created object is final

To create the final object, user must be contributor or diagrammer.

 

Ignore Mandatory Fields

Specifies whether the mandatory fields can be ignored

 

 

Filter

Specifies the Filter option to filter the value for custom form types

  1. Click Add Filter

  2. Click Property drop-down list box and select the required option

  3. Click Operator drop-down list box and select the required option

  4. Use Value or drop-down list to specify the property value

 

Notification Title & Notification message

Specifies the title and message of notification

Available only when you select the Enable Notification check box or the Create the Final Object check box

 

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

Diagram

Description automatically generated

Icon

Description automatically generated

The Save icon saves JSON configuration into erwin Evolve Web Platform.

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

  1. Start Evolve Designer.

  2. Click a model. For example, EDGEWorkflow.

Diagram

Description automatically generated with low confidence

  1. Click Erwin Demo.

A picture containing company name

Description automatically generated

An Evolve Designer window opens.

  1. Expand Erwin Demo.

    A picture containing text

Description automatically generated

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

    A picture containing graphical user interface

Description automatically generated

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

    Graphical user interface, application

Description automatically generated

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

    Graphical user interface, text, application

Description automatically generated

  4. Click index_architecture_enablers.

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

  5. Expand index_architecture_enablers_workflow > Architecture Enabler.

    Graphical user interface, text

Description automatically generated

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

    Graphical user interface, application

Description automatically generated

     

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

    Text

Description automatically generated with medium confidence

  7. Click the Layout Workflow node.

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

Icon

Description automatically generated

Ensure that ObjectType Scriptname is in lowercase.

Graphical user interface, application

Description automatically generated

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

    Graphical user interface, text, application, email

Description automatically generated

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

    Graphical user interface, text, application

Description automatically generated

  3. Expand Menu node.

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

    Graphical user interface, application

Description automatically generated

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

  6. Click Save.

  7. Click Dynamic Site.

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

A picture containing icon

Description automatically generated

Icon

Description automatically generated

The publish icon publishes the workflow to the server.

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

Diagram

Description automatically generated with medium confidence

Icon

Description automatically generated

The Refresh icon discards the workflow's saved changes and reloads it from the server.

Page Review Workflow

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

Graphical user interface, text, application, email

Description automatically generated

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.

Users cannot delete or modify the attachment unless the status of the request is Resubmit.

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

Graphical user interface, application

Description automatically generated

  1. Click Workflow.

Shape, rectangle

Description automatically generated

  1. Click New Application.

    Graphical user interface, text, application

Description automatically generated

    An application form appears.

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

Property

Description

Additional Information

Name

Specifies the name of the new application

 

Category

Specifies the business category of input

You can customize categories using workflow configuration according to your business usage.

Code

Specifies an informative message about the application

 

 

Lifecycle Status

Specifies the status of the lifecycle

 

 

Criticality

Specifies the importance of the application

You can customize the criticality options using workflow configuration.

Tier

Specifies the rank of the application

You can customize the tier options using workflow configuration.

 

Business Owner

Specifies the name of the business owner

 

Person

Specifies the person who created the application

For example, Malcom Brooks

Contact Person/Mail

Specifies the name or email address of the person to be contacted

For example, Malcom Brooks (person_email@company.com)

Attachment

Specifies the uploaded attachment of the application

Click the button to upload documents.

For more information, refer to Attachments Notification Message

Review 1

Specifies the first level reviewer, which is set in workflow configuration

 

Review 2

Specifies the second level reviewer, which is set in workflow configuration

 

Attachments Notification Message

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

File Type

Notification Message

Duplicate File

This file is already attached. Please select another file if needed.

Empty file

The attached file is empty. Please select another file.

Size is over 20 MB

This file has exceeded the size limit. Please Select another file or try reducing the size less than 20 MB.

Unsupported

This File type is unsupported. Please select the supported file types.

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

 

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

Icon

Description automatically generated

Save For Later enables you to save the information for later, and is stored under draft.

Once you click Save For Later, you will be notified that “This request has been saved”.

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.

    A picture containing graphical user interface

Description automatically generated

    The My Profile screen appears.

  2. Under Application Request, click My Request.

    Graphical user interface

Description automatically generated

    The My Request screen appears.

Icon

Description automatically generated

The My Request screen displays the status and history of all your requests.

Graphical user interface, application

Description automatically generated

To review tasks raised by the requestor:

  1. Login to erwin Evolve Web with reviewer.

  2. Click Tasks.

Graphical user interface, application

Description automatically generated

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

  2. Click Assign to Me.

Graphical user interface, application

Description automatically generated with medium confidence

  1. Click Take Action.

A picture containing application

Description automatically generated

An application form opens.

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

Graphical user interface, text, application, chat or text message

Description automatically generated

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

Graphical user interface, text, application

Description automatically generated

 

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.

Graphical user interface, text, application

Description automatically generated

 

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

Graphical user interface, text, application

Description automatically generated

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.

Graphical user interface, text, application

Description automatically generated

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

Graphical user interface, text, application

Description automatically generated

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.

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

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

Reviewers can only download and view the attachment, which is attached by the user. They cannot delete the attachment file.

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.

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

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

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

Graphical user interface, application

Description automatically generated

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

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

Additionally filter the list by time (from now) using the 1 Month3 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.

Graphical user interface, application

Description automatically generated

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

Click 1 Month3 Months1 Year or All  to specify the duration of notifications displayed.

Delete a Notification

To delete a notification:

  1. Click the Notifications menu.

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

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

Application

Description automatically generated with low confidence

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.

A picture containing graphical user interface

Description automatically generated

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.

Icon

Description automatically generated

Once the transfer request has been submitted, it cannot be undone.

 

Icon

Description automatically generated

The Task Delegation function is enabled by default. To switch off this feature, open Evolve Designer and deselect the Enable Task Delegation option on the Model node.

Text

Description automatically generated

With the function disabled, commit the changes to your Site.

See: Publish your Site

 

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.

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

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

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

Graphical user interface, application

Description automatically generated

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

Graphical user interface, text, application, email

Description automatically generated

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

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating