Class: ProcessManagementService

tibco.objectapi.service.ProcessManagementService

new ProcessManagementService()

Methods

cancelAdhocActivity(request, callback)

Cancels the currently active ad-hoc activity.
Parameters:
Name Type Description
request tibco.objectapi.service.request.CancelAdhocActivityRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type GeneralStatusType.

cancelProcessInstance(request, callback)

Cancels a specific process instance.
Parameters:
Name Type Description
request tibco.objectapi.service.request.CancelProcessInstanceRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

cancelProcessInstances(request, callback)

Cancels all process instances for the specified process templates.
Parameters:
Name Type Description
request tibco.objectapi.service.request.CancelProcessInstancesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type IntResponse.

checkPurgeTerminatedProcessInstances(request, callback)

Checks the status of a purge job started with purgeTerminatedProcessInstances.
Parameters:
Name Type Description
request tibco.objectapi.service.request.CheckPurgeTerminatedProcessInstancesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type PurgeStatus.

clearMigrationRules(request, callback)

Clears all currently set process instance migration rules for one process templates.
Parameters:
Name Type Description
request tibco.objectapi.service.request.ClearMigrationRulesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

createProcessInstance(request, callback)

Creates (starts) a process instance using a starter operation.

This function is used to create an instance of a process that has a start event with a trigger type of "None". If the process has a start event with a trigger type of "Message", it must be started either using a business service, if it was published as a business service, or by using the startProcessIncomingReceiveTask function, if it was published as a REST Service.

Parameters:
Name Type Description
request tibco.objectapi.service.request.CreateProcessInstanceRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

decodeProcessId(request, callback)

Decodes "process" IDs into "database" IDs.

Process IDs written to the log and returned from Process Manager are in the form "pvm:nnnn". Whereas, PVM engine tables use database IDs (dbId). In order to debug PVM engine tables, you can use this function to correlate the process IDs with the database IDs.

Parameters:
Name Type Description
request tibco.objectapi.service.request.DecodeProcessIdRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type ProcessIdDBInfo.

getActivityInstanceStatus(request, callback)

Returns the status of an activity for a particular process instance.
Parameters:
Name Type Description
request tibco.objectapi.service.request.GetActivityInstanceStatusRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type ActivityInstanceStatus.

getAvailableProcessInstanceVariables(request, callback)

Returns the details for all variables (or for a specific variable) that are available to the failed activity for a particular halted process instance.
Parameters:
Name Type Description
request tibco.objectapi.service.request.GetAvailableProcessInstanceVariablesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type AvailableProcessInstanceVariablesType.

getMigrationPoints(request, callback)

Lists the permissible process instance migration points for one process templates. (Migration points are the points in the process from which a process instance can be migrated to a different version.)
Parameters:
Name Type Description
request tibco.objectapi.service.request.GetMigrationPointsRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type MigrationPointTypes.

getParameterValue(request, callback)

Returns the value of a specific parameter (also referred to as "custom attributes") for a particular process instance.
Parameters:
Name Type Description
request tibco.objectapi.service.request.GetParameterValueRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type JsoResponse.

getProcessInstanceStatus(request, callback)

Returns the status of a particular process instance.
Parameters:
Name Type Description
request tibco.objectapi.service.request.GetProcessInstanceStatusRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type ProcessInstanceAudit.

getProcessInstanceSummary(request, callback)

Returns a full summary report on a specific process instance (this operation is most useful for debugging).

The response returns (in a formatted string) all information relevant to the specified process instance, including a snapshot of all process variables values.

Parameters:
Name Type Description
request tibco.objectapi.service.request.GetProcessInstanceSummaryRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

getStarterOperationInfo(request, callback)

Lists the parameter details for a particular starter operation. Starter operations refer to start events of processes.

To be able to directly start an instance of a process template, the start event of the process must have a trigger type of "None" (as opposed to a trigger type of "Message", which requires that the process be started by a business service).

Parameters:
Name Type Description
request tibco.objectapi.service.request.GetStarterOperationInfoRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type OperationInfo.

ignoreProcessInstance(request, callback)

Resumes execution of a process instance that has halted as a result of an activity failure, ignoring the failed activity. Execution continues from the point in the process after the failed activity, as if the failed activity had not been processed.
Parameters:
Name Type Description
request tibco.objectapi.service.request.IgnoreProcessInstanceRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

ignoreProcessInstances(request, callback)

