Manage workflows - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

This functionality was modified in an update. For more information, see Configure workflows (modified in an update).

Most SDx workflows are configured out-of-the-box with a set of steps that represent your business processes including distribution, reviews, approval, and notification.

What are the delivered workflow templates?

Two versions of each of the workflow templates are delivered for SDx.

  • A master workflow template with the prefix MSR that cannot be used in the system and is supplied only for reference.

  • An editable copy of the workflow template with the prefix HEX that customers can use and edit in their system.

The name and UID of the workflow template will have the prefix

  • MSR for the master or non-editable copy

  • HEX for the editable copy

Master workflow template (MSR)

In order that each master workflow template (MSR) remains intact and unaffected, the ISPFNonEditableCopy interface definition is instantiated on each master workflow template version. The ISPFNonEditableCopy interface is only realized by elements used in the master workflow template and does not allow those elements to be referenced, edited, updated, or attached. You cannot use the master workflow template in the user interface as selection or update options for it are disabled. When the master workflow template version is selected in the user interface, the edit option is not displayed. However, you can copy the master workflow template to create an editable copy of the workflow template that does not instantiate the ISPFNonEditableCopy interface.

When copying a master workflow template, if a step in the master workflow (M1) includes a success/failure step that comes from another master workflow (M2), then a deep copy of the template is performed. This creates two HEX copies of the template, one for M1 and one for M2. The steps between these two copies are related.

Editable copy of the workflow template (HEX)

The editable copy of the workflow template (HEX) is supplied so you can customize the workflow to add your own work processes. The editable copy does not contain or reference the elements that realize the ISPFNonEditableCopy interface. This allows you to edit the copy of the workflow template to meet your custom workflow needs, such as editing step recipients. A new master workflow template can be created by instantiating the ISPFNonEditableCopy interface onto the editable copy of the workflow template to lockdown the edit option. This is only possible when no parts of the workflow template are related to any other editable template copy.

If the SDx database has both the MSR and HEX workflow templates when upgrading, only the master workflow template (MSR) is upgraded. This process protects the existing workflow template from unwanted side effects if customers have edited the workflow template to meet their own workflow process needs. For more information on upgrading SDx, see Upgrade the workflow templates.

Workflow modification

You can modify the copy of the workflow template (HEX) at two levels.

Work process configuration - in which you cannot change the steps, but you can:

  • Change recipients of steps, for example, change the roles or users that review a technical query.

  • Control default behavior, for example, whether a technical query compliance review is required, optional, or never used.

  • Define review periods.

Work process remodeling - in which you can make changes to the workflow process:

  • Add or remove a work process step.

  • Re-order steps or sets of steps.

Many steps work in series and must be configured in the prescribed order. For example, process steps set the recipients and the durations of future interactive steps based on properties of the workflow object or its related contract. Refer to the details of each work process to understand how these work.

What are the rules for work process remodeling?

Two versions of each workflow template are delivered.

  • A master workflow template with the prefix MSR that cannot be used in the system and is supplied only for reference.

  • An editable copy of the workflow template with the prefix HEX that customers can use and edit in their system.

The following rules must be followed when changing the HEX version of the template:

  • Do not modify any existing step definitions, step classes, or their related conditions.

  • You can copy the step definition, its step class, and related condition.

  • You can add, remove, and reorder steps in the workflow template.

  • You can provide your own prefix to the workflow template.

Workflows are configured with a set of steps that represent your business process. Certain steps in the process are critical to the operation of that work process. These critical steps are indicated in the work process and should only be altered within the scope described at each step.

SHARED Tip For details on how to configure workflow steps, see Manage workflow templates.

See also

Configure workflows in SDx Operations

Configure workflows for SDx Projects