×

Supercharge your Proficy solution! Download a free trial of Proficy Operations Hub, CSense analytics, and more. Explore our Proficy 2024 releases!

Home
eSOP
Design eSOP Workflows Overview
Design eSOP Workflows Overview
eSOP requires a person with expert knowledge in workflow development to design a workflow before a person with production-specific knowledge can construct task content for the workflow.
Read Task Step Definition Activity
You can use this activity anywhere within a workflow if you need to read configuration that is specific for use with eSOP.

Workflow IPI
Get Started
Tutorials
Orientation
Configure Your Environment
Security
Resource Information and Configuration
Data Administration
Forms and User Displays
Building and Configuring Workflows
eSOP
- eSOP Orientation
- Client Layout Configuration for eSOP Users
- Design eSOP Workflows Overview
  - Design eSOP Workflows Overview
    eSOP requires a person with expert knowledge in workflow development to design a workflow before a person with production-specific knowledge can construct task content for the workflow.
    - Add custom input panels to create dynamic tabs in the Task Editor
      Workflow designers can import a user control that has been designed using third-party software. This control enables additional customized configuration during the task construction phase that task builders use when configuring the final content.
    - Associate a workflow with a template
      Workflow Designers create workflows to be used as eSOP task templates. You must first define the workflow and configure the template options. Then, in Config Panels, you use templates for additional, custom configuration.
    - Associate a global subprocess with a task step template
      Workflow designers create global subprocesses to be used as eSOP task step templates. You must first define the workflow subprocesses and configure the template options. Then, in Config Panels, you use task templates for additional, custom configuration.
    - Define available keyword text substitutions during run time
      Keywords are derived from local variables and properties configured in a workflow. Keywords enable the creation of parameterized content, such as work instructions and email, with specific text replaced with live values during workflow run time. All specially delimited keywords in a document or text string are replaced with keyword values in a workflow at runtime.
    - Replace keyword text during run time
      You can use keywords to replace text in work instructions and email subjects and bodies. This text is replaced with keyword values in a workflow at run time.
    - Add custom configuration to a template
      Workflow Designers can specify additional custom configuration information for the selected template within the Template Editor.
    - Config Panel Editor
      You use the Config Panel Editor to create custom configuration panels. These panels are based on existing forms or user displays that have been created in Workflow.
    - Replace Keywords Activity
      You can use keywords to replace text in email subjects and bodies. This text is replaced with keyword values in a workflow at run time.
    - Update Work Instruction Keywords Activity
      This activity updates task step work instructions with current keyword values during run time.
    - Keyword Properties
      Keywords are derived from local variables and properties configured in a workflow. Keyword property values are substituted during run time.
    - Read Task Definition Activity
      You can use this activity anywhere within a workflow if you need to read a configuration that is specific for use with eSOP.
    - Read Task Step Definition Activity
      You can use this activity anywhere within a workflow if you need to read configuration that is specific for use with eSOP.
    - Sequential Templates
      Sequential templates have subprocesses that are aligned in a linear order and displayed top to bottom; that is, the task steps are all the same. As a result, no branching or looping subprocesses are available; however, you can jump between steps by configuring jump options, as well as move task steps around.
    - Parallel Templates
      In these template types, the workflow contains a Parallel activity, allowing for branched subprocesses.
    - Fixed Templates
      With fixed templates, the number of steps in the task cannot be increased from the pre-set amount; however, you can remove steps, add missing steps, and re-order the steps.
- Task Construction for Procedures
- Task Maintenance
ActiveX Task Controls
Service Interfaces
Operator Task List in the Workflow Client
Best Practices

Read Task Step Definition Activity

You can use this activity anywhere within a workflow if you need to read configuration that is specific for use with eSOP.

Inputs

Processes an eSOP task step and returns all of the task step's properties.

Inputs	Value	Description
Task	Object	The task information returned by a GetExtendedTaskInfo method call.
Subprocess Id	String	Specifies the unique identifier of the subprocess for which you want step configuration.

Outputs

The following properties are associated with the task step being processed.

Inputs	Value	Description
ID	GUID	Specifies a unique identifier for the task step being processed.
Name	String	Specifies a name assigned to the task step being processed.
Display Name	String	Specifies a name given to a workflow task step for the user to see during run time.
Location Assignment	DirectoryResource	Specifies the assigned location of the task step being processed.
Personnel Assignment	DirectoryResource	Specifies the assigned human resource of the task step being processed.
Sequence	Int32	Specifies the order within the workflow that the task step is processed.
Enabled	Boolean	Specifies the activation status of the task step being processed. True if enabled, False if disabled.
Expiration	TimeSpan	Specifies the time that the task step being processed is set to expire, as determined during configuration.
Linked Documents	List<LinkedDocInfo>	Specifies the documents that have been linked to the task step being processed during configuration.
Started Emails	List<Email>	Specifies the emails that will be sent, as determined during configuration, when the task step being processed starts.
Expiry Emails	List<Email>	Specifies the emails that will be sent, as determined during configuration, when the task step being processed expires.
Jumps	List<JumpInfo>	Specifies the jumps associated with the task step being processed, as determined during configuration.
Config Panel Data	List<ConfigPanelDatumInfo>	Specifies all data provided by custom configuration panels for the task step.
Categories	CategoryList	Specifies all the categories related to the task step being processed.