Class: DocumentRoot

tibco.objectapi.pm.DocumentRoot

new DocumentRoot()

Constructs a new DocumentRoot.

The following features are supported:

Members

activityInstanceStatus :tibco.objectapi.pm.ActivityInstanceStatus

Response element for getActivityInstanceStatus operation. This property holds the value of the 'Activity Instance Status' containment reference.
Type:

availableProcessInstanceVariables :tibco.objectapi.pm.AvailableProcessInstanceVariablesType

Response element for getAvailableProcessInstanceVariables operation. This property holds the value of the 'Available Process Instance Variables' containment reference.
Type:

basicProcessTemplates :tibco.objectapi.pm.BasicProcessTemplatesType

Response element for listProcessTemplates operation, returning a list of process templates. This property holds the value of the 'Basic Process Templates' containment reference.
Type:

bulkCancelProcessInstancesRequest :tibco.objectapi.pm.BulkCancelProcessInstancesRequestType

This property holds the value of the 'Bulk Cancel Process Instances Request' containment reference.
Type:

bulkCancelProcessInstancesResponse :tibco.objectapi.pm.GeneralStatusType

This property holds the value of the 'Bulk Cancel Process Instances Response' containment reference.
Type:

cancelAdhocActivityRequest :tibco.objectapi.pm.CancelAdhocActivityRequestType

This property holds the value of the 'Cancel Adhoc Activity Request' containment reference.
Type:

cancelAdhocActivityResponse :tibco.objectapi.pm.GeneralStatusType

This property holds the value of the 'Cancel Adhoc Activity Response' containment reference.
Type:

checkPurgeTerminatedProcessInstancesRequest :tibco.objectapi.pm.Void

This property holds the value of the 'Check Purge Terminated Process Instances Request' containment reference.
Type:

checkPurgeTerminatedProcessInstancesResponse :tibco.objectapi.pm.PurgeStatus

This property holds the value of the 'Check Purge Terminated Process Instances Response' containment reference.
Type:

createProcessInstanceInput :tibco.objectapi.pm.CreateProcessInstanceInputType

Request element for createProcessInstance operation. This property holds the value of the 'Create Process Instance Input' containment reference.
Type:

getActivityInstanceStatusInput :tibco.objectapi.pm.GetActivityInstanceStatusInputType

Request element for getActivityInstanceStatus operation. This property holds the value of the 'Get Activity Instance Status Input' containment reference.
Type:

getAvailableProcessInstanceVariablesInput :tibco.objectapi.pm.GetAvailableProcessInstanceVariablesInputType

Request element for getAvailableProcessInstanceVariables operation. This property holds the value of the 'Get Available Process Instance Variables Input' containment reference.
Type:

getParameterValueInput :tibco.objectapi.pm.GetParameterValueInputType

Request element for getParameterValue operation. This property holds the value of the 'Get Parameter Value Input' containment reference.
Type:

getParameterValueOutput :tibco.objectapi.pm.GetParameterValueOutputType

Response element for getParameterValue operation. This property holds the value of the 'Get Parameter Value Output' containment reference.
Type:

getProcessInstanceStatusOutput :tibco.objectapi.pm.ProcessInstance

Response element for getProcessInstanceStatus operation, to summarize the current status of one process instance. Note that: - getProcessInstanceStatus is a convenience operation. It is possible to obtain the same data by calling queryProcessInstances with more complex inputs. - The ProcessInstance type is re-used. Some elements (namely, customAttributes) would never contain any data when returned in a getProcessInstanceStatus call. This property holds the value of the 'Get Process Instance Status Output' containment reference.
Type:

illegalArgumentFault :tibco.objectapi.pm.BasicFaultType

Fault element for illegal or missing input argument(s) exception. This property holds the value of the 'Illegal Argument Fault' containment reference.
Type:

illegalStateFault :tibco.objectapi.pm.BasicFaultType

