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

API Type

Web Services

Description

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

Syntax

public virtual WFEvent CreateProcInstEx(string ProcessID, string ProcessInstID, string ProcInstName, string WorkObjID, string WorkObjInfo, string SuperProcInstID, string Initiator, string CustomID, NameValue[] Attributes, bool blnStartImmediately)

Parameters

Name	Description
ProcessID	Definition: The process definition ID or process template name for a released process definition. Type string Allowed Values: A valid process definition ID or process template name.
ProcessInstID	Definition: 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	Definition: A unique process name that is associated with the process definition. Type string Allowed Values: A unique process instance name up to 1024 characters.
WorkObjID	Definition: 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	Definition: 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.
SuperProcInstID	Definition: 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.
Initiator	Definition: Specifies the user who initiates a process. Type string Allowed Values: A valid user name.
CustomID	Definition: A work object ID specified within a process instance. Type string Allowed Values: One valid work object ID.
Attributes	Definition: Name-value pairs associated with a custom ID. Type NameValue Allowed Values: A valid custom ID with an associated name.
blnStartImmediately	Definition: An obsolete, legacy parameter that must be true. Type bool Allowed Values: True

Output

WFEvent object that provides the status of the transaction. The possible statuses are:

Sent - Indicates event has been sent to engine for processing.
Failed - Indicates event failed to process.
Processed - Indicates event has been processed successfully.
Canceled - Indicates event was canceled.
Deferred - Indicates event does not need to be sent immediately.

Example

… see previous sample
string workObjectInfo = ..// for example, a XML-serialized of an object
WFEvent evt = svc.CreateProcInstEx(
                  ProcessID,
                  ProcessInstID,
                  ProcInstName,
                  WorkObjID,
                  WorkObjInfo,
                  parentProcessInstID,
                  Initiator,
                  WorkObjID,
                  ds.ToArray(),
                  true);

Supported Versions

4.0.1 and higher

Parent topic: Methods for Process Instances