authenticate

Authenticates a user with the identity authentication service and passes back a valid IWorkflowContext object.

authenticateOnBehalfOf

Optionally makes authentication on behalf of another user.

countTasks

Counts the number of tasks that match the specified query criteria.

countViewTasks

Counts the number of tasks that match the query criteria of the specified view.

createContext

Creates a valid IWorkflowContext object from a preauthenticated HTTP request.

doesTaskExist

Checks to see if any existing tasks match the specified query criteria.

Includes SYS as an assignment filter value to search across all pillar data (that is, search across packages).

doesViewTaskExist

Checks to see if any tasks exist match the query criteria of the specified view.

Includes SYS as an assignment filter value to search across all pillar data (that is, search across packages).

destroyWorkflowContext

Cleans up a human workflow context that is no longer needed. This method is typically used when a user logs out.

getPersistedTaskSequence

Gets the cached task sequence object if it exists and fetchTaskSequenceForRootTask is true. Otherwise, prepares a new task sequence object with TaskSequenceType as ALL and caches it. The task sequence object is processed to apply the filers to remove or retain required task sequence records. The sequence number is regenerated as a few of the task sequence records may be removed. Aggregation logic is run at the end to ensure all the repeating participants are collapsed in task sequence.

TaskSequence 
oracle.bpel.services.workflow.query.ITaskQueryService.getPersistedTaskSequence 

( 
IWorkflowContext ctx, 
String taskId,List<String> taskDisplayColumns, List<TaskSequenceType> 
taskSequenceType, 
List<TaskSequenceBuilderContext> taskSequenceBuilderContext, boolean 
fetchTaskSequenceForRootTask, 
Set<TaskSequenceFilterOptionalInfoType> optionalInfo 
) 
throws WorkflowException;

getTask

Gets a single task populated with details specified by the caller.

Interface:

public Task getTask(IWorkflowContext ctx, TaskIdentifier taskIdentifier, List<String> columnList, List<OptionalInfo> optionalInformation) throws WorkflowException;

• IWorkflowContext ctx: The authenticated user context.
• TaskIdentifier taskIdentifier

  TaskIdentifier {
      Type (enum): Id, Number, IdentificationKey
      Value (String): <value>
  }

  Any of the following unique identifiers of the task can be used:

  • Task Id
  • Task Number
  • Identification Key
• List<String> columnList: The list of task-columns to populate in the returned task object.

  Note: There are some defaults columns such as TaskId and TaskNumber that will always be populated.

• List<OptionalInfo> optionalInformation: List of additional/optional data/information to be populated in the returned task object such as comments, attachments, and actions.

  Note: None of the additional data will be populated by default.

• IdentificationKey: It is the responsibility of the system that uses the Human Workflow Task to ensure that the IdentificationKey is unique for a given task. If a task is undergoing parallel (subtasks) then all the subtasks will have the same IdentificationKey as the original/initiated task.

  If more than one task has the same IdentificationKey then the task with the highest task number will be fetched.

  There is an existing index on the task IdentificationKey column to support querying a single task based on its IdentificationKey.

Benefits:

• Fetch a single task using a single API by any of its unique identifiers: TaskID, TaskNumber, and IdentificationKey.
• The complete task need not be obtained when a single task is needed:
  • List<String> columnList parameter can be used to specify what task information needs to be fetched and populated in the task.
  • List<OptionalInfo> optionalInformation parameter can be used to specify what additional information needs to be fetched and populated in the task.
• Use when only actions that can be performed by a user on a task is required.
• Use when only a list of attachments on a task is required.
• Use when only a list of comments on a task is required.

Recommendations and Usage Notes:

• Replace the usage of the following APIs with getTask:
  • getTaskDetailsById
  • getTaskDetailsByNumber
  • queryTasks:
    For fetching a single task

    • Using IdentificationKey
    • Since the following are only available in queryTasks:
      • List<String> columnList
      • List<OptionalInfo> optionalInformation
• If only the list of actions that can be performed by a user on a task is required: call getTask with null/empty columnList and only ALL_ACTIONS in optionalInformation.
• If only the list of attachments on a task is required: call getTask with null/empty columnList and only ATTACHMENTS in optionalInformation.
• If only list of comments on a task is required: call getTask with null/empty columnList and only COMMENTS in optionalInformation.

