(!) WIP

h2. RAFT Service


{include:Interface Style}
{table:id=serviceMetaTable}
{tr}
{th:class=h}Name
{th}
{td:id=serviceName|colspan=2}RAFT Service
{td}
{tr}
{tr}
{th:class=h}Version
{th}
{td:id=serviceVersion}Dev ([0.1|Search Service 0.1])
{td}
{td:id=serviceVersionHistory}[Release Notes|Search Service Release Notes#current]
{td}
{tr}
{table}
| [#References] | [#Operations] | [#Capabilities] |



h3. 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


h3. References

see RAFT Requirements Documentation (RAFT-*)

h3. Operations

{include:Method Table Style Page}
{panel:title=Setup|borderStyle=solid|borderColor=#cccccc|bgColor=#ffffff|titleBGColor=#eeeeee}
*Domain Operations*
[#getModelTypes]

{panel}
{panel:title=Search|borderStyle=solid|borderColor=#cccccc|bgColor=#ffffff|titleBGColor=#eeeeee}
searchbyParm(&parm)
searchCollectionbyParm(&collection,&parm)

Listinfo about user sets
getSearchLists
listSupervisor(#count)
listAddressee(#count)
listSponsor(#count)
listPrimeSponsor(#count)
listId(#count)
listWorksets(#count)
listFlaggedCostObjects(#count)

{panel}
{panel:title=Maintenance|borderStyle=solid|borderColor=#cccccc|bgColor=#ffffff|titleBGColor=#eeeeee}

addComment
deleteComment
updateComment
getComment
getCommentsforObject

addWorksetAuthorizations
dropWorksetAuthorizations
viewAuthorizationsforUser
viewAuthorizationsforObject
isAuthorized

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





{panel}

h4. {color:#000066}{_}Search{_}{color}

{anchor:searchByParm}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}searchByParm
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Searches the cost collector set and returns matches based on the passed in parameters
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}Parm
{td}
{td:class=methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[coResultType|coResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns cost object details for all of the matching cost objects.
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No cost objects found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MAX_COUNT
{td}
{td:class=methodErrorDesc}Number of objects returned >250
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3} See RAFT-Search
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:searchCollectionbyParm}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}searchCollectionByParm
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Performs a collection search based off the identified parameters. Collection searches cannot be used to define sets
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Collection
{td}
{td:class=methodParamDesc}Which collection will be searched, one of supervisor, sponsor, fund_center, profit_center, workset
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}Parm
{td}
{td:class=methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[collectionResultType|collectionResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns cost object details for all of the matching cost objects wrapped in a metadata header for the collection.
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No cost objects found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MAX_COUNT
{td}
{td:class=methodErrorDesc}Count of returned objects (including the collection header) exceeds 250 and cannot be displayed.
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:getSearchLists}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getSearchLists
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the default collection of selection items for each of the search lists.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}Parm
{td}
{td:class=methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listSetResultType|listSetResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}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.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:listSupervisor}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listSupervisor
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of supervisors accessible by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Count
{td}
{td:class=methodParamDesc}The number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:listAddressee}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listAddressee
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of adressees accessible by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Count
{td}
{td:class=methodParamDesc}The number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:listSponsor}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listSponsor
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of sponsors accessible by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Count
{td}
{td:class=methodParamDesc}The number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:listPrimeSponsor}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listPrimeSponsor
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of prime sponsors accessible by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Count
{td}
{td:class=methodParamDesc}The number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:listWorkset}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listWorkset
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of worksets accessible by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Count
{td}
{td:class=methodParamDesc}The number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:listId}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listId
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of cost object ids and titles accessible by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Count
{td}
{td:class=methodParamDesc}The number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:listFlaggedCostObjects}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listFlaggedCostObjects
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of flagged cost objects flagged by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Count
{td}
{td:class=methodParamDesc}The number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[coResultType|coResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns cost object details for all of the matching cost objects
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

h4. {color:#000066}{_}Comment{_}{color}

{anchor:addComment}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addComment
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Adds a comment to the identified object
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Parameters
{th}
{td:class=methodParamType}Comment_Type
{td}
{td:class=methodParamName}Comment_Type
{td}
{td:class=methodParamDesc}Denotes whether a particular comment is public or private.
{td}
{tr}
{tr}
{td:class=methodParamType}Ref_Type
{td}
{td:class=methodParamName}Ref_Type
{td}
{td:class=methodParamDesc}Identifies what sort of speculation the reference is on (EXPENSE_RULE, APPT_RULE, APPT, CO, SCENARIO, WORKSET)
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}REF_ID
{td}
{td:class=methodParamDesc}The object id for the associated item (cost_collector_key, etc.)
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns status information and object id for the action (in this case, the comment)
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}EXISTS
{td}
{td:class=methodErrorDesc}Object already exists
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Object identified by REF_ID does not exist
{td}
{tr}
{td:class=methodErrorType|colspan=2}EMPTY
{td}
{td:class=methodErrorDesc}Comment body is empty
{td}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User does not have comment authorizations here.
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:deleteComment}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}deleteComment
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Sets the status for the identified comment to 'D', effectively removing the comment from display.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}Parm
{td}
{td:class=methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns the result status and objectId for the action.
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No comment match found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot delete this authorization.
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:getComment}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getComment
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Requests the Comment from the system.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Comment_Id
{td}
{td:class=methodParamDesc}The specific comment to retreive
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[commentResultType|commentResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Object containing the associated comments
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No comment found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User does not have access to this comment
{td}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:getCommentsforObject}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getCommentsforObject
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns all comments associated with the identified object
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}REF_TYPE
{td}
{td:class=methodParamDesc}The type of object to look up comments for
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}REF_ID
{td}
{td:class=methodParamDesc}The Id for the object to look up comments for (cost_collector_key, personell_key, etc.)
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[commentResultType|commentResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Object containing the associated comments. If there is no match than an empty structure is returned.
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No object found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User does not have access to look at comments on this object.
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]


h4. {color:#000066}{_}RAFT Authorizations{_}{color}

{anchor:addWorksetAuthorization}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addWorksetAuthorization
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=4}Adds a particular authorization for a Workset to the system
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Parameters
{th}
{td:class=methodParamType}REF_TYPE
{td}
{td:class=methodParamName}Object_Type
{td}
{td:class=methodParamDesc}The type of object to be authorized (currently always WORKSET). The Object's Qualifier_Type
{td}
{tr}
{tr}
{td:class=methodParamType}REF_KEY
{td}
{td:class=methodParamName}Object_ID
{td}
{td:class=methodParamDesc}The id of the object to be authorized. The Object Qualifier.
{td}
{tr}
{tr}
{td:class=methodParamType}AUTH_TYPE
{td}
{td:class=methodParamName}Authorization
{td}
{td:class=methodParamDesc}What type of authorization to set
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}User
{td}
{td:class=methodParamDesc}The kerb_name for the associated user
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns status information and object id for the action (in this case, the comment)
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}EXISTS
{td}
{td:class=methodErrorDesc}Authorization already exists
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Object identified by REF_KEY does not exist
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User does not have  authorizations to peform this action here.
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropWorksetAuthorization}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=4}dropWorksetAuthorization
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=4}Removes a particular authorization for a Workset from the system
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Auth_Key
{td}
{td:class=methodParamDesc}The authorization key to be removed
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns status information and object id for the action
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Authorization identified by AUTH_Key does not exist
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}EMPTY
{td}
{td:class=methodErrorDesc}Comment body is empty
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User does not have authorizations to perform this action.
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]



