Workset Management
Workset Service
| Name | Workset Service | |
|---|---|---|
| Version | Dev (0.1) | Release Notes |
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
Workset Management
| Method | createWorkset | ||
|---|---|---|---|
| Description | Define a new, empty, workset | ||
| Parameters | String | Workset_key | The short string identifying the workset |
| String | Workset_Title | The name of the workset | |
| longText | Workset_Desc | Long description of this workset | |
| Return | confirmResultType | Returns the confirmation status along with the object reference | |
| Errors | EXISTS | Workset with this workset key already exists | |
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | dropWorkset | ||
|---|---|---|---|
| Description | Drop an existing workset | ||
| Parameters | String | Workset_key | The short string identifying the workset |
| CONSTRAINT_TYPE | Constraint type | Identifies whether or not to remove this workset from any parent workset rules | |
| Return | confirmResultType | Returns the confirmation status along with the object reference | |
| Errors | NO_MATCH | No workset with this key exists in the system | |
| HAS_CHILDREN | Workset has associated child objects that must be removed first | ||
| NO_AUTH | User can not perform this action | ||
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | archiveWorkset | ||
|---|---|---|---|
| Description | Archive an existing workset | ||
| Parameters | String | Workset_key | The short string identifying the workset |
| CONSTRAINT_TYPE | Constraint type | Identifies whether or not to archive all children worksets as well | |
| Return | confirmResultType | Returns the confirmation status along with the object reference | |
| Errors | NO_MATCH | No workset with this key exists in the system | |
| NO_AUTH | User can not perform this action | ||
| PARENT_REQUIRES | This workset is required by another workset that has not been archived | ||
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | listWorksets | ||
|---|---|---|---|
| Description | Show details for all worksets accessible by this person | ||
| Parameters | |||
| Return | worksetSummaryResultType | Returns all worksets accessible by the current user | |
| Errors | |||
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | showWorkset | ||
|---|---|---|---|
| Description | Returns structure containing all cost objects, people, and scenarios owned by this workset | ||
| Parameters | String | Workset_key | The unique identifier for this workset |
| Return | worksetDetailResultType | Returns the objects contained by this workset | |
| Errors | NO_MATCH | No workset with this key exists in the system | |
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | addWorksetObjects | ||
|---|---|---|---|
| Description | Adds cost objects or people to the workset | ||
| Parameters | String | Workset_key | The unique identifier for this workset |
| REF_TYPE | REF_TYPE | The object type to add | |
| Array | REF_KEY | The unique identifiers of object_type to add | |
| Return | confirmResultType | Returns the completion status of the identified task along with the associated references | |
| Errors | MISSING | Certain objects identified do not exist in the system | |
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | delWorksetObjects | ||
|---|---|---|---|
| Description | Removes cost objects or people from the workset | ||
| Parameters | String | Workset_key | The unique identifier for this workset |
| REF_TYPE | REF_TYPE | The object type to drop | |
| Array | REF_KEY | The unique identifiers of the object_type to drop | |
| Return | confirmResultType | Returns the completion status of the identified task along with the associated references | |
| Errors | MISSING | Certain objects identified do not exist in the system | |
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | listWorksetObjects | ||
|---|---|---|---|
| Description | Show the objects in the workset | ||
| Parameters | String | Workset_key | The unique identifier for this workset |
| REF_TYPE | REF_TYPE | (optional) The object type to restrict by | |
| Return | confirmResultType | Returns a structure containing the list of objects, by type, in the workset | |
| Errors | NO_MATCH | No such workset in system | |
| EMPTY | Contains no child objects | ||
| NO_AUTH | User does not have access to workset objects | ||
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | addWorksetRule | ||
|---|---|---|---|
| Description | Removes cost objects or people from the workset | ||
| Parameters | String | Workset_key | The unique identifier for this workset |
| longText | criteria | Basically, a where clause sql snippet | |
| Return | confirmResultType | Returns the completion status of the identified task along with the associated references | |
| Errors | MISSING | Rule has no matches in the system currently | |
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | dropWorksetRule | ||
|---|---|---|---|
| Description | Removes cost objects or people from the workset | ||
| Parameters | String | Workset_key | The unique identifier for this workset |
| Return | confirmResultType | Returns the completion status of the identified task along with the associated references | |
| Errors | NO_MATCH | Rule does not exist in system | |
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | showWorksetRules | ||
|---|---|---|---|
| Description | Shows the definition rules in place for the specified workset | ||
| Parameters | String | Workset_key | The unique identifier for this workset |
| Return | worksetRulesResultType | Returns the list of defined rules in the system. | |
| Errors | NO_MATCH | Workset does not exist in system | |
| NO_AUTH | User does not have access to objects in this workset | ||
| INCORRECT_TYPE | This workset type does not have rules | ||
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | updateWorksetfromRules | ||
|---|---|---|---|
| Description | Processes all of the associated workset rules, logging the changes to the change_log | ||
| Parameters | String | Workset_key | The unique identifier for this workset |
| Return | confirmResultType | Returns the completion status of the identified task along with the associated references | |
| Errors | NO_MATCH | Rule does not exist in system | |
| NO_CHANGE | No objects added or removed from the workset | ||
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | convertWorksettoStatic | ||
|---|---|---|---|
| Description | Converts a workset from dynamic (rules-based) to static | ||
| Parameters | String | Workset_key | The unique identifier for this workset |
| Return | confirmResultType | Returns the completion status of the identified task along with the associated references | |
| Errors | NO_MATCH | Rule does not exist in system | |
| NO_AUTH | User cannot perform this action | ||
| INCORRECT_TYPE | Workset is already static | ||
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | showWorksetChanges | ||
|---|---|---|---|
| Description | 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. | ||
| Parameters | String | Workset_key | The unique identifier for this workset |
| Return | changeResultType | Returns the list of object changes to this workset | |
| Errors | NO_MATCH | Workset does not exist in system | |
| NO_CHANGE | No objects added or removed from the workset | ||
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | showWorksetAccessChanges | ||
|---|---|---|---|
| Description | 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. | ||
| Parameters | String | Workset_key | The unique identifier for this workset |
| Return | changeResultType | Returns the list of access changes to this workset | |
| Errors | NO_MATCH | Workset does not exist in system | |
| NO_CHANGE | No objects added or removed from the workset | ||
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | showWorksetBalanceExceptions | ||
|---|---|---|---|
| Description | Show the list of cost objects whose balance < 0 currently or are expected to be < 0 on the project end date. | ||
| Parameters | String | Workset_key | The unique identifier for this workset |
| Return | changeResultType | Returns the list of balance exceptions on this workset | |
| Errors | NO_MATCH | Workset does not exist in system | |
| NO_CHANGE | No issues identified | ||
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | showWorksetCOSummary | ||
|---|---|---|---|
| Description | Show summary information about the COs in the workset | ||
| Parameters | String | Workset_Key | The unique identifier for this workset |
| Return | worksetCOSummaryResultType | Returns a summary of cost objects in the workset | |
| Errors | NO_MATCH | Workset does not exist in system | |
| NO_AUTH | User cannot access workset information | ||
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | showWorksetApptSummary | ||
|---|---|---|---|
| Description | Shows a summary of People/Appt information in the workset | ||
| Parameters | String | Workset_key | The unique identifier for this workset |
| Return | worksetApptSummaryResultType | Returns a summary of people/appts in the workset | |
| Errors | NO_MATCH | Workset does not exist in system | |
| NO_AUTH | User cannot access objects in this workset | ||
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||
| Method | showWorksetScenarioSummary | ||
|---|---|---|---|
| Description | Show the list of defined of defined Scenarios in the workset | ||
| Parameters | String | Workset_key | The unique identifier for this workset |
| Return | worksetScenarioResultType | Returns the list of scenarios in the workset | |
| Errors | NO_MATCH | Workset does not exist in system | |
| NO_AUTH | User cannot access objects in the workset | ||
| Capabilities | |||
| Use Cases | |||
| Comments/Feedback | |||