WebSphere MQ Workflow 3.4 Generic C API Test / Prototyping Tool

[prev][next][parent][TOC]

FmcjWorkitem

===Syntax for FmcjWorkitem APIs=========================================

Remark: When you select option "WorkitemVectorHdl" instead of 
        "WorkitemHdl", the API call applies to ALL elements
        of the vector.

FmcjWorkitemUpdate
  WorkitemHdl                       i
  ExecutionDataHdl                  i
  XpRc                              FMC_OK
End

FmcjWorkitemCopy
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  WorkitemHdl2                      n
  XpRc                              FMC_OK
End

FmcjWorkitemDelete
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpRc                              FMC_OK
End

FmcjWorkitemDeallocate
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpRc                              FMC_OK
End

FmcjWorkitemRefresh
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpRc                              FMC_OK
End

FmcjWorkitemStart
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpRc                              FMC_OK
End

FmcjWorkitemRestart
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpRc                              FMC_OK
End

FmcjWorkitemTerminate
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpRc                              FMC_OK
End

FmcjWorkitemFinish
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpRc                              FMC_OK
End

FmcjWorkitemForceFinish
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpRc                              FMC_OK
End

/* version 3.3.0 or > */
FmcjWorkitemForceFinishWithContainer
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  XpRc                              FMC_OK
End

FmcjWorkitemForceRestart
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpRc                              FMC_OK
End

/* version 3.3.0 or > */
FmcjWorkitemForceRestartWithContainer
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  ReadOnlyContainerHdl              i
  | ReadWriteContainerHdl           i
  XpRc                              FMC_OK
End

FmcjWorkitemSetName
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  WorkitemName                      "value" | NULL
  XpRc                              FMC_OK
End

FmcjWorkitemInContainer
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  ReadOnlyContainerHdl              n
  XpRc                              FMC_OK
End

FmcjWorkitemOutContainer
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  ReadWriteContainerHdl             n
  XpRc                              FMC_OK
End

FmcjWorkitemProcessInstance
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  ProcessInstanceHdl                n
  XpRc                              FMC_OK
End

FmcjWorkitemActivityInstance
  WorkitemHdl                       i
  ActivityInstanceHdl               n
  XpRc                              FMC_OK
End

FmcjWorkitemCheckOut
  WorkitemHdl                       i
  RequestedData                     Fmc_WS_NotSet
                                  | Fmc_WS_CommonDataOnly
                                  | Fmc_WS_SpecifiedDefinitions
                                  | Fmc_WS_AllDefinitions
  Platform                          Fmc_DP_NotSet
                                  | Fmc_DP_OS2
                                  | Fmc_DP_AIX
                                  | Fmc_DP_HPUX
                                  | Fmc_DP_Solaris
                                  | Fmc_DP_Windows95
                                  | Fmc_DP_WindowsNT
                                  | Fmc_DP_OS390
  ProgramDataHdl                    n
  XpRc                              FMC_OK
End

FmcjWorkitemCancelCheckOut
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpRc                              FMC_OK
End

FmcjWorkitemCheckIn
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  [ReadWriteContainerHdl            i]
  ReturnCode                        long
  XpRc                              FMC_OK
End

FmcjWorkitemSetDescription
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  Description                       "value" | NULL
  XpRc                              FMC_OK
End

FmcjWorkitemStartTool
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  ToolName                          "value" | NULL
  XpRc                              FMC_OK
End

FmcjWorkitemTransfer
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  UserID                            "value" | NULL
  XpRc                              FMC_OK 
End

/* the following API is deprecated (version 3.3.0) */
FmcjWorkitemPersistentObject
  ExecutionServiceHdl               i
  PersistentOidHdl                  i
  | PersistentOidInputFileSpec      "FileSpec"
  WorkitemHdl                       n
  XpRc                              FMC_OK
End

FmcjWorkitemPersistentOid
  WorkitemHdl                       i
  PersistentOidHdl                  n
  [ PersistentOidOutputFileSpec     "FileSpec" ]
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemPersistentOidOfActivityInstance
  WorkitemHdl                       i
  PersistentOidHdl                  n
  [ PersistentOidOutputFileSpec     "FileSpec" ]
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemPersistentOidOfProcessInstance
  WorkitemHdl                       i
  PersistentOidHdl                  n
  [ PersistentOidOutputFileSpec     "FileSpec" ]
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemEqual
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  WorkitemHdl2                      i
  XpValue                           TRUE | FALSE
End

FmcjWorkitemStateOfNotification
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           Fmc_AE_NotSet
                                  | Fmc_AE_NoNotification
                                  | Fmc_AE_FirstNotification
                                  | Fmc_AE_SecondNotification
End