{anchor:viewAuthorizationsforUser}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}viewAuthorizationsforUser
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}View the authorizations for this user
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}User
{td}
{td:class=methodParamDesc}The user to view the authorizations for. The kerb_name.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[authResultType|authResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns all the authorizations for the user
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No user found
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:viewAuthorizationsforObject}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}viewAuthorizationsforObject
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Provide a breakdown of all of the authorizations for a particular object
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}Ref_Type
{td}
{td:class=methodParamName}Ref_Type
{td}
{td:class=methodParamDesc}The type of object. The qualifier_type
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}REF_KEY
{td}
{td:class=methodParamDesc}The unique identifier for the object (cost_collector_key, personnel_key, etc.)
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[authResultType|authResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns all authorizations for the associated object. 
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No cost objects found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot view the associated authorizations
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:isAuthorized}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}isAuthorized
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=4}Can the given user perform the specified function
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}User
{td}
{td:class=methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{tr}
{td:class=methodParamType}REF_Type
{td}
{td:class=methodParamName}REF_TYPE
{td}
{td:class=methodParamDesc}The type of object to perform the action on. The Qualifier_Type
{td}
{tr}
{tr}
{td:class=methodParamType}REF_Key
{td}
{td:class=methodParamName}User
{td}
{td:class=methodParamDesc}The key of the associated object (Cost_Collector_key, Personell_Key, etc.)
{td}
{tr}
{tr}
{td:class=methodParamType}AUTH_TYPE
{td}
{td:class=methodParamName}Action
{td}
{td:class=methodParamDesc}The function the user is attempting to perform.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[boolean|booleanResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Can the user perform the action identified by 'AUTH_TYPE' for the specified REF_TYPE/IDi (Y/N)
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Cannot find the object to be accessed.
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

h4. {color:#000066}{_}CO Metadata{_}{color}

{anchor:listBudgets}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listBudgets
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of budgets available for the specified Cost Object.
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_Collector_key
{td}
{td:class=methodParamDesc}The cost object to look up
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children accounts.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, value pairs. In this case, key = budget version code, value = Description
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:listWorksetScenarios}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listWorksetScenarios
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of Scenarios associated with this workset. This list is implicitly restricted to the scenarios that the accessing user has access to.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_Key
{td}
{td:class=methodParamDesc}The id for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, value pairs. In this case, key = scenario ID, value = scenario name
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:listProjectPeriods}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listProjectPeriods
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of Project Periods for this cost object
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for this cost object
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[projectYearResultType|projectYearResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the project year date ranges associated with this cost object
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:updateProjectPeriod}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateProjectPeriod
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=4}For the given project period, alter the start and end date.
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for this cost object
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Project_Period_Key
{td}
{td:class=methodParamDesc}The identifier for this project period
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The start date for this project period
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The end date for this project period
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status along with the object reference.
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc} No match for this project period/cost object
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}OVERLAP
{td}
{td:class=methodErrorDesc}Warning: Project period now overlaps another project period defined for this cost object
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INVALID
{td}
{td:class=methodErrorDesc}Project period defined outside of start/final expiration date range for this cost object
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:addProjectPeriod}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addProjectPeriod
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=4}Add project year to cost object
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for this cost object
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Project_Period_Key
{td}
{td:class=methodParamDesc}The identifier for this project period
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The start date for this project period
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The end date for this project period
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status along with the object reference.
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc} No match for this cost object
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}OVERLAP
{td}
{td:class=methodErrorDesc}Warning: Project period now overlaps another project period defined for this cost object
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INVALID
{td}
{td:class=methodErrorDesc}Project period defined outside of start/final expiration date range for this cost object
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropProjectPeriod}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}dropProjectPeriod
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=4}Delete project year from cost object
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for this cost object
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Project_Period_Key
{td}
{td:class=methodParamDesc}The identifier for this project period
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status along with the object reference.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc} No match for this cost object
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:validateProjectPeriods}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}validateProjectPeriods
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=4}Validate that the project periods are contiguous and non overlapping, and that they begin at the start of the project and end at the end of the final expiration date
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for this cost object
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[validateResultType|validateResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the validity status of the project periods on the cost object and identifies exceptions
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc} No match for this cost object
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:normalizeProjectPeriods}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}normalizeProjectPeriods
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=4}Starting from the first period, push out the start date of the subsequent project periods so that the full set of project periods are contiguous and non-overlapping
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for this cost object
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[validateResultType|validateResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the validity status of the project periods on the cost object and identifies exceptions
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc} No match for this cost object
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INCOMPLETE
{td}
{td:class=methodErrorDesc} Warning: Project Period schedule does not cover the full date range for this CO (from effective through final expiration date)
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

h4. {color:#000066}{_}Reports{_}{color}
h4. {color:#000066}{_}Reports{_}{color}

{anchor:listReports}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listReports
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}For a given context, list the available reports in that context
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}REF_TYPE
{td}
{td:class=methodParamName}REF_TYPE
{td}
{td:class=methodParamDesc}The context. Workset, Scenario, Person, Cost Object, Allocation
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}REF_KEY
{td}
{td:class=methodParamDesc}(optional) A unique identifier for a particular object. For object specific reports
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[reportListResultType|reportListResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of reports. Returns the ID, Title, and Description for the report
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc} Warning: No reports for specific ref_key found. Returning report list for the general context.
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INVALID
{td}
{td:class=methodErrorDesc} Invalid REF_TYPE identified
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:executeReport}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}executeReport
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the result document for the report request
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Report_ID
{td}
{td:class=methodParamDesc}The id for this report
{td}
{tr}
{tr}
{td:class=methodParamType}FORMAT_TYPE
{td}
{td:class=methodParamName}FORMAT_TYPE
{td}
{td:class=methodParamDesc}The format type, one of: XLS,CSV,PDF,HTML,(addional options depend on the backend)
{td}
{tr}
{tr}
{td:class=methodParamType}@PARM
{td}
{td:class=methodParamName}PARM
{td}
{td:class=methodParamDesc}Associative array of parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[reportResultType|reportResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the resulting report object
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}ERROR
{td}
{td:class=methodErrorDesc}Report processing error (Error passed in body)
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

h4. {color:#000066}{_}Summary{_}{color}


{anchor:BvAQueryDay}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}BvAQueryDay
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Expenses only.
{td}
{tr}
{tr}
{th:class=h|rowspan=9}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Hierarchy
{td}
{td:class=methodParamDesc}The Hierarchy of GL categories and accounts to use.
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Budget_version
{td}
{td:class=methodParamDesc}Which budget to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_version
{td}
{td:class=methodParamDesc}Which scenario to use
{td}
{tr}
{tr}
{td:class=methodParamType}Cost_collector_key
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for the cost object
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The end_date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Consolidate the results to include all associated children with the parent
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Collection_type
{td}
{td:class=methodParamDesc}When including children, use the following collection for the aggregation
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Collection_key
{td}
{td:class=methodParamDesc}When including children, use this particular collection key as the root of the consolidation tree
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[coSummaryResultType|coSummaryResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Flattened cube of summary financial information
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Either the Cost object or collection key does not exist in the system
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:RvEQueryDay}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}RvEQueryDay
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Revenue & Expenses.
{td}
{tr}
{tr}
{th:class=h|rowspan=9}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Hierarchy
{td}
{td:class=methodParamDesc}The Hierarchy of GL categories and accounts to use.
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Budget_version
{td}
{td:class=methodParamDesc}Which budget to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_version
{td}
{td:class=methodParamDesc}Which scenario to use
{td}
{tr}
{tr}
{td:class=methodParamType}Cost_collector_key
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for the cost object
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The end_date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Consolidate the results to include all associated children with the parent
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Collection_type
{td}
{td:class=methodParamDesc}When including children, use the following collection for the aggregation
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Collection_key
{td}
{td:class=methodParamDesc}When including children, use this particular collection key as the root of the consolidation tree
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[coSummaryResultType|coSummaryResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Flattened cube of summary financial information
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Either the Cost object or collection key does not exist in the system
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]


