WIP
RAFT Service
Name
RAFT Service
Version
Dev ([0.1])
[Release Notes]
Description
The RAFT Service is focused on providing a consistent interface for:
- Searching for Cost Objects and Cost Object Collections
- Viewing Budget, Actual, Commitments, and Forecast information for Cost Object Collections
- Creating What If scenarios as collections of speculations
- Viewing the projected impacts of those speculations
- Generating and viewing reports on this information
References
see RAFT Requirements Documentation (RAFT-*)
Operations
Domain Operations
getModelTypes
searchbyParm(&parm)
searchCollectionbyParm(&collection,&parm)
Listinfo about user sets
getSearchLists
listSupervisor(#count)
listAddressee(#count)
listSponsor(#count)
listPrimeSponsor(#count)
listId(#count)
listWorksets(#count)
listFlaggedCostObjects(#count)
addComment
deleteComment
updateComment
getComment
getCommentsforObject
addWorksetAuthorizations
dropWorksetAuthorizations
viewAuthorizationsforUser
viewAuthorizationsforObject
List info about cost objects
listBudgets(CO,withchildren)
listWorksetScenarios(Workset,withchildren)
listCOScenarios(CO, withchildren)
listProjectPeriods
updateProjectPeriods
addProjectPeriod
dropProjectPeriod
validateProjectPeriods
listReport
executeReport
listDomain
buildDomainReport
executeDomainReport
Summary
BvAQueryDay
RvEQueryDay
BvAQueryMonth
RvEQueryMonth
Query
queryActualsSumm
queryActualsPODetail
queryActualsPEDetail
queryBudgetDay
queryCommitmentsSumm
queryCommitmentsPODetail
queryCommitmentsPEDetail
queryForecastSumm
queryForecastPODetail
queryForecastPEDetail
workset Management
createWorkset
deleteWorkset
archiveWorkset
listWorksets
showWorkset
addWorksetObj
delWorksetObj
addWorksetRule
deleteWorksetRule
updateWorksetfromRules
showWorksetChanges
showAccessChanges
showBalanceExceptions
showworksetCOSummary
showworksetApptSummary
scenario Management
showCOAttributes
showApptAttributes
showScenarioOverview
showScenaroFinImpact
showScenarioPersonImpact
showScenarioDetail
showCOExpenseDetail
showCOPersonDetail
showCODetail
showApptDetail
createScenario
deleteScenario
addCOtoScenario
addAppttoScenario
dropCOfromScenario
dropApptfromScenario
copyScenario
archiveScenario
addAssumption
dropAssumption
updateAssumption
addExpenseAllocSpec
addApptAllocSpec
updateExpenseAllocSpec
updateApptAllocSpec
dropExpenseAllocSpec
dropApptAllocSpec
addTBACOSpec
addTBHApptSpec
dropTBACOSpec
dropTBHApptSpec
updateCOSpec
updateApptSpec
addAdjSpec
dropAdjSpec
addCORateSpec
dropCORateSpec
updateFTESpec
updateVacationSpec
createExpenseAllocSpecfromCOEUS
createExpenseAllocSpecfromSAP
createPersonAllocSpecfromCOEUS
recalcApptDetail
recalcExpenseDetail
buildScenarioSummary
buildWorksetSummary
updateUserPrefGL
updateUserPrefBudget
checkSystemStatus
setScenarioVisibility
setWorksetVisibility
checkProjectedBalance
checkGLBudget
checkMonthlyBurn
checkPersonAlloc
checkRemainingGLBalance
checkRemainingBalance
addProjectTerm
dropProjectTerm
checkProjectTerms
showGlsInCategory
showGLHierarchy
showRatesonObj
showVarianceonScenario
showlineItemsonGL
Search">Search
Method
searchByParm
Description
Searches the cost collector set and returns matches based on the passed in parameters
Parameters
Array
Parm
An associative array of key value pairs for search parameters
Return
[coResultType]
Returns cost object details for all of the matching cost objects.
Errors
NO_MATCH
No cost objects found
MAX_COUNT
Number of objects returned >250
Capabilities
Use Cases
See RAFT-Search
Comments/Feedback
Method
searchCollectionByParm
Description
Performs a collection search based off the identified parameters. Collection searches cannot be used to define sets
Parameters
String
Collection
Which collection will be searched, one of supervisor, sponsor, fund_center, profit_center, workset
Array
Parm
An associative array of key value pairs for search parameters
Return
[collectionResultType]
Returns cost object details for all of the matching cost objects wrapped in a metadata header for the collection.
Errors
NO_MATCH
No cost objects found
MAX_COUNT
Count of returned objects (including the collection header) exceeds 250 and cannot be displayed.
Capabilities
Use Cases
Comments/Feedback
Method
getSearchLists
Description
Returns the default collection of selection items for each of the search lists.
Parameters
Array
Parm
An associative array of key value pairs for search parameters
Return
[listSetResultType]
Master structure for list data that includes supervisor, addressee, sponsor, prime_sponsor, workset. The set always returns a max of 150 entries. To extend beyond that requires the user to use the autocomplete methods.
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listSupervisor
Description
Returns the list of supervisors accessible by the requesting user.
Parameters
Integer
Count
The number of entries to return.
Return
[listResultType]
Array list of key, value pairs
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listAddressee
Description
Returns the list of adressees accessible by the requesting user.
Parameters
Integer
Count
The number of entries to return.
Return
[listResultType]
Array list of key, value pairs
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listSponsor
Description
Returns the list of sponsors accessible by the requesting user.
Parameters
Integer
Count
The number of entries to return.
Return
[listResultType]
Array list of key, value pairs
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listPrimeSponsor
Description
Returns the list of prime sponsors accessible by the requesting user.
Parameters
Integer
Count
The number of entries to return.
Return
[listResultType]
Array list of key, value pairs
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listWorkset
Description
Returns the list of worksets accessible by the requesting user.
Parameters
Integer
Count
The number of entries to return.
Return
[listResultType]
Array list of key, value pairs
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listId
Description
Returns the list of cost object ids and titles accessible by the requesting user.
Parameters
Integer
Count
The number of entries to return.
Return
[listResultType]
Array list of key, value pairs
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listFlaggedCostObjects
Description
Returns the list of flagged cost objects flagged by the requesting user.
Parameters
Integer
Count
The number of entries to return.
Return
[coResultType]
Returns cost object details for all of the matching cost objects
Errors
Capabilities
Use Cases
Comments/Feedback
Comment">Comment
Method
addComment
Description
Adds a comment to the identified object
Parameters
Comment_Type
Comment_Type
Denotes whether a particular comment is public or private.
Ref_Type
Ref_Type
Identifies what sort of speculation the reference is on (EXPENSE_RULE, APPT_RULE, APPT, CO, SCENARIO, WORKSET)
String
REF_ID
The object id for the associated item (cost_collector_key, etc.)
Return
[confirmResultType]
Returns status information and object id for the action (in this case, the comment)
Errors
EXISTS
Object already exists
NO_MATCH
Object identified by REF_ID does not exist
EMPTY
Comment body is empty
NO_AUTH
User does not have comment authorizations here.
Capabilities
Use Cases
Comments/Feedback
Method
deleteComment
Description
Sets the status for the identified comment to 'D', effectively removing the comment from display.
Parameters
Array
Parm
An associative array of key value pairs for search parameters
Return
[confirmResultType]
Returns the result status and objectId for the action.
Errors
NO_MATCH
No comment match found
NO_AUTH
User cannot delete this authorization.
Capabilities
Use Cases
Comments/Feedback
Method
getComment
Description
Requests the Comment from the system.
Parameters
String
Comment_Id
The specific comment to retreive
Return
[commentResultType]
Object containing the associated comments
Errors
NO_MATCH
No comment found
NO_AUTH
User does not have access to this comment
Capabilities
Use Cases
Comments/Feedback
Method
getCommentsforObject
Description
Returns all comments associated with the identified object
Parameters
String
REF_TYPE
The type of object to look up comments for
String
REF_ID
The Id for the object to look up comments for (cost_collector_key, personell_key, etc.)
Return
[commentResultType]
Object containing the associated comments. If there is no match than an empty structure is returned.
Errors
NO_MATCH
No object found
NO_AUTH
User does not have access to look at comments on this object.
Capabilities
Use Cases
Comments/Feedback
RAFT Authorizations">RAFT Authorizations
Method
addWorksetAuthorization
Description
Adds a particular authorization for a Workset to the system
Parameters
REF_TYPE
Object_Type
The type of object to be authorized (currently always WORKSET). The Object's Qualifier_Type
REF_KEY
Object_ID
The id of the object to be authorized. The Object Qualifier.
AUTH_TYPE
Authorization
What type of authorization to set
String
User
The kerb_name for the associated user
Return
[confirmResultType]
Returns status information and object id for the action (in this case, the comment)
Errors
EXISTS
Authorization already exists
NO_MATCH
Object identified by REF_KEY does not exist
NO_AUTH
User does not have authorizations to peform this action here.
Capabilities
Use Cases
Comments/Feedback
Method
addWorksetAuthorizations
Description
Removes a particular authorization for a Workset from the system
Parameters
String
Auth_Key
The authorization key to be removed
Return
[confirmResultType]
Returns status information and object id for the action
Errors
NO_MATCH
Authorization identified by AUTH_Key does not exist
EMPTY
Comment body is empty
NO_AUTH
User does not have authorizations to perform this action.
Capabilities
Use Cases
Comments/Feedback
Method
viewAuthorizationsforUser
Description
View the authorizations for this user
Parameters
String
User
The user to view the authorizations for. The kerb_name.
Return
[authResultType]
Returns all the authorizations for the user
Errors
NO_MATCH
No user found
Capabilities
Use Cases
Comments/Feedback
Method
viewAuthorizationsforObject
Description
Provide a breakdown of all of the authorizations for a particular object
Parameters
Ref_Type
Ref_Type
The type of object. The qualifier_type
String
REF_KEY
The unique identifier for the object (cost_collector_key, personnel_key, etc.)
Return
[authResultType]
Returns all authorizations for the associated object.
Errors
NO_MATCH
No cost objects found
NO_AUTH
User cannot view the associated authorizations
Capabilities
Use Cases
Comments/Feedback
Method
isAuthorized
Description
Can the given user perform the specified function
Parameters
String
User
An associative array of key value pairs for search parameters
td:class=methodParamType}REF_Type
REF_TYPE
The type of object to perform the action on. The Qualifier_Type
REF_Key
User
The key of the associated object (Cost_Collector_key, Personell_Key, etc.)
AUTH_TYPE
Action
The function the user is attempting to perform.
Return
[boolean]
Can the user perform the action identified by 'AUTH_TYPE' for the specified REF_TYPE/ID
Errors
NO_MATCH
Cannot find the object to be accessed.
Capabilities
Use Cases
Comments/Feedback