Workflow Reserved Actions
Description of reserved states and actions that can be defined in a workflow definition.
Table of Contents
- Introduction
- Generic Reserved Actions
- Service-Specific Reserved Actions
- Contract-Specific Reserved Actions
Introduction
The Policy Manager Workflow Library includes a Reserved Actions that are arbitrary states and actions that can be defined in a Workflow Definition. The following reserved actions have special meaning to be interpreted by Policy Manager's Workflow Engine. All Reserved Actions have @ as prefix. A reference to a Workbench Object means the service or contract under the control of a Workflow Instance.
Note: Policy Workflow does not include policy-specific actions.
Generic Reserved Actions
Action Name | Description |
---|---|
@read |
This reserved action is used to specify additional set of users who can read the workbench objects.
The following rules are used to decide if a specific user can read a Workflow object at any moment:
In summary, the reserved @read action provides a mechanism for Administrators to grant a set of users the ability to track/monitor the progress of the Workflow object without allowing those users the ability to influence the Workflow process. |
@modify |
This reserved action is used to specify who can modify the Workflow document. Similar to @read, @modify will never be directly invoked by the Workflow Engine—only the restriction rules defined in it will be evaluated. The following rules are used to decide if a specific user can modify a Workflow object:
Customers can use the @modify action to restrict the rights of modifying the Workbench objects to only a subset of Workflow participants. For example:
|
@reset |
This reserved initial action is invoked when a new version of a Workflow definition is uploaded and user has selected to reset all the active Workflow instances associated with that Workflow definition. Users can use this action to reset the object to the proper initialized state. Note that only users with System Administrator role can modify a Workflow definition, thus the caller of the @reset action may not be normal business users. In general, a Workflow definition should not put restriction on the caller of the @reset action and should not set the caller of the @reset action as the owner of the Workflow. |
Service-Specific Reserved Actions
Action Name | Description |
---|---|
@create |
This reserved initial action is invoked when a new service is created. Multiple @create actions can be defined. |
@discover |
This reserved initial action is invoked when a new service is discovered. Since service is always discovered automatically by Policy Manager, the user who invokes the @discover action is always Policy Manager instead of normal business users. In general, a Workflow definition should not put a restriction on the caller of the @discover action and should not set the caller of @discover action as the owner of the Workflow. |
@updateInterface | The @updateInterface action identifies the ability to change the schemas, portTypes, or bindings of a service. |
@updateBinding | The @updateBinding action identifies the ability to change the bindings of a service. |
Contract-Specific Reserved Actions
Action Name | Description |
---|---|
@CreateOffer | This reserved initial action is invoked when a new offer is created. Multiple @CreateOffer actions can be defined. |
@CreateRequest | This reserved initial action is invoked when a new request is created. Multiple @CreateRequest actions can be defined. |