Ignores failed activities and resume the execution of all halted process instances for the specified process templates. For each process instance, execution continues from the point in the process after the failed activity, as if the failed activity had not been processed.
Parameters:
Name Type Description
request tibco.objectapi.service.request.IgnoreProcessInstancesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type IntResponse.

isSetMigrationRule(request, callback)

Tests whether any process instance migration rules are set for a particular qualified task name.
Parameters:
Name Type Description
request tibco.objectapi.service.request.IsSetMigrationRuleRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type BooleanResponse.

listAdhocActivitiesByGlobalRef(request, callback)

Lists all ad-hoc activities associated with the specified global data reference.
Parameters:
Name Type Description
request tibco.objectapi.service.request.ListAdhocActivitiesByGlobalRefRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type AdhocActivityTypes.

listAdhocActivitiesById(request, callback)

Lists all ad-hoc activities associated with the specified process ID.
Parameters:
Name Type Description
request tibco.objectapi.service.request.ListAdhocActivitiesByIdRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type AdhocActivityTypes.

listMigrationRules(request, callback)

Lists the process instance migration rules that are set for one process templates.
Parameters:
Name Type Description
request tibco.objectapi.service.request.ListMigrationRulesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type MigrationRuleTypesList.

listProcessInstanceAttributes(request, callback)

Lists process instance attributes for the specified process templates (these attributes can be used in process instance queries).
Parameters:
Name Type Description
request tibco.objectapi.service.request.ListProcessInstanceAttributesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type InstanceAttributesType.

listProcessInstances(request, callback)

Lists process instances for one process template.

The response can contain a maximum of 500 process instances. This limit is fixed and cannot be configured. If you are expecting a response that exceeds 500 process instances, use the queryProcessInstances function with a positive pageSize parameter instead.

Parameters:
Name Type Description
request tibco.objectapi.service.request.ListProcessInstancesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type JsoResponse.

listProcessTemplateAttributes(request, callback)

Lists process template attributes. These attributes, which are pre-defined variables and are the same for all process templates, can be used in queries for process templates - see queryProcessTemplates.
Parameters:
Name Type Description
request tibco.objectapi.service.request.ListProcessTemplateAttributesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type TemplateAttributes.

listProcessTemplates(request, callback)

Lists process templates that match the input criteria.
Parameters:
Name Type Description
request tibco.objectapi.service.request.ListProcessTemplatesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type BasicProcessTemplatesType.

listServices(request, callback)

Lists the processes that have been "published as a REST service" in TIBCO Business Studio.

The processes/services returned by this function can be started using the startProcessIncomingReceiveTask function.

Parameters:
Name Type Description
request tibco.objectapi.service.request.ListServicesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type QueryBusinessServicesResponse.

listSetofProcessInstanceAttributes(request, callback)

Lists process instance attributes for a set of process templates (these attributes can be used in process instance queries).
Parameters:
Name Type Description
request tibco.objectapi.service.request.ListSetofProcessInstanceAttributesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type InstanceAttributesType.

listStarterOperations(request, callback)

Lists available starter operations for one process template.

Starter operations refer to start events of processes. To be able to directly start an instance of a process template, the start event of the process must have a trigger type of "None" (as opposed to a trigger type of "Message", which requires that the process be started by a business service).

Parameters:
Name Type Description
request tibco.objectapi.service.request.ListStarterOperationsRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StarterOperationsType.

purgeProcessInstances(request, callback)

Purges process instances that match the specified parameters.
Parameters:
Name Type Description
request tibco.objectapi.service.request.PurgeProcessInstancesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type IntResponse.

purgeTerminatedProcessInstances(request, callback)

Immediately purges saved process instances with terminal states that correspond to one or more of the specified marked process templates. There can only be one outstanding purge job at one time.
Parameters:
Name Type Description
request tibco.objectapi.service.request.PurgeTerminatedProcessInstancesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type PurgeStatus.

queryApplications(request, callback)

Returns all process template(s) belonging to the specified application(s).
Parameters:
Name Type Description
request tibco.objectapi.service.request.QueryApplicationsRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type QueryApplicationsResponseType.

queryDone(request, callback)

Releases all resources associated with a particular paged result set. An application must call this operation whenever it has finished with a particular paged result set. The request must include a paging ID, which can be obtained using queryProcessInstances, queryProcessInstancesAlt, queryProcessTemplates, or queryProcessTemplatesAlt.
Parameters:
Name Type Description
request tibco.objectapi.service.request.QueryDoneRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

