getRunningDefinitions

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

getRunningDefinitions

Description

Returns an array of all the definitions that have instances in the system. This includes definitions that have only completed or terminated/suspended instances. Each array element is a ProcessDefinitionDescriptor, rather than an entire process definition.

Syntax

public ProcessDefinitionDescriptor[] getRunningDefinitions()
throws PMServiceException

Parameters

None

Return

An array of Process Definition Descriptors

Exception Thrown

PMServiceException

getStatus

Description

Returns the status of a process.

Syntax

public java.lang.String getStatus(java.lang.String processid)
throws PMServiceException

Parameters

Parameter	Type	Description
processid	string	Identifies the process instance ID

Return: The status of the specified process instance as string
Exception Thrown: PMServiceException

getStatusCode

Description

Returns the status code of a process. The possible status codes are:

STATUS_CREATED = 0
STATUS_RUNNING = 1
STATUS_COMPLETED = 2
STATUS_SUSPENDED = 3
STATUS_TERMINATED = 4

Syntax

public java.lang.String getStatusCode(java.lang.String processid)
throws PMServiceException

Parameters

Parameter	Type	Description
processid	string	Identifies the process instance ID

Return: A process status as string for numeric value
Exception Thrown: PMServiceException

hasDefinitionPermission

Description

Checks if the current user has a permission on a selected definition. Valid definition permissions are:

PM_EDIT_DEFINITION_SECURITY
PM_VIEW_DEFINITION
PM_EDIT_DEFINITION
PM_DELETE_DEFINITION
PM_LOCK_DEFINITION
PM_UNLOCK_DEFINITION
PM_START_INSTANCE
PM_LIST_INSTANCES

Syntax

public boolean hasDefinitionPermission(java.lang.String permissionName,java.lang.String definitionId)
throws PMServiceException

Parameters

Parameter	Type	Description
permissionName	string	Identifies the name of the permission to check
definitionId	string	Identifies the ID of the process definition to check against

Return: TRUE if the current user has the selected permission; otherwise, returns FALSE
Exception Thrown: PMServiceException

hasGlobalPermission

Description

Checks if the current user has the given global permission. Valid global permission names are:

Login permissions
PD_LOGIN

WL_LOGIN

WM_LOGIN
Worklist Permissions
WL_START_PROCESS

WL_REASSIGN_TASK
GlobalActorManager permissions
AM_VIEW_ACTOR

AM_CREATE_ACTOR

AM_EDIT_ACTOR

AM_DELETE_ACTOR
GlobalProcessManager permissions
PM_ACCESS PD_ACCESS

PM_VIEW_CONFIGURATION

PM_EDIT_CONFIGURATION

PM_VIEW_LOG

PM_CLEAR_LOG

PM_ENABLE_LOG

PM_LIST_DEFINITIONS

PM_CREATE_DEFINITION
GlobalObjectManager permissions
OM_VIEW_OBJECT

OM_CREATE_OBJECT

OM_EDIT_OBJECT

OM_DELETE_OBJECT
Global ProcessMonitor permissions
PMON_RUN_REPORT

PMON_CREATE_REPORT

PMON_EDIT_REPORT

PMON_DELETE_REPORT
Global DataType permissions
DT_CREATE_DATATYPE

DT_DELETE_DATATYPE

DT_VIEW_DATATYPE

Syntax

public boolean hasGlobalPermission(java.lang.String permissionName)
throws PMServiceException

Parameters

Parameter	Type	Description
permissionName	string	Identifies the permission name to check

Return: TRUE if the current user has this permission; otherwise, returns FALSE
Exception Thrown: PMServiceException

hasInstancePermission

Description

Checks if the current user has a permission on a given instance. Valid instance permission names are:

PM_VIEW_INSTANCE
PM_EDIT_INSTANCE
PM_DELETE_INSTANCE
PM_SUSPEND_INSTANCE
PM_RESUME_INSTANCE
PM_TERMINATE_INSTANCE

Syntax

public boolean hasInstancePermission(java.lang.String permissionName, java.lang.String instanceId)
throws PMServiceException

Parameters

Parameter	Type	Description
permissionName	string	Identifies the permission name to check
instanceId	string	Identifies the process instance ID to check the permission against

Return: TRUE if the current user has permission; otherwise, returns FALSE
Exception Thrown: PMServiceException

isLoggingEnabled

Description

Returns a boolean flag that indicates if logging is enabled.

Syntax

public boolean isLoggingEnabled()
throws PMServiceException

Parameters

None

Return

A boolean TRUE if the Process Manager server enabled logging; otherwise, returns FALSE

Exception Thrown

PMServiceException

isSessionValid

Description

Checks if this PMService2 session is still valid.

Syntax

public boolean isSessionValid()
throws PMServiceException

Parameters

None

Return

A boolean TRUE if the session is valid; otherwise, returns FALSE

Exception Thrown

PMServiceException

lock

Description