{anchor:BvAQueryMonthly}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}BvAQueryMonthly
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Expenses only. Monthly view
{td}
{tr}
{tr}
{th:class=h|rowspan=9}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Hierarchy
{td}
{td:class=methodParamDesc}The Hierarchy of GL categories and accounts to use.
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Budget_version
{td}
{td:class=methodParamDesc}Which budget to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_version
{td}
{td:class=methodParamDesc}Which scenario to use
{td}
{tr}
{tr}
{td:class=methodParamType}Cost_collector_key
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for the cost object
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Start_Period
{td}
{td:class=methodParamDesc}The start period for the query window - format = YYYYMM
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}End_Period
{td}
{td:class=methodParamDesc}The end_date for the query window - format = YYYYMM
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Consolidate the results to include all associated children with the parent
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Collection_type
{td}
{td:class=methodParamDesc}When including children, use the following collection for the aggregation
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Collection_key
{td}
{td:class=methodParamDesc}When including children, use this particular collection key as the root of the consolidation tree
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[coSummaryResultType|coSummaryResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Flattened cube of summary financial information
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Either the Cost object or collection key does not exist in the system
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:RvEQueryMonth}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}RvEQueryMonth
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Revenue & Expenses. Monthly view
{td}
{tr}
{tr}
{th:class=h|rowspan=9}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Hierarchy
{td}
{td:class=methodParamDesc}The Hierarchy of GL categories and accounts to use.
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Budget_version
{td}
{td:class=methodParamDesc}Which budget to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_version
{td}
{td:class=methodParamDesc}Which scenario to use
{td}
{tr}
{tr}
{td:class=methodParamType}Cost_collector_key
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for the cost object
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Start_Period
{td}
{td:class=methodParamDesc}The start period for the query window - format = YYYYMM
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}End_Period
{td}
{td:class=methodParamDesc}The end period  for the query window - format = YYYYMM
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Consolidate the results to include all associated children with the parent
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Collection_type
{td}
{td:class=methodParamDesc}When including children, use the following collection for the aggregation
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Collection_key
{td}
{td:class=methodParamDesc}When including children, use this particular collection key as the root of the consolidation tree
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[coSummaryResultType|coSummaryResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Flattened cube of summary financial information
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Either the Cost object or collection key does not exist in the system
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]



h4. {color:#000066}{_}Drill-down{_}{color}


{anchor:queryActualsSumm}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryActualsSumm
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns a summary of the totals by GL/CO 
{td}
{tr}
{tr}
{th:class=h|rowspan=10}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[actSummResultType|actSummResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:queryActualsPODetail}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryActualsPODetail
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns matching actuals expense Records (rename?)
{td}
{tr}
{tr}
{th:class=h|rowspan=10}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[actPOResultType|actPOResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:queryActualsPEDetail}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryActualsPEDetail
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns matching actuals personnel Records (rename?)
{td}
{tr}
{tr}
{th:class=h|rowspan=10}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[actPEResultType|actPEResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:queryBudgetDetail}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryBudgetDetail
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns matching budget records (SAP = GL Level, COEUS = line item level)
{td}
{tr}
{tr}
{th:class=h|rowspan=11}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Budget Version
{td}
{td:class=methodParamDesc}The plan version for the associated budget
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[budResultType|budPEResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:queryCommitmentsSumm}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryCommitmentsSumm
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns a summary of the commitments information by gl
{td}
{tr}
{tr}
{th:class=h|rowspan=10}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[commSummResultType|commSummResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:queryCommitmentsPODetail}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryCommitmentsPODetail
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns matching commitments expense Records (rename?)
{td}
{tr}
{tr}
{th:class=h|rowspan=10}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[commPOResultType|commPOResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:queryCommitmentsPEDetail}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryCommitmentsPEDetail
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns matching commitments personnel Records (rename?)
{td}
{tr}
{tr}
{th:class=h|rowspan=10}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[commPEResultType|commPEResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:queryForecastSumm}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryForecastSumm
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns a summary of the forecast(scenario) information by gl
{td}
{tr}
{tr}
{th:class=h|rowspan=11}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_key
{td}
{td:class=methodParamDesc}The scenario key. Defaults to the Common scenario key (COMMON)
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[forSummResultType|forSummResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:queryForecastPODetail}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryForecastPODetail
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns matching forecast (scenario) expense Records (rename?)
{td}
{tr}
{tr}
{th:class=h|rowspan=11}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_key
{td}
{td:class=methodParamDesc}The scenario key. Defaults to the Common scenario key (COMMON)
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[commPOResultType|commPOResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:queryForecastPEDetail}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryForecastPEDetail
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns matching forecast (scenario) personnel Records (rename?)
{td}
{tr}
{tr}
{th:class=h|rowspan=11}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_key
{td}
{td:class=methodParamDesc}The scenario key. Defaults to the Common scenario key (COMMON)
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[commPEResultType|commPEResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

h4. {color:#000066}{_}Workset Management{_}{color}

Workset Management


{anchor:createWorkset}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}createWorkset
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Define a new, empty, workset
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The short string identifying the workset
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_Title
{td}
{td:class=methodParamDesc}The name of the workset
{td}
{tr}
{tr}
{td:class=methodParamType}longText
{td}
{td:class=methodParamName}Workset_Desc
{td}
{td:class=methodParamDesc}Long description of this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}EXISTS
{td}
{td:class=methodErrorDesc}Workset with this workset key already exists
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropWorkset}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}createWorkset
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Drop an existing workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The short string identifying the workset
{td}
{tr}
{tr}
{td:class=methodParamType}CONSTRAINT_TYPE
{td}
{td:class=methodParamName}Constraint type
{td}
{td:class=methodParamDesc}Identifies whether or not to remove this workset from any parent workset rules
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No workset with this key exists in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}HAS_CHILDREN
{td}
{td:class=methodErrorDesc}Workset has associated child objects that must be removed first
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User can not perform this action
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:archiveWorkset}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}archiveWorkset
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Archive an existing workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The short string identifying the workset
{td}
{tr}
{tr}
{td:class=methodParamType}CONSTRAINT_TYPE
{td}
{td:class=methodParamName}Constraint type
{td}
{td:class=methodParamDesc}Identifies whether or not to archive all children worksets as well
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No workset with this key exists in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User can not perform this action
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}PARENT_REQUIRES
{td}
{td:class=methodErrorDesc}This workset is required by another workset that has not been archived
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:listWorksets}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listWorksets
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Show details for all worksets accessible by this person
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}
{td}
{td:class=methodParamName}
{td}
{td:class=methodParamDesc}
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[worksetSummaryResultType|worksetSummaryResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns all worksets accessible by the current user
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]