Fault element for illegal state exception. This exception is returned when the requested operation cannot be performed because the target is not in the correct state. This property holds the value of the 'Illegal State Fault' containment reference.
Type:

instanceAttributes :tibco.objectapi.pm.InstanceAttributesType

Response element for the listProcessInstanceAttributes and listSetofProcessInstanceAttributes operations, returning a list of process instance attributes. This property holds the value of the 'Instance Attributes' containment reference.
Type:

isSet :boolean

Element (mostly response) for many operations that return a true/false indication. This property holds the value of the 'Is Set' attribute.
Type:
  • boolean

itemCount :number

Element (mostly response) for many operations that return a count of certain items. This property holds the value of the 'Item Count' attribute.
Type:
  • number

listAdhocActivitiesRequest :tibco.objectapi.pm.ListAdhocActivitiesRequestType

This property holds the value of the 'List Adhoc Activities Request' containment reference.
Type:

listAdhocActivitiesResponse :tibco.objectapi.pm.ListAdhocActivitiesResponseType

This property holds the value of the 'List Adhoc Activities Response' containment reference.
Type:

listProcessInstanceAttributesInput :tibco.objectapi.pm.ListProcessInstanceAttributesInputType

Request element for listProcessInstanceAttributes operation. Attributes include process parameters, process data fields and pre-defined/system variables. These attributes can also be used in process instance queries - see queryProcessInstances. This property holds the value of the 'List Process Instance Attributes Input' containment reference.
Type:

listProcessTemplateAttributesInput :tibco.objectapi.pm.ListProcessTemplateAttributesInputType

Request element for listProcessTemplateAttributes operation. Process template attributes, which are pre-defined variables and are the same for all process templates, can be used in process template queries - see the queryProcessTemplates operation. This property holds the value of the 'List Process Template Attributes Input' containment reference.
Type:

listSetofProcessInstanceAttributesInput :tibco.objectapi.pm.ListSetofProcessInstanceAttributesInputType

Request element for listSetofProcessInstanceAttributes operation. Attributes include process parameters, process data fields and pre-defined/system variables. These attributes can also be used in process instance queries - see queryProcessInstances. This property holds the value of the 'List Setof Process Instance Attributes Input' containment reference.
Type:

migrationPoints :tibco.objectapi.pm.MigrationPointTypes

Response element for getMigrationPoints operation. This property holds the value of the 'Migration Points' containment reference.
Type:

migrationRuleList :tibco.objectapi.pm.MigrationRuleTypesList

Response element for listMigrationRules operation. This property holds the value of the 'Migration Rule List' containment reference.
Type:

migrationRules :tibco.objectapi.pm.MigrationRuleTypes

Request element for setMigrationRules and unsetMigrationRules operations. This property holds the value of the 'Migration Rules' containment reference.
Type:

operationFailedFault :tibco.objectapi.pm.BasicFaultType

Fault element for various exceptions. This property holds the value of the 'Operation Failed Fault' containment reference.
Type:

operationInfo :tibco.objectapi.pm.OperationInfo

Response element for getStarterOperationInfo operation. This property holds the value of the 'Operation Info' containment reference.
Type:

page :tibco.objectapi.pm.ExtendedPage

Response element for queryFirstPage, queryPreviousPage, queryNextPage and queryLastPage operations. This property holds the value of the 'Page' containment reference.
Type:

pagingID :number

Request element for many operations supporting paging of query result sets. A pagingID identifies a particular set of data that can be paged (like a database cursor). This property holds the value of the 'Paging ID' attribute.
Type:
  • number

processID :string

Unique ID assigned to a process instance. This element is the request or response element for many operations. This property holds the value of the 'Process ID' attribute.
Type:
  • string

processIdDBInfo :tibco.objectapi.pm.ProcessIdDBInfo

PVM database information corresponding to a process (PVM) ID. This property holds the value of the 'Process Id DB Info' containment reference.
Type:

processInstances :tibco.objectapi.pm.ProcessInstances

