The Process Manager Web Service - PMService2 › The com.ejbtech.processmanager.services Package › Class PMService2 › Class PMService2 Methods › putDefinition

Previous Topic: putConfiguration

Next Topic: updateActor
putDefinition
Description

Updates an existing process definition or creates a new process definition if the process definition id is null.

Syntax
public java.lang.String putDefinition(java.lang.String xml)
throws PMServiceException
Parameters

Parameter

Type

Description

xml

string

Specifies the process definition expressed as an XML document
Return

The ID of the updated or created process definition

Exception Thrown

PMServiceException

resumeInstance
Description

Resumes the specified process instance, putting the instance back into a running state.

Syntax
public void resumeInstance(java.lang.String id) 
throws PMServiceException
Parameters

Parameter

Type

Description

ID

string

Identifies the process instance ID
Return

None

Exception Thrown

PMServiceException

setExternalVariables
Description

Sets the external variables for a process instance.

Syntax
public void setExternalVariables(java.lang.String processId,
Pair[] externals)
throws PMServiceException
Parameters

Parameter

Type

Description

processId

string

Identifies the ID of the process instance to modify

attrMap

pair[]

Identifies an array of name/value pairs (see Complex Types-PMServices)

If a name does not match an external variable for the process, the name is ignored. All names and values should be of the type String.
Return

None

Exception Thrown

PMServiceException

start
Description

Starts a new process instance from the specified process definition. The Process Manager chooses the version of the process definition that is the most effective.

Syntax
public java.lang.String start(java.lang.String definitionId,
com.ejbtech.processengine.Parameter[] parameters)
throws PMServiceException
Parameters

Parameter

Type

Description

definitionId

string

Identifies the process definition ID

parameters

parameter[]

Identifies an array of parameters that are input to the process instance that is created
Return

The process instance ID

Exception Thrown

PMServiceException

suspendInstance
Description

Suspends the specified process instance. The process instance can be resumed with the resumeInstance operation.

Syntax
public void suspendInstance(java.lang.String id) 
throws PMServiceException
Parameters

Parameter

Type

Description

ID

string

Identifies the process instance ID
Return

None

Exception Thrown

PMServiceException

terminateInstance
Description

Terminates the specified process instance. All outstanding workitems are deleted.

Syntax
public void terminateInstance(java.lang.String id) 
throws PMServiceException
Parameters

Parameter

Type

Description

ID

string

Identifies the process instance ID
Return

None

Exception Thrown

PMServiceException

unlock
Description

Unlocks the process definition or process instance identified.

Syntax
public void unlock(java.lang.String id)
throws PMServiceException
Parameters

Parameter

Type

Description

ID

string

Identifies the process definition ID
Return

None

Exception Thrown

PMServiceException