{anchor:showWorkset}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorkset
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns structure containing all cost objects, people, and scenarios owned by this workset
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[worksetDetailResultType|worksetDetailResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the objects contained by this workset
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No workset with this key exists in the system
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:addWorksetObjects}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addWorksetObjects
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Adds cost objects or people to the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{td:class=methodParamType}REF_TYPE
{td}
{td:class=methodParamName}REF_TYPE
{td}
{td:class=methodParamDesc}The object type to add
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}REF_KEY
{td}
{td:class=methodParamDesc}The unique identifiers of object_type to add
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the completion status of the identified task along with the associated references
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}MISSING
{td}
{td:class=methodErrorDesc}Certain objects identified do not exist in the system
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:delWorksetObjects}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}delWorksetObjects
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Removes cost objects or people from the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{td:class=methodParamType}REF_TYPE
{td}
{td:class=methodParamName}REF_TYPE
{td}
{td:class=methodParamDesc}The object type to drop
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}REF_KEY
{td}
{td:class=methodParamDesc}The unique identifiers of the object_type to drop
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the completion status of the identified task along with the associated references
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}MISSING
{td}
{td:class=methodErrorDesc}Certain objects identified do not exist in the system
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:listWorksetObjects}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listWorksetObjects
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Show the objects in the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{td:class=methodParamType}REF_TYPE
{td}
{td:class=methodParamName}REF_TYPE
{td}
{td:class=methodParamDesc}(optional) The object type to restrict by
{td}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns a structure containing the list of objects, by type, in the workset 
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No such workset in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}EMPTY
{td}
{td:class=methodErrorDesc}Contains no child objects
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User does not have access to workset objects
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:addWorksetRule}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addWorksetRule
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Removes cost objects or people from the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{td:class=methodParamType}longText
{td}
{td:class=methodParamName}criteria
{td}
{td:class=methodParamDesc}Basically, a where clause sql snippet
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the completion status of the identified task along with the associated references
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}MISSING
{td}
{td:class=methodErrorDesc}Rule has no matches in the system currently
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropWorksetRule}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}dropWorksetRule
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Removes cost objects or people from the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the completion status of the identified task along with the associated references
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Rule does not exist in system
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showWorksetRules}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorksetRules
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Shows the definition rules in place for the specified workset
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[worksetRulesResultType|worksetRulesResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the list of defined rules in the system.
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Workset does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User does not have access to objects in this workset
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INCORRECT_TYPE
{td}
{td:class=methodErrorDesc}This workset type does not have rules
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:updateWorksetfromRules}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateWorksetfromRules
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Processes all of the associated workset rules, logging the changes to the change_log
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the completion status of the identified task along with the associated references
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Rule does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_CHANGE
{td}
{td:class=methodErrorDesc}No objects added or removed from the workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:convertWorksettoStatic}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}convertWorksettoStatic
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Converts a workset from dynamic (rules-based) to static
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the completion status of the identified task along with the associated references
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Rule does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot perform this action
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INCORRECT_TYPE
{td}
{td:class=methodErrorDesc}Workset is already static
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showWorksetChanges}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorksetChanges}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}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.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[changeResultType|changeResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the list of object changes to this workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Workset does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_CHANGE
{td}
{td:class=methodErrorDesc}No objects added or removed from the workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showWorksetAccessChanges}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorksetAccessChanges}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}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.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[changeResultType|changeResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the list of access changes to this workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Workset does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_CHANGE
{td}
{td:class=methodErrorDesc}No objects added or removed from the workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showWorksetBalanceExceptions}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorksetBalanceExceptions}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Show the list of cost objects whose balance < 0 currently or are expected to be < 0 on the project end date.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[changeResultType|changeResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the list of balance exceptions on this workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Workset does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_CHANGE
{td}
{td:class=methodErrorDesc}No issues identified
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showWorksetCOSummary}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorksetCOSummary}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Show summary information about the COs in the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_Key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[worksetCOSummaryResultType|worksetCOSummaryResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns a summary of cost objects in the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Workset does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access workset information
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]


{anchor:showWorksetApptSummary}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorksetApptSummary}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Shows a summary of People/Appt information in the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[worksetApptSummaryResultType|worksetApptResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns a summary of people/appts in the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Workset does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access objects in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]


{anchor:showWorksetScenarioSummary}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorksetScenarioSummary}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Show the list of defined of defined Scenarios in the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[worksetScenarioResultType|worksetResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the list of scenarios in the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Workset does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access objects in the workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]