Response element for listProcessInstances, queryProcessInstances and queryProcessInstancesAlt operations. This property holds the value of the 'Process Instances' containment reference.
Type:

processInstanceSummary :tibco.objectapi.pm.ProcessInstanceSummaryType

Response element for getProcessInstanceSummary operation, to capture the summary information about a process instance. This operation is mainly used for debugging purposes. This property holds the value of the 'Process Instance Summary' containment reference.
Type:

processTemplates :tibco.objectapi.pm.ProcessTemplates

Response element for queryProcessTemplates and queryProcessTemplatesAlt operations. This property holds the value of the 'Process Templates' containment reference.
Type:

purgeTerminatedProcessInstancesRequest :tibco.objectapi.pm.PurgeTerminatedProcessInstancesRequestType

This property holds the value of the 'Purge Terminated Process Instances Request' containment reference.
Type:

purgeTerminatedProcessInstancesResponse :tibco.objectapi.pm.PurgeStatus

This property holds the value of the 'Purge Terminated Process Instances Response' containment reference.
Type:

qualifiedProcessName :tibco.objectapi.pm.QualifiedProcessName

Element (mostly request) for many operations that require the fully qualified name of a process template. Wildcard characters can be used when specifying moduleName or processName, as follows: - An asterisk '*' can be used to match zero or more characters. - A question mark '?' can be used to match any single character. - A preceding backslash can be used to escape a wild-card character (i.e. to match a '*' or '?' character). - Using double backslash escapes the escape character (i.e. to match the backslash character). version must either specify an exact version, or can be left blank to return information about all versions. The response message will then include data for all process templates whose fully qualified names match the defined input criteria. This property holds the value of the 'Qualified Process Name' containment reference.
Type:

qualifiedProcessNames :tibco.objectapi.pm.QualifiedProcessNames

qualified process names This property holds the value of the 'Qualified Process Names' containment reference.
Type:

qualifiedTaskName :tibco.objectapi.pm.QualifiedTaskName

Request element for isSetMigrationRule operation. This property holds the value of the 'Qualified Task Name' containment reference.
Type:

queryApplicationsRequest :tibco.objectapi.pm.QueryApplicationsRequestType

This property holds the value of the 'Query Applications Request' containment reference.
Type:

queryApplicationsResponse :tibco.objectapi.pm.QueryApplicationsResponseType

This property holds the value of the 'Query Applications Response' containment reference.
Type:

queryProcessInstancesAltInput :tibco.objectapi.pm.QueryProcessInstancesAltInputType

Request element for queryProcessInstancesAlt operation. This operation works the same way as queryProcessInstances, except the query string is broken into multiple parts. See also: listProcessInstanceAttributes operation. This property holds the value of the 'Query Process Instances Alt Input' containment reference.
Type:

queryProcessInstancesCountAltInput :tibco.objectapi.pm.QueryProcessInstancesCountAltInputType

Request element for queryProcessInstancesCountAlt operation. This property holds the value of the 'Query Process Instances Count Alt Input' containment reference.
Type:

queryProcessInstancesInput :tibco.objectapi.pm.QueryProcessInstancesInputType

Request element for queryProcessInstances, queryProcessInstancesAlt, queryHaltedProcessInstances operations. See also: listProcessInstanceAttributes operation. This property holds the value of the 'Query Process Instances Input' containment reference.
Type:

queryProcessInstancesOutput :tibco.objectapi.pm.QueryProcessInstancesOutputType

Response element for queryProcessInstances, queryProcessInstancesAlt, queryHaltedProcessInstances operations. This property holds the value of the 'Query Process Instances Output' containment reference.
Type:

queryProcessTemplatesAltInput :tibco.objectapi.pm.QueryProcessTemplatesAltInputType

Request element for queryProcessTemplatesAlt operation. Works the same way as queryProcessTemplates, except the query string is broken into multiple parts. See also listProcessTemplateAttributes. This property holds the value of the 'Query Process Templates Alt Input' containment reference.
Type:

