Create Process Instance (Extended with Initiator and Work Object Info)

Description

Creates a process instance with a specified workObjectInfo value. The workObjectInfo parameter provides additional information about a work object, such as a URL for a document.

Syntax

public virtual WFEvent CreateProcInstEx(string PID, string PIID, string PIName, string workObjectID, string workObjectInfo, string superPIID, string initiator, string customID, NameValue[] attributes, bool startImmediately)

Parameters

Name	Type	Description
PID	string	The process definition ID for a released process definition.
PIID	string	A 32 character unique process instance ID for the process instance you are creating. If you set this value to null, the AgilePoint Server generates the ID.
PIName	string	A unique process name that is associated with the process definition. The maximum length of process instance name is 1024 characters.
workObjectID	string	A 256-character ID for an object, such as a document, that is associated with the process instance. (Even though the field size is 256 characters, in common practice, this will usually return a 32-character GUID.)
workObjectInfo	string	A 1024-character string associated with the process instance. Usually this parameter is used to hold more information about the work object, such as a URL for a document, within the process instance.
superPIID	string	A 32-character unique 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.
initiator	string	A string that contains the user name of the user who initiates process.
customID	string	A work object ID as identified in the process instance. This method allows only one custom ID (work object ID).
attributes	NameValue	Name-value pairs associated with a custom ID.
startImmediately	bool	An obsolete, legacy parameter that must be true.

Output

WFEvent object that provides the status of the transaction. Possible statuses are Success, Failed, and Sent.

Example

… see previous sample
string workObjectInfo = ..// for example, a XML-serialized of an object
WFEvent evt = svc.CreateProcInstEx(
                  processDefinitionID,
                  processInstanceID,
                  processInstanceName,
                  workObjectID,
                  workObjectInfo,
                  parentProcessInstanceID,
                  initiator,
                  workObjectID,
                  ds.ToArray(),
                  true);

Supported Versions

4.0.1 and higher