h4. {color:#000066}{_}Scenario Management{_}{color}

Scenario Management

{anchor:showCOAttributes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showCOAttributes}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}For a given Cost Object Definition, show all of the speculative adjustments on that Cost Object
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_Collector_key
{td}
{td:class=methodParamDesc}The unique identifier for the cost object
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td} 
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for this scenario
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[coMetaResultType|coMetaResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} For the given cost object, return the final cost object including all adjustments
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Scenario or CO does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access objects in the scenario
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showApptAttributes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showApptAttributes}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}For a given Person/Appt Definition, show all of the speculative adjustments on that Person/Appt
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Personnel_key
{td}
{td:class=methodParamDesc}The unique identifier for the cost object
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for this scenario
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[apptMetaResultType|apptMetaResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} For the given person/Appt, return the final person/appt including all adjustments
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Scenario or Appt does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access objects in the scenario
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showScenarioOverview}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showScenarioOverview}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Provide a top level-overview of this scenario including: Pertinent people and expenses for CO and balances
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[scenarioOverviewMetaResultType|scenarioOverviewResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Provides a high-level overview of the scenario, limited by the associated authorizations
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Scenario does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access objects in the scenario
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showScenarioFinImpact}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showScenarioFinImpact}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Shows a CO level summary of the cost object
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[scenarioFinancialImpactMetaResultType|scenarioFinancialImpactResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Provides a high-level of the CO financial impact information
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Scenario does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access objects in the scenario
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showScenarioPersonImpact}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showScenarioPersonImpact}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Provide a summary view of the personnel Impact of this Scenario
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[scenarioOverviewMetaResultType|scenarioOverviewResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Provides a high-level overview of the personnel resources and associated financial impact, limited by the associated authorizations
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Scenario does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access objects in the scenario
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showScenarioSpeculations}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showScenarioSpeculations}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Provide a change log showing all of the speculations in the system
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[speclistMetaResultType|speclistResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns a structure of speculations by type. Only includes type/title/descriptions
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Scenario does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access objects in the scenario
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showScenarioExceptions}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showScenarioExceptions}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Provide a change log showing all of the validation exceptions for this scenario.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[scenarioExceptionMetaResultType|scenarioResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns a structure of scenario validation exceptions by type. References the associated speculations
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Scenario does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access objects in the scenario
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showExpenseDetail}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showExpenseDetail}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}For a given CO, the breakdown of Expense speculations for this account
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_Collector_key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[expenseSpeculationMetaResultType|expenseSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the Expense Speculation information as a structure
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Scenario does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access objects in the scenario
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showCOApptDetail}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showCOApptDetail}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}For a CO, the labor distributions on this account
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_Collector_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Cost Object
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[distributionSpeculationMetaResultType|distributionSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the labor distributiuon Speculation information as a structure for this CO
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Scenario does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access objects in the scenario
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showApptDetail}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showApptDetail}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}For a given person/appt, the labor distributions for that person
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Personnel_key
{td}
{td:class=methodParamDesc}The unique identifier for the Person/Appt
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[distributionSpeculationMetaResultType|distributionSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the Labor Distribution Speculation information as a structure for this person
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Scenario does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access objects in the scenario
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:createScenario}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}createScenario
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Defines an empty Scenario
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}Parm
{td}
{td:class=methodParamDesc}Scenario parameters (Include commitments so far)
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}EXISTS
{td}
{td:class=methodErrorDesc}Scenario exists in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:updateScenario}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateScenario
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Updates the scenario metadata with the identified PARM
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}Parm
{td}
{td:class=methodParamDesc}Scenario parameters (Include commitments so far)
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_EXIST
{td}
{td:class=methodErrorDesc}Scenario does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:deleteScenario}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}deleteScenario}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}D-flags a given scenario. D-flagged scenarios are reaped after 30 days.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Scenario does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:addCOtoScenario}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addCOtoScenario}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Adds a collection of COs to a scenario
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}A collection of cost objects to add to the scenario
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include child cost objects
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}EXISTS
{td}
{td:class=methodErrorDesc}Warning: One or more of the objects specified exist in the scenario 
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot perform actions on this scenario
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}One or more COs specified do not exist
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:addAppttoScenario}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addAppttoScenario}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Adds a collection of Appts to a scenario
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ApptArray
{td}
{td:class=methodParamDesc}A collection of appointments to add to the scenario
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}EXISTS
{td}
{td:class=methodErrorDesc}Warning: One or more of the objects specified exist in the scenario 
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot perform actions on this scenario
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}One or more COs specified do not exist
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropCOfromScenario}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}dropCOfromScenario}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Removes a CO from a Scenario
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_Collector_key
{td}
{td:class=methodParamDesc}A cost objects to remove from the scenario
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include child cost objects
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot perform actions on this scenario
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}CO specified does not exist
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}DEPENDENT_OBJECTS
{td}
{td:class=methodErrorDesc}Warning: CO has speculations
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropApptfromScenario}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}dropApptfromScenario}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Drops an Appts from a scenario
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Personnel_key
{td}
{td:class=methodParamDesc}An appt to remove from a scenario
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}DEPENDENT_OBJECTS
{td}
{td:class=methodErrorDesc}Warning: Appt has speculations
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}DEPENDENT_COS
{td}
{td:class=methodErrorDesc}ERROR: Cannot remove appt due to the fact that it is used in CO labor distribution speculations
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot perform actions on this scenario
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}One or more COs specified do not exist
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:archiveScenario}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}archiveScenario}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Archives the specific scenario in question.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Scenario does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:copyScenario}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}copyScenario}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Copies a Scenario to another scenario
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Source_Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the source Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Destination_Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the destination Scenario (null if new)
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}Overwrite
{td}
{td:class=methodParamDesc}If true, delete all speculations for associated objects and replace with mine. If false, add my speculations to the existing set. It will add only speculations for object combinations that do not exist as speculations in the destination system.
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}Update_Objects
{td}
{td:class=methodParamDesc}If true, add missing target objects (people/cos) to the destination set. Otherwise speculations with no object match are dropped with a warning.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_SOURCE
{td}
{td:class=methodErrorDesc}Source Scenario does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_DESTINATION
{td}
{td:class=methodErrorDesc}Destination scenario does not exist in the system
{td}
{tr}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}SET_ISSUE
{td}
{td:class=methodErrorDesc}The collections of target objects(people/appt) in the scenario do not match
{td}
{tr}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}SPEC_EXISTS
{td}
{td:class=methodErrorDesc}You are not overwriting speculations and a matching speculation combination exists. Backing out.
{td}
{tr}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:addAssumption}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addAssumption
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Adds a global assumption to a scenario. Assumptions can be one of: MERIT_INCREASE, RATE or INFLATION
{td}
{tr}
{tr}
{th:class=h|rowspan=9}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}ASSUMPTION_TYPE
{td}
{td:class=methodParamName}Assumption_TYPE
{td}
{td:class=methodParamDesc}One of: MERIT_INCREASE, RATE or INFLATION
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Assumption_Desc
{td}
{td:class=methodParamDesc}Short description for the assumption
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Assumption_Percent
{td}
{td:class=methodParamDesc}Adjustment percentage for the assumption
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The Start_Date for the Assumption
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The End_Date for the Assumption
{td}
{tr}
{tr}
{td:class=methodParamType}GL_ACCOUNT
{td}
{td:class=methodParamName}Source_GL
{td}
{td:class=methodParamDesc}The Source GL for the Assumption (the basis for calculations)
{td}
{tr}
{tr}
{td:class=methodParamType}GL_ACCOUNT
{td}
{td:class=methodParamName}Target_GL
{td}
{td:class=methodParamDesc}The target GL for the Assumption (where the resulting line items should land)
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}Merge
{td}
{td:class=methodParamDesc}Instead of throwing an error on overwrite, merge this change into the associated base assumption
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=6}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_SOURCE
{td}
{td:class=methodErrorDesc}Source GL does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_DESTINATION
{td}
{td:class=methodErrorDesc}Destination GL does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}SET_ISSUE
{td}
{td:class=methodErrorDesc}There exists an assumption of the type/gl identified with a different start/end date range (Merge prevents this error)
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}EXISTS
{td}
{td:class=methodErrorDesc}There exists an auumption of the type/gl/date range identified with different % valyes (Merge preents this error)
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropAssumption}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}dropAssumption
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Removes an assumption from the system for the identified scenario
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}ASSUMPTION_TYPE
{td}
{td:class=methodParamName}Assumption_TYPE
{td}
{td:class=methodParamDesc}One of: MERIT_INCREASE, RATE or INFLATION
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Assumption_ID
{td}
{td:class=methodParamDesc}The unique identifier for the assumption to be removed
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Assumption_Percent
{td}
{td:class=methodParamDesc}Adjustment percentage for the assumption
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_ASSUMPTION
{td}
{td:class=methodErrorDesc}Assumption does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:updateAssumption}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateAssumption
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Alter an existing assumption in the system. Assumptions can be one of: MERIT_INCREASE, RATE or INFLATION
{td}
{tr}
{tr}
{th:class=h|rowspan=10}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Assumption_ID
{td}
{td:class=methodParamDesc}The unique identifier for the assumption
{td}
{tr}
{tr}
{td:class=methodParamType}ASSUMPTION_TYPE
{td}
{td:class=methodParamName}Assumption_TYPE
{td}
{td:class=methodParamDesc}One of: MERIT_INCREASE, RATE or INFLATION
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Assumption_Desc
{td}
{td:class=methodParamDesc}Short description for the assumption
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Assumption_Percent
{td}
{td:class=methodParamDesc}Adjustment percentage for the assumption
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The Start_Date for the Assumption
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The End_Date for the Assumption
{td}
{tr}
{tr}
{td:class=methodParamType}GL_ACCOUNT
{td}
{td:class=methodParamName}Source_GL
{td}
{td:class=methodParamDesc}The Source GL for the Assumption (the basis for calculations)
{td}
{tr}
{tr}
{td:class=methodParamType}GL_ACCOUNT
{td}
{td:class=methodParamName}Target_GL
{td}
{td:class=methodParamDesc}The target GL for the Assumption (where the resulting line items should land)
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}Merge
{td}
{td:class=methodParamDesc}Instead of throwing an error on overwrite, merge this change into the associated base assumption
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=5}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_SOURCE
{td}
{td:class=methodErrorDesc}Source GL does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_DESTINATION
{td}
{td:class=methodErrorDesc}Destination GL does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_Assumption
{td}
{td:class=methodErrorDesc}Assumption does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:addExpenseAllocSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addExpenseAllocSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Adds an expense allocation to the system. Expense allocations are by line item for one or more Cost Objects
{td}
{tr}
{tr}
{th:class=h|rowspan=6}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Line_Item
{td}
{td:class=methodParamDesc}Description of the Line_Item to add
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Line_Item_Total
{td}
{td:class=methodParamDesc}The Total cost of the Line Item
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The Start_Date for the Speculation
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The End_Date for the Assumption
{td}
{tr}
{tr}
{td:class=methodParamType}[allocationMetaResultType|AllocationResultTypeInfo Structure]
{td}
{td:class=methodParamName}Allocation_Obj
{td}
{td:class=methodParamDesc}For the given Line item, the distribution as follows: CO | GL | Start Date | End Date | %
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}MISSING_CO
{td}
{td:class=methodErrorDesc}COs identified do not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}EXISTS
{td}
{td:class=methodErrorDesc}Line Item exists for start/end Date range specified
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MIS-ALLOC
{td}
{td:class=methodErrorDesc}Allocation does not = 100% and/or total does not equal the Line_Item_Total
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:addApptAllocSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addApptAllocSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Adds an appt allocation to the system. Appt allocations are by person for one or more Cost Objects. By default all of a person's allocations must be included for the time frame specified.
{td}
{tr}
{tr}
{th:class=h|rowspan=6}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}Personnel_key
{td}
{td:class=methodParamName}Personnel_key
{td}
{td:class=methodParamDesc}The unique identifier for the person/appt
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Dist_Total
{td}
{td:class=methodParamDesc}The Total distribution amount for the person/appt within the timeframe specified
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The Start_Date for the Speculation
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The End_Date for the Assumption
{td}
{tr}
{tr}
{td:class=methodParamType}[allocationMetaResultType|AllocationResultTypeInfo Structure]
{td}
{td:class=methodParamName}Allocation_Obj
{td}
{td:class=methodParamDesc}For the given personnel_key, the distribution as follows: CO | GL | Start Date | End Date | %
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=5}Errors
{th}
{td:class=methodErrorType|colspan=2}MISSING_CO
{td}
{td:class=methodErrorDesc}COs identified do not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}EXISTS
{td}
{td:class=methodErrorDesc}Person Allocations exist for start/end date range specified
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MIS-ALLOC
{td}
{td:class=methodErrorDesc}Allocation does not = 100% and/or total does not equal the Line_Item_Total
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MISSING_Appt
{td}
{td:class=methodErrorDesc}Appt Identifier does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:updateExpenseAllocSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateExpenseAllocSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Updates an expense allocation to the system. Expense allocations are by line item for one or more Cost Objects
{td}
{tr}
{tr}
{th:class=h|rowspan=6}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Speculation_ID
{td}
{td:class=methodParamDesc}Unique identifier for speculation
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Line_Item
{td}
{td:class=methodParamDesc}Description of the Line_Item to add
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Line_Item_Total
{td}
{td:class=methodParamDesc}The Total cost of the Line Item
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The Start_Date for the Speculation
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The End_Date for the Assumption
{td}
{tr}
{tr}
{td:class=methodParamType}[allocationMetaResultType|AllocationResultTypeInfo Structure]
{td}
{td:class=methodParamName}Allocation_Obj
{td}
{td:class=methodParamDesc}For the given Line item, the distribution as follows: CO | GL | Start Date | End Date | %
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=5}Errors
{th}
{td:class=methodErrorType|colspan=2}MISSING_CO
{td}
{td:class=methodErrorDesc}COs identified do not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MIS-ALLOC
{td}
{td:class=methodErrorDesc}Allocation does not = 100% and/or total does not equal the Line_Item_Total
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_Speculation_MATCH
{td}
{td:class=methodErrorDesc}No Match for the speculation
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:updateApptAllocSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateApptAllocSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Updates an appt allocation to the system. Appt allocations are by person for one or more Cost Objects. By default all of a person's allocations must be included for the time frame specified.
{td}
{tr}
{tr}
{th:class=h|rowspan=6}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Speculation_ID
{td}
{td:class=methodParamDesc}The unique identifier for the speculation
{td}
{tr}
{tr}
{td:class=methodParamType}Personnel_key
{td}
{td:class=methodParamName}Personnel_key
{td}
{td:class=methodParamDesc}The unique identifier for the person/appt
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Dist_Total
{td}
{td:class=methodParamDesc}The Total distribution amount for the person/appt within the timeframe specified
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The Start_Date for the Speculation
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The End_Date for the Assumption
{td}
{tr}
{tr}
{td:class=methodParamType}[allocationMetaResultType|AllocationResultTypeInfo Structure]
{td}
{td:class=methodParamName}Allocation_Obj
{td}
{td:class=methodParamDesc}For the given personnel_key, the distribution as follows: CO | GL | Start Date | End Date | %
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=5}Errors
{th}
{td:class=methodErrorType|colspan=2}MISSING_CO
{td}
{td:class=methodErrorDesc}COs identified do not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_SPEC_MATCH
{td}
{td:class=methodErrorDesc}Speculation ID does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MIS-ALLOC
{td}
{td:class=methodErrorDesc}Allocation does not = 100% and/or total does not equal the Line_Item_Total
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MISSING_Appt
{td}
{td:class=methodErrorDesc}Appt Identifier does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropExpenseAllocSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}dropExpenseAllocSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Drops an expense allocation from the system. 
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Speculation_ID
{td}
{td:class=methodParamDesc}Unique identifier for speculation
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_Speculation_MATCH
{td}
{td:class=methodErrorDesc}No Match for the speculation
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropApptAllocSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}dropApptAllocSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Drops an appt allocation from the system. 
{td}
{tr}
{tr}
{th:class=h|rowspan=6}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Speculation_ID
{td}
{td:class=methodParamDesc}The unique identifier for the speculation
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=5}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_SPEC_MATCH
{td}
{td:class=methodErrorDesc}Speculation ID does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:addTBACOSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addTBACOSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Adds a non-existent CO to a scenario 
{td}
{tr}
{tr}
{th:class=h|rowspan=8}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_Collector_Key
{td}
{td:class=methodParamDesc}The unique identifier for the CO
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_Collector_Title
{td}
{td:class=methodParamDesc}Description of the cost object. Prefixed with TBA in system.
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Total
{td}
{td:class=methodParamDesc}The authorized total or total institute budget
{td}
{tr}
{tr}
{td:class=methodParamType}Sponsor_key
{td}
{td:class=methodParamName}Sponsor_key
{td}
{td:class=methodParamDesc}The source of funding
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The cost object effective date
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The cost object expiration date
{td}
{tr}
{tr}
{td:class=methodParamType}Cost_Collector_key
{td}
{td:class=methodParamName}Cost_Collector_parent_key
{td}
{td:class=methodParamDesc}The parent of this cost object
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}CO_EXISTS
{td}
{td:class=methodErrorDesc}Cost Collector already exists in scenario
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_CO_PARENT
{td}
{td:class=methodErrorDesc}Parent CO does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:addTBHApptSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addTBHApptSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Adds a person that does not exist into the scenario as a speculation
{td}
{tr}
{tr}
{th:class=h|rowspan=6}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Person
{td}
{td:class=methodParamDesc}Name/Descriptor for the person
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Position_Title
{td}
{td:class=methodParamDesc}The name of the position
{td}
{tr}
{tr}
{td:class=methodParamType}Appt_Type
{td}
{td:class=methodParamName}Appt_Type
{td}
{td:class=methodParamDesc}The Employee Category used for overhead calculations
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start Date for the appointment
{td}
{tr}
{tr}
{td:class=methodParamType}End
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End Date for the appointment
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Period_Salary
{td}
{td:class=methodParamDesc}How much will this person/appt. be paid for the time frame specified?
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropTBACOSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}dropTBACOSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Removes a TBA CO from a scenario 
{td}
{tr}
{tr}
{th:class=h|rowspan=8}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Speculation_ID
{td}
{td:class=methodParamDesc}The unique identifier for the Speculation
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_SPEC_MATCH
{td}
{td:class=methodErrorDesc}No Match for the speculation_id
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropTBHApptSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}dropTBHApptSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Removes a TBH person from the scenario
{td}
{tr}
{tr}
{th:class=h|rowspan=6}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Speculation_ID
{td}
{td:class=methodParamDesc}The unique identifier for the speculation
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_SPEC_MATCH
{td}
{td:class=methodErrorDesc}Speculation does not exist in scenario
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:updateTBACOSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateTBACOSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Updates CO metadata for a TBA cost object
{td}
{tr}
{tr}
{th:class=h|rowspan=9}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Speculation_ID
{td}
{td:class=methodParamDesc}The unique identifier for the Speculation
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_Collector_Key
{td}
{td:class=methodParamDesc}The unique identifier for the CO
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_Collector_Title
{td}
{td:class=methodParamDesc}Description of the cost object. Prefixed with TBA in system.
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Total
{td}
{td:class=methodParamDesc}The authorized total or total institute budget
{td}
{tr}
{tr}
{td:class=methodParamType}Sponsor_key
{td}
{td:class=methodParamName}Sponsor_key
{td}
{td:class=methodParamDesc}The source of funding
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The cost object effective date
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The cost object expiration date
{td}
{tr}
{tr}
{td:class=methodParamType}Cost_Collector_key
{td}
{td:class=methodParamName}Cost_Collector_parent_key
{td}
{td:class=methodParamDesc}The parent of this cost object
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_SPEC_MATCH
{td}
{td:class=methodErrorDesc}Speculation does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_CO_PARENT
{td}
{td:class=methodErrorDesc}Parent CO does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:updateTBHApptSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateTBHApptSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Update metadata for a particular appointment
{td}
{tr}
{tr}
{th:class=h|rowspan=8}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Speculation_ID
{td}
{td:class=methodParamDesc}Unique identifier for the speculation
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Person
{td}
{td:class=methodParamDesc}Name/Descriptor for the person
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Position_Title
{td}
{td:class=methodParamDesc}The name of the position
{td}
{tr}
{tr}
{td:class=methodParamType}Appt_Type
{td}
{td:class=methodParamName}Appt_Type
{td}
{td:class=methodParamDesc}The Employee Category used for overhead calculations
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start Date for the appointment
{td}
{tr}
{tr}
{td:class=methodParamType}End
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End Date for the appointment
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Period_Salary
{td}
{td:class=methodParamDesc}How much will this person/appt. be paid for the time frame specified?
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_SPEC_MATCH
{td}
{td:class=methodErrorDesc}No match for the speculation in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]



