The ClientBusinessProcess component allows you to access information about a deployed business process, search for process instances in that process and execute Global Interactive activities.
Each instance of ClientBusinessProcess operates on a single business process. For operating on multiple processes use ClientProcessService.
The ClientBusinessProcess component provides the same functionality as BusinessProcess but re-uses the current WorkSpace's PAPI session. This means you don't have to provide URL, user and password to ClientBusinessProcess's connectTo() method.
This component must only be used from client-side methods, like those invoked from BPM Object Presentations (most commonly, Dashboards). If you need this functionality on the server side (e.g. from automatic activities), use component BusinessProcess instead.
// Connect to our Orders Management process
ordersProcess = ClientBusinessProcess()
connectTo ordersProcess
using processId = "/TestOU/OrdersManagement"
// Obtain process instances in the "Pending Approval" activity
pendingOrders = getInstancesByActivity(ordersProcess,
activity : "pending_approval")