WebSphere MQ Workflow 3.4 Generic C API Test / Prototyping Tool

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

FmcjProcessTemplate

===Syntax for FmcjProcessTemplate APIs==================================

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

FmcjProcessTemplateCopy
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  ProcessTemplateHdl2               n
  XpRc                              FMC_OK
End

FmcjProcessTemplateDelete
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  PastVersions                      TRUE | FALSE
  CurrentVersion                    TRUE | FALSE
  FutureVersions                    TRUE | FALSE
  XpRc                              FMC_OK
End

FmcjProcessTemplateDeallocate
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  XpRc                              FMC_OK
End

/* the following API is deprecated (version 3.3.0) */
FmcjProcessTemplateInContainer
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  ReadWriteContainerHdl             n
  XpRc                              FMC_OK
End

FmcjProcessTemplateCreateInstance
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  InstanceName                      "value" | NULL
  SystemGroup                       "value" | "<CL-VALUE>" | NULL
  System                            "value" | "<CL-VALUE>" | NULL
  KeepName                          TRUE | FALSE
  ProcessInstanceHdl                n
  [ CreateNoObj                     unsigned long ]
  XpRc                              FMC_OK
End

FmcjProcessTemplateCreateAndStartInstance
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  InstanceName                      "value" | NULL
  SystemGroup                       "value" | "<CL-VALUE>" | NULL
  System                            "value" | "<CL-VALUE>" | NULL
  [ ReadWriteContainerHdl           i ]
  KeepName                          TRUE | FALSE
  ProcessInstanceHdl                n
  [ CreateNoObj                     unsigned long ]
  XpRc                              FMC_OK
End

/* version 3.3.2 or > */
FmcjProcessTemplateCreateAndStartInstanceWithContext
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  InstanceName                      "value" | NULL
  SystemGroup                       "value" | "<CL-VALUE>" | NULL
  System                            "value" | "<CL-VALUE>" | NULL
  [ ReadWriteContainerHdl           i ]
  KeepName                          TRUE | FALSE
  ProcessContext                    "value" | NULL
  ProcessInstanceHdl                n
  [ CreateNoObj                     unsigned long ]
  XpRc                              FMC_OK
End

FmcjProcessTemplateExecuteProcessInstance
  ProcessTemplateHdl                i
  InstanceName                      "value" | NULL
  SystemGroup                       "value" | "<CL-VALUE>" | NULL
  System                            "value" | "<CL-VALUE>" | NULL
  [ ReadWriteContainerHdl           i ]
  KeepName                          TRUE | FALSE
  ProcessInstanceHdl                n
  ReadOnlyContainerHdl              n
  XpRc                              FMC_OK
End

/* version 3.3.2 or > */
FmcjProcessTemplateExecuteProcessInstanceWithContext
  ProcessTemplateHdl                i
  InstanceName                      "value" | NULL
  SystemGroup                       "value" | "<CL-VALUE>" | NULL
  System                            "value" | "<CL-VALUE>" | NULL
  [ ReadWriteContainerHdl           i ]
  KeepName                          TRUE | FALSE
  ProcessContext                    "value" | NULL
  ProcessInstanceHdl                n
  ReadOnlyContainerHdl              n
  XpRc                              FMC_OK
End

FmcjProcessTemplateExecuteProcessInstanceAsync
  ProcessTemplateHdl                i
  InstanceName                      "value" | NULL
  SystemGroup                       "value" | "<CL-VALUE>" | NULL
  System                            "value" | "<CL-VALUE>" | NULL
  [ ReadWriteContainerHdl           i ]
  KeepName                          TRUE | FALSE
  CorrelId                          n | NULL
  UserContext                       "value" | NULL
  XpRc                              FMC_OK
End

/* version 3.3.2 or > */
FmcjProcessTemplateExecuteProcessInstanceWithContextAsync
  ProcessTemplateHdl                i
  InstanceName                      "value" | NULL
  SystemGroup                       "value" | "<CL-VALUE>" | NULL
  System                            "value" | "<CL-VALUE>" | NULL
  [ ReadWriteContainerHdl           i ]
  KeepName                          TRUE | FALSE
  ProcessContext                    "value" | NULL
  CorrelId                          n | NULL
  UserContext                       "value" | NULL
  XpRc                              FMC_OK
End

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

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

FmcjProcessTemplateRefresh
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  XpRc                              FMC_OK
End

FmcjProcessTemplateEqual
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  ProcessTemplateHdl2               i
  XpValue                           TRUE | FALSE
End

FmcjProcessTemplateIsComplete
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessTemplateInContainerNeeded
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessTemplateInitialInContainer
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  ReadWriteContainerHdl             n
  XpRc                              FMC_OK
End

FmcjProcessTemplateCategoryIsNull
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessTemplateDescriptionIsNull
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessTemplateDocumentationIsNull
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessTemplateOrganizationNameIsNull
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessTemplateProcessAdminIsNull
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessTemplateProgramTemplate
  ProcessTemplateHdl                i
  ProgramName                       "value" | NULL
  ProgramTemplateHdl                n
  XpRc                              FMC_OK
End

FmcjProcessTemplateRoleNameIsNull
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  XpValue                           TRUE | FALSE
End

FmcjProcessTemplateAuditMode
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  XpValue                           Fmc_TA_NotSet
                                  | Fmc_TA_NoAudit
                                  | Fmc_TA_Condensed
                                  | Fmc_TA_Full
                                  | Fmc_TA_Filter
End

FmcjProcessTemplateCategory
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessTemplateDescription
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessTemplateDocumentation
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessTemplateInContainerName
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessTemplateName
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessTemplateOrganizationName
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessTemplateOutContainerName
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessTemplateProcessAdmin
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessTemplateRoleName
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End

FmcjProcessTemplateCreationTime
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjProcessTemplateLastModificationTime
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjProcessTemplateValidFromTime
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  DateTimeHdl                       n
  XpValue                           "dt_value" | NULL
End

FmcjProcessTemplateIcon
  ProcessTemplateHdl                i
  | ProcessTemplateVectorHdl        i
  BufferLength                      unsigned long
  XpValue                           "value" | NULL
End