{anchor:updateCOSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateCOSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Alter the metadata on a real CO. Only one alteration on a CO is allowed, but alterations can be over-ridden 
{td}
{tr}
{tr}
{th:class=h|rowspan=7}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_Collector_Key
{td}
{td:class=methodParamDesc}The unique identifier for the CO
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Authorized_Total
{td}
{td:class=methodParamDesc}The authorized total or total institute budget
{td}
{tr}
{tr}
{td:class=methodParamType}Sponsor_key
{td}
{td:class=methodParamName}Sponsor_key
{td}
{td:class=methodParamDesc}The source of funding
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The cost object effective date
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The cost object expiration date
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_CO_MATCH
{td}
{td:class=methodErrorDesc}Cost Object does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:updateApptSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateApptSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Alters the metadata associated with a particular real appointment. Only one set of alterations is allowed, but a) additional appointments can be added via the TBH mechanisma and b) appointment changes can be overriden
{td}
{tr}
{tr}
{th:class=h|rowspan=8}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Personell_key
{td}
{td:class=methodParamDesc}Unique identfier for the appointment
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Position_Title
{td}
{td:class=methodParamDesc}The name of the position
{td}
{tr}
{tr}
{td:class=methodParamType}Appt_Type
{td}
{td:class=methodParamName}Appt_Type
{td}
{td:class=methodParamDesc}The Employee Category used for overhead calculations
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start Date for the appointment
{td}
{tr}
{tr}
{td:class=methodParamType}End
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End Date for the appointment
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Period_Salary
{td}
{td:class=methodParamDesc}How much will this person/appt. be paid for the time frame specified?
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_APPT_MATCH
{td}
{td:class=methodErrorDesc}Appt does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:addAdjSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addAdjSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Adds an adjustment to a CO/GL combination
{td}
{tr}
{tr}
{th:class=h|rowspan=8}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}cost_collector_key
{td}
{td:class=methodParamDesc}Unique identfier for the cost object
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}gl_account_key
{td}
{td:class=methodParamDesc}Unique identifer for the gl account
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start Date for the appointment
{td}
{tr}
{tr}
{td:class=methodParamType}End
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End Date for the appointment
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Adjustment_Percent
{td}
{td:class=methodParamDesc}The positive of negative adjustment to be applied to this gl
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_CO_MATCH
{td}
{td:class=methodErrorDesc}CO does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_IMPACT
{td}
{td:class=methodErrorDesc}Warning: CO does not currently have entries for the associated GLs
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropAdjSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}dropAdjSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Drop adjustment spec from the scenario
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Speculation_ID
{td}
{td:class=methodParamDesc}Unique identfier for the speculation
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_SPEC_MATCH
{td}
{td:class=methodErrorDesc} Speculation does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:addCORateSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addCORateSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Add a new rate onto an existing (Real or TBA) CO. Includes overriding.
{td}
{tr}
{tr}
{th:class=h|rowspan=9}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}cost_collector_key
{td}
{td:class=methodParamDesc}Unique identfier for the cost object
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}gl_account_key
{td}
{td:class=methodParamDesc}Unique identifer for the gl account
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start Date for the appointment
{td}
{tr}
{tr}
{td:class=methodParamType}End
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End Date for the appointment
{td}
{tr}
{tr}
{td:class=methodParamType}RATE_NAME
{td}
{td:class=methodParamName}Rate_name
{td}
{td:class=methodParamDesc}The name of the rate (from the list of available rates)
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Rate_Percent
{td}
{td:class=methodParamDesc}The positive of negative adjustment to be applied to this gl
{td}
{tr}
{tr}
{td:class=methodParamType}GL_Account
{td}
{td:class=methodParamName}Source_GL
{td}
{td:class=methodParamDesc}The source GL for overhead amounts to be calcluated from
{td}
{tr}
{tr}
{td:class=methodParamType}GL_Account
{td}
{td:class=methodParamName}Target_GL
{td}
{td:class=methodParamDesc}The target GL where the overhead surcharge lands
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=5}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_CO_MATCH
{td}
{td:class=methodErrorDesc}CO does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_GL_MATCH
{td}
{td:class=methodErrorDesc} Either the source or target GLs do not exist
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}RATE_EXISTS
{td}
{td:class=methodErrorDesc}You are attempting to edit a rate that already exists on this Scenario/CO/GL
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:updateCORateSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateCORateSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Adds an adjustment to a CO/GL combination
{td}
{tr}
{tr}
{th:class=h|rowspan=10}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Speculation_ID
{td}
{td:class=methodParamDesc}Unique identfier for the speculation to adjust
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}cost_collector_key
{td}
{td:class=methodParamDesc}Unique identfier for the cost object
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}gl_account_key
{td}
{td:class=methodParamDesc}Unique identifer for the gl account
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start Date for the appointment
{td}
{tr}
{tr}
{td:class=methodParamType}End
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End Date for the appointment
{td}
{tr}
{tr}
{td:class=methodParamType}RATE_NAME
{td}
{td:class=methodParamName}Rate_name
{td}
{td:class=methodParamDesc}The name of the rate (from the list of available rates)
{td}
{tr}
{tr}
{td:class=methodParamType}Double
{td}
{td:class=methodParamName}Rate_Percent
{td}
{td:class=methodParamDesc}The positive of negative adjustment to be applied to this gl
{td}
{tr}
{tr}
{td:class=methodParamType}GL_Account
{td}
{td:class=methodParamName}Source_GL
{td}
{td:class=methodParamDesc}The source GL for overhead amounts to be calcluated from
{td}
{tr}
{tr}
{td:class=methodParamType}GL_Account
{td}
{td:class=methodParamName}Target_GL
{td}
{td:class=methodParamDesc}The target GL where the overhead surcharge lands
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_CO_MATCH
{td}
{td:class=methodErrorDesc}CO does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_GL_MATCH
{td}
{td:class=methodErrorDesc} Either the source or target GLs do not exist
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}RATE_EXISTS
{td}
{td:class=methodErrorDesc}You are attempting to edit a rate that already exists on this Scenario/CO/GL
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropCORateSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}dropCORateSpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Drop a Speculative rate from the system
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Speculation_ID
{td}
{td:class=methodParamDesc}Unique identfier for the speculation to adjust
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_SPEC_MATCH
{td}
{td:class=methodErrorDesc}Speculation does not exist in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:updateFTESpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateFTESpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Update the FTE breakdown for a person
{td}
{tr}
{tr}
{th:class=h|rowspan=5}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Personnel_key
{td}
{td:class=methodParamDesc}Unique identfier for the person
{td}
{tr}
{tr}
{td:class=methodParamType}MonthYear
{td}
{td:class=methodParamName}Start_Period
{td}
{td:class=methodParamDesc}Start period for changes
{td}
{tr}
{tr}
{td:class=methodParamType}MonthYear
{td}
{td:class=methodParamName}End_Period
{td}
{td:class=methodParamDesc}End Period for changes
{td}
{tr}

