What Happens When You Create a Guided Business Process Instance

Building a Guided Business Process Client Application 25-7

25.5 Guided Business Process Run-time APIs

Guided Business Processes provide you a set of APIs that enable you to get details about the available milestones and the tasks that compose them. If the predefined Activity Guide ADF taskflows do not satisfy your requirements then you can use these APIs to obtain the information that you display in the client application.

25.5.1 Guided Business Process query Service API

This API is designed to support the following user navigation scenarios in an application displaying a Guided Business Process: Display a list of Guided Business Process instances using a filter. Available filters are: ■ MY : Guided Business Process instances containing active tasks assigned to the user. ■ REPORTEES : Guided Business Process instances containing active tasks assigned to reportees to the current user. ■ PREVIOUS : Guided Business Process instances containing completed tasks assigned to the user, and instances in which a particular task is reassigned to another user. ■ ADMIN : Guided Business Process instances visible to the Guided Business Process administrator. Active instances can be assigned to any user. Note: The BPMAGAdmin role maps to a user with an Administrator role assigned. This role enables the user to query for all the Guided Business Process instances available in the server, including completed, active, and instances with errors. The configuration file located in DOMAIN_HOMEconfigfmwconfigsystem-jazn-data.xml contains the definition of this role. Note: The Guided Business Process APIs enables retrieving detailed task information by providing the task ID, but do not retrieve the task information. Other APIs, such as the Workflow service APIs, are required for this purpose. For more information about Workflow services, see Introduction to Human Workflow Services in Oracle Fusion Middleware Developers Guide for Oracle SOA Suite. 25-8 Modeling and Implementation Guide for Oracle Business Process Management Table 25–1 Guided Business Process Query Service API Method Description List queryAGDisplayInfosS tring bpmProcessType,IWorkf lowContext ctx,List agDisplayColumns,AGAs signmentFilter agAssignmentFilter,Pr edicate predicate,Ordering ordering, int startRow,int endRow Returns a list of AGDisplayInfo objects with fields defined in displayColumns , meeting the criteria defined by assignmentFilter and predicate, in the order specified by order , and with row numbers between startRow and endRow . The AGDisplayInfo objects contain both metadata and run-time data of the Guided Business Process instances involved, which you can use to render the Guided Business Process instance views in Oracle BPEL Worklist or custom applications. You can assign the String parameter bpmProcessType the following values: ■ IAGQueryService.AG_PROCESS_TYPE_BPM ■ IAGQueryService.AG_PROCESS_TYPE_BPEL ■ IAGQueryService.AG_PROCESS_TYPE_ANY As milestones and tasks are not visible from the Activity Guide instance views, it is recommended not to include the MILESTONE_STATE column in displayColumns to avoid unnecessary performance overhead. AGDisplayInfo getAGDisplayInfoDetai lsByIdString bpmProcessType,IWorkf lowContext ctx,long ciKey,List taskDisplayColumns,St ring agAssignmentFilter Returns the AGDisplayInfo object specified by the Activity Guide instance ID. The AGDisplayInfo object returned includes both milestone and task information, which you can use to render the Activity Guide tree structure in the custom application. You can assign the String parameter bpmProcessType the following values: ■ IAGQueryService.AG_PROCESS_TYPE_BPM ■ IAGQueryService.AG_PROCESS_TYPE_BPEL ■ IAGQueryService.AG_PROCESS_TYPE_ANY The String parameter agAssignmentFilter enables specifying a filter for this method. The following IAGQueryService parameters can be used as values this parameter: ■ IAGQueryService.AGASSIGNMENT_FILTER_MY ■ IAGQueryService.AGASSIGNMENT_FILTER_ REPORTEES ■ IAGQueryService.AGASSIGNMENT_FILTER_PREVIOUS ■ IAGQueryService.AGASSIGNMENT_FILTER_ADMIN