com.ibm.workflow.api
Interface ExecutionService

All Superinterfaces:
Service

public interface ExecutionService
extends Service


Method Summary
 ActivityInstanceList createActivityInstanceList(java.lang.String name, TypeOfList type, java.lang.String owner, java.lang.String description, java.lang.String filter, java.lang.String sortCriteria, java.lang.Integer threshold)
          This API call creates an activity instance list on the MQ Workflow execution server so that activity instances can be grouped to one's own taste or for a group of users (action call).
 ProcessInstanceList createProcessInstanceList(java.lang.String name, TypeOfList type, java.lang.String owner, java.lang.String description, java.lang.String filter, java.lang.String sortCriteria, java.lang.Integer threshold)
          This API call creates a process instance list on the MQ Workflow execution server so that process instances can be grouped to one's own taste or for a group of users (action call).
 ProcessTemplateList createProcessTemplateList(java.lang.String name, TypeOfList type, java.lang.String owner, java.lang.String description, java.lang.String filter, java.lang.String sortCriteria, java.lang.Integer threshold)
          This API call creates a process template list on the MQ Workflow execution server so that process templates can be grouped to one's own taste or for a group of users (action call).
 WorkList createWorkList(java.lang.String name, TypeOfList type, java.lang.String owner, java.lang.String description, java.lang.String filter, java.lang.String sortCriteria, java.lang.Integer threshold)
          This API call creates a worklist on the MQ Workflow execution server so that work items or notifications can be grouped to one's own taste or for a group of users (action call).
 void forceLogoff(java.lang.String userID)
          This API call allows an administrator to finish all sessions of the specified user with an MQ Workflow execution server (action call).
 void forceProgramExecutionAgentShutDown(java.lang.String userID)
          This API call allows an administrator to terminate the PEA sessions of the specified user with an MQ Workflow execution server (action call).
 void logoff()
          This API call allows the application to finish the specified user session with an MQ Workflow execution server (action call).
 void logon(java.lang.String userID, java.lang.String password)
          This API call allows an application to establish a user session with an MQ Workflow execution server (action call).
 void logon2(java.lang.String userID, java.lang.String password, SessionMode mode, AbsenceIndicator absenceIndicator)
          See logon(java.lang.String, java.lang.String); allows for the specification of the session mode and absence setting.
 void logon3(byte[] userCredentials)
          See logon(java.lang.String, java.lang.String); allows for logging on with user credentials.
 void logon4(byte[] userCredentials, SessionMode mode, AbsenceIndicator absenceIndicator, java.lang.String userName)
          See logon(java.lang.String, java.lang.String); allows for logging on with user credentials and for the specification of the session mode and absence setting.
 void passthrough()
          The native implementation of the Java API does not support this method.
 ActivityInstance persistentActivityInstance(java.lang.String oid)
          Constructs a transient activity instance object representing the persistent object identified by the passed object identification; does not contact the server.
 ActivityInstanceList persistentActivityInstanceList(java.lang.String oid)
          Documentation for method not yet available
 ActivityInstanceNotification persistentActivityInstanceNotification(java.lang.String oid)
          Constructs a transient activity instance notification object representing the persistent object identified by the passed object identification; does not contact the server.
 InstanceMonitor persistentInstanceMonitor(java.lang.String oid)
          Constructs a transient instance monitor object representing the persistent object identified by the passed object identification; does not contact the server.
 Person persistentPerson(java.lang.String userID)
          Constructs a transient person object representing the persistent object identified by the passed user identification; does not contact the server.
 ProcessInstance persistentProcessInstance(java.lang.String oid)
          Constructs a transient process instance object representing the persistent object identified by the passed object identification; does not contact the server.
 ProcessInstanceList persistentProcessInstanceList(java.lang.String oid)
          Constructs a transient process instance list object representing the persistent object identified by the passed object identification; does not contact the server.
 ProcessInstanceNotification persistentProcessInstanceNotification(java.lang.String oid)
          Constructs a transient process instance notification object representing the persistent object identified by the passed object identification; does not contact the server.
 ProcessTemplate persistentProcessTemplate(java.lang.String oid)
          Constructs a transient process template object representing the persistent object identified by the passed object identification; does not contact the server.
 ProcessTemplateList persistentProcessTemplateList(java.lang.String oid)
          Constructs a transient process template list object representing the persistent object identified by the passed object identification; does not contact the server.
 WorkItem persistentWorkItem(java.lang.String oid)
          Constructs a transient work item object representing the persistent object identified by the passed object identification; does not contact the server.
 WorkList persistentWorkList(java.lang.String oid)
          Constructs a transient worklist object representing the persistent object identified by the passed object identification; does not contact the server.
 ProgramData programDataFromStream(byte[] stream)
          Constructs a transient program data object from the stream passed.
 void programExecutionAgentShutDown()
          This API call allows to shut down the program execution agent associated to the logged on user (program execution management API call call).
 void programExecutionAgentStartUp()
          This API call is used to start a program execution agent associated to the logged-on user (program-execution-management call).
 ProgramTemplate programTemplateFromStream(byte[] stream)
          Constructs a transient program template object from the stream passed.
 ActivityInstanceList[] queryActivityInstanceLists()
          This API call retrieves the activity instance lists the user has access to from the MQ Workflow execution server (action call).
 ActivityInstanceNotification[] queryActivityInstanceNotifications(java.lang.String filter, java.lang.String sortCriteria, java.lang.Integer threshold)
          This API call retrieves the activity instance notifications the user has access to from the MQ Workflow execution server (action call).
 int queryActivityInstanceNotificationsResultSize(java.lang.String filter)
          This API call retrieves the number of current activity instance notifications the user has access to from the MQ Workflow execution server (action call).
 ActivityInstance[] queryActivityInstances(java.lang.String filter, java.lang.String sortCriteria, java.lang.Integer threshold)
          This API call retrieves the current activity instances the user has access to from the MQ Workflow execution server (action call).
 int queryActivityInstancesResultSize(java.lang.String filter)
          This API call retrieves the number of current activity instances the user has access to from the MQ Workflow execution server (action call).
 Item[] queryItems(java.lang.String filter, java.lang.String sortCriteria, java.lang.Integer threshold)
          This API call retrieves the work items or notifications the user has access to from the MQ Workflow execution server (action call).
 int queryItemsResultSize(java.lang.String filter)
          This API call retrieves the number of current work items or notifications the user has access to from the MQ Workflow execution server (action call).
 ProcessInstanceList[] queryProcessInstanceLists()
          This API call retrieves the process instance lists the user has access to from the MQ Workflow execution server (action call).
 ProcessInstanceNotification[] queryProcessInstanceNotifications(java.lang.String filter, java.lang.String sortCriteria, java.lang.Integer threshold)
          This API call retrieves the process instance notifications the user has access to from the MQ Workflow execution server (action call).
 int queryProcessInstanceNotificationsResultSize(java.lang.String filter)
          This API call retrieves the number of current process instance notifications the user has access to from the MQ Workflow execution server (action call).
 ProcessInstance[] queryProcessInstances(java.lang.String filter, java.lang.String sortCriteria, java.lang.Integer threshold)
          This API call retrieves the current process instances the user has access to from the MQ Workflow execution server (action call).
 int queryProcessInstancesResultSize(java.lang.String filter)
          This API call retrieves the number of current process instances the user has access to from the MQ Workflow execution server (action call).
 ProcessTemplateList[] queryProcessTemplateLists()
          This API call retrieves the current process template lists the user has access to from the MQ Workflow execution server (action call).
 ProcessTemplate[] queryProcessTemplates(java.lang.String filter, java.lang.String sortCriteria, java.lang.Integer threshold)
          This API call retrieves the current process templates from the MQ Workflow execution server (action call).
 int queryProcessTemplatesResultSize(java.lang.String filter)
          This API call retrieves the number of current process templates the user has access to from the MQ Workflow execution server (action call).
 WorkItem[] queryWorkItems(java.lang.String filter, java.lang.String sortCriteria, java.lang.Integer threshold)
          This API call retrieves the work items the user has access to from the MQ Workflow execution server (action call).
 int queryWorkItemsResultSize(java.lang.String filter)
          This API call retrieves the number of current work items the user has access to from the MQ Workflow execution server (action call).
 WorkList[] queryWorkLists()
          This API call retrieves the worklists the user has access to from the MQ Workflow execution server (action call).
 ReadOnlyContainer readOnlyContainerFromStream(byte[] stream)
          Constructs a transient read-only container object from the stream passed.
 ReadWriteContainer readWriteContainerFromStream(byte[] stream)
          Constructs a transient read/write container object from the stream passed.
 void remotePassthrough(java.lang.String programID)
          The native implementation of the Java API does not support this method.
 java.lang.String sessionID()
          Returns a string representation of the session.
 void setPersonAbsent()
          This API call sets the absence indication of the specified user to the specified value (action call).
 void setPersonAbsent2(java.lang.String userID, boolean newValue)
           
 void setSessionContext(java.lang.String userID, java.lang.String sessionID)
          Associates the execution service object with the session identified by the passed session identification.
 
Methods inherited from interface com.ibm.workflow.api.Service
isLoggedOn, reconnectCount, refresh, setPassword, setReconnectCount, setTimeout, systemGroupName, systemName, timeout, userID, userSettings
 

Method Detail

sessionID

public java.lang.String sessionID()
                           throws FmcException
Returns a string representation of the session.

Throws:
FmcException - thrown if an API error or a communication error occurred.

createActivityInstanceList

public ActivityInstanceList createActivityInstanceList(java.lang.String name,
                                                       TypeOfList type,
                                                       java.lang.String owner,
                                                       java.lang.String description,
                                                       java.lang.String filter,
                                                       java.lang.String sortCriteria,
                                                       java.lang.Integer threshold)
                                                throws FmcException

This API call creates an activity instance list on the MQ Workflow execution server so that activity instances can be grouped to one's own taste or for a group of users (action call).

An activity instance list is identified by:

If the list is for public usage, any owner specification is ignored. If the list is for private usage and no owner is provided, then the list is created for the logged-on user.

When the activity instance list is to be created for public usage or for the private usage of another user, that is, not the logged-on user itself, then the logged-on user needs to have staff definition authorization.

An activity instance list groups a set of activity instances which have the same characteristics. These characteristics are defined via search filters. The number of activity instances in the list can be restricted via a threshold

which specifies the maximum number of activity instances to be returned to the client. That threshold is applied after the activity instance list has been sorted according to sort criteria specified. Note that activity instances are sorted on the server, that is, the code page of the server determines the sort sequence.

The following rules apply for specifying an activity instance list name:

The following rules apply for specifying a description:

An activity instance list filter is specified as a character string containing a filter on activity instances (refer to How to read the syntax diagrams).