{tr}
{td:class=methodParamType}[fteEntryType|fteEntryTypeInfo Structure]
{td}
{td:class=methodParamName}FTE_Schedule
{td}
{td:class=methodParamDesc}For any given person |personnel_key|fiscal_period| FTE %|
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=5}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_APPT_MATCH
{td}
{td:class=methodErrorDesc}Appointment not in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}DATE_MISMATCH
{td}
{td:class=methodErrorDesc}Date in the API request does not match date in the FTE_Schedule
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}DATE_APPT_MISMATCH
{td}
{td:class=methodErrorDesc}Date outside of Appt date ranges
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:updateVacationSpec}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateFTESpec
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Update the Vacation day breakdown for a person
{td}
{tr}
{tr}
{th:class=h|rowspan=5}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Personnel_key
{td}
{td:class=methodParamDesc}Unique identfier for the person
{td}
{tr}
{tr}
{td:class=methodParamType}MonthYear
{td}
{td:class=methodParamName}Start_Period
{td}
{td:class=methodParamDesc}Start period for changes
{td}
{tr}
{tr}
{td:class=methodParamType}MonthYear
{td}
{td:class=methodParamName}End_Period
{td}
{td:class=methodParamDesc}End Period for changes
{td}
{tr}
{tr}
{td:class=methodParamType}[fteEntryType|fteEntryTypeInfo Structure]
{td}
{td:class=methodParamName}FTE_Schedule
{td}
{td:class=methodParamDesc}For any given person |personnel_key|fiscal_period| # of vacation days|
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=5}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_APPT_MATCH
{td}
{td:class=methodErrorDesc}Appointment not in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}DATE_MISMATCH
{td}
{td:class=methodErrorDesc}Date in the API request does not match date in the FTE_Schedule
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}DATE_APPT_MISMATCH
{td}
{td:class=methodErrorDesc}Date outside of Appt date ranges
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]