queryProcessTemplatesInput :tibco.objectapi.pm.QueryProcessTemplatesInputType

Request element for queryProcessTemplates operation. See also: listProcessTemplateAttributes operation. This property holds the value of the 'Query Process Templates Input' containment reference.
Type:

queryProcessTemplatesOutput :tibco.objectapi.pm.QueryProcessTemplatesOutputType

Response element for queryProcessTemplates and queryProcessTemplatesAlt operations. This property holds the value of the 'Query Process Templates Output' containment reference.
Type:

queryString :string

Request element for queryProcessInstanceCount and queryProcessTemplateCount operations, which require a query string (in SQL syntax) as their input. The query can be either a full SQL query string, or just the WHERE clause. If a full query string is used, the "FROM process" clause should be included. (The underlying code knows whether to count process templates or process instances, depending on the calling operation.) This property holds the value of the 'Query String' attribute.
Type:
  • string

replaceUserRequest :tibco.objectapi.pm.ReplaceUserRequestType

This property holds the value of the 'Replace User Request' containment reference.
Type:

replaceUserResponse :tibco.objectapi.pm.GeneralStatusType

This property holds the value of the 'Replace User Response' containment reference.
Type:

runAdhocActivityRequest :tibco.objectapi.pm.RunAdhocActivityRequestType

This property holds the value of the 'Run Adhoc Activity Request' containment reference.
Type:

runAdhocActivityResponse :tibco.objectapi.pm.GeneralStatusType

This property holds the value of the 'Run Adhoc Activity Response' containment reference.
Type:

saveTerminatedProcessInstancesRequest :tibco.objectapi.pm.SaveTerminatedProcessInstancesRequestType

This property holds the value of the 'Save Terminated Process Instances Request' containment reference.
Type:

saveTerminatedProcessInstancesResponse :tibco.objectapi.pm.PurgeStatus

This property holds the value of the 'Save Terminated Process Instances Response' containment reference.
Type:

setAvailableProcessInstanceVariablesInput :tibco.objectapi.pm.SetAvailableProcessInstanceVariablesInputType

Request element for setAvailableProcessInstanceVariables operation. This property holds the value of the 'Set Available Process Instance Variables Input' containment reference.
Type:

setDeadlineExpirationInput :tibco.objectapi.pm.SetDeadlineExpirationInputType

Request element for setDeadlineExpiration operation. This property holds the value of the 'Set Deadline Expiration Input' containment reference.
Type:

setPriorityInput :tibco.objectapi.pm.SetPriorityInputType

Request element for setPriority operation. This property holds the value of the 'Set Priority Input' containment reference.
Type:

starterOperation :tibco.objectapi.pm.StarterOperation

Request element for any operation, such as getStarterOperationInfo, that needs starter operation information This property holds the value of the 'Starter Operation' containment reference.
Type:

starterOperations :tibco.objectapi.pm.StarterOperationsType

Response element for listStarterOperations operation. This property holds the value of the 'Starter Operations' containment reference.
Type:

stopPurgeTerminatedProcessInstancesRequest :tibco.objectapi.pm.Void

This property holds the value of the 'Stop Purge Terminated Process Instances Request' containment reference.
Type:

stopPurgeTerminatedProcessInstancesResponse :tibco.objectapi.pm.PurgeStatus

This property holds the value of the 'Stop Purge Terminated Process Instances Response' containment reference.
Type:

success :string

Element (mostly response) for many operations that return a success indication. This is a work-around so that WSDL 1.1 allows fault message(s) to be declared and thrown. This property holds the value of the 'Success' attribute.
Type:
  • string

templateAttributes :tibco.objectapi.pm.TemplateAttributes

Response element for listProcessTemplateAttributes operation, returning a list of process template attributes This property holds the value of the 'Template Attributes' containment reference.
Type:

test :string

This property holds the value of the 'Test' attribute.
Type:
  • string