queryFirstPage(request, callback)

Lists the first page of data from the result set of a particular query operation.

The request must include a paging ID, which can be obtained using queryProcessInstances, queryProcessInstancesAlt, queryProcessTemplates, or queryProcessTemplatesAlt.

Parameters:
Name Type Description
request tibco.objectapi.service.request.QueryFirstPageRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type Page.

queryHaltedProcessInstances(request, callback)

Lists process instances that have halted (as a result of an activity failure) that match certain criteria.

Note - This function only queries HALTED process instances. To list process instances that are in a state other than HALTED, use queryProcessInstances or queryProcessInstancesAlt instead.

Parameters:
Name Type Description
request tibco.objectapi.service.request.QueryHaltedProcessInstancesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type QueryProcessInstancesOutputType.

queryLastPage(request, callback)

Lists the last page of data from the result set of a particular query operation. The request must include a paging ID, which can be obtained using queryProcessInstances, queryProcessInstancesAlt, queryProcessTemplates, or queryProcessTemplatesAlt.
Parameters:
Name Type Description
request tibco.objectapi.service.request.QueryLastPageRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type Page.

queryNextPage(request, callback)

Lists the next page of data from the result set of a particular query operation. The request must include a paging ID, which can be obtained using queryProcessInstances, queryProcessInstancesAlt, queryProcessTemplates, or queryProcessTemplatesAlt.
Parameters:
Name Type Description
request tibco.objectapi.service.request.QueryNextPageRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type Page.

queryPreviousPage(request, callback)

Lists the previous page of data from the result set of a particular query operation. The request must include a paging ID, which can be obtained using queryProcessInstances, queryProcessInstancesAlt, queryProcessTemplates, or queryProcessTemplatesAlt.
Parameters:
Name Type Description
request tibco.objectapi.service.request.QueryPreviousPageRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type Page.

queryProcessInstanceCount(request, callback)

Counts the number of process instances that match certain criteria.
Parameters:
Name Type Description
request tibco.objectapi.service.request.QueryProcessInstanceCountRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type IntResponse.

queryProcessInstanceCountAlt(request, callback)

Counts the number of process instances that match specified criteria.
Parameters:
Name Type Description
request tibco.objectapi.service.request.QueryProcessInstanceCountAltRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type IntResponse.

queryProcessInstances(request, callback)

Lists process instances that match certain criteria.
Parameters:
Name Type Description
request tibco.objectapi.service.request.QueryProcessInstancesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type QueryProcessInstancesOutputType.

queryProcessInstancesAlt(request, callback)

Lists process instances that match certain criteria. (This is a variation of queryProcessInstances in which the query string is divided into its constituent parts.).
Parameters:
Name Type Description
request tibco.objectapi.service.request.QueryProcessInstancesAltRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type QueryProcessInstancesOutputType.

queryProcessTemplateCount(request, callback)

Counts the number of process templates that match certain criteria.
Parameters:
Name Type Description
request tibco.objectapi.service.request.QueryProcessTemplateCountRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type IntResponse.

queryProcessTemplates(request, callback)

Lists process templates that match certain criteria.
Parameters:
Name Type Description
request tibco.objectapi.service.request.QueryProcessTemplatesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type QueryProcessTemplatesOutputType.

queryProcessTemplatesAlt(request, callback)

Lists process templates that match certain criteria. (This is a variation of queryProcessTemplates in which the query string is divided into its constituent parts.).
Parameters:
Name Type Description
request tibco.objectapi.service.request.QueryProcessTemplatesAltRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type QueryProcessTemplatesOutputType.

replaceUser(request, callback)

Accepts a list of process IDs or a user name as input, and uses the Subject on this request to replace the Subject associated with each of the referenced process instances or user. If the specified process instance has sub-processes, the Subjects of the sub-processes are replaced as well.
Parameters:
Name Type Description
request tibco.objectapi.service.request.ReplaceUserRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type GeneralStatusType.

resumeHaltedProcessInstance(request, callback)

Resumes execution of a process instance that has halted as a result of an activity failure. Execution continues as if the activity had failed.
Parameters:
Name Type Description
request tibco.objectapi.service.request.ResumeHaltedProcessInstanceRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

resumeHaltedProcessInstances(request, callback)

