DOCUMENTATION (v8.x)

Current Documentation (v9.0 or Higher) v6.x-v7.x Documentation

CreateProcInstHelper

Syntax

public class CreateProcInstHelper

Constructors

public CreateProcInstHelper();

Namespace and Assembly

Requirement	Value
Namespace	Ascentn.Workflow.Base
Assembly	Ascentn.Workflow.WFBase (in Ascentn.Workflow.WFBase.dll)

Properties

Property	Description
Attributes	Function: Name-value pairs associated with a custom ID. Type NameValue Accepted Values: A valid custom ID with an associated name.
blnStartImmediately	Function: An obsolete, legacy parameter that must be true. Type bool Accepted Values: True
CustomID	Function: A work object ID specified within a process instance. Type string Accepted Values: One valid work object ID.
Initiator	Function: Specifies the user who initiates a process. Type string Accepted Values: A valid user name.
ProcessID	Function: The process definition ID for a released process definition. Type string Accepted Values: A valid process definition ID.
ProcessInstID	Function: A process instance ID for the process instance you are creating. Type string Accepted Values: A unique, 32 character process instance ID. If you set this value to null, the AgilePoint Server generates the ID.
ProcInstName	Function: A unique process name that is associated with the process definition. Type string Accepted Values: A unique process instance name up to 1024 characters.
SuperProcInstID	Function: A process instance ID that acts as a parent process instance of the process instance that is intended to create. In other words, this is the ID of the process instance on which you want to base your new process instance. Type string Accepted Values: A valid, unique 32-character process instance ID.
WorkObjID	Function: An ID for an object, such as a document, that is associated with the process instance. Type string Accepted Values: A valid, unique 256-character ID. Even though the field size is 256 characters, in common practice, this will usually return a 32-character GUID.
WorkObjInfo	Function: Usually this parameter is used to hold supplemental information about the work object, such as a URL for a document, within the process instance. Type string Accepted Values: A string up to 1024 characters.