Notes:

  1. A string constant is to be enclosed in single quotes (').

  2. A single quote within a string constant is to be doubled ('').

  3. A pattern is a string constant in which the asterisk and the question mark have special meanings.
    • The question mark (?) represents any single character.
    • The asterisk (*) represents a string of zero or more characters.
    • The escape character is backslash (\) and must be used when the pattern itself contains actual question marks or asterisks. An actual backslash is to be doubled (\\).

  4. A TimeStamp is a string constant, 24 hours based in local time.

  5. Optional specifications in the TimeStamp are set to 0 (zero) if not specified.

  6. A process template or global container member name which contains letters other than a-z, A-Z, and 0-9 is to be enclosed in single quotes (').

  7. For global data container member comparisons, the type of the value specified must conform to the type of the global data container member.

  8. A long integer is to be given in decimal notation.

  9. For binary literals, every byte is represented by a 2-digit hexadecimal number. The binary literal is to be preceded by 0x or 0X. For example, 0xFF is a valid binary literal.
AILFilter

 >>-+-----+--+-|  AIPredicate |------+--------------------------->
    '-NOT-'  '- (--| AILFilter |-- )-'

 >--+------------------------------------------------+----------><
    '-+- AND-+--+------+--+-|  AIPredicate |-------+-'
      '- OR--'  '- NOT-'  '- (--|  AILFilter |-- )-'


 

AIPredicate

 >>-+- STARTER--|  BasicPredicate |--+- string-------+-----------------------------+-><
    |                                '- CURRENT_USER-'                             |
    +- STARTER--+------+-- BETWEEN--+- string-------+-- AND--+- string-------+-----+
    |           '- NOT-'            '- CURRENT_USER-'        '- CURRENT_USER-'     |
    +- STARTER--+------+-- IN--+-+- string-------+---------+-----------------------+
    |           '- NOT-'       | '- CURRENT_USER-'         |                       |
    |                          '- (--+- string-------+-- )-'                       |
    |                                '- CURRENT_USER-'                             |
    +- STARTER--+------+-- LIKE--+- pattern------+---------------------------------+
    |           '- NOT-'         '- CURRENT_USER-'                                 |
    +- STARTER-- IS--+------+-- NULL-----------------------------------------------+
    |                '- NOT-'                                                      |
    +-|  AIString |--|  BasicPredicate |-- string----------------------------------+
    +-|  AIString |--+------+-- BETWEEN-- string-- AND-- string--------------------+
    |                '- NOT-'                                                      |
    +-|  AIString |--+------+-- IN--+- string---------+----------------------------+
    |                '- NOT-'       '- (-- string-- )-'                            |
    +-|  AIString |--+------+-- LIKE-- pattern-------------------------------------+
    |                '- NOT-'                                                      |
    +-|  AIString |-- IS--+------+-- NULL------------------------------------------+
    |                     '- NOT-'                                                 |
    +-|  AITimeStamp |--|  BasicPredicate |--|  TimeStamp |------------------------+
    +-|  AITimeStamp |--+------+-- BETWEEN--|  TimeStamp |-- AND--|  TimeStamp |---+
    |                   '- NOT-'                                                   |
    +-|  AITimeStamp |--+------+-- IN--+-|  TimeStamp |---------+------------------+
    |                   '- NOT-'       '- (--|  TimeStamp |-- )-'                  |
    +-|  AITimeStamp |-- IS--+------+-- NULL---------------------------------------+
    |                        '- NOT-'                                              |
    +-|  PRIORITY |--|  BasicPredicate |-- integer---------------------------------+
    +-|  PRIORITY |--+------+-- BETWEEN-- integer-- AND-- integer------------------+
    |                '- NOT-'                                                      |
    +- PRIORITY--+------+-- IN--+- integer---------+-------------------------------+
    |            '- NOT-'       '- (-- integer-- )-'                               |
    +- STATE--|  BasicPredicate |--|  AIState |------------------------------------+
    +- STATE--+------+-- IN--+- AIState---------+----------------------------------+
    |         '- NOT-'       '- (-- AIState-- )-'                                  |
    +- PROCESS_STATE--|  BasicPredicate |--|  PIState |----------------------------+
    +- PROCESS_STATE--+------+-- IN--+- PIState--------+---------------------------+
    |                 '- NOT-'       '- (--PIState-- )-'                           |
    +- TYPE--|  BasicPredicate |--|  AIType |--------------------------------------+
    +- TYPE--+------+-- IN--+- AIType--------+-------------------------------------+
    |        '- NOT-'       '- (--AIType-- )-'                                     |
    +-|  GlobalContainerMember |--+------+-- BETWEEN--|  Value |-- AND--|  Value |-+
    |                             '- NOT-'                                         |
    +-|  GlobalContainerMember |--|  BasicPredicate |--|  Value |------------------+
    +-|  GlobalContainerMember |--+------+-- IN--+-|  Value |---------+------------+
    |                             '- NOT-'       '- (--|  Value |-- )-'            |
    +-|  GlobalContainerMember |--+------+-- LIKE--+- pattern-----+----------------+
    |                             '- NOT-'         '-CURRENT_USER-'                |
    '-|  GlobalContainerMember |-- IS--+------+-- NULL-----------------------------'
                                       '- NOT-'


 

BasicPredicate

 >>-+- =--+-----------------------------------------------------><
    +- >--+
    +- >=-+
    +- <--+
    +- <=-+
    '- <>-'


 

GlobalContainerMember

 >>-+- ProcessTemplateName-+--:-- MemberName--------------------><
    '- *-------------------'


 

AIState

 >>-+- READY----------+-----------------------------------------><
    +- RUNNING--------+
    +- FINISHED-------+
    +- TERMINATED-----+
    +- SUSPENDED------+
    +- INACTIVE-------+
    +- CHECKED_OUT----+
    +- IN_ERROR-------+
    +- EXECUTED-------+
    +- FORCE_FINISHED-+
    +- SKIPPED--------+
    +- TERMINATING----+
    +- SUSPENDING-----+
    '- EXPIRED--------'


 

PIState

 >>-+- READY-------+--------------------------------------------><
    +- RUNNING-----+
    +- FINISHED----+
    +- TERMINATED--+
    +- SUSPENDED---+
    +- TERMINATING-+
    '- SUSPENDING--'


 

AIString

 >>-+- PROCESS_CATEGORY-+---------------------------------------><
    +- DESCRIPTION------+
    +- IMPLEMENTATION---+
    +- PROCESS_NAME-----+
    +- FULL_NAME--------+
    '- NAME-------------'


 

AIType

 >>-+- PROGRAM_ACTIVITY-+---------------------------------------><
    +- PROCESS_ACTIVITY-+
    '- BLOCK_ACTIVITY---'


 

AITimeStamp

 >>-+- ACTIVATION_TIME--------+---------------------------------><
    +- LAST_MODIFICATION_TIME-+
    +- LAST_STATE_CHANGE_TIME-+
    '- START_TIME-------------'


 

TimeStamp

 >>- year-- --- month-- --- day---------------------------------->

 >--+------------------------------------------------+----------><
    '-  -- hours--+--------------------------------+-'
                  '- :-- minutes--+--------------+-'
                                  '- :-- seconds-'


 

Value

 >>-+-+- string------+-+----------------------------------------><
    | '-CURRENT_USER-' |
    +- long integer----+
    +- float-----------+
    '- binary----------'


 

Activity instances can be sorted. An activity instance list sort criterion is specified as a character string.

AILOrderBy

 >>-+- STARTER---------------+--+-------+-----------------------><
    +-|  AIString |----------+  +- ASC--+
    +-|  AITimeStamp |-------+  '- DESC-'
    +- GlobalContainerMember-+
    +- STATE-----------------+
    +- PROCESS_STATE---------+
    +- PRIORITY--------------+
    '- TYPE------------------'


 

Notes:

  1. If a filter is specified, the default sort order is ascending. Otherwise, there is no intrinsic default sort order.

  2. States are sorted according to the sequence shown in the AIState diagram.
Parameters:
name - Documentation for parameter not yet available
type - Documentation for parameter not yet available
owner - Documentation for parameter not yet available
description - Documentation for parameter not yet available
filter - Documentation for parameter not yet available
sortCriteria - Documentation for parameter not yet available
threshold - Documentation for parameter not yet available
Returns:
Documentation for return value not yet available
Throws:
FmcException - Documentation for exception not yet available

createProcessInstanceList

public ProcessInstanceList createProcessInstanceList(java.lang.String name,
                                                     TypeOfList type,
                                                     java.lang.String owner,
                                                     java.lang.String description,
                                                     java.lang.String filter,
                                                     java.lang.String sortCriteria,
                                                     java.lang.Integer threshold)
                                              throws FmcException

This API call creates a process instance list on the MQ Workflow execution server so that process instances can be grouped to one's own taste or for a group of users (action call).

A process instance list is identified by:

If the list is for public usage, any owner specification is ignored. If the list is for private usage and no owner is provided, then the list is created for the logged-on user.

When the process instance list is to be created for public usage or for the private usage of another user, that is, not the logged-on user itself, then the logged-on user needs to have staff definition authorization.

A process instance list groups a set of process instances which have the same characteristics. These characteristics are defined via search filters. The number of process instances in the list can be restricted via a threshold which specifies the maximum number of process instances to be returned to the client. That threshold is applied after the process instance list has been sorted according to sort criteria specified. Note that process instances are sorted on the server, that is, the code page of the server determines the sort sequence.

The following rules apply for specifying a process instance list name:

The following rules apply for specifying a description:

A process instance list filter is specified as a character string containing a filter on process instances (refer to How to read the syntax diagrams).

Notes:

  1. A string constant is to be enclosed in single quotes (').

  2. A single quote within a string constant is to be doubled ('').

  3. A pattern is a string constant in which the asterisk and the question mark have special meanings.
    • The question mark (?) represents any single character.
    • The asterisk (*) represents a string of zero or more characters.
    • The escape character is backslash (\) and must be used when the pattern itself contains actual question marks or asterisks. An actual backslash is to be doubled (\\).

  4. A TimeStamp is a string constant, 24 hours based in local time.

  5. Optional specifications in the TimeStamp are set to 0 (zero) if not specified.

  6. A process template or global container member name which contains letters other than a-z, A-Z, and 0-9 is to be enclosed in single quotes (').

  7. For global data container member comparisons, the type of the value specified must conform to the type of the global data container member.

  8. A long integer is to be given in decimal notation.

  9. For binary literals, every byte is represented by a 2-digit hexadecimal number. The binary literal is to be preceded by 0x or 0X. For example, 0xFF is a valid binary literal.
PILFilter

 >>-+------+--+-|  PIPredicate |-------+------------------------->
    '- NOT-'  '- (--|  PILFilter |-- )-'

 >--+----------------------------------------------------+------><
    '-+- AND-+--+------+--+-|  PIPredicate |-----------+-'
      '- OR--'  '- NOT-'  | .------------------------. |
                          | V                        | |
                          '--- (--|  PILFilter |-- )-+-'


 
PIPredicate

 >>-+-|  PIString |--|  BasicPredicate |-- string----------------------------------+-><
    +-|  PIString |--+------+-- BETWEEN-- string-- AND-- string--------------------+
    |                '- NOT-'                                                      |
    +-|  PIString |--+------+-- IN--+- string-------------+------------------------+
    |                '- NOT-'       |     .- ,------.     |                        |
    |                               |     V         |     |                        |
    |                               '- (---- string-+-- )-'                        |
    +-|  PIString |--+------+-- LIKE-- pattern-------------------------------------+
    |                '- NOT-'                                                      |
    +-|  PIString |-- IS--+------+-- NULL------------------------------------------+
    |                     '- NOT-'                                                 |
    +-|  PITimeStamp |--|  BasicPredicate |--|  TimeStamp |------------------------+
    +-|  PITimeStamp |--+------+-- BETWEEN--|  TimeStamp |-- AND--|  TimeStamp |---+
    |                   '- NOT-'                                                   |
    +-|  PITimeStamp |--+------+-- IN--+-|  TimeStamp |-------------+--------------+
    |                   '- NOT-'       |     .- ,-------------.     |              |
    |                                  |     V                |     |              |
    |                                  '- (----|  TimeStamp |-+-- )-'              |
    +-|  PITimeStamp |-- IS--+------+-- NULL---------------------------------------+
    |                        '- NOT-'                                              |
    +- STATE--|  BasicPredicate |--|  PIState |------------------------------------+
    +- STATE--+------+-- IN--+- PIState-------------+------------------------------+
    |         '- NOT-'       |     .- ,-------.     |                              |
    |                        |     V          |     |                              |
    |                        '- (---- PIState-+-- )-'                              |
    +- NAME--|  BasicPredicate |-- TOP_LEVEL_PROCESS_NAME--------------------------+
    +-|  GlobalContainerMember |--+------+-- BETWEEN--|  Value |-- AND--|  Value |-+
    |                             '- NOT-'                                         |
    +-|  GlobalContainerMember |--|  BasicPredicate |--|  Value |------------------+
    +-|  GlobalContainerMember |--+------+-- IN--+-|  Value |-------------+--------+
    |                             '- NOT-'       |     .- ,---------.     |        |
    |                                            |     V            |     |        |
    |                                            '- (----|  Value |-+-- )-'        |
    +-|  GlobalContainerMember |--+------+-- LIKE--+- pattern-----+----------------+
    |                             '- NOT-'         '-CURRENT_USER-'                |
    '-|  GlobalContainerMember |-- IS--+------+-- NULL-----------------------------'
                                       '- NOT-'


 
BasicPredicate

 >>-+- =--+-----------------------------------------------------><
    +- >--+
    +- >=-+
    +- <--+
    +- <=-+
    '- <>-'


 
GlobalContainerMember

 >>-+- ProcessTemplateName-+--:-- MemberName--------------------><
    '- *-------------------'


 
PIState

 >>-+- READY-------+--------------------------------------------><
    +- RUNNING-----+
    +- FINISHED----+
    +- TERMINATED--+
    +- SUSPENDED---+
    +- TERMINATING-+
    '- SUSPENDING--'


 
PIString

 >>-+- ADMINISTRATOR----------+---------------------------------><
    +- CATEGORY---------------+
    +- DESCRIPTION------------+
    +- NAME-------------------+
    +- PARENT_PROCESS_NAME----+
    +- PROCESS_CONTEXT--------+
    +- PROCESS_TEMPLATE_NAME--+
    '- TOP_LEVEL_PROCESS_NAME-'


 
PITimeStamp

 >>-+- LAST_MODIFICATION_TIME-+---------------------------------><
    +- LAST_STATE_CHANGE_TIME-+
    +- START_TIME-------------+
    '- VALID_FROM_TIME--------'


 
TimeStamp

 >>- year-- --- month-- --- day---------------------------------->

 >--+------------------------------------------------+----------><
    '-  -- hours--+--------------------------------+-'
                  '- :-- minutes--+--------------+-'
                                  '- :-- seconds-'


 
Value

 >>-+-+- string------+-+----------------------------------------><
    | '-CURRENT_USER-' |
    +- long integer----+
    +- float-----------+
    '- binary----------'


 

A process instance list sort criterion is specified as a character string.

PILOrderBy

 >>-+-|  PIString |----------+--+-------+-----------------------><
    +-|  PITimeStamp |-------+  +- ASC--+
    +- GlobalContainerMember-+  '- DESC-'
    +- STATE-----------------+
    '-PROCESS_TEMPLATE_OID---'


 

Notes:

  1. If a filter is specified, the default sort order is ascending. Otherwise, there is no intrinsic default sort order.

  2. States are sorted according to the sequence shown in the PIState diagram.
Throws:
FmcException - thrown if an API error or a communication error occurred.

createProcessTemplateList

public ProcessTemplateList createProcessTemplateList(java.lang.String name,
                                                     TypeOfList type,
                                                     java.lang.String owner,
                                                     java.lang.String description,
                                                     java.lang.String filter,
                                                     java.lang.String sortCriteria,
                                                     java.lang.Integer threshold)
                                              throws FmcException

This API call creates a process template list on the MQ Workflow execution server so that process templates can be grouped to one's own taste or for a group of users (action call).

A process template list is identified by:

If the list is for public usage, any owner specification is ignored. If the list is for private usage and no owner is provided, then the list is created for the logged-on user.

When the process template list is to be created for public usage or for the private usage of another user, that is, not the logged-on user itself, then the logged-on user needs to have staff definition authorization.

A process template list groups a set of process templates which have the same characteristics. These characteristics are defined via filters. The number of process templates in the list can be restricted via a threshold which specifies the maximum number of process templates to be returned to the client. That threshold is applied after the process template list has been sorted according to sort criteria specified. Process templates are sorted on the server, that is, the code page of the server determines the sort sequence.

The following rules apply for specifying a process template list name:

The following rules apply for specifying a description:

A process template list filter is specified as a character string containing a filter on process templates (refer to How to read the syntax diagrams).

Notes:

  1. A string constant is to be enclosed in single quotes (').

  2. A single quote within a string constant is to be doubled ('').

  3. A pattern is a string constant in which the asterisk and the question mark have special meanings.
    • The question mark (?) represents any single character.
    • The asterisk (*) represents a string of zero or more characters.
    • The escape character is backslash (\) and must be used when the pattern itself contains actual question marks or asterisks. An actual backslash is to be doubled (\\).

  4. A TimeStamp is a string constant, 24 hours based in local time.

  5. Optional specifications in the TimeStamp are set to 0 (zero) if not specified.
PTLFilter

 >>-+------+--+-|  PTPredicate |-------+------------------------->
    '- NOT-'  '- (--|  PTLFilter |-- )-'

 >--+----------------------------------------------------+------><
    '-+- AND-+--+------+--+-|  PTPredicate |-----------+-'
      '- OR--'  '- NOT-'  | .------------------------. |
                          | V                        | |
                          '--- (--|  PTLFilter |-- )-+-'


 
PTPredicate

 >>-+-|  PTString |--|  BasicPredicate |-- string--------------------------------+-><
    +-|  PTString |--+------+-- BETWEEN-- string-- AND-- string------------------+
    |                '- NOT-'                                                    |
    +-|  PTString |--+------+-- IN--+- string-------------+----------------------+
    |                '- NOT-'       |     .- ,------.     |                      |
    |                               |     V         |     |                      |
    |                               '- (---- string-+-- )-'                      |
    +-|  PTString |--+------+-- LIKE-- pattern-----------------------------------+
    |                '- NOT-'                                                    |
    +-|  PIString |-- IS--+------+-- NULL----------------------------------------+
    |                     '- NOT-'                                               |
    +-|  PTTimeStamp |--|  BasicPredicate |--|  TimeStamp |----------------------+
    +-|  PTTimeStamp |--+------+-- BETWEEN--|  TimeStamp |-- AND--|  TimeStamp |-+
    |                   '- NOT-'                                                 |
    +-|  PTTimeStamp |--+------+-- IN--+-|  TimeStamp |-------------+------------+
    |                   '- NOT-'       |     .- ,-------------.     |            |
    |                                  |     V                |     |            |
    |                                  '- (----|  TimeStamp |-+-- )-'            |
    '-|  PTTimeStamp |-- IS--+------+-- NULL-------------------------------------'
                             '- NOT-'


 
BasicPredicate

 >>-+- =--+-----------------------------------------------------><
    +- >--+
    +- >=-+
    +- <--+
    +- <=-+
    '- <>-'


 
PTString

 >>-+- CATEGORY----+--------------------------------------------><
    +- DESCRIPTION-+
    '- NAME--------'


 
PTTimeStamp

 >>--- LAST_MODIFICATION_TIME-----------------------------------><


 
TimeStamp

 >>- year-- --- month-- --- day---------------------------------->

 >--+------------------------------------------------+----------><
    '-  -- hours--+--------------------------------+-'
                  '- :-- minutes--+--------------+-'
                                  '- :-- seconds-'


 

A process template list sort criterion is specified as a character string.

PTLOrderBy

    .- ,------------------------------.
    V                                 |
 >>---+-|  PTString |----+--+-------+-+-------------------------><
      '-|  PTTimeStamp |-'  +- ASC--+
                            '- DESC-'


 

Note:
If a filter is specified, the default sort order is ascending. Otherwise, there is no intrinsic default sort order.
Throws:
FmcException - thrown if an API error or a communication error occurred.

createWorkList

public WorkList createWorkList(java.lang.String name,
                               TypeOfList type,
                               java.lang.String owner,
                               java.lang.String description,
                               java.lang.String filter,
                               java.lang.String sortCriteria,
                               java.lang.Integer threshold)
                        throws FmcException

This API call creates a worklist on the MQ Workflow execution server so that work items or notifications can be grouped to one's own taste or for a group of users (action call).

A worklist is identified by:

If the list is for public usage, any owner specification is ignored. If the list is for private usage and no owner is provided, then the list is created for the logged-on user.

When the worklist is to be created for public usage or for the private usage of another user, that is, not the logged-on user itself, then the logged-on user needs to have staff definition authorization.

A worklist groups a set of work items or notifications which have the same characteristics. These characteristics are defined via filters. The number of items in the worklist can be restricted via a threshold which specifies the maximum number of items to be returned to the client. That threshold is applied after the worklist has been sorted according to sort criteria specified. Items are sorted on the server, that is, the code page of the server determines the sort sequence.

The following rules apply for specifying a worklist name:

The following rules apply for specifying a description:

A worklist filter is specified as a character string containing a filter on the items in the worklist (refer to How to read the syntax diagrams).

Notes:

  1. A string constant is to be enclosed in single quotes (').

  2. A single quote within a string constant is to be doubled ('').

  3. A pattern is a string constant in which the asterisk and the question mark have special meanings.
    • The question mark (?) represents any single character.
    • The asterisk (*) represents a string of zero or more characters.
    • The escape character is backslash (\) and must be used when the pattern itself contains actual question marks or asterisks. An actual backslash is to be doubled (\\).

  4. A TimeStamp is a string constant, 24 hours based in local time.

  5. Optional specifications in the TimeStamp are set to 0 (zero) if not specified.

  6. A process template or global container member name which contains letters other than a-z, A-Z, and 0-9 is to be enclosed in single quotes (').

  7. For global data container member comparisons, the type of the value specified must conform to the type of the global data container member.

  8. A long integer is to be given in decimal notation.

  9. For binary literals, every byte is represented by a 2-digit hexadecimal number. The binary literal is to be preceded by 0x or 0X. For example, 0xFF is a valid binary literal.
WLFilter

 >>-+------+--+-|  WLPredicate-1 |----+-------------------------->
    '- NOT-'  +-|  WLPredicate-2 |----+
              '- (--|  WLFilter |-- )-'

 >--+---------------------------------------------------+-------><
    '-+- AND-+--+------+--+-|  WLPredicate-1 |--------+-'
      '- OR--'  '- NOT-'  +-|  WLPredicate-2 |--------+
                          | .-----------------------. |
                          | V                       | |
                          '--- (--|  WLFilter |-- )-+-'


 
WLPredicate-1

 >>-+- TYPE--+------+-- IN--+- ITType-------------+--------------------------+-><
    |        '- NOT-'       |     .- ,------.     |                          |
    |                       |     V         |     |                          |
    |                       '- (---- ITType-+-- )-'                          |
    +- OWNER--|  BasicPredicate |--+- string-------+-------------------------+
    |                              '- CURRENT_USER-'                         |
    +- OWNER--+------+-- BETWEEN--+- string-------+-- AND--+- string-------+-+
    |         '- NOT-'            '- CURRENT_USER-'        '- CURRENT_USER-' |
    +- OWNER--+------+-- IN--+-+- string-------+-------------+---------------+
    |         '- NOT-'       | '- CURRENT_USER-'             |               |
    |                        |     .- ,----------------.     |               |
    |                        |     V                   |     |               |
    |                        '- (----+- string-------+-+-- )-'               |
    |                                '- CURRENT_USER-'                       |
    +- OWNER--+------+-- LIKE--+- pattern------+-----------------------------+
    |         '- NOT-'         '- CURRENT_USER-'                             |
    '- OWNER-- IS--+------+-- NULL-------------------------------------------'
                   '- NOT-'


 
WLPredicate-2

 >>-+-|  ITString |--|  BasicPredicate |-- string----------------------------------+-><
    +-|  ITString |--+------+-- BETWEEN-- string-- AND-- string--------------------+
    |                '- NOT-'                                                      |
    +-|  ITString |--+------+-- IN--+- string-------------+------------------------+
    |                '- NOT-'       |     .- ,------.     |                        |
    |                               |     V         |     |                        |
    |                               '- (---- string-+-- )-'                        |
    +-|  ITString |--+------+-- LIKE-- pattern-------------------------------------+
    |                '- NOT-'                                                      |
    +-|  ITString |-- IS--+------+-- NULL------------------------------------------+
    |                     '- NOT-'                                                 |
    +-|  ITTimeStamp |--|  BasicPredicate |--|  TimeStamp |------------------------+
    +-|  ITTimeStamp |--+------+-- BETWEEN--|  TimeStamp |-- AND--|  TimeStamp |---+
    |                   '- NOT-'                                                   |
    +-|  ITTimeStamp |--+------+-- IN--+-|  TimeStamp |-------------+--------------+
    |                   '- NOT-'       |     .- ,-------------.     |              |
    |                                  |     V                |     |              |
    |                                  '- (----|  TimeStamp |-+-- )-'              |
    +-|  ITTimeStamp |-- IS--+------+-- NULL---------------------------------------+
    |                        '- NOT-'                                              |
    +-|  PRIORITY |--|  BasicPredicate |-- integer---------------------------------+
    +-|  PRIORITY |--+------+-- BETWEEN-- integer-- AND-- integer------------------+
    |                '- NOT-'                                                      |
    +- PRIORITY--+------+-- IN--+- integer-------------+---------------------------+
    |            '- NOT-'       |     .- ,-------.     |                           |
    |                           |     V          |     |                           |
    |                           '- (---- integer-+-- )-'                           |
    +- ACTIVITY_TYPE--+------+-- IN--+- AIType-------------+-----------------------+
    |                 '- NOT-'       |     .- ,------.     |                       |
    |                                |     V         |     |                       |
    |                                '- (---- AIType-+-- )-'                       |
    +- STATE--|  BasicPredicate |--|  ITState |------------------------------------+
    +- STATE--+------+-- IN--+- ITState-------------+------------------------------+
    |         '- NOT-'       |     .- ,-------.     |                              |
    |                        |     V          |     |                              |
    |                        '- (---- ITState-+-- )-'                              |
    +- PROCESS_STATE--|  BasicPredicate |--|  PIState |----------------------------+
    +- PROCESS_STATE--+------+-- IN--+- PIState-------------+----------------------+
    |                 '- NOT-'       |     .- ,-------.     |                      |
    |                                |     V          |     |                      |
    |                                '- (---- PIState-+-- )-'                      |
    +-|  GlobalContainerMember |--|  BasicPredicate |--|  Value |------------------+
    +-|  GlobalContainerMember |--+------+-- BETWEEN--|  Value |-- AND--|  Value |-+
    |                             '- NOT-'                                         |
    +-|  GlobalContainerMember |--+------+-- IN--+-|  Value |-------------+--------+
    |                             '- NOT-'       |     .-,----------.     |        |
    |                                            |     V            |     |        |
    |                                            '- (----|  Value |-+-- )-'        |
    +-|  GlobalContainerMember |--+------+-- LIKE--+- pattern-----+----------------+
    |                             '- NOT-'         '-CURRENT_USER-'                |
    '-|  GlobalContainerMember |-- IS--+------+-- NULL-----------------------------'
                                       '- NOT-'


 
AIType

 >>-+- PROCESS_ACTIVITY-+---------------------------------------><
    '- PROGRAM_ACTIVITY-'


 
BasicPredicate

 >>-+- =--+-----------------------------------------------------><
    +- >--+
    +- >=-+
    +- <--+
    +- <=-+
    '- <>-'


 
GlobalContainerMember

 >>-+- ProcessTemplateName-+--:-- MemberName--------------------><
    '-*--------------------'


 
ITState

 >>-+- READY----------+-----------------------------------------><
    +- RUNNING--------+
    +- FINISHED-------+
    +- TERMINATED-----+
    +- SUSPENDED------+
    +- DISABLED-------+
    +- CHECKED_OUT----+
    +- IN_ERROR-------+
    +- EXECUTED-------+
    +- PLANNING-------+
    +- FORCE_FINISHED-+
    +- TERMINATING----+
    +- SUSPENDING-----+
    '- EXPIRED--------'


 
ITString

 >>-+- DESCRIPTION------+---------------------------------------><
    +- NAME-------------+
    +- PROCESS_CATEGORY-+
    '- PROCESS_NAME-----'


 
ITTimeStamp

 >>-+- CREATION_TIME----------+---------------------------------><
    +- LAST_MODIFICATION_TIME-+
    '- RECEIVED_TIME----------'


 
ITType

 >>-+- WORK_ITEM------------+-----------------------------------><
    +- PROCESS_NOTIFICATION-+
    +- FIRST_NOTIFICATION---+
    '- SECOND_NOTIFICATION--'


 
PIState

 >>-+- READY-------+--------------------------------------------><
    +- RUNNING-----+
    +- FINISHED----+
    +- TERMINATED--+
    +- SUSPENDED---+
    +- TERMINATING-+
    '- SUSPENDING--'


 
TimeStamp

 >>- year-- --- month-- --- day---------------------------------->

 >--+------------------------------------------------+----------><
    '-  -- hours--+--------------------------------+-'
                  '- :-- minutes--+--------------+-'
                                  '- :-- seconds-'


 
Value

 >>-+-+- string------+-+----------------------------------------><
    | '-CURRENT_USER-' |
    +- long integer----+
    +- float-----------+
    '- binary----------'


 

A worklist sort criterion is specified as a character string.

WLOrderBy

    .- ,-----------------------------------.
    V                                      |
 >>---+- ACTIVITY_TYPE--------+--+-------+-+--------------------><
      +-|  ITString |---------+  +- ASC--+
      +-|  ITTimeStamp |------+  '- DESC-'
      +-GlobalContainerMember-+
      +- OWNER----------------+
      +- PRIORITY-------------+
      +- PROCESS_STATE--------+
      +- STATE----------------+
      '- TYPE-----------------'


 

Notes:

  1. If a filter is specified, the default sort order is ascending. Otherwise, there is no intrinsic default sort order.

  2. Activity types are sorted according to the sequence shown in the AIType diagram.

  3. Item types are sorted according to the sequence shown in the ITType diagram.

  4. States are sorted according to the sequence shown in the ITState respectively the PIState diagram.
Throws:
FmcException - thrown if an API error or a communication error occurred.

forceLogoff

public void forceLogoff(java.lang.String userID)
                 throws FmcException

This API call allows an administrator to finish all sessions of the specified user with an MQ Workflow execution server (action call).

When logoff has been successfully executed, no further client/server calls are accepted from the closed sessions. An associated program execution agent is not affected.

Throws:
FmcException - thrown if an API error or a communication error occurred.

forceProgramExecutionAgentShutDown

public void forceProgramExecutionAgentShutDown(java.lang.String userID)
                                        throws FmcException

This API call allows an administrator to terminate the PEA sessions of the specified user with an MQ Workflow execution server (action call).

When forceProgramExecutionAgentShutDown has been successfully executed, this PEA will no longer process program invocation requests.

Throws:
FmcException - thrown if an API error or a communication error occurred.

logoff

public void logoff()
            throws FmcException

This API call allows the application to finish the specified user session with an MQ Workflow execution server (action call).

When logoff has been successfully executed, no further client/server calls are accepted using this execution service object.

Throws:
FmcException - thrown if an API error or a communication error occurred.

logon

public void logon(java.lang.String userID,
                  java.lang.String password)
           throws FmcException

This API call allows an application to establish a user session with an MQ Workflow execution server (action call). The execution server is identified by the system group and system of the execution service object which is used to issue this API call.

A successful Logon() is the prerequisite for using all other action and program execution management API calls of the MQ Workflow API.

You either log on by specifying a user ID and a password or you log on by specifying user credentials which are then verified by your authentication exit.

The user ID to log on with, respectively the user ID returned by your authentication exit, must be a registered MQ Workflow user.

When the execution server supports unified logon and when you log on with a user ID and password, an empty password and user ID can be provided. The user ID to log on with is then retrieved from the operating system, that is, logon must have been performed at the client. The client is trusted and the execution server performs no password checking.

After a successful logon, the execution service object represents that single user session. A further request to log on with a different user ID will be rejected. You can, however, establish as many sessions as needed, even for the same user, using different execution service objects, one for each session.

At logon time, you can specify your mode of operation. When you are operating in a present session mode, the execution server can assume that you are able to react to requests from activity implementations which might ask, for example, for container data. Thus, activity instances that are started automatically may be scheduled on your behalf - provided that you also started a program execution agent.

Furthermore, the present mode indicates to MQ Workflow that the session can handle unsolicited messages pushed by the execution server - see The push data access model for additional prerequisites.

There can only be a single present session for one user. The present here option can be used, to force that other present session logoff and to newly establish a present session here. Note that using a present here session mode also requests to shut down the program execution agent.

When you are operating in a default session mode, the execution server does not assume that you are able to react. Activity instances are not automatically started on your behalf and messages are not pushed to you. There can be multiple sessions for one user with the default session mode.

Throws:
FmcException - thrown if an API error or a communication error occurred.

logon2

public void logon2(java.lang.String userID,
                   java.lang.String password,
                   SessionMode mode,
                   AbsenceIndicator absenceIndicator)
            throws FmcException
See logon(java.lang.String, java.lang.String); allows for the specification of the session mode and absence setting.

Throws:
FmcException - thrown if an API error or a communication error occurred.

logon3

public void logon3(byte[] userCredentials)
            throws FmcException
See logon(java.lang.String, java.lang.String); allows for logging on with user credentials.

Throws:
FmcException -  

logon4

public void logon4(byte[] userCredentials,
                   SessionMode mode,
                   AbsenceIndicator absenceIndicator,
                   java.lang.String userName)
            throws FmcException
See logon(java.lang.String, java.lang.String); allows for logging on with user credentials and for the specification of the session mode and absence setting.

Throws:
FmcException -  

passthrough

public void passthrough()
                 throws FmcException

The native implementation of the Java API does not support this method. A call to this method throws an FMC_ERROR_NOT_SUPPORTED exception.

Throws:
FmcException - an FMC_ERROR_NOT_SUPPORTED exception is thrown

persistentActivityInstance

public ActivityInstance persistentActivityInstance(java.lang.String oid)
                                            throws FmcException
Constructs a transient activity instance object representing the persistent object identified by the passed object identification; does not contact the server.

Throws:
FmcException - thrown if an API error or a communication error occurred.

persistentActivityInstanceList

public ActivityInstanceList persistentActivityInstanceList(java.lang.String oid)
                                                    throws FmcException
Documentation for method not yet available
Parameters:
oid - Documentation for parameter not yet available
Returns:
Documentation for return value not yet available
Throws:
FmcException - Documentation for exception not yet available

persistentActivityInstanceNotification

public ActivityInstanceNotification persistentActivityInstanceNotification(java.lang.String oid)
                                                                    throws FmcException
Constructs a transient activity instance notification object representing the persistent object identified by the passed object identification; does not contact the server.

Throws:
FmcException - thrown if an API error or a communication error occurred.

persistentInstanceMonitor

public InstanceMonitor persistentInstanceMonitor(java.lang.String oid)
                                          throws FmcException
Constructs a transient instance monitor object representing the persistent object identified by the passed object identification; does not contact the server.

Throws:
FmcException - thrown if an API error or a communication error occurred.

persistentPerson

public Person persistentPerson(java.lang.String userID)
                        throws FmcException
Constructs a transient person object representing the persistent object identified by the passed user identification; does not contact the server.

Throws:
FmcException - thrown if an API error or a communication error occurred.

persistentProcessInstance

public ProcessInstance persistentProcessInstance(java.lang.String oid)
                                          throws FmcException
Constructs a transient process instance object representing the persistent object identified by the passed object identification; does not contact the server.

Throws:
FmcException - thrown if an API error or a communication error occurred.

persistentProcessInstanceList

public ProcessInstanceList persistentProcessInstanceList(java.lang.String oid)
                                                  throws FmcException
Constructs a transient process instance list object representing the persistent object identified by the passed object identification; does not contact the server.

Throws:
FmcException - thrown if an API error or a communication error occurred.

persistentProcessInstanceNotification

public ProcessInstanceNotification persistentProcessInstanceNotification(java.lang.String oid)
                                                                  throws FmcException
Constructs a transient process instance notification object representing the persistent object identified by the passed object identification; does not contact the server.

Throws:
FmcException - thrown if an API error or a communication error occurred.

persistentProcessTemplate

public ProcessTemplate persistentProcessTemplate(java.lang.String oid)
                                          throws FmcException
Constructs a transient process template object representing the persistent object identified by the passed object identification; does not contact the server.

Throws:
FmcException - thrown if an API error or a communication error occurred.

persistentProcessTemplateList

public ProcessTemplateList persistentProcessTemplateList(java.lang.String oid)
                                                  throws FmcException
Constructs a transient process template list object representing the persistent object identified by the passed object identification; does not contact the server.

Throws:
FmcException - thrown if an API error or a communication error occurred.

persistentWorkItem

public WorkItem persistentWorkItem(java.lang.String oid)
                            throws FmcException
Constructs a transient work item object representing the persistent object identified by the passed object identification; does not contact the server.

Throws:
FmcException - thrown if an API error or a communication error occurred.

persistentWorkList

public WorkList persistentWorkList(java.lang.String oid)
                            throws FmcException
Constructs a transient worklist object representing the persistent object identified by the passed object identification; does not contact the server.

Throws:
FmcException - thrown if an API error or a communication error occurred.

programDataFromStream

public ProgramData programDataFromStream(byte[] stream)
                                  throws FmcException
Constructs a transient program data object from the stream passed.

Throws:
FmcException - thrown if an API error or a communication error occurred.

programExecutionAgentShutDown

public void programExecutionAgentShutDown()
                                   throws FmcException

This API call allows to shut down the program execution agent associated to the logged on user (program execution management API call call).

The program execution agent is then shut down whether activity implementations are still running or not. Be careful to wait for any running activity implementations so that their result is correctly passed to the execution server.

Throws:
FmcException - thrown if an API error or a communication error occurred.

programExecutionAgentStartUp

public void programExecutionAgentStartUp()
                                  throws FmcException

This API call is used to start a program execution agent associated to the logged-on user (program-execution-management call).

The program execution agent is then started on the same node where this calling application runs. A single program execution agent per user is supported. All user's work, whether from this session or from others, is send to this program execution agent.

The program execution agent is not automatically shut down when the user session(s) ends; it must be possible for the program execution agent to wait for activity implementations to complete.

If you are told that the program execution agent already runs on a different node, you can issue a shutdown and try again. Be careful to wait for any running activity implementations.

Throws:
FmcException - thrown if an API error or a communication error occurred.

programTemplateFromStream

public ProgramTemplate programTemplateFromStream(byte[] stream)
                                          throws FmcException
Constructs a transient program template object from the stream passed.

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryActivityInstanceLists

public ActivityInstanceList[] queryActivityInstanceLists()
                                                  throws FmcException

This API call retrieves the activity instance lists the user has access to from the MQ Workflow execution server (action call).

Returns:
Documentation for return value not yet available
Throws:
FmcException - Documentation for exception not yet available

queryProcessInstanceLists

public ProcessInstanceList[] queryProcessInstanceLists()
                                                throws FmcException

This API call retrieves the process instance lists the user has access to from the MQ Workflow execution server (action call).

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryProcessTemplateLists

public ProcessTemplateList[] queryProcessTemplateLists()
                                                throws FmcException

This API call retrieves the current process template lists the user has access to from the MQ Workflow execution server (action call).

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryWorkLists

public WorkList[] queryWorkLists()
                          throws FmcException

This API call retrieves the worklists the user has access to from the MQ Workflow execution server (action call).

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryActivityInstances

public ActivityInstance[] queryActivityInstances(java.lang.String filter,
                                                 java.lang.String sortCriteria,
                                                 java.lang.Integer threshold)
                                          throws FmcException

This API call retrieves the current activity instances the user has access to from the MQ Workflow execution server (action call).

A filter on activity instances is specified as a character string containing a filter predicate:

Notes:

  1. A string constant is to be enclosed in single quotes (').

  2. A single quote within a string constant is to be doubled ('').

  3. A pattern is a string constant in which the asterisk and the question mark have special meanings.
    • The question mark (?) represents any single character.
    • The asterisk (*) represents a string of zero or more characters.
    • The escape character is backslash (\) and must be used when the pattern itself contains actual question marks or asterisks. An actual backslash is to be doubled (\\).

  4. A TimeStamp is a string constant, 24 hours based in local time.

  5. Optional specifications in the TimeStamp are set to 0 (zero) if not specified.

  6. A process template or global container member name which contains letters other than a-z, A-Z, and 0-9 is to be enclosed in single quotes (').

  7. For global data container member comparisons, the type of the value specified must conform to the type of the global data container member.

  8. A long integer is to be given in decimal notation.

  9. For binary literals, every byte is represented by a 2-digit hexadecimal number. The binary literal is to be preceded by 0x or 0X. For example, 0xFF is a valid binary literal.
AILFilter

 >>-+-----+--+-|  AIPredicate |------+--------------------------->
    '-NOT-'  '- (--| AILFilter |-- )-'

 >--+------------------------------------------------+----------><
    '-+- AND-+--+------+--+-|  AIPredicate |-------+-'
      '- OR--'  '- NOT-'  '- (--|  AILFilter |-- )-'


 
AIPredicate

 >>-+- STARTER--|  BasicPredicate |--+- string-------+-----------------------------+-><
    |                                '- CURRENT_USER-'                             |
    +- STARTER--+------+-- BETWEEN--+- string-------+-- AND--+- string-------+-----+
    |           '- NOT-'            '- CURRENT_USER-'        '- CURRENT_USER-'     |
    +- STARTER--+------+-- IN--+-+- string-------+---------+-----------------------+
    |           '- NOT-'       | '- CURRENT_USER-'         |                       |
    |                          '- (--+- string-------+-- )-'                       |
    |                                '- CURRENT_USER-'                             |
    +- STARTER--+------+-- LIKE--+- pattern------+---------------------------------+
    |           '- NOT-'         '- CURRENT_USER-'                                 |
    +- STARTER-- IS--+------+-- NULL-----------------------------------------------+
    |                '- NOT-'                                                      |
    +-|  AIString |--|  BasicPredicate |-- string----------------------------------+
    +-|  AIString |--+------+-- BETWEEN-- string-- AND-- string--------------------+
    |                '- NOT-'                                                      |
    +-|  AIString |--+------+-- IN--+- string-------------+------------------------+
    |                '- NOT-'       |     .- ,------.     |                        |
    |                               |     V         |     |                        |
    |                               '- (---- string-+-- )-'                        |
    +-|  AIString |--+------+-- LIKE-- pattern-------------------------------------+
    |                '- NOT-'                                                      |
    +-|  AIString |-- IS--+------+-- NULL------------------------------------------+
    |                     '- NOT-'                                                 |
    +-|  AITimeStamp |--|  BasicPredicate |--|  TimeStamp |------------------------+
    +-|  AITimeStamp |--+------+-- BETWEEN--|  TimeStamp |-- AND--|  TimeStamp |---+
    |                   '- NOT-'                                                   |
    +-|  AITimeStamp |--+------+-- IN--+-|  TimeStamp |-------------+--------------+
    |                   '- NOT-'       |     .- ,-------------.     |              |
    |                                  |     V                |     |              |
    |                                  '- (----|  TimeStamp |-+-- )-'              |
    +-|  AITimeStamp |-- IS--+------+-- NULL---------------------------------------+
    |                        '- NOT-'                                              |
    +-|  PRIORITY |--|  BasicPredicate |-- integer---------------------------------+
    +-|  PRIORITY |--+------+-- BETWEEN-- integer-- AND-- integer------------------+
    |                '- NOT-'                                                      |
    +- PRIORITY--+------+-- IN--+- integer---------+-------------------------------+
    |            '- NOT-'       '- (-- integer-- )-'                               |
    +- STATE--|  BasicPredicate |--|  AIState |------------------------------------+
    +- STATE--+------+-- IN--+- AIState-------------+------------------------------+
    |         '- NOT-'       |     .- ,-------.     |                              |
    |                        |     V          |     |                              |
    |                        '- (---- AIState-+-- )-'                              |
    +- PROCESS_STATE--|  BasicPredicate |--|  PIState |----------------------------+
    +- PROCESS_STATE--+------+-- IN--+- PIState------------+-----------------------+
    |                 '- NOT-'       |     .- ,------.     |                       |
    |                                |     V         |     |                       |
    |                                '- (----PIState-+-- )-'                       |
    +- TYPE--|  BasicPredicate |--|  AIType |--------------------------------------+
    +- TYPE--+------+-- IN--+- AIType------------+---------------------------------+
    |        '- NOT-'       |     .- ,-----.     |                                 |
    |                       |     V        |     |                                 |
    |                       '- (----AIType-+-- )-'                                 |
    +-|  GlobalContainerMember |--+------+-- BETWEEN--|  Value |-- AND--|  Value |-+
    |                             '- NOT-'                                         |
    +-|  GlobalContainerMember |--|  BasicPredicate |--|  Value |------------------+
    +-|  GlobalContainerMember |--+------+-- IN--+-|  Value |-------------+--------+
    |                             '- NOT-'       |     .- ,---------.     |        |
    |                                            |     V            |     |        |
    |                                            '- (----|  Value |-+-- )-'        |
    +-|  GlobalContainerMember |--+------+-- LIKE--+- pattern-----+----------------+
    |                             '- NOT-'         '-CURRENT_USER-'                |
    '-|  GlobalContainerMember |-- IS--+------+-- NULL-----------------------------'
                                       '- NOT-'


 
BasicPredicate

 >>-+- =--+-----------------------------------------------------><
    +- >--+
    +- >=-+
    +- <--+
    +- <=-+
    '- <>-'


 
GlobalContainerMember

 >>-+- ProcessTemplateName-+--:-- MemberName--------------------><
    '- *-------------------'


 
AIState

 >>-+- READY----------+-----------------------------------------><
    +- RUNNING--------+
    +- FINISHED-------+
    +- TERMINATED-----+
    +- SUSPENDED------+
    +- INACTIVE-------+
    +- CHECKED_OUT----+
    +- IN_ERROR-------+
    +- EXECUTED-------+
    +- FORCE_FINISHED-+
    +- SKIPPED--------+
    +- TERMINATING----+
    +- SUSPENDING-----+
    '- EXPIRED--------'


 
PIState

 >>-+- READY-------+--------------------------------------------><
    +- RUNNING-----+
    +- FINISHED----+
    +- TERMINATED--+
    +- SUSPENDED---+
    +- TERMINATING-+
    '- SUSPENDING--'


 
AIString

 >>-+- PROCESS_CATEGORY-+---------------------------------------><
    +- DESCRIPTION------+
    +- IMPLEMENTATION---+
    +- PROCESS_NAME-----+
    +- FULL_NAME--------+
    '- NAME-------------'


 
AIType

 >>-+- PROGRAM_ACTIVITY-+---------------------------------------><
    +- PROCESS_ACTIVITY-+
    '- BLOCK_ACTIVITY---'


 
AITimeStamp

 >>-+- ACTIVATION_TIME--------+---------------------------------><
    +- LAST_MODIFICATION_TIME-+
    +- LAST_STATE_CHANGE_TIME-+
    '- START_TIME-------------'


 
TimeStamp

 >>- year-- --- month-- --- day---------------------------------->

 >--+------------------------------------------------+----------><
    '-  -- hours--+--------------------------------+-'
                  '- :-- minutes--+--------------+-'
                                  '- :-- seconds-'


 
Value

 >>-+-+- string------+-+----------------------------------------><
    | '-CURRENT_USER-' |
    +- long integer----+
    +- float-----------+
    '- binary----------'


 

Activity instances can be sorted. An activity instance sort criterion is specified as a character string.

AILOrderBy

    .- ,------------------------------------.
    V                                       |
 >>---+- STARTER---------------+--+-------+-+-------------------><
      +-|  AIString |----------+  +- ASC--+
      +-|  AITimeStamp |-------+  '- DESC-'
      +- GlobalContainerMember-+
      +- STATE-----------------+
      +- PROCESS_STATE---------+
      +- PRIORITY--------------+
      '- TYPE------------------'


 

Notes:

  1. If a filter is specified, the default sort order is ascending. Otherwise, there is no intrinsic default sort order.

  2. States are sorted according to the sequence shown in the AIState diagram.

The number of activity instances to be retrieved can be restricted via a threshold which specifies the maximum number of activity instances to be returned to the client. That threshold is applied after the activity instances have been sorted according to the sort criteria specified. Note that the activity instances are sorted on the server, that is, the code page of the server determines the sort sequence.

The primary information that is retrieved for each activity instance is:

Parameters:
filter - Documentation for parameter not yet available
sortCriteria - Documentation for parameter not yet available
threshold - Documentation for parameter not yet available
Returns:
Documentation for return value not yet available
Throws:
FmcException - Documentation for exception not yet available

queryProcessInstances

public ProcessInstance[] queryProcessInstances(java.lang.String filter,
                                               java.lang.String sortCriteria,
                                               java.lang.Integer threshold)
                                        throws FmcException

This API call retrieves the current process instances the user has access to from the MQ Workflow execution server (action call).

A filter on process instances is specified as a character string containing a filter predicate:

Notes:

  1. A string constant is to be enclosed in single quotes (').

  2. A single quote within a string constant is to be doubled ('').

  3. A pattern is a string constant in which the asterisk and the question mark have special meanings.
    • The question mark (?) represents any single character.
    • The asterisk (*) represents a string of zero or more characters.
    • The escape character is backslash (\) and must be used when the pattern itself contains actual question marks or asterisks. An actual backslash is to be doubled (\\).

  4. A TimeStamp is a string constant, 24 hours based in local time.

  5. Optional specifications in the TimeStamp are set to 0 (zero) if not specified.

  6. A process template or global container member name which contains letters other than a-z, A-Z, and 0-9 is to be enclosed in single quotes (').

  7. For global data container member comparisons, the type of the value specified must conform to the type of the global data container member.

  8. A long integer is to be given in decimal notation.

  9. For binary literals, every byte is represented by a 2-digit hexadecimal number. The binary literal is to be preceded by 0x or 0X. For example, 0xFF is a valid binary literal.
PIFilter

 >>-+------+--+-|  PIPredicate |------+-------------------------->
    '- NOT-'  '- (--|  PIFilter |-- )-'

 >--+---------------------------------------------------+-------><
    '-+- AND-+--+------+--+-|  PIPredicate |----------+-'
      '- OR--'  '- NOT-'  | .-----------------------. |
                          | V                       | |
                          '--- (--|  PIFilter |-- )-+-'


 
PIPredicate

 >>-+-|  PIString |--|  BasicPredicate |-- string----------------------------------+-><
    +-|  PIString |--+------+-- BETWEEN-- string-- AND-- string--------------------+
    |                '- NOT-'                                                      |
    +-|  PIString |--+------+-- IN--+- string-------------+------------------------+
    |                '- NOT-'       |     .- ,------.     |                        |
    |                               |     V         |     |                        |
    |                               '- (---- string-+-- )-'                        |
    +-|  PIString |--+------+-- LIKE-- pattern-------------------------------------+
    |                '- NOT-'                                                      |
    +-|  PIString |-- IS--+------+-- NULL------------------------------------------+
    |                     '- NOT-'                                                 |
    +-|  PITimeStamp |--|  BasicPredicate |--|  TimeStamp |------------------------+
    +-|  PITimeStamp |--+------+-- BETWEEN--|  TimeStamp |-- AND--|  TimeStamp |---+
    |                   '- NOT-'                                                   |
    +-|  PITimeStamp |--+------+-- IN--+-|  TimeStamp |-------------+--------------+
    |                   '- NOT-'       |     .- ,-------------.     |              |
    |                                  |     V                |     |              |
    |                                  '- (----|  TimeStamp |-+-- )-'              |
    +-|  PITimeStamp |-- IS--+------+-- NULL---------------------------------------+
    |                        '- NOT-'                                              |
    +- STATE--|  BasicPredicate |--|  PIState |------------------------------------+
    +- STATE--+------+-- IN--+- PIState-------------+------------------------------+
    |         '- NOT-'       |     .- ,-------.     |                              |
    |                        |     V          |     |                              |
    |                        '- (---- PIState-+-- )-'                              |
    +- NAME--|  BasicPredicate |-- TOP_LEVEL_PROCESS_NAME--------------------------+
    +-|  GlobalContainerMember |--|  BasicPredicate |--|  Value |------------------+
    +-|  GlobalContainerMember |--+------+-- BETWEEN--|  Value |-- AND--|  Value |-+
    |                             '- NOT-'                                         |
    +-|  GlobalContainerMember |--+------+-- IN--+-|  Value |-------------+--------+
    |                             '- NOT-'       |     .- ,---------.     |        |
    |                                            |     V            |     |        |
    |                                            '- (----|  Value |-+-- )-'        |
    +-|  GlobalContainerMember |--+------+-- LIKE--+- pattern-----+----------------+
    |                             '- NOT-'         '-CURRENT_USER-'                |
    '-|  GlobalContainerMember |-- IS--+------+-- NULL-----------------------------'
                                       '- NOT-'


 
BasicPredicate

 >>-+- =--+-----------------------------------------------------><
    +- >--+
    +- >=-+
    +- <--+
    +- <=-+
    '- <>-'


 
GlobalContainerMember

 >>-+- ProcessTemplateName-+--:-- MemberName--------------------><
    '-*--------------------'


 
PIState

 >>-+- READY-------+--------------------------------------------><
    +- RUNNING-----+
    +- FINISHED----+
    +- TERMINATED--+
    +- SUSPENDED---+
    +- TERMINATING-+
    '- SUSPENDING--'


 
PIString

 >>-+- ADMINISTRATOR----------+---------------------------------><
    +- CATEGORY---------------+
    +- DESCRIPTION------------+
    +- NAME-------------------+
    +- PARENT_PROCESS_NAME----+
    +- PROCESS_CONTEXT--------+
    +- PROCESS_TEMPLATE_NAME--+
    '- TOP_LEVEL_PROCESS_NAME-'


 
PITimeStamp

 >>-+- LAST_MODIFICATION_TIME-+---------------------------------><
    +- LAST_STATE_CHANGE_TIME-+
    +- START_TIME-------------+
    '- VALID_FROM_TIME--------'


 
TimeStamp

 >>- year-- --- month-- --- day---------------------------------->

 >--+------------------------------------------------+----------><
    '-  -- hours--+--------------------------------+-'
                  '- :-- minutes--+--------------+-'
                                  '- :-- seconds-'


 
Value

 >>-+-+- string------+-+----------------------------------------><
    | '-CURRENT_USER-' |
    +- long integer----+
    +- float-----------+
    '- binary----------'


 

Process instances can be sorted. A process instance sort criterion is specified as a character string.

PIOrderBy

    .- ,------------------------------------.
    V                                       |
 >>---+-|  PIString |----------+--+-------+-+-------------------><
      +-|  PITimeStamp |-------+  +- ASC--+
      +- GlobalContainerMember-+  '- DESC-'
      '- STATE-----------------'


 

Notes:

  1. If a filter is specified, the default sort order is ascending. Otherwise, there is no intrinsic default sort order.

  2. States are sorted according to the sequence shown in the PIState diagram.

The number of process instances to be retrieved can be restricted via a threshold which specifies the maximum number of process instances to be returned to the client. That threshold is applied after the process instances have been sorted according to the sort criteria specified. Note that the process instances are sorted on the server, that is, the code page of the server determines the sort sequence.

The primary information that is retrieved for each process instance is:

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryProcessTemplates

public ProcessTemplate[] queryProcessTemplates(java.lang.String filter,
                                               java.lang.String sortCriteria,
                                               java.lang.Integer threshold)
                                        throws FmcException

This API call retrieves the current process templates from the MQ Workflow execution server (action call).

A filter on process templates is specified as a character string containing a filter predicate:

Notes:

  1. A string constant is to be enclosed in single quotes (').

  2. A single quote within a string constant is to be doubled ('').

  3. A pattern is a string constant in which the asterisk and the question mark have special meanings.
    • The question mark (?) represents any single character.
    • The asterisk (*) represents a string of zero or more characters.
    • The escape character is backslash (\) and must be used when the pattern itself contains actual question marks or asterisks. An actual backslash is to be doubled (\\).

  4. A TimeStamp is a string constant, 24 hours based in local time.

  5. Optional specifications in the TimeStamp are set to 0 (zero) if not specified.
PTFilter

 >>-+------+--+-|  PTPredicate |------+-------------------------->
    '- NOT-'  '- (--|  PTFilter |-- )-'

 >--+---------------------------------------------------+-------><
    '-+- AND-+--+------+--+-|  PTPredicate |----------+-'
      '- OR--'  '- NOT-'  | .-----------------------. |
                          | V                       | |
                          '--- (--|  PTFilter |-- )-+-'


 
PTPredicate

 >>-+-|  PTString |--|  BasicPredicate |-- string--------------------------------+-><
    +-|  PTString |--+------+-- BETWEEN-- string-- AND-- string------------------+
    |                '- NOT-'                                                    |
    +-|  PTString |--+------+-- IN--+- string-------------+----------------------+
    |                '- NOT-'       |     .- ,------.     |                      |
    |                               |     V         |     |                      |
    |                               '- (---- string-+-- )-'                      |
    +-|  PTString |--+------+-- LIKE-- pattern-----------------------------------+
    |                '- NOT-'                                                    |
    +-|  PIString |-- IS--+------+-- NULL----------------------------------------+
    |                     '- NOT-'                                               |
    +-|  PTTimeStamp |--|  BasicPredicate |--|  TimeStamp |----------------------+
    +-|  PTTimeStamp |--+------+-- BETWEEN--|  TimeStamp |-- AND--|  TimeStamp |-+
    |                   '- NOT-'                                                 |
    +-|  PTTimeStamp |--+------+-- IN--+-|  TimeStamp |-------------+------------+
    |                   '- NOT-'       |     .- ,-------------.     |            |
    |                                  |     V                |     |            |
    |                                  '- (----|  TimeStamp |-+-- )-'            |
    '-|  PTTimeStamp |-- IS--+------+-- NULL-------------------------------------'
                             '- NOT-'


 
BasicPredicate

 >>-+- =--+-----------------------------------------------------><
    +- >--+
    +- >=-+
    +- <--+
    +- <=-+
    '- <>-'


 
PTString

 >>-+- CATEGORY----+--------------------------------------------><
    +- DESCRIPTION-+
    '- NAME--------'


 
PTTimeStamp

 >>--- LAST_MODIFICATION_TIME-----------------------------------><


 
TimeStamp

 >>- year-- --- month-- --- day---------------------------------->

 >--+------------------------------------------------+----------><
    '-  -- hours--+--------------------------------+-'
                  '- :-- minutes--+--------------+-'
                                  '- :-- seconds-'


 

Process templates can be sorted. A process template sort criterion is specified as a character string.

PTOrderBy

    .- ,------------------------------.
    V                                 |
 >>---+-|  PTString |----+--+-------+-+-------------------------><
      '-|  PTTimeStamp |-'  +- ASC--+
                            '- DESC-'


 
Note:
If a filter is specified, the default sort order is ascending. Otherwise, there is no intrinsic default sort order.

The number of process templates to be retrieved can be restricted via a threshold which specifies the maximum number of process templates to be returned to the client. That threshold is applied after the process templates have been sorted according to the sort criteria specified. Note that the process templates are sorted on the server, that is, the code page of the server determines the sort sequence.

The primary information that is retrieved for each process template is:

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryItems

public Item[] queryItems(java.lang.String filter,
                         java.lang.String sortCriteria,
                         java.lang.Integer threshold)
                  throws FmcException

This API call retrieves the work items or notifications the user has access to from the MQ Workflow execution server (action call).

The items to be retrieved can be characterized by a filter. An item filter is specified as a character string.

Notes:

  1. A string constant is to be enclosed in single quotes (').

  2. A single quote within a string constant is to be doubled ('').

  3. A pattern is a string constant in which the asterisk and the question mark have special meanings.
    • The question mark (?) represents any single character.
    • The asterisk (*) represents a string of zero or more characters.
    • The escape character is backslash (\) and must be used when the pattern itself contains actual question marks or asterisks. An actual backslash is to be doubled (\\).

  4. A TimeStamp is a string constant, 24 hours based in local time.

  5. Optional specifications in the TimeStamp are set to 0 (zero) if not specified.

  6. A process template or global container member name which contains letters other than a-z, A-Z, and 0-9 is to be enclosed in single quotes (').

  7. For global data container member comparisons, the type of the value specified must conform to the type of the global data container member.

  8. A long integer is to be given in decimal notation.

  9. For binary literals, every byte is represented by a 2-digit hexadecimal number. The binary literal is to be preceded by 0x or 0X. For example, 0xFF is a valid binary literal.
ItemFilter

 >>-+------+--+-|  ITPredicate-1 |------+------------------------>
    '- NOT-'  +-|  ITPredicate-2 |------+
              '- (--|  ItemFilter |-- )-'

 >--+-----------------------------------------------------+-----><
    '-+- AND-+--+------+--+-|  ITPredicate-1 |----------+-'
      '- OR--'  '- NOT-'  +-|  ITPredicate-2 |----------+
                          | .-------------------------. |
                          | V                         | |
                          '--- (--|  ItemFilter |-- )-+-'


 
ITPredicate-1

 >>-+- OWNER--|  BasicPredicate |--+- string-------+-----------------------------+-><
    |                              '- CURRENT_USER-'                             |
    +- OWNER--+------+-- BETWEEN--+- string-------+-- AND--+- string-------+-----+
    |         '- NOT-'            '- CURRENT_USER-'        '- CURRENT_USER-'     |
    +- OWNER--+------+-- IN--+-+- string-------+-------------+-------------------+
    |         '- NOT-'       | '- CURRENT_USER-'             |                   |
    |                        |     .- ,----------------.     |                   |
    |                        |     V                   |     |                   |
    |                        '- (----+- string-------+-+-- )-'                   |
    |                                '- CURRENT_USER-'                           |
    +- OWNER--+------+-- LIKE--+- pattern------+---------------------------------+
    |         '- NOT-'         '- CURRENT_USER-'                                 |
    +- OWNER-- IS--+------+-- NULL-----------------------------------------------+
    |              '- NOT-'                                                      |
    +-|  ITString |--|  BasicPredicate |-- string--------------------------------+
    +-|  ITString |--+------+-- BETWEEN-- string-- AND-- string------------------+
    |                '- NOT-'                                                    |
    +-|  ITString |--+------+-- IN--+- string-------------+----------------------+
    |                '- NOT-'       |     .- ,------.     |                      |
    |                               |     V         |     |                      |
    |                               '- (---- string-+-- )-'                      |
    +-|  ITString |--+------+-- LIKE-- pattern-----------------------------------+
    |                '- NOT-'                                                    |
    +-|  ITString |-- IS--+------+-- NULL----------------------------------------+
    |                     '- NOT-'                                               |
    +-|  ITTimeStamp |--|  BasicPredicate |--|  TimeStamp |----------------------+
    +-|  ITTimeStamp |--+------+-- BETWEEN--|  TimeStamp |-- AND--|  TimeStamp |-+
    |                   '- NOT-'                                                 |
    +-|  ITTimeStamp |--+------+-- IN--+-|  TimeStamp |-------------+------------+
    |                   '- NOT-'       |     .- ,-------------.     |            |
    |                                  |     V                |     |            |
    |                                  '- (----|  TimeStamp |-+-- )-'            |
    +-|  ITTimeStamp |-- IS--+------+-- NULL-------------------------------------+
    |                        '- NOT-'                                            |
    +-|  PRIORITY |--|  BasicPredicate |-- integer-------------------------------+
    +-|  PRIORITY |--+------+-- BETWEEN-- integer-- AND-- integer----------------+
    |                '- NOT-'                                                    |
    +- PRIORITY--+------+-- IN--+- integer-------------+-------------------------+
    |            '- NOT-'       |     .- ,-------.     |                         |
    |                           |     V          |     |                         |
    |                           '- (---- integer-+-- )-'                         |
    +- ACTIVITY_TYPE--+------+-- IN--+- AIType-------------+---------------------+
    |                 '- NOT-'       |     .- ,------.     |                     |
    |                                |     V         |     |                     |
    |                                '- (---- AIType-+-- )-'                     |
    +- STATE--|  BasicPredicate |--|  ITState |----------------------------------+
    '- STATE--+------+-- IN--+- ITState-------------+----------------------------'
              '- NOT-'       |     .- ,-------.     |
                             |     V          |     |
                             '- (---- ITState-+-- )-'


 
ITPredicate-2

 >>-+- PROCESS_STATE--|  BasicPredicate |--|  PIState |----------------------------+-><
    +- PROCESS_STATE--+------+-- IN--+- PIState-------------+----------------------+
    |                 '- NOT-'       |     .- ,-------.     |                      |
    |                                |     V          |     |                      |
    |                                '- (---- PIState-+-- )-'                      |
    +-|  GlobalContainerMember |--|  BasicPredicate |--|  Value |------------------+
    +-|  GlobalContainerMember |--+------+-- BETWEEN--|  Value |-- AND--|  Value |-+
    |                             '- NOT-'                                         |
    +-|  GlobalContainerMember |--+------+-- IN--+-|  Value |-------------+--------+
    |                             '- NOT-'       |     .- ,---------.     |        |
    |                                            |     V            |     |        |
    |                                            '- (----|  Value |-+-- )-'        |
    +-|  GlobalContainerMember |--+------+-- LIKE--+- pattern-----+----------------+
    |                             '- NOT-'         '-CURRENT_USER-'                |
    '-|  GlobalContainerMember |-- IS--+------+-- NULL-----------------------------'
                                       '- NOT-'


 
AIType

 >>-+- PROCESS_ACTIVITY-+---------------------------------------><
    '- PROGRAM_ACTIVITY-'


 
BasicPredicate

 >>-+- =--+-----------------------------------------------------><
    +- >--+
    +- >=-+
    +- <--+
    +- <=-+
    '- <>-'


 
GlobalContainerMember

 >>-+- ProcessTemplateName-+--:-- MemberName--------------------><
    '-*--------------------'


 
ITState

 >>-+- READY----------+-----------------------------------------><
    +- RUNNING--------+
    +- FINISHED-------+
    +- TERMINATED-----+
    +- SUSPENDED------+
    +- DISABLED-------+
    +- CHECKED_OUT----+
    +- IN_ERROR-------+
    +- EXECUTED-------+
    +- PLANNING-------+
    +- FORCE_FINISHED-+
    +- TERMINATING----+
    +- SUSPENDING-----+
    '- EXPIRED--------'


 
ITString

 >>-+- DESCRIPTION------+---------------------------------------><
    +- NAME-------------+
    +- PROCESS_CATEGORY-+
    '- PROCESS_NAME-----'


 
ITTimeStamp

 >>-+- CREATION_TIME----------+---------------------------------><
    +- LAST_MODIFICATION_TIME-+
    '- RECEIVED_TIME----------'


 
PIState

 >>-+- READY-------+--------------------------------------------><
    +- RUNNING-----+
    +- FINISHED----+
    +- TERMINATED--+
    +- SUSPENDED---+
    +- TERMINATING-+
    '- SUSPENDING--'


 
TimeStamp

 >>- year-- --- month-- --- day---------------------------------->

 >--+------------------------------------------------+----------><
    '-  -- hours--+--------------------------------+-'
                  '- :-- minutes--+--------------+-'
                                  '- :-- seconds-'


 
Value

 >>-+-+- string------+-+----------------------------------------><
    | '-CURRENT_USER-' |
    +- long integer----+
    +- float-----------+
    '- binary----------'


 

Items can be sorted. An item sort criterion is specified as a character string.

ItemOrderBy

    .- ,------------------------------------.
    V                                       |
 >>---+- ACTIVITY_TYPE---------+--+-------+-+-------------------><
      +-|  ITString |----------+  +- ASC--+
      +-|  ITTimeStamp |-------+  '- DESC-'
      +- GlobalContainerMember-+
      +- OWNER-----------------+
      +- PRIORITY--------------+
      +- PROCESS_STATE---------+
      '- STATE-----------------'


 

Notes:

  1. If a filter is specified, the default sort order is ascending. Otherwise, there is no intrinsic default sort order.

  2. Activity types are sorted according to the sequence shown in the AIType diagram.

  3. States are sorted according to the sequence shown in the ITState respectively the PIState diagram.

The number of items to be retrieved can be restricted via a threshold which specifies the maximum number of items to be returned to the client. That threshold is applied after the items have been sorted according to the sort criteria specified. Note that the items are sorted on the server, that is, the code page of the server determines the sort sequence.

The primary information that is retrieved for each item is:

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryWorkItems

public WorkItem[] queryWorkItems(java.lang.String filter,
                                 java.lang.String sortCriteria,
                                 java.lang.Integer threshold)
                          throws FmcException

This API call retrieves the work items the user has access to from the MQ Workflow execution server (action call).

The work items to be retrieved can be characterized by a filter. A work item filter is specified as a character string:

Notes:

  1. A string constant is to be enclosed in single quotes (').

  2. A single quote within a string constant is to be doubled ('').

  3. A pattern is a string constant in which the asterisk and the question mark have special meanings.
    • The question mark (?) represents any single character.
    • The asterisk (*) represents a string of zero or more characters.
    • The escape character is backslash (\) and must be used when the pattern itself contains actual question marks or asterisks. An actual backslash is to be doubled (\\).

  4. A TimeStamp is a string constant, 24 hours based in local time.

  5. Optional specifications in the TimeStamp are set to 0 (zero) if not specified.

  6. A process template or global container member name which contains letters other than a-z, A-Z, and 0-9 is to be enclosed in single quotes (').

  7. For global data container member comparisons, the type of the value specified must conform to the type of the global data container member.

  8. A long integer is to be given in decimal notation.

  9. For binary literals, every byte is represented by a 2-digit hexadecimal number. The binary literal is to be preceded by 0x or 0X. For example, 0xFF is a valid binary literal.
WIFilter

 >>-+------+--+-|  ITPredicate-1 |----+-------------------------->
    '- NOT-'  +-|  ITPredicate-2 |----+
              '- (--|  WIFilter |-- )-'

 >--+---------------------------------------------------+-------><
    '-+- AND-+--+------+--+-|  ITPredicate-1 |--------+-'
      '- OR--'  '- NOT-'  +-|  ITPredicate-2 |--------+
                          | .-----------------------. |
                          | V                       | |
                          '--- (--|  WIFilter |-- )-+-'


 
ITPredicate-1

 >>-+- OWNER--|  BasicPredicate |--+- string-------+-----------------------------+-><
    |                              '- CURRENT_USER-'                             |
    +- OWNER--+------+-- BETWEEN--+- string-------+-- AND--+- string-------+-----+
    |         '- NOT-'            '- CURRENT_USER-'        '- CURRENT_USER-'     |
    +- OWNER--+------+-- IN--+-+- string-------+-------------+-------------------+
    |         '- NOT-'       | '- CURRENT_USER-'             |                   |
    |                        |     .- ,----------------.     |                   |
    |                        |     V                   |     |                   |
    |                        '- (----+- string-------+-+-- )-'                   |
    |                                '- CURRENT_USER-'                           |
    +- OWNER--+------+-- LIKE--+- pattern------+---------------------------------+
    |         '- NOT-'         '- CURRENT_USER-'                                 |
    +- OWNER-- IS--+------+-- NULL-----------------------------------------------+
    |              '- NOT-'                                                      |
    +-|  ITString |--|  BasicPredicate |-- string--------------------------------+
    +-|  ITString |--+------+-- BETWEEN-- string-- AND-- string------------------+
    |                '- NOT-'                                                    |
    +-|  ITString |--+------+-- IN--+- string-------------+----------------------+
    |                '- NOT-'       |     .- ,------.     |                      |
    |                               |     V         |     |                      |
    |                               '- (---- string-+-- )-'                      |
    +-|  ITString |--+------+-- LIKE-- pattern-----------------------------------+
    |                '- NOT-'                                                    |
    +-|  ITString |-- IS--+------+-- NULL----------------------------------------+
    |                     '- NOT-'                                               |
    +-|  ITTimeStamp |--|  BasicPredicate |--|  TimeStamp |----------------------+
    +-|  ITTimeStamp |--+------+-- BETWEEN--|  TimeStamp |-- AND--|  TimeStamp |-+
    |                   '- NOT-'                                                 |
    +-|  ITTimeStamp |--+------+-- IN--+-|  TimeStamp |-------------+------------+
    |                   '- NOT-'       |     .- ,-------------.     |            |
    |                                  |     V                |     |            |
    |                                  '- (----|  TimeStamp |-+-- )-'            |
    +-|  ITTimeStamp |-- IS--+------+-- NULL-------------------------------------+
    |                        '- NOT-'                                            |
    +-|  PRIORITY |--|  BasicPredicate |-- integer-------------------------------+
    +-|  PRIORITY |--+------+-- BETWEEN-- integer-- AND-- integer----------------+
    |                '- NOT-'                                                    |
    +- PRIORITY--+------+-- IN--+- integer-------------+-------------------------+
    |            '- NOT-'       |     .- ,-------.     |                         |
    |                           |     V          |     |                         |
    |                           '- (---- integer-+-- )-'                         |
    +- ACTIVITY_TYPE--+------+-- IN--+- AIType-------------+---------------------+
    |                 '- NOT-'       |     .- ,------.     |                     |
    |                                |     V         |     |                     |
    |                                '- (---- AIType-+-- )-'                     |
    +- STATE--|  BasicPredicate |--|  ITState |----------------------------------+
    '- STATE--+------+-- IN--+- ITState-------------+----------------------------'
              '- NOT-'       |     .- ,-------.     |
                             |     V          |     |
                             '- (---- ITState-+-- )-'


 
ITPredicate-2

 >>-+- PROCESS_STATE--|  BasicPredicate |--|  PIState |-------------------------+-><
    +- PROCESS_STATE--+------+-- IN--+- PIState-------------+-------------------+
    |                 '- NOT-'       |     .- ,-------.     |                   |
    |                                |     V          |     |                   |
    |                                '- (---- PIState-+-- )-'                   |
    +-| GlobalContainerMember |--+------+-- BETWEEN--| Value |-- AND--| Value |-+
    |                            '- NOT-'                                       |
    +-|  GlobalContainerMember |--|  BasicPredicate |--|  Value |---------------+
    +-|  GlobalContainerMember |--+------+-- IN--+-|  Value |-------------+-----+
    |                             '- NOT-'       |     .- ,---------.     |     |
    |                                            |     V            |     |     |
    |                                            '- (----|  Value |-+-- )-'     |
    +-|  GlobalContainerMember |--+------+-- LIKE--+- pattern-----+-------------+
    |                             '- NOT-'         '-CURRENT_USER-'             |
    '-|  GlobalContainerMember |-- IS--+------+-- NULL--------------------------'
                                       '- NOT-'


 
AIType

 >>-+- PROCESS_ACTIVITY-+---------------------------------------><
    '- PROGRAM_ACTIVITY-'


 
BasicPredicate

 >>-+- =--+-----------------------------------------------------><
    +- >--+
    +- >=-+
    +- <--+
    +- <=-+
    '- <>-'


 
GlobalContainerMember

 >>-+- ProcessTemplateName-+--:-- MemberName--------------------><
    '-*--------------------'


 
ITState

 >>-+- READY----------+-----------------------------------------><
    +- RUNNING--------+
    +- FINISHED-------+
    +- TERMINATED-----+
    +- SUSPENDED------+
    +- DISABLED-------+
    +- CHECKED_OUT----+
    +- IN_ERROR-------+
    +- EXECUTED-------+
    +- PLANNING-------+
    +- FORCE_FINISHED-+
    +- TERMINATING----+
    +- SUSPENDING-----+
    '- EXPIRED--------'


 
ITString

 >>-+- DESCRIPTION------+---------------------------------------><
    +- NAME-------------+
    +- PROCESS_CATEGORY-+
    '- PROCESS_NAME-----'


 
ITTimeStamp

 >>-+- CREATION_TIME----------+---------------------------------><
    +- LAST_MODIFICATION_TIME-+
    '- RECEIVED_TIME----------'


 
PIState

 >>-+- READY-------+--------------------------------------------><
    +- RUNNING-----+
    +- FINISHED----+
    +- TERMINATED--+
    +- SUSPENDED---+
    +- TERMINATING-+
    '- SUSPENDING--'


 
TimeStamp

 >>- year-- --- month-- --- day---------------------------------->

 >--+------------------------------------------------+----------><
    '-  -- hours--+--------------------------------+-'
                  '- :-- minutes--+--------------+-'
                                  '- :-- seconds-'


 
Value

 >>-+-+- string------+-+----------------------------------------><
    | '-CURRENT_USER-' |
    +- long integer----+
    +- float-----------+
    '- binary----------'


 

Work items can be sorted. A work item sort criterion is specified as a character string.

WIOrderBy

    .- ,------------------------------------.
    V                                       |
 >>---+- ACTIVITY_TYPE---------+--+-------+-+-------------------><
      +-|  ITString |----------+  +- ASC--+
      +-|  ITTimeStamp |-------+  '- DESC-'
      +- GlobalContainerMember-+
      +- OWNER-----------------+
      +- PRIORITY--------------+
      +- PROCESS_STATE---------+
      '- STATE-----------------'


 

Notes:

  1. If a filter is specified, the default sort order is ascending. Otherwise, there is no intrinsic default sort order.

  2. Activity types are sorted according to the sequence shown in the AIType diagram.

  3. States are sorted according to the sequence shown in the ITState respectively the PIState diagram.

The number of work items to be retrieved can be restricted via a threshold which specifies the maximum number of work items to be returned to the client. That threshold is applied after the items have been sorted according to the sort criteria specified. Note that the items are sorted on the server, that is, the code page of the server determines the sort sequence.

The primary information that is retrieved for each work item is:

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryActivityInstanceNotifications

public ActivityInstanceNotification[] queryActivityInstanceNotifications(java.lang.String filter,
                                                                         java.lang.String sortCriteria,
                                                                         java.lang.Integer threshold)
                                                                  throws FmcException

This API call retrieves the activity instance notifications the user has access to from the MQ Workflow execution server (action call).

The activity instance notifications to be retrieved can be characterized by a filter. An activity instance notification filter is specified as a character string:

Notes:

  1. A string constant is to be enclosed in single quotes (').

  2. A single quote within a string constant is to be doubled ('').

  3. A pattern is a string constant in which the asterisk and the question mark have special meanings.
    • The question mark (?) represents any single character.
    • The asterisk (*) represents a string of zero or more characters.
    • The escape character is backslash (\) and must be used when the pattern itself contains actual question marks or asterisks. An actual backslash is to be doubled (\\).

  4. A TimeStamp is a string constant, 24 hours based in local time.

  5. Optional specifications in the TimeStamp are set to 0 (zero) if not specified.

  6. A process template or global container member name which contains letters other than a-z, A-Z, and 0-9 is to be enclosed in single quotes (').

  7. For global data container member comparisons, the type of the value specified must conform to the type of the global data container member.

  8. A long integer is to be given in decimal notation.

  9. For binary literals, every byte is represented by a 2-digit hexadecimal number. The binary literal is to be preceded by 0x or 0X. For example, 0xFF is a valid binary literal.
AINFilter

 >>-+------+--+-|  ITPredicate-1 |-----+------------------------->
    '- NOT-'  +-|  ITPredicate-2 |-----+
              '- (--|  AINFilter |-- )-'

 >--+----------------------------------------------------+------><
    '-+- AND-+--+------+--+-|  ITPredicate-1 |---------+-'
      '- OR--'  '- NOT-'  +-|  ITLPredicate-2 |--------+
                          | .------------------------. |
                          | V                        | |
                          '--- (--|  AINFilter |-- )-+-'


 
ITPredicate-1

 >>-+- OWNER--|  BasicPredicate |--+- string-------+-----------------------------+-><
    |                              '- CURRENT_USER-'                             |
    +- OWNER--+------+-- BETWEEN--+- string-------+-- AND--+- string-------+-----+
    |         '- NOT-'            '- CURRENT_USER-'        '- CURRENT_USER-'     |
    +- OWNER--+------+-- IN--+-+- string-------+-------------+-------------------+
    |         '- NOT-'       | '- CURRENT_USER-'             |                   |
    |                        |     .- ,----------------.     |                   |
    |                        |     V                   |     |                   |
    |                        '- (----+- string-------+-+-- )-'                   |
    |                                '- CURRENT_USER-'                           |
    +- OWNER--+------+-- LIKE--+- pattern------+---------------------------------+
    |         '- NOT-'         '- CURRENT_USER-'                                 |
    +- OWNER-- IS--+------+-- NULL-----------------------------------------------+
    |              '- NOT-'                                                      |
    +-|  ITString |--|  BasicPredicate |-- string--------------------------------+
    +-|  ITString |--+------+-- BETWEEN-- string-- AND-- string------------------+
    |                '- NOT-'                                                    |
    +-|  ITString |--+------+-- IN--+- string-------------+----------------------+
    |                '- NOT-'       |     .- ,------.     |                      |
    |                               |     V         |     |                      |
    |                               '- (---- string-+-- )-'                      |
    +-|  ITString |--+------+-- LIKE-- pattern-----------------------------------+
    |                '- NOT-'                                                    |
    +-|  ITString |-- IS--+------+-- NULL----------------------------------------+
    |                     '- NOT-'                                               |
    +-|  ITTimeStamp |--|  BasicPredicate |--|  TimeStamp |----------------------+
    +-|  ITTimeStamp |--+------+-- BETWEEN--|  TimeStamp |-- AND--|  TimeStamp |-+
    |                   '- NOT-'                                                 |
    +-|  ITTimeStamp |--+------+-- IN--+-|  TimeStamp |-------------+------------+
    |                   '- NOT-'       |     .- ,-------------.     |            |
    |                                  |     V                |     |            |
    |                                  '- (----|  TimeStamp |-+-- )-'            |
    +-|  ITTimeStamp |-- IS--+------+-- NULL-------------------------------------+
    |                        '- NOT-'                                            |
    +-|  PRIORITY |--|  BasicPredicate |-- integer-------------------------------+
    +-|  PRIORITY |--+------+-- BETWEEN-- integer-- AND-- integer----------------+
    |                '- NOT-'                                                    |
    +- PRIORITY--+------+-- IN--+- integer-------------+-------------------------+
    |            '- NOT-'       |     .- ,-------.     |                         |
    |                           |     V          |     |                         |
    |                           '- (---- integer-+-- )-'                         |
    +- ACTIVITY_TYPE--+------+-- IN--+- AIType-------------+---------------------+
    |                 '- NOT-'       |     .- ,------.     |                     |
    |                                |     V         |     |                     |
    |                                '- (---- AIType-+-- )-'                     |
    +- STATE--|  BasicPredicate |--|  ITState |----------------------------------+
    '- STATE--+------+-- IN--+- ITState-------------+----------------------------'
              '- NOT-'       |     .- ,-------.     |
                             |     V          |     |
                             '- (---- ITState-+-- )-'


 
ITPredicate-2

 >>-+- PROCESS_STATE--|  BasicPredicate |--|  PIState |----------------------------+-><
    +- PROCESS_STATE--+------+-- IN--+- PIState-------------+----------------------+
    |                 '- NOT-'       |     .- ,-------.     |                      |
    |                                |     V          |     |                      |
    |                                '- (---- PIState-+-- )-'                      |
    +-|  GlobalContainerMember |--|  BasicPredicate |--|  Value |------------------+
    +-|  GlobalContainerMember |--+------+-- BETWEEN--|  Value |-- AND--|  Value |-+
    |                             '- NOT-'                                         |
    +-|  GlobalContainerMember |--+------+-- IN--+-|  Value |-------------+--------+
    |                             '- NOT-'       |     .- ,---------.     |        |
    |                                            |     V            |     |        |
    |                                            '- (----|  Value |-+-- )-'        |
    +-|  GlobalContainerMember |--+------+-- LIKE--+- pattern-----+----------------+
    |                             '- NOT-'         '-CURRENT_USER-'                |
    '-|  GlobalContainerMember |-- IS--+------+-- NULL-----------------------------'
                                       '- NOT-'


 
AIType

 >>-+- PROCESS_ACTIVITY-+---------------------------------------><
    '- PROGRAM_ACTIVITY-'


 
BasicPredicate

 >>-+- =--+-----------------------------------------------------><
    +- >--+
    +- >=-+
    +- <--+
    +- <=-+
    '- <>-'


 
GlobalContainerMember

 >>-+- ProcessTemplateName-+--:-- MemberName--------------------><
    '-*--------------------'


 
ITState

 >>-+- READY----------+-----------------------------------------><
    +- RUNNING--------+
    +- FINISHED-------+
    +- TERMINATED-----+
    +- SUSPENDED------+
    +- DISABLED-------+
    +- CHECKED_OUT----+
    +- IN_ERROR-------+
    +- EXECUTED-------+
    +- PLANNING-------+
    +- FORCE_FINISHED-+
    +- TERMINATING----+
    +- SUSPENDING-----+
    '- EXPIRED--------'


 
ITString

 >>-+- DESCRIPTION------+---------------------------------------><
    +- NAME-------------+
    +- PROCESS_CATEGORY-+
    '- PROCESS_NAME-----'


 
ITTimeStamp

 >>-+- CREATION_TIME----------+---------------------------------><
    +- LAST_MODIFICATION_TIME-+
    '- RECEIVED_TIME----------'


 
PIState

 >>-+- READY-------+--------------------------------------------><
    +- RUNNING-----+
    +- FINISHED----+
    +- TERMINATED--+
    +- SUSPENDED---+
    +- TERMINATING-+
    '- SUSPENDING--'


 
TimeStamp

 >>- year-- --- month-- --- day---------------------------------->

 >--+------------------------------------------------+----------><
    '-  -- hours--+--------------------------------+-'
                  '- :-- minutes--+--------------+-'
                                  '- :-- seconds-'


 
Value

 >>-+-+- string------+-+----------------------------------------><
    | '-CURRENT_USER-' |
    +- long integer----+
    +- float-----------+
    '- binary----------'


 

Activity instance notifications can be sorted. An activity instance notification sort criterion is specified as a character string.

AINOrderBy

    .- ,-----------------------------------.
    V                                      |
 >>---+- ACTIVITY_TYPE--------+--+-------+-+--------------------><
      +-|  ITString |---------+  +- ASC--+
      +-|  ITTimeStamp |------+  '- DESC-'
      +-GlobalContainerMember-+
      +- OWNER----------------+
      +- PRIORITY-------------+
      +- PROCESS_STATE--------+
      '- STATE----------------'


 

Notes:

  1. If a filter is specified, the default sort order is ascending. Otherwise, there is no intrinsic default sort order.

  2. Activity types are sorted according to the sequence shown in the AIType diagram.

  3. States are sorted according to the sequence shown in the ITState respectively the PIState diagram.

The number of activity instance notifications to be retrieved can be restricted via a threshold which specifies the maximum number of activity instance notifications to be returned to the client. That threshold is applied after the activity instance notifications have been sorted according to the sort criteria specified. Note that the activity instance notifications are sorted on the server, that is, the code page of the server determines the sort sequence.

The primary information that is retrieved for each activity instance notification is:

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryProcessInstanceNotifications

public ProcessInstanceNotification[] queryProcessInstanceNotifications(java.lang.String filter,
                                                                       java.lang.String sortCriteria,
                                                                       java.lang.Integer threshold)
                                                                throws FmcException

This API call retrieves the process instance notifications the user has access to from the MQ Workflow execution server (action call).

The process instance notifications to be retrieved can be characterized by a filter. A process instance notification filter is specified as a character string.

Notes:

  1. A string constant is to be enclosed in single quotes (').

  2. A single quote within a string constant is to be doubled ('').

  3. A pattern is a string constant in which the asterisk and the question mark have special meanings.
    • The question mark (?) represents any single character.
    • The asterisk (*) represents a string of zero or more characters.
    • The escape character is backslash (\) and must be used when the pattern itself contains actual question marks or asterisks. An actual backslash is to be doubled (\\).

  4. A TimeStamp is a string constant, 24 hours based in local time.

  5. Optional specifications in the TimeStamp are set to 0 (zero) if not specified.

  6. A process template or global container member name which contains letters other than a-z, A-Z, and 0-9 is to be enclosed in single quotes (').

  7. For global data container member comparisons, the type of the value specified must conform to the type of the global data container member.

  8. A long integer is to be given in decimal notation.

  9. For binary literals, every byte is represented by a 2-digit hexadecimal number. The binary literal is to be preceded by 0x or 0X. For example, 0xFF is a valid binary literal.
PINFilter

 >>-+------+--+-|  ITPredicate |-------+------------------------->
    '- NOT-'  '- (--|  PINFilter |-- )-'

 >--+----------------------------------------------------+------><
    '-+- AND-+--+------+--+-|  ITPredicate |-----------+-'
      '- OR--'  '- NOT-'  | .------------------------. |
                          | V                        | |
                          '--- (--|  PINFilter |-- )-+-'


 
ITPredicate

 >>-+- OWNER--|  BasicPredicate |--+- string-------+-------------------------------+-><
    |                              '- CURRENT_USER-'                               |
    +- OWNER--+------+-- BETWEEN--+- string-------+-- AND--+- string-------+-------+
    |         '- NOT-'            '- CURRENT_USER-'        '- CURRENT_USER-'       |
    +- OWNER--+------+-- IN--+-+- string-------+-------------+---------------------+
    |         '- NOT-'       | '- CURRENT_USER-'             |                     |
    |                        |     .- ,----------------.     |                     |
    |                        |     V                   |     |                     |
    |                        '- (----+- string-------+-+-- )-'                     |
    |                                '- CURRENT_USER-'                             |
    +- OWNER--+------+-- LIKE--+- pattern------+-----------------------------------+
    |         '- NOT-'         '- CURRENT_USER-'                                   |
    +- OWNER-- IS--+------+-- NULL-------------------------------------------------+
    |              '- NOT-'                                                        |
    +-|  ITString |--|  BasicPredicate |-- string----------------------------------+
    +-|  ITString |--+------+-- BETWEEN-- string-- AND-- string--------------------+
    |                '- NOT-'                                                      |
    +-|  ITString |--+------+-- IN--+- string-------------+------------------------+
    |                '- NOT-'       |     .- ,------.     |                        |
    |                               |     V         |     |                        |
    |                               '- (---- string-+-- )-'                        |
    +-|  ITString |--+------+-- LIKE-- pattern-------------------------------------+
    |                '- NOT-'                                                      |
    +-|  ITString |-- IS--+------+-- NULL------------------------------------------+
    |                     '- NOT-'                                                 |
    +-|  ITTimeStamp |--|  BasicPredicate |--|  TimeStamp |------------------------+
    +-|  ITTimeStamp |--+------+-- BETWEEN--|  TimeStamp |-- AND--|  TimeStamp |---+
    |                   '- NOT-'                                                   |
    +-|  ITTimeStamp |--+------+-- IN--+-|  TimeStamp |-------------+--------------+
    |                   '- NOT-'       |     .- ,-------------.     |              |
    |                                  |     V                |     |              |
    |                                  '- (----|  TimeStamp |-+-- )-'              |
    +-|  ITTimeStamp |-- IS--+------+-- NULL---------------------------------------+
    |                        '- NOT-'                                              |
    +- PROCESS_STATE--|  BasicPredicate |--|  PIState |----------------------------+
    +- PROCESS_STATE--+------+-- IN--+- PIState-------------+----------------------+
    |                 '- NOT-'       |     .- ,-------.     |                      |
    |                                |     V          |     |                      |
    |                                '- (---- PIState-+-- )-'                      |
    +-|  GlobalContainerMember |--|  BasicPredicate |--|  Value |------------------+
    +-|  GlobalContainerMember |--+------+-- BETWEEN--|  Value |-- AND--|  Value |-+
    |                             '- NOT-'                                         |
    +-|  GlobalContainerMember |--+------+-- IN--+-|  Value |-------------+--------+
    |                             '- NOT-'       |     .- ,---------.     |        |
    |                                            |     V            |     |        |
    |                                            '- (----|  Value |-+-- )-'        |
    +-|  GlobalContainerMember |--+------+-- LIKE--+- pattern-----+----------------+
    |                             '- NOT-'         '-CURRENT_USER-'                |
    '-|  GlobalContainerMember |-- IS--+------+-- NULL-----------------------------'
                                       '- NOT-'


 
BasicPredicate

 >>-+- =--+-----------------------------------------------------><
    +- >--+
    +- >=-+
    +- <--+
    +- <=-+
    '- <>-'


 
GlobalContainerMember

 >>-+- ProcessTemplateName-+--:-- MemberName--------------------><
    '-*--------------------'


 
ITString

 >>-+- DESCRIPTION------+---------------------------------------><
    +- NAME-------------+
    +- PROCESS_CATEGORY-+
    '- PROCESS_NAME-----'


 
ITTimeStamp

 >>-+- CREATION_TIME----------+---------------------------------><
    +- LAST_MODIFICATION_TIME-+
    '- RECEIVED_TIME----------'


 
PIState

 >>-+- READY-------+--------------------------------------------><
    +- RUNNING-----+
    +- FINISHED----+
    +- TERMINATED--+
    +- SUSPENDED---+
    +- TERMINATING-+
    '- SUSPENDING--'


 
TimeStamp

 >>- year-- --- month-- --- day---------------------------------->

 >--+------------------------------------------------+----------><
    '-  -- hours--+--------------------------------+-'
                  '- :-- minutes--+--------------+-'
                                  '- :-- seconds-'


 
Value

 >>-+-+- string------+-+----------------------------------------><
    | '-CURRENT_USER-' |
    +- long integer----+
    +- float-----------+
    '- binary----------'


 

Process instance notifications can be sorted. A process instance notification sort criterion is specified as a character string.

PINOrderBy

    .- ,------------------------------------.
    V                                       |
 >>---+-|  ITString |----------+--+-------+-+-------------------><
      +-|  ITTimeStamp |-------+  +- ASC--+
      +- GlobalContainerMember-+  '- DESC-'
      +- OWNER-----------------+
      '- PROCESS_STATE---------'


 

Notes:

  1. If a filter is specified, the default sort order is ascending. Otherwise, there is no intrinsic default sort order.

  2. Activity types are sorted according to the sequence shown in the AIType diagram.

  3. States are sorted according to the sequence shown in the ITState respectively the PIState diagram.

The number of process instance notifications to be retrieved can be restricted via a threshold which specifies the maximum number of process instance notifications to be returned to the client. That threshold is applied after the activity instance notifications have been sorted according to the sort criteria specified. Note that the process instance notifications are sorted on the server, that is, the code page of the server determines the sort sequence.

The primary information that is retrieved for each process instance notification is:

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryActivityInstancesResultSize

public int queryActivityInstancesResultSize(java.lang.String filter)
                                     throws FmcException

This API call retrieves the number of current activity instances the user has access to from the MQ Workflow execution server (action call).

The query can be characterized by a filter. A filter on activity instances is specified as a character string containing a filter predicate. See ExecutionService.queryActivityInstances() for specification of a valid activity instance filter.

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryProcessInstancesResultSize

public int queryProcessInstancesResultSize(java.lang.String filter)
                                    throws FmcException

This API call retrieves the number of current process instances the user has access to from the MQ Workflow execution server (action call).

The query can be characterized by a filter. A filter on process instances is specified as a character string containing a filter predicate. See ExecutionService.queryProcessInstances() for specification of a valid process instance filter.

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryProcessTemplatesResultSize

public int queryProcessTemplatesResultSize(java.lang.String filter)
                                    throws FmcException

This API call retrieves the number of current process templates the user has access to from the MQ Workflow execution server (action call).

The query can be characterized by a filter. A filter on process templates is specified as a character string containing a filter predicate. See ExecutionService.queryProcessTemplates() for specification of a valid process template filter.

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryItemsResultSize

public int queryItemsResultSize(java.lang.String filter)
                         throws FmcException

This API call retrieves the number of current work items or notifications the user has access to from the MQ Workflow execution server (action call).

The query can be characterized by a filter. A filter on items is specified as a character string containing a filter predicate. See ExecutionService.queryItems() for specification of a valid item filter.

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryWorkItemsResultSize

public int queryWorkItemsResultSize(java.lang.String filter)
                             throws FmcException

This API call retrieves the number of current work items the user has access to from the MQ Workflow execution server (action call).

The work items to be retrieved can be characterized by a filter. A filter on work items is specified as a character string containing a filter predicate. See ExecutionService.queryWorkItems() for specification of a valid work item filter.

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryActivityInstanceNotificationsResultSize

public int queryActivityInstanceNotificationsResultSize(java.lang.String filter)
                                                 throws FmcException

This API call retrieves the number of current activity instance notifications the user has access to from the MQ Workflow execution server (action call).

The query can be characterized by a filter. A filter on activity instance notifications is specified as a character string containing a filter predicate. See ExecutionService.queryActivityInstanceNotifications() for specification of a valid activity instance notification filter.

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryProcessInstanceNotificationsResultSize

public int queryProcessInstanceNotificationsResultSize(java.lang.String filter)
                                                throws FmcException

This API call retrieves the number of current process instance notifications the user has access to from the MQ Workflow execution server (action call).

The process instance notifications to be retrieved can be characterized by a filter. A filter on process instance notifications is specified as a character string containing a filter predicate. See ExecutionService.queryProcessInstanceNotifications() for specification of a valid process instance notification filter.

Throws:
FmcException - thrown if an API error or a communication error occurred.

readOnlyContainerFromStream

public ReadOnlyContainer readOnlyContainerFromStream(byte[] stream)
                                              throws FmcException
Constructs a transient read-only container object from the stream passed.

Throws:
FmcException - thrown if an API error or a communication error occurred.

readWriteContainerFromStream

public ReadWriteContainer readWriteContainerFromStream(byte[] stream)
                                                throws FmcException
Constructs a transient read/write container object from the stream passed.

Throws:
FmcException - thrown if an API error or a communication error occurred.

remotePassthrough

public void remotePassthrough(java.lang.String programID)
                       throws FmcException

The native implementation of the Java API does not support this method. A call to this method throws an FMC_ERROR_NOT_SUPPORTED exception.

Throws:
FmcException - an FMC_ERROR_NOT_SUPPORTED exception is thrown

setPersonAbsent

public void setPersonAbsent()
                     throws FmcException

This API call sets the absence indication of the specified user to the specified value (action call).

When a person is absent and the staff resolution options specify 'assign substitute if user is absent' or 'prefer non-absent users', then an absent person does not participate in staff resolution, that is, this person does not get assigned any work items.

Throws:
FmcException - thrown if an API error or a communication error occurred.

setPersonAbsent2

public void setPersonAbsent2(java.lang.String userID,
                             boolean newValue)
                      throws FmcException

setSessionContext

public void setSessionContext(java.lang.String userID,
                              java.lang.String sessionID)
                       throws FmcException
Associates the execution service object with the session identified by the passed session identification.

Throws:
FmcException - thrown if an API error or a communication error occurred.


© Copyright IBM Corporation 1999, 2007. All Rights Reserved.