Locks the process definition or process instance identified. The Process Manager maintains the locks in memory.

Syntax

public void lock(java.lang.String id)
throws PMServiceException

Parameters

Parameter	Type	Description
ID	string	Identifies the process definition ID

Return: None
Exception Thrown: PMServiceException

logIn

Description

Logs the specified user into the Process Manager. This method is intended to be used in conjunction with session cookies to establish a user session. You must first enable session tracking on your Web services client library before calling this method.

Syntax

public void logIn(java.lang.String user, java.lang.String password)
throws PMServiceException

Parameters

Parameter	Type	Description
user	string	Identifies the user ID
password	string	Identifies the user password

Return: None
Exception Thrown: PMServiceException

loginToken

Description

Logs the specified user into the Process Manager using a token from EIAM. This method is intended to be used in conjunction with session cookies to establish a user session. You must first enable session tracking on your Web services client library before calling this method.

Syntax

public void loginToken(java.lang.String token)
throws PMServiceException

Parameters

Parameter	Type	Description
token	string	Identifies the EIAM token

Return: None
Exception Thrown: PMServiceException

logOut

Description

Logs out of the Process Manager session.

Syntax

public void logOut()

Parameters

None

Return

None

Exception Thrown

None

purgeAsynchronouslyForCompletedWithStats

Description

Permanently deletes all process instances created from the specified process definition that started or completed between the specified dates and also the associated data from the STATS table. This is an asynchronous operation that runs in the background.

Syntax

public void purgeAsynchronouslyForCompletedWithStats (java.lang.String

definitionId

,long

from

,long

, boolean

completed, Boolean deleteStats

)

throws PMServiceException

Parameters

Parameter	Type	Description
definitionID	string	Identifies the process definition ID
from	long	Identifies the date to which instances should be listed
to	long	Identifies the date to which instances should be listed
completed	Boolean	Specifies whether this operation should select process instances based on their start date or completion date If false, selects process instances based on the start date.
deleteStats	Boolean	Specifies whether this operation should delete the stats table records as part of purge If false, the stats table records are not deleted.

Return: None
Exception Thrown: PMServiceException

purgeInstances

Description

Permanently deletes all process instances created from the specified process definition that started between the specified dates.

Syntax

public void purgeInstances(java.lang.String definitionId,long from,long to)
throws PMServiceException

Parameters

Parameter	Type	Description
definitionId	string	Identifies the process definition ID
from	long	Identifies the date from which to start listing instances
to	long	Identifies the date to which instances should be listed

Return: None
Exception Thrown: PMServiceException

purgeInstancesAsynchronously

Description

Permanently deletes all process instances created from the specified process definition that started or completed between the specified dates. This is an asynchronous operation that runs in the background.

Syntax

public void purgeInstancesAsynchronously(java.lang.String

definitionId

,long

from

,long

, boolean

completed

)

throws PMServiceException

Parameters

Parameter	Type	Description
definitionID	string	Identifies the process definition ID
from	long	Identifies the date from which to start listing instances
to	long	Identifies the date to which instances should be listed
completed	Boolean	Specifies whether this operation should select process instances based on their start or completion date If false, selects process instances based on the start date.

Return: None
Exception Thrown: PMServiceException

purgeInstancesSynchronously

Description

Permanently deletes all process instances created from the specified process definition that started or completed between the specified dates.

Syntax

public int purgeInstancesSynchronously(java.lang.String

definitionId

,long

from

,long

, boolean

completed

)

throws PMServiceException

Parameters

Parameter	Type	Description
definitionID	string	Identifies the process definition ID
from	long	Identifies the date from which to start listing instances
to	long	Identifies the date to which instances should be listed
completed	Boolean	Specifies whether this operation should select process instances based on their start or completion date. If false, selects process instances based on the start date.

Return

Returns the purge operation status. Valid values are:

0 = PURGE_SUCCESS

1 = PURGE_FAILURE_INTERNAL_ERROR

3 = NO_INSTANCES_TO_PURGE

Exception Thrown

PMServiceException

purgeSynchronouslyForCompletedWithStats

Description

Syntax

public int purgeSynchronouslyForCompletedWithStats(java.lang.String

definitionId

,long

from

,long

, boolean

completed, boolean deleteStats

)

throws PMServiceException

Parameters

Parameter	Type	Description
definitionID	string	Identifies the process definition ID
from	long	Identifies the date from which to start listing instances
to	long	Identifies the date to which instances should be listed
completed	Boolean	Specifies whether this operation should select process instances based on their start or completion date. If false, selects process instances based on the start date.
deleteStats	Boolean	Specifies whether this operation should delete the stats table records as part of purge If false, the stats table records are not deleted.

Return

Returns the purge operation status. Valid values are:

0 = PURGE_SUCCESS

1 = PURGE_FAILURE_INTERNAL_ERROR

3 = NO_INSTANCES_TO_PURGE

Exception Thrown

PMServiceException

Tell Technical Publications how we can improve this information