Procedures available in the IBM BPM MobileFirst application-specific adapter

The IBM® BPM MobileFirst application-specific adapter provides a common set of procedures for each exposed business process definition (BPD) and case type that is found in the process application and its dependent toolkits.

The following procedures are available in the application-specific adapter for the exposed BPD and case type.

Table 1. Common set of procedures that are exposed in the application-specific adapter for BPDs and case types
Procedure name	Description
`start<BPDName/CaseTypeName>Process()`	Starts the exposed BPD or case type. This procedure calls the startProcess procedure in the generic adapter. Parameters None Return Same as the startProcess procedure
`get<BPDName/CaseTypeName>ProcessId(processInstanceDetails)`	Gets the instance ID of the process. Parameters processInstanceDetails: The object from the response of the start<BPDName/CaseTypeName>Process procedure Return A JavaScript object that has a `piid` key and the value of the process ID.
`get<BPDName/CaseTypeName>ProcessInstanceDetails(piid)`	Gets the instance details of the process. This procedure calls the getProcessInstanceDetails procedure in the generic adapter. Parameters piid: The identifier of the process instance Return Same as the getProcessInstanceDetails procedure
`terminate<BPDName/CaseTypeName>ProcessInstance(piid)`	Terminates the process instance. This procedure calls the `terminateProcessInstance` procedure in the generic adapter. Parameters piid: The identifier of the process instance Return Same as the `terminateProcessInstance` procedure
`suspend<BPDName/CaseTypeName>ProcessInstance(piid)`	Suspends the process instance. This procedure calls the `suspendProcessInstance` procedure in the generic adapter. Parameters piid: The identifier of the process instance Return Same as the `suspendProcessInstance` procedure
`resume<BPDName/CaseTypeName>ProcessInstance(piid)`	Resumes the process instance. This procedure calls the `resumeProcessInstance` procedure in the generic adapter. Parameters piid: The identifier of the process instance Return Same as the `resumeProcessInstance` procedure
`retry<BPDName/CaseTypeName>ProcessInstance(piid)`	Retries the process instance. This procedure calls the `retryProcessInstance` procedure in the generic adapter. Parameters piid: The identifier of the process instance Return Same as the `retryProcessInstance` procedure
`delete<BPDName/CaseTypeName>ProcessInstance(piid)`	Deletes the process instance. This procedure calls the `deleteProcessInstance` procedure in the generic adapter. Parameters piid: The identifier of the process instance Return Same as the `deleteProcessInstance` procedure
`start<Service>Task(processInstanceDetails, taskInputParam1, taskInputParam2, ...)`	Starts the service task in the process instance. This procedure calls the `startTask` procedure in the generic adapter. Parameters processInstanceDetails: The object from the response of the `start<BPDName/CaseTypeName>Process` procedure taskInputParam1, taskInputParam2, ...: Input parameters for the specified task Return Same as the `startTask` procedure
`finish<Service>Task(processInstanceDetails, taskOutputParam1, taskOutputParam2, ...)`	Finishes the service task in the process instance. This procedure calls the `finishTask` procedure in the generic adapter. Parameters processInstanceDetails: The object from the response of the `start<BPDName/CaseTypeName>Process` procedure taskOutputParam1, taskOutputParam2, ...: Output parameters or variables for the specified task Return Same as the `finishTask` procedure