getTaskActionsWithOptionalAttrs

Computes and returns all allowed actions based on the current task state and roles assigned to the requesting user.

Interface:

public List<Task> getTaskActionsWithOptionalAttrs(IWorkflowContext ctx, List<TaskIdentifier> taskIdentifiers, Map<TaskIdentifier, TaskActionsType> actions, Map<TaskIdentifier, List<OptionalAttribute>> optAttrs) throws WorkflowException;

• ctx and taskIdentifiers are mandatory parameters.
• taskIdentifiers can be one or many.
• TaskIdentifier currently supports taskId, taskNumber, and IdentificationKey. The input list can contain any combination of the TaskIdentifier type.
• actions is an optional parameter. If nothing requested for a specific taskIdentifier, by default ALL_ACTIONS will be computed for the corresponding taskIdentifier.
• TaskActionsType is an Enum containing following supported values:
  • ALL_ACTIONS
  • GROUP_ACTIONS
  • CUSTOM_ACTIONS
• The returned task object will contain the current set of allowed actions for that task based on the actions input, task's current state, and roles assigned to the requested user.
• The returned task object will contain task id, number, and identificationKey if any as basic output parameters, besides allowed actions and any optional info requested using the optAttrs parameter. The returned actions can be accessed as follows:
  • returnTask.getSystemAttributes().getRestrictedActions()
  • returnTask.getSystemAttributes().getSystemActions()
  • returnTask.getSystemAttributes().getCustomActions()
• The user can request more optional information using the optAttrs parameter. Currently the only optional attribute supported for this API is WORKLIST_URL. The returned value for this attribute can be accessed using returnTask.getSystemAttributes().getDisplayInfo().
• The returned task list count may not always match the requested TaskIdentifier list count. Any task that's not found in the system using the input TaskIdentifier will be ignored.
• May not satisfy <1s benchmark especially if the API is called for multiple tasks.
• Validations: All the input parameters are validated. Any invalid input will result in the API throwing WorkflowException citing the root cause properly.

getTaskDetailsById

Gets the details of a specific task from the task's taskId property.

getTaskDetailsByNumber

Gets the details of a specific task from the task's task number property.

getTaskHistory

Gets a list of the task versions for the specified task ID.

getTasks

Interface:

List<Task> getTasks(IWorkflowContext wfCtx, Set<String> displayColumns, QueryContext qryCtx) throws WorkflowException

The applicable parameters in QueryContext for this API are:

• QueryAssignmentFilter queryAssignmentFilter (mandatory)

  Currently the following are supported:

  • MY
  • GROUP
  • MY_GROUP
  • MY_GROUP_ALL
  • OWNER
  • CREATOR

  Others will be added based on the need.

• QueryContextTaskIdentifier taskIdentifier (mandatory)

  • QueryContextTaskIdentifierEnum type
  • List<String> values
  • Enum QueryContextTaskIdentifierEnum
    • String TASK_DEFN_NAME
    • String TASK_DEFN_ID
    • String TASK_NAME_SPACE

• QueryContextTaskSelector taskSelector

  • QueryContextTaskSelectorEnum type
  • Enum QueryContextTaskSelectorEnum
    • String ROOT_TASK_ONLY
    • String AGGREGATED_TASKS
    • String ROOT_TASK_AND_SUB_TASKS_ONLY
• List<String> identificationKeys = new ArrayList<String>();
• List<String> applicationStripes = new ArrayList<String>();
• List<String> applicationRoles = new ArrayList<String>();

• QueryContextTaskStates taskStates;

  • List<TaskStatesEnum> states;
  • Enum TaskStatesEnum
    • "ALERTED"
    • "ASSIGNED"
    • "COMPLETED"
    • "DELETED"
    • "ERRORED"
    • "EXPIRED"
    • "INFO_REQUESTED"
    • "OUTCOME_UPDATED"
    • "STALE"
    • "SUSPENDED"
    • "WITHDRAWN"
• boolean includeFYITasks (default is false)
• int startRow;
• int endRow;
• boolean localizeTasks (default is false)

• taskOutcome (single value) a choice of one of the following:

  • custom value
  • Enum of
    • APPROVE
    • REJECT
    • DEFER
    • YES
    • OK
    • ACCEPT
    • NO

