StartProcess( ) method

Starts an instance of a process template associated with a connected Progress.BPM.UserSession; that is, it causes the Business Process Server to instantiate a process and initiate this process as defined by the process template.

Return type:

Progress.BPM.Process class

Access:

PUBLIC

Applies to:

Progress.BPM.UserSession class

 

Syntax 

StartProcess( INPUT TemplateName AS CHARACTER)   StartProcess( INPUT TemplateName AS CHARACTER,   INPUT dsTemplateArray AS Progress.BPM.DataSlotTemplate EXTENT,               INPUT NamePrefix AS CHARACTER, INPUT Priority AS CHARACTER )

TemplateName

The name of the template for the process that is to be started.

dsTemplateArray

An array of DataSlotTemplate objects used to initialize values when the process is started.

NamePrefix

Character expression to be used as the first part of the name of the process. It is followed by a # and then the process ID. If NamePrefix resolves to an UNKNOWN or an empty string, the first part of the name will be the name of the process template.

Priority

Specifies the priority of the new process. You can specify "Critical", "High", "Medium", or "Low". If it is an UNKNOWN value or an empty string, the priority will be set to "Medium". Any other value will cause the call to fail.

If you call the one-parameter overload of the method, the Business Process Server starts the process with the dataslots set to the initial values specified in the process template. If you call the two-parameter overload of the method, you can override some or all of those initial values.

If the method succeeds, it returns a reference to a Progress.BPM.Process object. The Progress.BPM.Process object is a snapshot of the process instance created on the Business Process Server.

If the method fails, it raises a BPM error.