User Metadata Service

The user metadata service provides methods for managing metadata specific to individual users and groups. It is used for getting and setting user worklist preferences, managing user custom views, and managing human workflow rules for users and groups.

For most methods in the user metadata service, the authenticated user can query and update their own user metadata. However, they cannot update metadata belonging to other users.

In the case of group metadata (for example, human workflow rules for groups), only a user designated as an owner of a group (or a user with the workflow.admin privilege) can query and update the metadata for that group. However, a user with the workflow.admin privilege can query and update metadata for any user or group.

Table 34-7 describes some of the common operations of the user metadata service. Package oracle.bpel.services.workflow.user corresponds to the user metadata service.

For more information about user metadata service, see Workflow Services Java API Reference for Oracle SOA Suite.

Table 34-7 User Metadata Service Methods

Method	Description
`createRule`	Creates a new rule.
`decreaseRulePriority`	Decreases the priority of a rule by one. This method does nothing if this rule has the lowest priority.
`deleteRule`	Deletes a rule.
`getVacationInfo`	Retrieves the date range (if any) during which a user is unavailable for the assignment of tasks.
`getRuleDetail`	Gets the details for a particular human workflow rule.
`getRuleList`	Retrieves a list of rules for a particular user or group.
`updateRule`	Updates an existing rule.
`increaseRulePriority`	Increases the priority of a rule by one. Rules for a user or group are maintained in an ordered list of priority. Higher priority rules (those closer to the head of the list) are executed before rules with lower priority. This method does nothing if this rule has the highest priority.
`getUserTaskViewList`	Gets a list of the user task views that the user owns.
`getGrantedTaskViewList`	Gets a list of user task views that have been granted to the user by other users. Users can use granted views for querying lists of tasks, but they cannot update the view definition.
`getStandardTaskViewList`	Gets a list of standard task views that ship with the human workflow service, and are available to all users.
`getUserTaskViewDetails`	Gets the details for a single view.
`createUserTaskView`	Creates a new user task view.
`updateUserTaskView`	Updates an existing user task view.
`deleteUserTaskView`	Deletes a user task view.
`updateGrantedTaskView`	Updates details of a view grant made to this user by another user. Updates are limited to hiding or unhiding the view grant (hiding a view means that the view is not listed in the main inbox page of Oracle BPM Worklist), and changing the name and description that the granted user sees for the view.
`getUserPreferences`	Gets a list of user preferences for the user. User preferences are simple name-value pairs of strings. User preferences are private to each user (but can still be queried and updated by a user with the `workflow.admin` privilege).
`setUserPreferences`	Sets the user preference values for the user. Any preferences that were previously stored and are not in the new list of user preferences are deleted.
`getPublicPreferences`	Gets a list of public preferences for the user. Public preferences are similar to user preferences, except that any user can query them. However, only the user that owns the preferences, or a user with the w`orkflow.admin` privilege, can update them. Public preferences are useful for storing application-wide preferences (preferences can be stored under a dummy user name, such as `MyAppPrefs`).
`setPublicPreferences`	Sets the public preferences for the user.
`setVacationInfo`	Sets a date range over which the user is unavailable for the assignment of tasks. (Dynamic assignment functions do not assign tasks to a user that is on vacation.)
`getStandardTaskViewDetails`	Gets the full details for a particular standard view, identified by its `viewId`.

For more information, see the following:

Using Oracle BPM Worklist for details about the rule configuration and user preference pages
Workflow Services Java API Reference for Oracle SOA Suite