Workset Management
Workset Service
Description
The Workset Service allows the definition and manipulation of user defined groups of cost objects and people (worksets). Worksets can be defined statically (picking a list of specific cost objects and/or people) or dynamicaly (storing a collection of attributes. For dynamically defined worksets the attributes are stacked in a manner similar to an AND clause, returning only those records that match all the specified criteria.
References
see RAFT Requirements Documentation (RAFT-*)
Operations
Workset Management
| Define a new, empty, workset |
|
| The short string identifying the workset |
|
| Long description of this workset |
|
| Returns the confirmation status along with the object reference |
|
| Workset with this workset key already exists |
|
|
Back to Operations
| The short string identifying the workset |
|
| Identifies whether or not to remove this workset from any parent workset rules |
|
| Returns the confirmation status along with the object reference |
|
| No workset with this key exists in the system |
|
| Workset has associated child objects that must be removed first |
|
| User can not perform this action |
|
|
Back to Operations
| Archive an existing workset |
|
| The short string identifying the workset |
|
| Identifies whether or not to archive all children worksets as well |
|
| Returns the confirmation status along with the object reference |
|
| No workset with this key exists in the system |
|
| User can not perform this action |
|
| This workset is required by another workset that has not been archived |
|
|
Back to Operations
| Show details for all worksets accessible by this person |
|
| Returns all worksets accessible by the current user |
|
|
Back to Operations
| Returns structure containing all cost objects, people, and scenarios owned by this workset |
|
| The unique identifier for this workset |
|
| Returns the objects contained by this workset |
|
| No workset with this key exists in the system |
|
|
Back to Operations
| Adds cost objects or people to the workset |
|
| The unique identifier for this workset |
|
| The unique identifiers of object_type to add |
|
| Returns the completion status of the identified task along with the associated references |
|
| Certain objects identified do not exist in the system |
|
|
Back to Operations
| Removes cost objects or people from the workset |
|
| The unique identifier for this workset |
|
| The unique identifiers of the object_type to drop |
|
| Returns the completion status of the identified task along with the associated references |
|
| Certain objects identified do not exist in the system |
|
|
Back to Operations
| Show the objects in the workset |
|
| The unique identifier for this workset |
|
| (optional) The object type to restrict by |
|
| Returns a structure containing the list of objects, by type, in the workset |
| No such workset in system |
| Contains no child objects |
| User does not have access to workset objects |
|
Back to Operations
| Removes cost objects or people from the workset |
|
| The unique identifier for this workset |
|
| Basically, a where clause sql snippet |
|
| Returns the completion status of the identified task along with the associated references |
|
| Rule has no matches in the system currently |
|
|
Back to Operations
| Removes cost objects or people from the workset |
|
| The unique identifier for this workset |
|
| Returns the completion status of the identified task along with the associated references |
|
| Rule does not exist in system |
|
|
Back to Operations
| Shows the definition rules in place for the specified workset |
|
| The unique identifier for this workset |
|
| Returns the list of defined rules in the system. |
|
| Workset does not exist in system |
|
| User does not have access to objects in this workset |
|
| This workset type does not have rules |
|
|
Back to Operations
| Processes all of the associated workset rules, logging the changes to the change_log |
|
| The unique identifier for this workset |
|
| Returns the completion status of the identified task along with the associated references |
|
| Rule does not exist in system |
|
| No objects added or removed from the workset |
|
|
Back to Operations
| Converts a workset from dynamic (rules-based) to static |
|
| The unique identifier for this workset |
|
| Returns the completion status of the identified task along with the associated references |
|
| Rule does not exist in system |
|
| User cannot perform this action |
|
| Workset is already static |
|
|
Back to Operations
| Pull the last set of changes on this workset from the change_log. The change_log will return any changes from the user's last access date. |
|
| The unique identifier for this workset |
|
| Returns the list of object changes to this workset |
|
| Workset does not exist in system |
|
| No objects added or removed from the workset |
|
|
Back to Operations
| Pull the last set of authorization changes on this workset from the change_log. The change_log will return any changes from the user's last access date. |
|
| The unique identifier for this workset |
|
| Returns the list of access changes to this workset |
|
| Workset does not exist in system |
|
| No objects added or removed from the workset |
|
|
Back to Operations
| showWorksetBalanceExceptions |
|
| Show the list of cost objects whose balance < 0 currently or are expected to be < 0 on the project end date. |
|
| The unique identifier for this workset |
|
| Returns the list of balance exceptions on this workset |
|
| Workset does not exist in system |
|
|
Back to Operations
| Show summary information about the COs in the workset |
|
| The unique identifier for this workset |
|
| Returns a summary of cost objects in the workset |
|
| Workset does not exist in system |
|
| User cannot access workset information |
|
|
Back to Operations
| Shows a summary of People/Appt information in the workset |
|
| The unique identifier for this workset |
|
| Returns a summary of people/appts in the workset |
|
| Workset does not exist in system |
|
| User cannot access objects in this workset |
|
|
Back to Operations
| showWorksetScenarioSummary |
|
| Show the list of defined of defined Scenarios in the workset |
|
| The unique identifier for this workset |
|
| Returns the list of scenarios in the workset |
|
| Workset does not exist in system |
|
| User cannot access objects in the workset |
|
|
Back to Operations