FmcjWorkitemActivityKind
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           Fmc_AT_NotSet
                                  | Fmc_AT_Process
                                  | Fmc_AT_Program
                                  | Fmc_AT_Block
                                  | Fmc_AT_Bundle
End

FmcjWorkitemIsComplete
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           TRUE | FALSE
End

FmcjWorkitemSecondNotificationTimeIsNull
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           TRUE | FALSE
End

FmcjWorkitemCategoryIsNull
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           TRUE | FALSE
End

FmcjWorkitemDescriptionIsNull
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           TRUE | FALSE
End

FmcjWorkitemDocumentationIsNull
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           TRUE | FALSE
End

FmcjWorkitemEndTimeIsNull
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           TRUE | FALSE
End

FmcjWorkitemStartTimeIsNull
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           TRUE | FALSE
End

FmcjWorkitemFirstNotificationTimeIsNull
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           TRUE | FALSE
End

FmcjWorkitemImplementationIsNull
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           TRUE | FALSE
End

FmcjWorkitemSupportToolsIsNull
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           TRUE | FALSE
End

/* version 3.3.0 or > */
FmcjWorkitemExpirationTimeIsNull
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           TRUE | FALSE
End

FmcjWorkitemManualExitMode
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           TRUE | FALSE
End

FmcjWorkitemManualStartMode
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           TRUE | FALSE
End

FmcjWorkitemKind
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           Fmc_IT_NotSet
                                  | Fmc_IT_Workitem
                                  | Fmc_IT_ProcessInstanceNotification
                                  | Fmc_IT_FirstActivityInstanceNotification
                                  | Fmc_IT_SecondActivityInstanceNotification
End

FmcjWorkitemReceivedAs
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           Fmc_IR_NotSet
                                  | Fmc_IR_Normal
                                  | Fmc_IR_Substitute
                                  | Fmc_IR_ProcessAdministrator
                                  | Fmc_IR_SystemAdministrator
                                  | Fmc_IR_ByTransfer
End

FmcjWorkitemState
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           Fmc_IS_NotSet
                                  | Fmc_IS_Ready
                                  | Fmc_IS_Running
                                  | Fmc_IS_Finished
                                  | Fmc_IS_Terminated
                                  | Fmc_IS_Suspended
                                  | Fmc_IS_Disabled
                                  | Fmc_IS_CheckedOut
                                  | Fmc_IS_InError
                                  | Fmc_IS_Executed
                                  | Fmc_IS_Planning
                                  | Fmc_IS_ForceFinished
                                  | Fmc_IS_Deleted
                                  | Fmc_IS_Terminating
                                  | Fmc_IS_Suspending
                                  | Fmc_IS_Expired
End

FmcjWorkitemProcessInstanceState
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           Fmc_PS_NotSet
                                  | Fmc_PS_Ready
                                  | Fmc_PS_Running
                                  | Fmc_PS_Finished
                                  | Fmc_PS_Terminated
                                  | Fmc_PS_Suspended
                                  | Fmc_PS_Terminating
                                  | Fmc_PS_Suspending
                                  | Fmc_PS_Deleted
End

FmcjWorkitemCategory
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemDescription
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemDocumentation
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemName
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemInContainerName
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemOutContainerName
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemProcessInstanceName
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemProcessAdmin
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemOwner
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemImplementation
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemStartCondition
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemExitCondition
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemProcessInstanceSystemGroupName
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemProcessInstanceSystemName
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemStartTime
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjWorkitemEndTime
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjWorkitemFirstNotificationTime
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjWorkitemSecondNotificationTime
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjWorkitemCreationTime
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjWorkitemLastModificationTime
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjWorkitemReceivedTime
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

/* version 3.3.0 or > */
FmcjWorkitemExpirationTime
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjWorkitemIcon
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjWorkitemPriority
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           unsigned long
End

FmcjWorkitemStaff
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  StringVectorHdl                   n
  XpValue                           "value1;value2;..."
End

FmcjWorkitemSupportTools
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  StringVectorHdl                   n
  XpValue                           "value1;value2;..."
End

FmcjWorkitemErrorReason
  WorkitemHdl                       i
  ErrorHdl                          n
End

FmcjWorkitemErrorReasonIsNull
  WorkitemHdl                       i
  | WorkitemVectorHdl               i
  XpValue                           TRUE | FALSE
End

/* the following API is deprecated (version 3.3.0) */
FmcjWorkitemObtainProcessInstanceMonitor
  WorkitemHdl                       i
  Deep                              TRUE | FALSE
  ProcessInstanceMonitorHdl         n
  XpRc                              FMC_OK
End

/* version 3.3.0 or > */
FmcjWorkitemObtainProcessMonitor
  WorkitemHdl                       i
  Deep                              TRUE | FALSE
  InstanceMonitorHdl                n
  XpRc                              FMC_OK
End