Usage notes:

• Both wfCtx and qryCtx are mandatory parameters in the interface. displayColumns is an optional parameter if the user wants to fetch additional display columns.
• Within qryCtx:
  • queryAssignmentFilter and taskIdentifier are mandatory parameters and rest are all optional parameters.
  • Default startRow is 0 and default endRow is 50.
  • User cannot request a pagination size more than 50 rows.
  • ROOT_TASK_ONLY will return only root tasks.
  • AGGREGATED_TASKS will return aggregated tasks and tasks that cannot be aggregated or don't have to be aggregated.
  • ROOT_TASK_AND_SUB_TASKS_ONLY will return only the root tasks and the subtasks (collection target instances) for each root task.
• This API by default will exclude FYI tasks; that is, includeFYITasks = false. The user can request explicitly to return FYI tasks by setting this Boolean to true:
  • When includeFYITasks=true along with taskSelector=ROOT_TASK_ONLY, all root level FYI tasks will also be returned.
  • When includeFYITasks=true along with taskSelector=AGGREGATED_TASKS, all aggregated FYI tasks and FYI tasks that cannot be aggregated will also be returned.
• Currently there is no option to specify ordering as a parameter. Ordering is done by default using task-number in descending order and nulls at the end.
• When no state is used for search filter the query fetches tasks in all states hence this has a performance impact for retrieval of data.
• When task state is searched for ASSIGNED or REQUEST_INFO or both, this API only returns 'actionable' tasks by adding a sub condition to the query: ASSIGNEES != null.
• This API will not do localization/translation of tasks by default for performance reasons. Caller needs to use localizeTasks attribute to explicitly request for translation of task fields like title.
• Action computation:
  • This API will not do 'entire' action computation, hence won't return any action related attributes.
  • This API will do a 'limited' action computation to check if the user has read access to the task, else populate an empty task.
  • Use getTaskActionsWithOptionalAttrs API for complete action computation.
• Default column set:
  • WFTASK_TASKID_COLUMN
  • WFTASK_ASSIGNEES_COLUMN
  • WFTASK_ASSIGNEESDISPLAYNAME_COLUMN
  • WFTASK_ASSIGNEDDATE_COLUMN
  • WFTASK_STATE_COLUMN
  • WFTASK_SUBSTATE_COLUMN
  • WFTASK_TITLE_COLUMN
  • WFTASK_DUEDATE_COLUMN
  • WFTASK_TASKDISPLAYURL_COLUMN returns instance level URL (whatever is stored in wftask table). No API level processing due to performance reasons.
  • WFTASK_UPDATEDBY_COLUMN
  • <collection target>
  • taskDefinitionId
  • isRoot
  • isAggregated
  • isFyi
• Additional display column set: Only the following columns will be allowed in the additional set:
  • Identificationkey
  • Stage
  • VersionReason
  • TaskDefinitionName
  • RootTaskID
  • ParentTaskId
  • taskNumber (added due to worklist use case)
• Translatable fields in the returned field set: Only the following columns will be allowed in the additional set:
  • Title (translated value from wftask_tl table)
  • State (translated value from wftask_tl table)
  • Assignees (display name translation during query processing)
  • UpdatedBy (display name translation during query processing)
• Will satisfy <1s benchmark.

Conditions for Task Selectors with includeFYITasks:

• includeFYITasks = true
  • ROOT_TASK_ONLY
    • Base Conditions AND (roottaskid = taskid)
  • AGGREGATED_TASKS
    • Base conditions AND (workflowpattern = 'AGGREGATION' OR (aggregationtaskid IS NULL AND subtaskgroupinstanceid IS NOT NULL) OR (roottaskid = taskid AND aggregationtaskid IS NULL AND subtaskgroupinstanceid IS NULL))
  • ROOT_TASK_AND_SUB_TASKS_ONLY
    • Base Conditions AND (roottaskid = taskid OR subtaskgroupinstanceid IS NOT NULL)
