All Packages Class Hierarchy This Package Previous Next Index
This function/method 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).
This function/method 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).
This function/method 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).
This function/method allows the application to finish the specified user session with an MQ Workflow execution server (action call).
This function/method allows an application to establish a user session with an MQ Workflow execution server (action call).
See logon; allows for the sepcification of the session mode and absence setting.
This function/method can be used by an activity implementation to establish a user session with an MQ Workflow execution server from within this program (activity-implementation call).
This function/method allows to shutdown the program execution agent associated to the logged on user (program execution management function/method call).
This function/method is used to start a program execution agent associated to the logged-on user (program-execution-management call).
This function/method retrieves the activity instance notifications the user has access to from the MQ Workflow execution server (action call).
This function/method retrieves the work items or notifications the user has access to from the MQ Workflow execution server (action call).
This function/method retrieves the process instance lists the user has access to from the MQ Workflow execution server (action call).
This function/method retrieves the process instance notifications the user has access to from the MQ Workflow execution server (action call).
This function/method retrieves the current process instances the user has access to from the MQ Workflow execution server (action call).
This function/method retrieves the current process template lists the user has access to from the MQ Workflow execution server (action call).
This function/method retrieves the current process templates from the MQ Workflow execution server (action call).
This function/method retrieves the work items the user has access to from the MQ Workflow execution server (action call).
This function/method retrieves the worklists the user has access to from the MQ Workflow execution server (action call).
This function/method can be used by an application program to establish a user session with an MQ Workflow execution server from within this program (activity-implementation call).
public abstract ProcessInstanceList createProcessInstanceList(String name, TypeOfList type, String owner, String description, String filter, String sortCriteria, Integer threshold) throws FmcException
This function/method 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 Appendix A. How to read the syntax diagrams).
Notes:
A pattern is a string constant in which the asterisk and the question mark have special meanings.
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------------------------' >--------------------------------------------------------------><
BasicPredicate >>-+- =--+----------------------------------------------------->< +- >--+ +- >=-+ +- <--+ +- <=-+ '- <>-'
PIState >>-+- READY-------+-------------------------------------------->< +- RUNNING-----+ +- FINISHED----+ +- TERMINATED--+ +- SUSPENDED---+ +- TERMINATING-+ '- SUSPENDING--'
PIString >>-+- ADMINISTRATOR----------+--------------------------------->< +- CATEGORY---------------+ +- DESCRIPTION------------+ +- NAME-------------------+ +- PARENT_PROCESS_NAME----+ '- TOP_LEVEL_PROCESS_NAME-'
PITimeStamp >>-+- LAST_MODIFICATION_TIME-+--------------------------------->< '- LAST_STATE_CHANGE_TIME-'
TimeStamp >>- year- -- month- -- day--------------------------------------> >-----+---------------------------------------------+---------->< '- - hours-+------------------------------+--' '- :- minutes-+-------------+--' '- :- seconds-'
A process instance list sort criterion is specified as a character string.
Note: | The default sort order is ascending.
States are sorted according to the sequence shown in the PIState diagram. |
PILOrderBy .- ,----------. V | >>--+-| PIString |----+------+-------+--+--------------------->< +-| PITimeStamp |-+ +- ASC--+ '- STATE-----------' '- DESC-'
public abstract ProcessTemplateList createProcessTemplateList(String name, TypeOfList type, String owner, String description, String filter, String sortCriteria, Integer threshold) throws FmcException
This function/method 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 Appendix A. How to read the syntax diagrams).
Notes:
A pattern is a string constant in which the asterisk and the question mark have special meanings.
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.
Note: | The default sort order is ascending.
PTLOrderBy .- ,----------. V | >>--+-| PTString |----+------+-------+--+--------------------->< '-| PTTimeStamp |-' +- ASC--+ '- DESC-' |
public abstract WorkList createWorkList(String name, TypeOfList type, String owner, String description, String filter, String sortCriteria, Integer threshold) throws FmcException
This function/method 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 Appendix A. How to read the syntax diagrams).
Notes:
A pattern is a string constant in which the asterisk and the question mark have special meanings.
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--+--- )-' >--------------------------------------------------------------><
AIType >>-+- PROCESS_ACTIVITY-+--------------------------------------->< '- PROGRAM_ACTIVITY-'
BasicPredicate >>-+- =--+----------------------------------------------------->< +- >--+ +- >=-+ +- <--+ +- <=-+ '- <>-'
ITState >>-+- READY----------+----------------------------------------->< +- RUNNING--------+ +- FINISHED-------+ +- TERMINATED-----+ +- SUSPENDED------+ +- DISABLED-------+ +- CHECKED_OUT----+ +- IN_ERROR-------+ +- EXECUTED-------+ +- PLANNING-------+ +- FORCE_FINISHED-+ +- TERMINATING----+ '- SUSPENDING-----'
ITString >>-+- DESCRIPTION------+--------------------------------------->< +- NAME-------------+ +- PROCESS_CATEGORY-+ '- PROCESS_NAME-----'
ITTimeStamp >>-+- 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-'
A worklist sort criterion is specified as a character string.
Note: | The default sort order is ascending.
Activity types are sorted according to the sequence shown in the AIType diagram. Item types are sorted according to the sequence shown in the ITType diagram. States are sorted according to the sequence shown in the ITState respectively the PIState diagram. |
WLOrderBy .- ,----------. V | >>--+- ACTIVITY_TYPE---+------+-------+--+--------------------->< +-| ITString |----+ +- ASC--+ +-| ITTimeStamp |-+ '- DESC-' +- OWNER-----------+ +- PRIORITY--------+ +- PROCESS_STATE---+ +- STATE-----------+ '- TYPE------------'
public abstract ActivityInstanceNotification persistentActivityInstanceNotification(String oid) throws FmcException
public abstract ProcessInstance persistentProcessInstance(String oid) throws FmcException
public abstract ProcessInstanceNotification persistentProcessInstanceNotification(String oid) throws FmcException
public abstract ProcessTemplate persistentProcessTemplate(String oid) throws FmcException
public abstract WorkItem persistentWorkItem(String oid) throws FmcException
public abstract void programExecutionAgentShutDown() throws FmcException
This function/method allows to shutdown the program execution agent associated to the logged on user (program execution management function/method 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.
public abstract void programExecutionAgentStartUp() throws FmcException
This function/method 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.
public abstract void logoff() throws FmcException
This function/method 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.
public abstract void logon(String userID, String password) throws FmcException
This function/method allows an application to establish a user session with an MQ Workflow execution server (action call).
A successful Logon() is the prerequisite for using all other action and program execution management functions/methods of the MQ Workflow API.
The user ID to log on with must be a registered MQ Workflow user.
When the execution server supports unified logon, 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.
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.
The following enumeration types can be used to specify the session mode:
The enumeration constants can take the following values; it is strongly advised to use the symbolic names instead of the associated integer values.
At logon time, you can also specify whether you are back in case you are set to be absent. When you are not absent you participate in work assignment; otherwise no work items are assigned to you.
The following enumeration types can be used to deal with your absence:
The enumeration constants can take the following values; it is strongly advised to use the symbolic names instead of the associated integer values.
public abstract void logon2(String userID, String password, SessionMode mode, AbsenceIndicator absenceIndicator) throws FmcException
See logon; allows for the sepcification of the session mode and absence setting.
public abstract void passthrough() throws FmcException
This function/method can be used by an activity implementation to establish a user session with an MQ Workflow execution server from within this program (activity-implementation call).
When successfully executed, a session to the same execution server is set up from where the work item implemented by this program was started; the user on whose behalf the session is set up is the same one on whose behalf the work item was started.
public abstract ProcessInstanceList[] queryProcessInstanceLists() throws FmcException
This function/method retrieves the process instance lists the user has access to from the MQ Workflow execution server (action call).
public abstract ProcessTemplateList[] queryProcessTemplateLists() throws FmcException
This function/method retrieves the current process template lists the user has access to from the MQ Workflow execution server (action call).
public abstract WorkList[] queryWorkLists() throws FmcException
This function/method retrieves the worklists the user has access to from the MQ Workflow execution server (action call).
public abstract ProcessInstance[] queryProcessInstances(String filter, String sortCriteria, Integer threshold) throws FmcException
This function/method retrieves the current process instances the user has access to from the MQ Workflow execution server (action call).
In C and C++, any process instances retrieved are appended to the supplied vector. If you want to read the current process instances only, you have to clear the vector before you call this function/method. This means that you should set the vector handle to 0 in the C-language respectively erase all elements of the vector in the C++ API.
A filter on process instances is specified as a character string containing a filter predicate:
Notes:
A pattern is a string constant in which the asterisk and the question mark have special meanings.
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------------------------' >--------------------------------------------------------------><
BasicPredicate >>-+- =--+----------------------------------------------------->< +- >--+ +- >=-+ +- <--+ +- <=-+ '- <>-'
PIState >>-+- READY-------+-------------------------------------------->< +- RUNNING-----+ +- FINISHED----+ +- TERMINATED--+ +- SUSPENDED---+ +- TERMINATING-+ '- SUSPENDING--'
PIString >>-+- ADMINISTRATOR----------+--------------------------------->< +- CATEGORY---------------+ +- DESCRIPTION------------+ +- NAME-------------------+ +- PARENT_PROCESS_NAME----+ '- TOP_LEVEL_PROCESS_NAME-'
PITimeStamp >>-+- LAST_MODIFICATION_TIME-+--------------------------------->< '- LAST_STATE_CHANGE_TIME-'
TimeStamp >>- year- -- month- -- day--------------------------------------> >-----+---------------------------------------------+---------->< '- - hours-+------------------------------+--' '- :- minutes-+-------------+--' '- :- seconds-'
Process instances can be sorted. A process instance sort criterion is specified as a character string.
Note: | The default sort order is ascending.
States are sorted according to the sequence shown in the PIState diagram. |
PIOrderBy .- ,----------. V | >>--+-| PIString |----+------+-------+--+--------------------->< +-| PITimeStamp |-+ +- ASC--+ '- STATE-----------' '- DESC-'
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:
public abstract ProcessTemplate[] queryProcessTemplates(String filter, String sortCriteria, Integer threshold) throws FmcException
This function/method retrieves the current process templates from the MQ Workflow execution server (action call).
In C and C++, any process templates retrieved are appended to the supplied vector. If you want to read the current process templates only, you have to clear the vector before you call this function/method. This means that you should set the vector handle to 0 in the C-language respectively erase all elements of the vector in the C++ API.
A filter on process templates is specified as a character string containing a filter predicate:
Notes:
A pattern is a string constant in which the asterisk and the question mark have special meanings.
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.
Note: | The default sort order is ascending.
PTOrderBy .- ,----------. V | >>--+-| PTString |----+------+-------+--+--------------------->< '-| PTTimeStamp |-' +- ASC--+ '- DESC-' |
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:
public abstract Item[] queryItems(String filter, String sortCriteria, Integer threshold) throws FmcException
This function/method retrieves the work items or notifications the user has access to from the MQ Workflow execution server (action call).
In C and C++, any items retrieved are appended to the supplied vector. If you want to read the current items only, you have to clear the vector before you call this function/method. This means that you should set the handle to 0 in the C-language respectively erase all elements of the vector in the C++ API.
The items to be retrieved can be characterized by a filter. An item filter is specified as a character string.
Notes:
A pattern is a string constant in which the asterisk and the question mark have special meanings.
ItemFilter >>-+------+----+-| ITPredicate |------+------------------------> '- NOT-' '- (-| ItemFilter |- )-' >-----+--------------------------------------------------------+->< '--+- AND-+---+------+--+-| ITPredicate |------------+--' '- OR--' '- NOT-' | .------------------------. | | V | | '---- (-| ItemFilter |- )--+-'
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-' | +-| 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--+--- )-' >--------------------------------------------------------------><
AIType >>-+- PROCESS_ACTIVITY-+--------------------------------------->< '- PROGRAM_ACTIVITY-'
BasicPredicate >>-+- =--+----------------------------------------------------->< +- >--+ +- >=-+ +- <--+ +- <=-+ '- <>-'
ITState >>-+- READY----------+----------------------------------------->< +- RUNNING--------+ +- FINISHED-------+ +- TERMINATED-----+ +- SUSPENDED------+ +- DISABLED-------+ +- CHECKED_OUT----+ +- IN_ERROR-------+ +- EXECUTED-------+ +- PLANNING-------+ +- FORCE_FINISHED-+ +- TERMINATING----+ '- SUSPENDING-----'
ITString >>-+- DESCRIPTION------+--------------------------------------->< +- NAME-------------+ +- PROCESS_CATEGORY-+ '- PROCESS_NAME-----'
ITTimeStamp >>-+- LAST_MODIFICATION_TIME-+--------------------------------->< '- RECEIVED_TIME----------'
PIState >>-+- READY-------+-------------------------------------------->< +- RUNNING-----+ +- FINISHED----+ +- TERMINATED--+ +- SUSPENDED---+ +- TERMINATING-+ '- SUSPENDING--'
TimeStamp >>- year- -- month- -- day--------------------------------------> >-----+---------------------------------------------+---------->< '- - hours-+------------------------------+--' '- :- minutes-+-------------+--' '- :- seconds-'
Items can be sorted. An item sort criterion is specified as a character string.
Note: | The default sort order is ascending.
Activity types are sorted according to the sequence shown in the AIType diagram. States are sorted according to the sequence shown in the ITState respectively the PIState diagram. |
ItemOrderBy .- ,----------. V | >>--+- ACTIVITY_TYPE---+------+-------+--+--------------------->< +-| ITString |----+ +- ASC--+ +-| ITTimeStamp |-+ '- DESC-' +- OWNER-----------+ +- PRIORITY--------+ +- PROCESS_STATE---+ '- STATE-----------'
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:
public abstract WorkItem[] queryWorkItems(String filter, String sortCriteria, Integer threshold) throws FmcException
This function/method retrieves the work items the user has access to from the MQ Workflow execution server (action call).
In C and C++, any work items retrieved are appended to the supplied vector. If you want to read the current work items only, you have to clear the vector before you call this function/method. This means that you should set the vector handle to 0 in the C-language respectively erase all elements of the vector in the C++ API.
The work items to be retrieved can be characterized by a filter. A work item filter is specified as a character string:
Notes:
A pattern is a string constant in which the asterisk and the question mark have special meanings.
WIFilter >>-+------+----+-| ITPredicate |----+--------------------------> '- NOT-' '- (-| WIFilter |- )-' >-----+------------------------------------------------------+->< '--+- AND-+---+------+--+-| ITPredicate |----------+--' '- OR--' '- NOT-' | .----------------------. | | V | | '---- (-| WIFilter |- )--+-'
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-' | +-| 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--+--- )-' >--------------------------------------------------------------><
AIType >>-+- PROCESS_ACTIVITY-+--------------------------------------->< '- PROGRAM_ACTIVITY-'
BasicPredicate >>-+- =--+----------------------------------------------------->< +- >--+ +- >=-+ +- <--+ +- <=-+ '- <>-'
ITState >>-+- READY----------+----------------------------------------->< +- RUNNING--------+ +- FINISHED-------+ +- TERMINATED-----+ +- SUSPENDED------+ +- DISABLED-------+ +- CHECKED_OUT----+ +- IN_ERROR-------+ +- EXECUTED-------+ +- PLANNING-------+ +- FORCE_FINISHED-+ +- TERMINATING----+ '- SUSPENDING-----'
ITString >>-+- DESCRIPTION------+--------------------------------------->< +- NAME-------------+ +- PROCESS_CATEGORY-+ '- PROCESS_NAME-----'
ITTimeStamp >>-+- LAST_MODIFICATION_TIME-+--------------------------------->< '- RECEIVED_TIME----------'
PIState >>-+- READY-------+-------------------------------------------->< +- RUNNING-----+ +- FINISHED----+ +- TERMINATED--+ +- SUSPENDED---+ +- TERMINATING-+ '- SUSPENDING--'
TimeStamp >>- year- -- month- -- day--------------------------------------> >-----+---------------------------------------------+---------->< '- - hours-+------------------------------+--' '- :- minutes-+-------------+--' '- :- seconds-'
Work items can be sorted. A work item sort criterion is specified as a character string.
Note: | The default sort order is ascending.
Activity types are sorted according to the sequence shown in the AIType diagram. States are sorted according to the sequence shown in the ITState respectively the PIState diagram. |
WIOrderBy .- ,----------. V | >>--+- ACTIVITY_TYPE---+------+-------+--+--------------------->< +-| ITString |----+ +- ASC--+ +-| ITTimeStamp |-+ '- DESC-' +- OWNER-----------+ +- PRIORITY--------+ +- PROCESS_STATE---+ '- STATE-----------'
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:
public abstract ActivityInstanceNotification[] queryActivityInstanceNotifications(String filter, String sortCriteria, Integer threshold) throws FmcException
This function/method retrieves the activity instance notifications the user has access to from the MQ Workflow execution server (action call).
In C and C++, any activity instance notifications retrieved are appended to the supplied vector. If you want to read the current activity instance notifications only, you have to clear the vector before you call this function/method. This means that you should set the vector handle to 0 in the C-language, respectively erase all elements of the vector in the C++ API.
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:
A pattern is a string constant in which the asterisk and the question mark have special meanings.
AINFilter >>-+------+----+-| ITPredicate |-----+-------------------------> '- NOT-' '- (-| AINFilter |- )-' >-----+-------------------------------------------------------+->< '--+- AND-+---+------+--+-| ITPredicate |-----------+--' '- OR--' '- NOT-' | .-----------------------. | | V | | '---- (-| AINFilter |- )--+-'
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-' | +-| 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--+--- )-' >--------------------------------------------------------------><
AIType >>-+- PROCESS_ACTIVITY-+--------------------------------------->< '- PROGRAM_ACTIVITY-'
BasicPredicate >>-+- =--+----------------------------------------------------->< +- >--+ +- >=-+ +- <--+ +- <=-+ '- <>-'
ITState >>-+- READY----------+----------------------------------------->< +- RUNNING--------+ +- FINISHED-------+ +- TERMINATED-----+ +- SUSPENDED------+ +- DISABLED-------+ +- CHECKED_OUT----+ +- IN_ERROR-------+ +- EXECUTED-------+ +- PLANNING-------+ +- FORCE_FINISHED-+ +- TERMINATING----+ '- SUSPENDING-----'
ITString >>-+- DESCRIPTION------+--------------------------------------->< +- NAME-------------+ +- PROCESS_CATEGORY-+ '- PROCESS_NAME-----'
ITTimeStamp >>-+- LAST_MODIFICATION_TIME-+--------------------------------->< '- RECEIVED_TIME----------'
PIState >>-+- READY-------+-------------------------------------------->< +- RUNNING-----+ +- FINISHED----+ +- TERMINATED--+ +- SUSPENDED---+ +- TERMINATING-+ '- SUSPENDING--'
TimeStamp >>- year- -- month- -- day--------------------------------------> >-----+---------------------------------------------+---------->< '- - hours-+------------------------------+--' '- :- minutes-+-------------+--' '- :- seconds-'
Activity instance notifications can be sorted. An activity instance notification sort criterion is specified as a character string.
Note: | The default sort order is ascending.
Activity types are sorted according to the sequence shown in the AIType diagram. States are sorted according to the sequence shown in the ITState respectively the PIState diagram. |
AINOrderBy .- ,----------. V | >>--+- ACTIVITY_TYPE---+------+-------+--+--------------------->< +-| ITString |----+ +- ASC--+ +-| ITTimeStamp |-+ '- DESC-' +- OWNER-----------+ +- PRIORITY--------+ +- PROCESS_STATE---+ '- STATE-----------'
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:
public abstract ProcessInstanceNotification[] queryProcessInstanceNotifications(String filter, String sortCriteria, Integer threshold) throws FmcException
This function/method retrieves the process instance notifications the user has access to from the MQ Workflow execution server (action call).
In C and C++, any process instance notifications retrieved are appended to the supplied vector. If you want to read the current process instance notifications only, you have to clear the vector before you call this function/method. This means that you should set the vector handle to 0 in the C-language respectively erase all elements of the vector in the C++ API.
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:
A pattern is a string constant in which the asterisk and the question mark have special meanings.
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-' | +-| 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--+--- )-' >--------------------------------------------------------------><
AIType >>-+- PROCESS_ACTIVITY-+--------------------------------------->< '- PROGRAM_ACTIVITY-'
BasicPredicate >>-+- =--+----------------------------------------------------->< +- >--+ +- >=-+ +- <--+ +- <=-+ '- <>-'
ITState >>-+- READY----------+----------------------------------------->< +- RUNNING--------+ +- FINISHED-------+ +- TERMINATED-----+ +- SUSPENDED------+ +- DISABLED-------+ +- CHECKED_OUT----+ +- IN_ERROR-------+ +- EXECUTED-------+ +- PLANNING-------+ +- FORCE_FINISHED-+ +- TERMINATING----+ '- SUSPENDING-----'
ITString >>-+- DESCRIPTION------+--------------------------------------->< +- NAME-------------+ +- PROCESS_CATEGORY-+ '- PROCESS_NAME-----'
ITTimeStamp >>-+- LAST_MODIFICATION_TIME-+--------------------------------->< '- RECEIVED_TIME----------'
PIState >>-+- READY-------+-------------------------------------------->< +- RUNNING-----+ +- FINISHED----+ +- TERMINATED--+ +- SUSPENDED---+ +- TERMINATING-+ '- SUSPENDING--'
TimeStamp >>- year- -- month- -- day--------------------------------------> >-----+---------------------------------------------+---------->< '- - hours-+------------------------------+--' '- :- minutes-+-------------+--' '- :- seconds-'
Process instance notifications can be sorted. A process instance notification sort criterion is specified as a character string.
Note: | The default sort order is ascending.
Activity types are sorted according to the sequence shown in the AIType diagram. States are sorted according to the sequence shown in the ITState respectively the PIState diagram. |
PINOrderBy .- ,----------. V | >>--+- ACTIVITY_TYPE---+------+-------+--+--------------------->< +-| ITString |----+ +- ASC--+ +-| ITTimeStamp |-+ '- DESC-' +- OWNER-----------+ +- PRIORITY--------+ +- PROCESS_STATE---+ '- STATE-----------'
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:
public abstract void remotePassthrough(String programID) throws FmcException
This function/method can be used by an application program to establish a user session with an MQ Workflow execution server from within this program (activity-implementation call).
An activity implementation started by an MQ Workflow program execution agent can request services from that program execution agent without further identification. It is known by the program execution agent.
When that activity implementation decides to distribute work among other programs and starts those programs as separate operating system processes, then those processes are unknown by the program execution agent and cannot request services. The activity implementation can, however, ask the program execution agent for its program identification and pass that identification to the programs started. That is, the programs started receive the authorization to talk to the program execution agent as long as the actual activity implementation is alive.
The started programs can then request services from the program execution agent by themselves by specifying this program identification.
When successfully executed, a session to the same execution server is set up from where the original work item was started; the user on whose behalf the session is set up is the same one on whose behalf the original work item was started.
All Packages Class Hierarchy This Package Previous Next Index