Components of the workflow model - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The main components of the workflow model are shown in the following diagram.

Workflow templates

A workflow template defines the set of steps through which the object in a workflow must pass.

When a copy of a workflow is attached to an object, the workflow template definition is copied and used to manage that item. The copied workflow template is referred to as the instantiated workflow. The instantiated workflow is used to record all the step completion dates, user comments, and so forth.

You can modify some of the details and recipients of steps that have not yet been started without changing the original template definition. The steps in the template workflow are selected from a library of step definitions to ensure a consistent look and feel to all workflows.

Template workflow steps

See Step classification for a diagram.

The workflow steps are created in a workflow template from a library of step definitions which are “classified” by the step class. The step class contains all the configurable details such as the type of the step and shortcut menu methods.

Instantiated workflow steps

Instantiated workflow steps have a configurable behavior on instantiated workflows. The workflow steps appear in the user's To Do List as actions. Right-click the icon of the action and select a command. This is controlled by the related step class.

Workflow step definition classes and types

The Step Class controls the detailed behavior of the step; the basic behavior is identified by the Step Type and the shortcut menu is configured through the methods attached to the class. The Step Type dictates how the step is managed by the system; the methods determine the functionality available to the user in the client.

Workflow statuses

A workflow status is displayed on the object in a workflow to indicate how it is progressing through that workflow.

  • The status is set on the object in the workflow at the completion of a step.

  • Workflow statuses are user configurable.

Distribution matrices

Distribution matrices control sets of recipients for a workflow step dependent on the properties and/or the relationships of the object in the workflow. The matrix is a table with recipients along the top and transmittal categories down the side. Each recipient on the matrix has a Reason For Receipt (RFR), which indicates why the recipient is included.

Workflow

Date

Description

Step Start Date

Set by the system when the step starts.

Target Date

Step start date + Step duration (the due date).

Planned Date

A user entered date that can be used within reports to plan work (the forecast date).

Step Completed Date

Set by the system when the step is completed.

Step Overdue Date

A flag is set by the system to work out when the last e-mail was sent notifying the user they are late.

Step Duration

The time to complete the step.