{anchor:loadExpenseAllocSpecfromExternal}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}loadExpenseAllocSpecfromExternal
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Loads the expense allocation information from a particular external system (SAP,COEUS) 
{td}
{tr}
{tr}
{th:class=h|rowspan=7}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_Collector_Key
{td}
{td:class=methodParamDesc}The unique identifier for the CO
{td}
{tr}
{tr}
{td:class=methodParamType}Source_System
{td}
{td:class=methodParamName}Source_System
{td}
{td:class=methodParamDesc}Either SAP or COEUS to represent the source system
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Plan_Version
{td}
{td:class=methodParamDesc}Either the SAP plan version to load, or COP for Coeus Proposal Budget or COA for Coeus Award Budget
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The start date for the load
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The cend date for the load
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}Replace
{td}
{td:class=methodParamDesc}If true, replace the expense allocations in the system. Otherwise attempt to add them to existing structure. Not replacing may result in double entries.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_CO_MATCH
{td}
{td:class=methodErrorDesc}Cost Object does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_PLAN_MATCH
{td}
{td:class=methodErrorDesc}No Plan exists of the identified type in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:loadDistAllocSpecfromExternal}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}loadDistAllocSpecfromExternal
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Loads the labor distribution allocation information from a particular external system (SAP,COEUS) 
{td}
{tr}
{tr}
{th:class=h|rowspan=7}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_Key
{td}
{td:class=methodParamDesc}The unique identifier for the Scenario
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_Collector_Key
{td}
{td:class=methodParamDesc}The unique identifier for the CO
{td}
{tr}
{tr}
{td:class=methodParamType}Source_System
{td}
{td:class=methodParamName}Source_System
{td}
{td:class=methodParamDesc}Either SAP or COEUS to represent the source system
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Plan_Version
{td}
{td:class=methodParamDesc}Either the SAP plan version to load, or COP for Coeus Proposal Budget or COA for Coeus Award Budget
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The start date for the load
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The cend date for the load
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}Replace
{td}
{td:class=methodParamDesc}If true, replace the expense allocations in the system. Otherwise attempt to add them to existing structure. Not replacing may result in double entries.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmMetaResultType|confirmSpeculationResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status of the task along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_CO_MATCH
{td}
{td:class=methodErrorDesc}Cost Object does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No Match for the scenario key
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_PLAN_MATCH
{td}
{td:class=methodErrorDesc}No Plan exists of the identified type in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot define scenarios in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]