Resumes execution of all process instances for the specified process templates, where those instances have halted as a result of an activity failure. Execution of each process instance continues as if the activity had failed.
Parameters:
Name Type Description
request tibco.objectapi.service.request.ResumeHaltedProcessInstancesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type IntResponse.

resumeProcessInstance(request, callback)

Resumes a previously suspended process instance.
Parameters:
Name Type Description
request tibco.objectapi.service.request.ResumeProcessInstanceRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

resumeProcessInstances(request, callback)

Resumes all process instances for the specified process templates.
Parameters:
Name Type Description
request tibco.objectapi.service.request.ResumeProcessInstancesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type IntResponse.

retryProcessInstance(request, callback)

Resumes execution of a process instance that has halted as a result of an activity failure. Execution continues by retrying the failed activity.
Parameters:
Name Type Description
request tibco.objectapi.service.request.RetryProcessInstanceRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

retryProcessInstances(request, callback)

Resumes the execution of all halted process instances for the specified process templates, in each case retrying the activity that caused the process instance to fail. For each process instance, execution continues by retrying the failed activity.
Parameters:
Name Type Description
request tibco.objectapi.service.request.RetryProcessInstancesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type IntResponse.

runAdhocActivity(request, callback)

Invokes the identified ad-hoc activity. This function is applicable only to manual ad-hoc activities, not automatic ad-hoc activities (automatic ad-hoc activities are automatically invoked when they become enabled).

The ad-hoc activity must be enabled before it can be invoked. An ad-hoc activity is enabled when:

  • any initializer activity specified in the ad-hoc activity definition has completed, and
  • a pre-condition specified in the ad-hoc activity definition is true.

To determine if an ad-hoc activity is enabled, use the listAdhocActivities function, and view the enabled element in the response.

If an attempt is made to invoke an ad-hoc activity that is already active, the invocation is discarded, and an audit record is created for the request.

Parameters:
Name Type Description
request tibco.objectapi.service.request.RunAdhocActivityRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type GeneralStatusType.

saveTerminatedProcessInstances(request, callback)

Saves terminated process instances.
Parameters:
Name Type Description
request tibco.objectapi.service.request.SaveTerminatedProcessInstancesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type PurgeStatus.

setAvailableProcessInstanceVariables(request, callback)

Sets the value of one or more variables that are available to the failed activity for a particular halted process instance.
Parameters:
Name Type Description
request tibco.objectapi.service.request.SetAvailableProcessInstanceVariablesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

setDeadlineExpiration(request, callback)

Sets the deadline value for an activity.

Parameters:
Name Type Description
request tibco.objectapi.service.request.SetDeadlineExpirationRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

setMigrationRules(request, callback)

Sets one or more process instance migration rules. (Each migration rule consists of a unique set of module name, module version from which to migrate, process template name, task name from which to migrate, and module version to which to migrate.)
Parameters:
Name Type Description
request tibco.objectapi.service.request.SetMigrationRulesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

setPriority(request, callback)

Changes the scheduling priority for execution of a process instance.
Parameters:
Name Type Description
request tibco.objectapi.service.request.SetPriorityRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

startProcessIncomingReceiveTask(request, callback)

Starts an instance of a process template that was "published as a REST Service" in TIBCO Business Studio.

You can also start instances of process templates using the createProcessInstance function, or by starting a business service (see startBusinessService).

Parameters:
Name Type Description
request tibco.objectapi.service.request.StartProcessIncomingReceiveTaskRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type DataPayload.

stopPurgeTerminatedProcessInstances(request, callback)

Stops the purge job started with purgeTerminatedProcessInstances. Only effective when purge job is run in the background.
Parameters:
Name Type Description
request tibco.objectapi.service.request.StopPurgeTerminatedProcessInstancesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type PurgeStatus.

suspendProcessInstance(request, callback)

Suspends a process instance from being scheduled for execution.
Parameters:
Name Type Description
request tibco.objectapi.service.request.SuspendProcessInstanceRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

suspendProcessInstances(request, callback)

Suspends all process instances for one process templates from being scheduled for execution.
Parameters:
Name Type Description
request tibco.objectapi.service.request.SuspendProcessInstancesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type IntResponse.

unsetMigrationRules(request, callback)

Unsets one or more currently set process instance migration rules.
Parameters:
Name Type Description
request tibco.objectapi.service.request.UnsetMigrationRulesRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.