WebSphere MQ Workflow 3.4 Generic C API Test / Prototyping Tool
[prev][next][parent][TOC]
FmcjExecutionService
===Syntax for FmcjExecutionService APIs=================================
FmcjExecutionServiceAllocate
ExecutionServiceHdl n
XpRc FMC_OK
End
FmcjExecutionServiceAllocateForGroup
SystemGroup "value" | "<CL-VALUE>" | NULL
ExecutionServiceHdl n
XpRc FMC_OK
End
FmcjExecutionServiceAllocateForSystem
System "value" | "<CL-VALUE>" | NULL
SystemGroup "value" | "<CL-VALUE>" | NULL
ExecutionServiceHdl n
XpRc FMC_OK
End
FmcjExecutionServiceDeallocate
ExecutionServiceHdl i
XpRc FMC_OK
End
FmcjExecutionServiceCopy
ExecutionServiceHdl i
ExecutionServiceHdl2 n
XpRc FMC_OK
End
FmcjExecutionServiceEqual
ExecutionServiceHdl i
ExecutionServiceHdl2 i
XpValue TRUE | FALSE
End
FmcjExecutionServiceLogon
ExecutionServiceHdl i
UserID "value" | "<CL-VALUE>" | NULL
Password "value" | "<CL-VALUE>" | NULL
SessionMode Fmc_SM_Default
| Fmc_SM_Present
| Fmc_SM_PresentHere
| (any integer)
AbsentIndicator Fmc_SA_NotSet
| Fmc_SA_Reset
| Fmc_SA_Leave
| (any integer)
XpRc FMC_OK
End
/* version 3.3.0 or > */
FmcjExecutionServiceLogonWithCredentials
ExecutionServiceHdl i
UserCredentialsAsString "value"
| UserCredentialsAsByteInHex "hex_value"
| UserCredentialsByteInputFileSpec "fileSpec"
CredentialLength unsigned long
SessionMode Fmc_SM_Default
| Fmc_SM_Present
| Fmc_SM_PresentHere
| (any integer)
AbsentIndicator Fmc_SA_NotSet
| Fmc_SA_Reset
| Fmc_SA_Leave
| (any integer)
UserName "value"
XpRc FMC_OK
End
FmcjExecutionServiceLogoff
ExecutionServiceHdl i
XpRc FMC_OK
End
/* version 3.3.0 or > */
FmcjExecutionServiceSessionID
ExecutionServiceHdl i
BufferLength unsigned long
SessionIdHdl n
[ SessionIdOutputFileSpec "FileSpec"
XpValue "value"
End
/* version 3.3.0 or > */
FmcjExecutionServiceSetSessionContext
ExecutionServiceHdl i
UserID "value" | "<CL-VALUE>"
SessionID "value" | "<CL-VALUE>"
| SessionIdInputFileSpec "FileSpec"
| SessionIdHdl i
XpRc FMC_OK
End
FmcjExecutionServiceSetPassword
ExecutionServiceHdl i
Password "value" | NULL
XpRc FMC_OK
End
FmcjExecutionServiceRefresh
ExecutionServiceHdl i
XpRc FMC_OK
End
FmcjExecutionServiceUserSettings
ExecutionServiceHdl i
PersonHdl n
XpRc FMC_OK
End
FmcjExecutionServiceIsLoggedOn
ExecutionServiceHdl i
XpValue TRUE | FALSE
End
FmcjExecutionServiceSetPersonAbsent
ExecutionServiceHdl i
UserID "value" | NULL
Absence TRUE | FALSE
XpRc FMC_OK
End
FmcjExecutionServiceSetTimeout
ExecutionServiceHdl i
Timeout long
End
FmcjExecutionServiceTimeout
ExecutionServiceHdl i
XpValue long
End
FmcjExecutionServiceSystemName
ExecutionServiceHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjExecutionServiceSystemGroupName
ExecutionServiceHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjExecutionServiceUserID
ExecutionServiceHdl i
BufferLength unsigned long
XpValue "value" | NULL
End
FmcjExecutionServicePassthrough
ExecutionServiceHdl i
XpRc FMC_OK
End
FmcjExecutionServiceRemotePassthrough
ExecutionServiceHdl i
ProgramID DEFAULT
| "value"
| NULL
| ProgramIDInputFileSpec "FileSpec"
XpRc FMC_OK
End
FmcjExecutionServicePEAStartUp
ExecutionServiceHdl i
XpRc FMC_OK
End
FmcjExecutionServicePEAShutDown
ExecutionServiceHdl i
XpRc FMC_OK
End
FmcjExecutionServiceCreateProcessInstanceList
ExecutionServiceHdl i
ListName "value" | NULL
PersistentListType Fmc_LT_NotSet
| Fmc_LT_Public
| Fmc_LT_Private
| (any integer)
Owner "value" | NULL
Description "value" | NULL
Filter "fi_value" | NULL
SortCriteria "sc_value" | NULL
Threshold unsigned long | NULL
ProcessInstanceListHdl n
XpRc FMC_OK
End
FmcjExecutionServiceCreateProcessTemplateList
ExecutionServiceHdl i
ListName "value" | NULL
PersistentListType Fmc_LT_NotSet
| Fmc_LT_Public
| Fmc_LT_Private
| (any integer)
Owner "value" | NULL
Description "value" | NULL
Filter "fi_value" | NULL
SortCriteria "sc_value" | NULL
Threshold unsigned long | NULL
ProcessTemplateListHdl n
XpRc FMC_OK
End
FmcjExecutionServiceCreateWorklist
ExecutionServiceHdl i
ListName "value" | NULL
PersistentListType Fmc_LT_NotSet
| Fmc_LT_Public
| Fmc_LT_Private
| (any integer)
Owner "value" | NULL
Description "value" | NULL
Filter "fi_value" | NULL
SortCriteria "sc_value" | NULL
Threshold unsigned long | NULL
WorklistHdl n
XpRc FMC_OK
End
FmcjExecutionServiceQueryProcessTemplateLists
ExecutionServiceHdl i
ProcessTemplateListVectorHdl n | i+
[ ShowAllObjectNames TRUE | FALSE ]
XpRc FMC_OK
End
FmcjExecutionServiceQueryProcessInstanceLists
ExecutionServiceHdl i
ProcessInstanceListVectorHdl n | i+
[ ShowAllObjectNames TRUE | FALSE ]
XpRc FMC_OK
End
FmcjExecutionServiceQueryWorklists
ExecutionServiceHdl i
WorklistVectorHdl n | i+
[ ShowAllObjectNames TRUE | FALSE ]
XpRc FMC_OK
End
FmcjExecutionServiceQueryProcessTemplates
ExecutionServiceHdl i
Filter "fi_value" | NULL
SortCriteria "sc_value" | NULL
Threshold unsigned long | NULL
ProcessTemplateVectorHdl n | i+
[ ShowAllObjectNames TRUE | FALSE ]
XpRc FMC_OK
End
FmcjExecutionServiceQueryProcessInstances
ExecutionServiceHdl i
Filter "fi_value" | NULL
SortCriteria "sc_value" | NULL
Threshold unsigned long | NULL
ProcessInstanceVectorHdl n | i+
[ ShowAllObjectNames TRUE | FALSE ]
XpRc FMC_OK
End
FmcjExecutionServiceQueryItems
ExecutionServiceHdl i
Filter "fi_value" | NULL
SortCriteria "sc_value" | NULL
Threshold unsigned long | NULL
ItemVectorHdl n | i+
[ ShowAllObjectNames TRUE | FALSE ]
XpRc FMC_OK
End
FmcjExecutionServiceQueryWorkitems
ExecutionServiceHdl i
Filter "fi_value" | NULL
SortCriteria "sc_value" | NULL
Threshold unsigned long | NULL
WorkitemVectorHdl n | i+
[ ShowAllObjectNames TRUE | FALSE ]
XpRc FMC_OK
End
FmcjExecutionServiceQueryActivityInstanceNotifications
ExecutionServiceHdl i
Filter "fi_value" | NULL
SortCriteria "sc_value" | NULL
Threshold unsigned long | NULL
ActivityInstanceNotificationVectorHdl n | i+
[ ShowAllObjectNames TRUE | FALSE ]
XpRc FMC_OK
End
FmcjExecutionServiceQueryProcessInstanceNotifications
ExecutionServiceHdl i
Filter "fi_value" | NULL
SortCriteria "sc_value" | NULL
Threshold unsigned long | NULL
ProcessInstanceNotificationVectorHdl n | i+
[ ShowAllObjectNames TRUE | FALSE ]
XpRc FMC_OK
End
FmcjExecutionServiceReceive
ExecutionServiceHdl i
CorrelId i | NULL
ExecutionDataHdl n
Timeout long
XpRc FMC_OK
End
FmcjExecutionServiceTerminateReceive
ExecutionServiceHdl i
CorrelId i | NULL
XpRc FMC_OK
End
/* version 3.3.0 or > */
FmcjExecutionServicePersistentActivityInstance
ExecutionServiceHdl i
PersistentOidHdl i
| PersistentOidInputFileSpec "FileSpec"
ActivityInstanceHdl n
End
/* version 3.3.0 or > */
FmcjExecutionServicePersistentActivityInstanceNotification
ExecutionServiceHdl i
PersistentOidHdl i
| PersistentOidInputFileSpec "FileSpec"
ActivityInstanceNotificationHdl n
End
/* version 3.3.0 or > */
FmcjExecutionServicePersistentInstanceMonitor
ExecutionServiceHdl i
PersistentOidHdl i
| PersistentOidInputFileSpec "FileSpec"
InstanceMonitorHdl n
End
/* version 3.3.0 or > */
FmcjExecutionServicePersistentPerson
ExecutionServiceHdl i
PersistentOidHdl i
| PersistentOidInputFileSpec "FileSpec"
PersonHdl n
End
/* version 3.3.0 or > */
FmcjExecutionServicePersistentProcessInstance
ExecutionServiceHdl i
PersistentOidHdl i
| PersistentOidInputFileSpec "FileSpec"
ProcessInstanceHdl n
End
/* version 3.3.0 or > */
FmcjExecutionServicePersistentProcessInstanceList
ExecutionServiceHdl i
PersistentOidHdl i
| PersistentOidInputFileSpec "FileSpec"
ProcessInstanceListHdl n
End
/* version 3.3.0 or > */
FmcjExecutionServicePersistentProcessInstanceNotification
ExecutionServiceHdl i
PersistentOidHdl i
| PersistentOidInputFileSpec "FileSpec"
ProcessInstanceNotificationHdl n
End
/* version 3.3.0 or > */
FmcjExecutionServicePersistentProcessTemplate
ExecutionServiceHdl i
PersistentOidHdl i
| PersistentOidInputFileSpec "FileSpec"
ProcessTemplateHdl n
End
/* version 3.3.0 or > */
FmcjExecutionServicePersistentProcessTemplateList
ExecutionServiceHdl i
PersistentOidHdl i
| PersistentOidInputFileSpec "FileSpec"
ProcessTemplateListHdl n
End
/* version 3.3.0 or > */
FmcjExecutionServicePersistentWorkitem
ExecutionServiceHdl i
PersistentOidHdl i
| PersistentOidInputFileSpec "FileSpec"
WorkitemHdl n
End
/* version 3.3.0 or > */
FmcjExecutionServicePersistentWorklist
ExecutionServiceHdl i
PersistentOidHdl i
| PersistentOidInputFileSpec "FileSpec"
WorklistHdl n
End
/* version 3.3.0 or > */
FmcjExecutionServiceProgramDataFromStream
ExecutionServiceHdl i
StreamHdl i
| StreamInputFileSpec "FileSpec"
StreamLength unsigned long | DEFAULT
ProgramDataHdl n
End
/* version 3.3.0 or > */
FmcjExecutionServiceProgramTemplateFromStream
ExecutionServiceHdl i
StreamHdl i
| StreamInputFileSpec "FileSpec"
StreamLength unsigned long | DEFAULT
ProgramTemplateHdl n
End
/* version 3.3.0 or > */
FmcjExecutionServiceReadOnlyContainerFromStream
ExecutionServiceHdl i
StreamHdl i
| StreamInputFileSpec "FileSpec"
StreamLength unsigned long | DEFAULT
ReadOnlyContainerHdl n
End
/* version 3.3.0 or > */
FmcjExecutionServiceReadWriteContainerFromStream
ExecutionServiceHdl i
StreamHdl i
| StreamInputFileSpec "FileSpec"
StreamLength unsigned long | DEFAULT
ReadWriteContainerHdl n
End
Remark: StreamLength DEFAULT
stands for following:
If Fmcj...StreamLength() is called before,
then the last retrieved stream length will be passed
/* version 3.3.2 or > */
FmcjExecutionServiceSetReconnectCount
ExecutionServiceHdl i
Count long
End
/* version 3.3.2 or > */
FmcjExecutionServiceReconnectCount
ExecutionServiceHdl i
XpValue long
End
/* version 3.4.0 or > */
FmcjExecutionServiceForceLogoff
ExecutionServiceHdl i
UserID "value" | "<CL-VALUE>" | NULL
XpRc FMC_OK
End
/* version 3.4.0 or > */
FmcjExecutionServiceForcePEAShutDown
ExecutionServiceHdl i
UserID "value" | "<CL-VALUE>" | NULL
XpRc FMC_OK
End