WebSphere MQ Workflow 3.4 Generic C API Test / Prototyping Tool

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

FmcjProcessInstance

===Syntax for FmcjProcessInstance APIs==================================

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

FmcjProcessInstanceCopy
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  ProcessInstanceHdl2               n
  XpRc                              FMC_OK
End

FmcjProcessInstanceDelete
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpRc                              FMC_OK
End

FmcjProcessInstanceDeallocate
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpRc                              FMC_OK
End

FmcjProcessInstanceInContainer
  ProcessInstanceHdl                i
  ReadWriteContainerHdl             n
  XpRc                              FMC_OK
End

FmcjProcessInstanceOutContainer
  ProcessInstanceHdl                i
  ReadOnlyContainerHdl              n
  XpRc                              FMC_OK
End

/* version 3.3.2 or > */
FmcjProcessInstanceGlobalContainer
  ProcessInstanceHdl                i
  ReadOnlyContainerHdl              n
  XpRc                              FMC_OK
End

FmcjProcessInstanceRefresh
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpRc                              FMC_OK
End

FmcjProcessInstanceStart
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  [ ReadWriteContainerHdl           i ]
  XpRc                              FMC_OK
End

/* version 3.3.2 or > */
FmcjProcessInstanceStartWithContext
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  [ ReadWriteContainerHdl           i ]
  ProcessContext                    "value" | NULL
  XpRc                              FMC_OK
End

FmcjProcessInstanceRestart
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpRc                              FMC_OK
End

FmcjProcessInstanceResume
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  Deep                              TRUE | FALSE
  XpRc                              FMC_OK
End

FmcjProcessInstanceSuspend
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  Deep                              TRUE | FALSE
  XpRc                              FMC_OK
End

FmcjProcessInstanceSuspendUntil
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  DateTimeHdl                       i
  Deep                              TRUE | FALSE
  XpRc                              FMC_OK
End

FmcjProcessInstanceTerminate
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpRc                              FMC_OK
End

FmcjProcessInstanceSetDescription
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  Description                       "value" | NULL
  XpRc                              FMC_OK
End

FmcjProcessInstanceSetName
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  InstanceName                      "value"
  XpRc                              FMC_OK
End

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

/* version 3.3.0 or > */
FmcjProcessInstancePersistentOidOfProcessTemplate
  ProcessInstanceHdl                i
  PersistentOidHdl                  n
  [ PersistentOidOutputFileSpec     "FileSpec" ]
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

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

FmcjProcessInstanceEqual
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  ProcessInstanceHdl2               i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceIsComplete
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceInContainerNeeded
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceAuditMode
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           Fmc_TA_NotSet
                                  | Fmc_TA_NoAudit
                                  | Fmc_TA_Condensed
                                  | Fmc_TA_Full
                                  | Fmc_TA_Filter
End

FmcjProcessInstanceCategoryIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceDescriptionIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceDocumentationIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceEndTimeIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceNotificationTimeIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceOrganizationNameIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceParentNameIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceProcessAdminIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

/* version 3.3.2 or > */
FmcjProcessInstanceProcessContextIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceRoleNameIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceStarterIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceStartTimeIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceSuspensionTimeIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceSuspensionExpirationTimeIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceNotifiedPersonIsNull
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessInstanceCategory
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessInstanceDescription
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessInstanceDocumentation
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessInstanceInContainerName
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessInstanceName
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
  | XpValueLike                     "value" | NULL
End

FmcjProcessInstanceOrganizationName
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessInstanceOutContainerName
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessInstanceProcessAdmin
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

/* version 3.3.2 or > */
FmcjProcessInstanceProcessContext
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessInstanceRoleName
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessInstanceStarter
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessInstanceTopLevelName
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
  | XpValueLike                     "value" | NULL
End

FmcjProcessInstanceParentName
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
  | XpValueLike                     "value" | NULL
End

FmcjProcessInstanceCreator
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessInstanceProcessTemplateName
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessInstanceSystemName
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessInstanceSystemGroupName
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessInstanceNotifiedPerson
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessInstanceState
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        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

FmcjProcessInstanceStateOfNotification
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  XpValue                           Fmc_PE_NotSet
                                  | Fmc_PE_NoNotification
                                  | Fmc_PE_ProcessNotification
End

FmcjProcessInstanceStartTime
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjProcessInstanceEndTime
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjProcessInstanceNotificationTime
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjProcessInstanceCreationTime
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjProcessInstanceLastModificationTime
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjProcessInstanceLastStateChangeTime
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjProcessInstanceSuspensionTime
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjProcessInstanceSuspensionExpirationTime
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

/* version 3.3.2 or > */
FmcjProcessInstanceValidFromTime
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjProcessInstanceIcon
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

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

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

/* version 3.4.0 or > */
FmcjProcessInstanceSetProcessAdmin
  ProcessInstanceHdl                i
  | ProcessInstanceVectorHdl        i
  UserID                            "value" | "<CL-VALUE>" | NULL
  XpRc                              FMC_OK
End