Create a workflow step definition - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

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

You can create a custom workflow step definition which can be used to define the behavior of the corresponding step.

  1. In the Workflow Management feature set, click Create Workflow Step Definition.

  2. In the Configure Workflow Step Definition window, type the required values and select the appropriate options as shown in each of the following tabs:

    SHARED Tip You can click PREVIOUS or NEXT to navigate between different tabs.

    General Details

    • Type a name and description for the step definition.

    Workflow Step Type

    • Select an appropriate option from the Workflow step type list, based on the displayed for selection.

      Step types are properties of step classes. They determine the behavior and appearance of the step.

      What are different types of workflow steps?

      The step class controls the detailed behavior of the step. The basic behavior is identified by the step type. The step type dictates how the step is managed by the system; the methods determine the functionality available to the user in the client.

      The step types reflect the internal behavior of the step and cannot be altered without significant customization of the code.

      The following default step types are delivered with the software:

      Step type

      Description

      Purpose

      I

      Information

      This step is for information only and is a special work step that can support actions like Acknowledge Receipt. It contains no subsequent steps.

      W

      Working

      This step assigns work to the step's recipients.

      P

      Process

      This step is a non-interactive step that performs an operation on the object in the workflow.

      V

      Voting

      This step is used to process the results of parallel approval steps.

      S

      Sign Off

      This is a special process step used for electronic document sign off to indicate that the document has gone through the workflow.

      • Voting and sign off are forms of process steps.

      • When you select the Process step type, you can select the Is a merge process step option to combine a set of process steps and execute them in a defined order. For more information, see Create a merge workflow process step type.

    Email Options

    • Search for and select an appropriate email definition for each email notification type. The email notifications are sent to the recipients of a step when certain events occur during a workflow, such as when a step is completed. The email notification options vary depending on the workflow step type.

      What are different types of email notifications?

      Email

      Description

      Reject email definition

      The email message sent to a recipient whose step is rejected or is not completed successfully.

      Action email definition

      The email message sent to the recipients when the next step requires an action.

      Sign off email definition

      The email message sent to all relevant recipients when a step is signed off.

      Overdue email definition

      The email message sent to recipients whose To Do List has a step waiting to be done when a previous step is overdue.

      Information email definition

      The email message sent to all recipients when an information step is assigned to them.

      Claim email definition

      The email message sent to all recipients when the step action has been claimed.

    SHARED Tip You can also click the Advanced Search option to search for and display a targeted set of results based on the type of object selected in the Advanced Search window.

    • If an email definition is not specified for a workflow step or a relevant event, then no email is sent.

    • You can click Edit workflow template to update the corresponding email definition.

    • You can click CREATE NEW EMAIL DEFINITION to create a new custom email definition. For more information, see Create a new email definition.

    Todo List Actions

    • Select one or more Methods associated with the step class. These methods determine the actions that can be performed when the step is added in the Todo list.

  3. Click FINISH to save the changes.

  • Once a new step definition is configured, a corresponding step class is automatically created with the same name.

  • This feature uses the SDxCreateWorkflowStepDef method related to the SDxCreateWorkflowStepDef client API. For more information, see SDxCreateWorkflowStepDef client API.