• includeFYITasks = false
  • ROOT_TASK_ONLY
    • Base Conditions AND (IWT.taskid = IWT.roottaskid AND EXISTS (select 1 from wftask wfn where (wfn.workflowpattern IS NULL OR wfn.workflowpattern <> 'FYI') AND WT.rootTaskId = wfn.rootTaskId)
  • AGGREGATED_TASKS
    • Base Conditions AND ((workflowpattern = 'AGGREGATION' AND EXISTS (select 1 from wftask w2 where (w2.workflowpattern IS NULL OR w2.workflowpattern <> 'FYI') AND w2.aggregationtaskid = IWT.taskid)) OR (aggregationtaskid IS NULL AND subtaskgroupinstanceid IS NOT NULL AND workflowpattern <> 'FYI') OR (roottaskid = taskid AND aggregationtaskid IS NULL AND subtaskgroupinstanceid IS NULL AND workflowpattern <> 'FYI'))
  • ROOT_TASK_AND_SUB_TASKS_ONLY
    • Base Conditions AND ((IWT.taskid = IWT.roottaskid OR subtaskgroupinstanceid IS NOT NULL) AND EXISTS (select 1 from wftask wfn (where wfn.workflowpattern IS NULL OR wfn.workflowpattern <> 'FYI') AND IWT.rootTaskId = wfn.rootTaskId))

getTaskSequence

Gets the task sequence tree of a task whose ID is a task ID, for those type of sequences.

getTaskVersionDetails

Gets the specific task version details for the specified task ID and version number.

getWorkflowContext

Gets a human workflow context with the specified context token.

getWorkflowContextForAuthenticatedUser

Gets the IWorkflowContext object for a user authenticated by a JAAS application. Use this either with Enterprise JavaBeans or SAML token identity propagation.

isFYITask

Based on the taskId or rootTaskId input parameter, returns true if associated task is an FYI task, or false if not.

Interface:

boolean isFYITask(IWorkflowContext wfCtx, String taskId) throws WorkflowException

• Both wfCtx and taskId are mandatory parameters.
• Will satisfy <1s benchmark.

Behavior:

When the following conditions are satisfied, the API returns true, else it returns false.

• root task as FYI itself: use rootTaskId as input.

• root having exactly 1 child as FYI or all children as FYI (both for aggregation and non-aggregation): use rootTaskId as input.

• subtask as FYI itself: use taskId as input.

queryAggregatedTasks

Executes the specified query, and aggregates a count of the tasks returned by the query, grouped by the specified column.

queryTaskErrors

Returns a list of task error objects matching the specified predicate.

queryTasks

Returns a list of tasks that match the specified filter conditions. Tasks are listed according to the ordering condition specified (if any). The entire list of tasks matching the criteria can be returned or clients can execute paging queries in which only a specified number of tasks in the list are retrieved. The filter conditions are as follows:

• assignmentFilter: Filters tasks according to whom the task is assigned, or who created the task. Possible values for the assignment filter are:

  • ADMIN: No filtering; returns all tasks regardless of assignment or creator.
  • ALL: No filtering; returns all tasks regardless of assignment or creator.
  • CREATOR: Returns tasks in which the context user is the creator.
  • GROUP: Returns tasks that are assigned to a group, application role, or list of users of which the context user is a member.
  • MY: Returns tasks that are assigned exclusively to the context user.
  • MY_AND_GROUP: Returns tasks that are assigned exclusively to the context user, or to a group, application role, or list of users of which the context user is a member, excluding any tasks that have been claimed by other users.
  • MY_AND_GROUP_ALL: Returns tasks that are assigned exclusively to the context user, or to a group, application role, or list of users of which the context user is a member, including any tasks that have been claimed by other users.
  • OWNER: Returns tasks in which the context user is the task owner.
  • PREVIOUS: Returns tasks the context user previously updated.
  • REPORTEES: Returns tasks that are assigned to reportees of the context user.

  • REVIEWER: Returns tasks for which the context user is a reviewer.

• keywords: An optional search string. This only returns tasks in which the string is contained in the task title, task identification key, or one of the task text mapped attributes (formerly referred to as flex fields).

• predicate: An optional oracle.bpel.services.workflow.repos.Predicate object that allows clients to specify complex, SQL-like query predicates.

queryViewAggregatedTasks

Executes the query as defined in the specified view, and aggregates the selected tasks according to the chart property defined in the view.

queryViewTasks

Returns a list of tasks according to the criteria in the specified view. The entire list or paged list of tasks can be returned. Clients can specify additional filter and ordering criteria to those in the view.