CreateProcInstHelper

Syntax

public class CreateProcInstHelper

Constructors

public CreateProcInstHelper();

Namespace and Assembly

RequirementValue

Namespace

Ascentn.Workflow.Base

Assembly

Ascentn.Workflow.WFBase (in Ascentn.Workflow.WFBase.dll)

Properties

PropertyDescription

Attributes
Description:
Name-value pairs associated with a custom ID.
Type
NameValue
Allowed Values:
A valid custom ID with an associated name.

blnStartImmediately
Description:
An obsolete, legacy parameter that must be true.
Type
bool
Allowed Values:
True

CustomID
Description:
A work object ID specified within a process instance.
Type
string
Allowed Values:
One valid work object ID.

Initiator
Description:
Specifies the user who initiates a process.
Type
string
Allowed Values:
A valid user name.

ProcessID
Description:
The process definition ID for a released process definition.
Type
string
Allowed Values:
A valid process definition ID.

ProcessInstID
Description:
A process instance ID for the process instance you are creating.
Type
string
Allowed Values:
A unique, 32 character process instance ID.

If you set this value to null, the AgilePoint Server generates the ID.

ProcInstName
Description:
A unique process name that is associated with the process definition.
Type
string
Allowed Values:
A unique process instance name up to 1024 characters.

SuperProcInstID
Description:
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
Allowed Values:
A valid, unique 32-character process instance ID.

WorkObjID
Description:
An ID for an object, such as a document, that is associated with the process instance.
Type
string
Allowed 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
Description:
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
Allowed Values:
A string up to 1024 characters.