WIP
RAFT Service
Name
RAFT Service
Version
Dev ([0.1])
[Release Notes]
Description
The RAFT Service is focused on providing a consistent interface for:
- Searching for Cost Objects and Cost Object Collections
- Viewing Budget, Actual, Commitments, and Forecast information for Cost Object Collections
- Creating What If scenarios as collections of speculations
- Viewing the projected impacts of those speculations
- Generating and viewing reports on this information
References
see RAFT Requirements Documentation (RAFT-*)
Operations
Domain Operations
getModelTypes
searchbyParm(&parm)
searchCollectionbyParm(&collection,&parm)
Listinfo about user sets
getSearchLists
listSupervisor(#count)
listAddressee(#count)
listSponsor(#count)
listPrimeSponsor(#count)
listId(#count)
listWorksets(#count)
listFlaggedCostObjects(#count)
addComment
deleteComment
updateComment
getComment
getCommentsforObject
addWorksetAuthorizations
dropWorksetAuthorizations
viewAuthorizationsforUser
viewAuthorizationsforObject
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
Search">Search
Method
searchByParm
Description
Searches the cost collector set and returns matches based on the passed in parameters
Parameters
Array
Parm
An associative array of key value pairs for search parameters
Return
[coResultType]
Returns cost object details for all of the matching cost objects.
Errors
NO_MATCH
No cost objects found
MAX_COUNT
Number of objects returned >250
Capabilities
Use Cases
See RAFT-Search
Comments/Feedback
Method
searchCollectionByParm
Description
Performs a collection search based off the identified parameters. Collection searches cannot be used to define sets
Parameters
String
Collection
Which collection will be searched, one of supervisor, sponsor, fund_center, profit_center, workset
Array
Parm
An associative array of key value pairs for search parameters
Return
[collectionResultType]
Returns cost object details for all of the matching cost objects wrapped in a metadata header for the collection.
Errors
NO_MATCH
No cost objects found
MAX_COUNT
Count of returned objects (including the collection header) exceeds 250 and cannot be displayed.
Capabilities
Use Cases
Comments/Feedback
Method
getSearchLists
Description
Returns the default collection of selection items for each of the search lists.
Parameters
Array
Parm
An associative array of key value pairs for search parameters
Return
[listSetResultType]
Master structure for list data that includes supervisor, addressee, sponsor, prime_sponsor, workset. The set always returns a max of 150 entries. To extend beyond that requires the user to use the autocomplete methods.
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listSupervisor
Description
Returns the list of supervisors accessible by the requesting user.
Parameters
Integer
Count
The number of entries to return.
Return
[listResultType]
Array list of key, value pairs
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listAddressee
Description
Returns the list of adressees accessible by the requesting user.
Parameters
Integer
Count
The number of entries to return.
Return
[listResultType]
Array list of key, value pairs
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listSponsor
Description
Returns the list of sponsors accessible by the requesting user.
Parameters
Integer
Count
The number of entries to return.
Return
[listResultType]
Array list of key, value pairs
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listPrimeSponsor
Description
Returns the list of prime sponsors accessible by the requesting user.
Parameters
Integer
Count
The number of entries to return.
Return
[listResultType]
Array list of key, value pairs
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listWorkset
Description
Returns the list of worksets accessible by the requesting user.
Parameters
Integer
Count
The number of entries to return.
Return
[listResultType]
Array list of key, value pairs
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listId
Description
Returns the list of cost object ids and titles accessible by the requesting user.
Parameters
Integer
Count
The number of entries to return.
Return
[listResultType]
Array list of key, value pairs
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listFlaggedCostObjects
Description
Returns the list of flagged cost objects flagged by the requesting user.
Parameters
Integer
Count
The number of entries to return.
Return
[coResultType]
Returns cost object details for all of the matching cost objects
Errors
Capabilities
Use Cases
Comments/Feedback
Comment">Comment
Method
addComment
Description
Adds a comment to the identified object
Parameters
Comment_Type
Comment_Type
Denotes whether a particular comment is public or private.
Ref_Type
Ref_Type
Identifies what sort of speculation the reference is on (EXPENSE_RULE, APPT_RULE, APPT, CO, SCENARIO, WORKSET)
String
REF_ID
The object id for the associated item (cost_collector_key, etc.)
Return
[confirmResultType]
Returns status information and object id for the action (in this case, the comment)
Errors
EXISTS
Object already exists
NO_MATCH
Object identified by REF_ID does not exist
EMPTY
Comment body is empty
NO_AUTH
User does not have comment authorizations here.
Capabilities
Use Cases
Comments/Feedback
Method
deleteComment
Description
Sets the status for the identified comment to 'D', effectively removing the comment from display.
Parameters
Array
Parm
An associative array of key value pairs for search parameters
Return
[confirmResultType]
Returns the result status and objectId for the action.
Errors
NO_MATCH
No comment match found
NO_AUTH
User cannot delete this authorization.
Capabilities
Use Cases
Comments/Feedback
Method
getComment
Description
Requests the Comment from the system.
Parameters
String
Comment_Id
The specific comment to retreive
Return
[commentResultType]
Object containing the associated comments
Errors
NO_MATCH
No comment found
NO_AUTH
User does not have access to this comment
Capabilities
Use Cases
Comments/Feedback
Method
getCommentsforObject
Description
Returns all comments associated with the identified object
Parameters
String
REF_TYPE
The type of object to look up comments for
String
REF_ID
The Id for the object to look up comments for (cost_collector_key, personell_key, etc.)
Return
[commentResultType]
Object containing the associated comments. If there is no match than an empty structure is returned.
Errors
NO_MATCH
No object found
NO_AUTH
User does not have access to look at comments on this object.
Capabilities
Use Cases
Comments/Feedback
RAFT Authorizations">RAFT Authorizations
Method
addWorksetAuthorization
Description
Adds a particular authorization for a Workset to the system
Parameters
REF_TYPE
Object_Type
The type of object to be authorized (currently always WORKSET). The Object's Qualifier_Type
REF_KEY
Object_ID
The id of the object to be authorized. The Object Qualifier.
AUTH_TYPE
Authorization
What type of authorization to set
String
User
The kerb_name for the associated user
Return
[confirmResultType]
Returns status information and object id for the action (in this case, the comment)
Errors
EXISTS
Authorization already exists
NO_MATCH
Object identified by REF_KEY does not exist
NO_AUTH
User does not have authorizations to peform this action here.
Capabilities
Use Cases
Comments/Feedback
Method
dropWorksetAuthorization
Description
Removes a particular authorization for a Workset from the system
Parameters
String
Auth_Key
The authorization key to be removed
Return
[confirmResultType]
Returns status information and object id for the action
Errors
NO_MATCH
Authorization identified by AUTH_Key does not exist
EMPTY
Comment body is empty
NO_AUTH
User does not have authorizations to perform this action.
Capabilities
Use Cases
Comments/Feedback
Method
viewAuthorizationsforUser
Description
View the authorizations for this user
Parameters
String
User
The user to view the authorizations for. The kerb_name.
Return
[authResultType]
Returns all the authorizations for the user
Errors
NO_MATCH
No user found
Capabilities
Use Cases
Comments/Feedback
Method
viewAuthorizationsforObject
Description
Provide a breakdown of all of the authorizations for a particular object
Parameters
Ref_Type
Ref_Type
The type of object. The qualifier_type
String
REF_KEY
The unique identifier for the object (cost_collector_key, personnel_key, etc.)
Return
[authResultType]
Returns all authorizations for the associated object.
Errors
NO_MATCH
No cost objects found
NO_AUTH
User cannot view the associated authorizations
Capabilities
Use Cases
Comments/Feedback
Method
isAuthorized
Description
Can the given user perform the specified function
Parameters
String
User
An associative array of key value pairs for search parameters
REF_Type
REF_TYPE
The type of object to perform the action on. The Qualifier_Type
REF_Key
User
The key of the associated object (Cost_Collector_key, Personell_Key, etc.)
AUTH_TYPE
Action
The function the user is attempting to perform.
Return
[boolean]
Can the user perform the action identified by 'AUTH_TYPE' for the specified REF_TYPE/IDi (Y/N)
Errors
NO_MATCH
Cannot find the object to be accessed.
Capabilities
Use Cases
Comments/Feedback
CO Metadata">CO Metadata
Method
listBudgets
Description
Returns the list of budgets available for the specified Cost Object.
Parameters
String
Cost_Collector_key
The cost object to look up
Boolean
with_children
Include children accounts.
Return
[listResultType]
Array list of key, value pairs. In this case, key = budget version code, value = Description
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listWorksetScenarios
Description
Returns the list of Scenarios associated with this workset. This list is implicitly restricted to the scenarios that the accessing user has access to.
Parameters
String
Workset_Key
The id for this workset
Return
[listResultType]
Array list of key, value pairs. In this case, key = scenario ID, value = scenario name
Errors
Capabilities
Use Cases
Comments/Feedback
Method
listProjectPeriods
Description
Returns the list of Project Periods for this cost object
Parameters
String
Cost_collector_key
The identifier for this cost object
Return
[projectYearResultType]
Returns the project year date ranges associated with this cost object
Errors
Capabilities
Use Cases
Comments/Feedback
Method
updateProjectPeriod
Description
For the given project period, alter the start and end date.
Parameters
String
Cost_collector_key
The identifier for this cost object
String
Project_Period_Key
The identifier for this project period
Date
Start_Date
The start date for this project period
Date
End_Date
The end date for this project period
Return
[confirmResultType]
Returns the confirmation status along with the object reference.
Errors
NO_MATCH
No match for this project period/cost object
OVERLAP
Warning: Project period now overlaps another project period defined for this cost object
INVALID
Project period defined outside of start/final expiration date range for this cost object
Capabilities
Use Cases
Comments/Feedback
Method
addProjectPeriod
Description
Add project year to cost object
Parameters
String
Cost_collector_key
The identifier for this cost object
String
Project_Period_Key
The identifier for this project period
Date
Start_Date
The start date for this project period
Date
End_Date
The end date for this project period
Return
[confirmResultType]
Returns the confirmation status along with the object reference.
Errors
NO_MATCH
No match for this cost object
OVERLAP
Warning: Project period now overlaps another project period defined for this cost object
INVALID
Project period defined outside of start/final expiration date range for this cost object
Capabilities
Use Cases
Comments/Feedback
Method
dropProjectPeriod
Description
Delete project year from cost object
Parameters
String
Cost_collector_key
The identifier for this cost object
String
Project_Period_Key
The identifier for this project period
Return
[confirmResultType]
Returns the confirmation status along with the object reference.
Errors
NO_MATCH
No match for this cost object
Capabilities
Use Cases
Comments/Feedback
Method
validateProjectPeriods
Description
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
Parameters
String
Cost_collector_key
The identifier for this cost object
Return
[validateResultType]
Returns the validity status of the project periods on the cost object and identifies exceptions
Errors
NO_MATCH
No match for this cost object
Capabilities
Use Cases
Comments/Feedback
Method
normalizeProjectPeriods
Description
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
Parameters
String
Cost_collector_key
The identifier for this cost object
Return
[validateResultType]
Returns the validity status of the project periods on the cost object and identifies exceptions
Errors
NO_MATCH
No match for this cost object
INCOMPLETE
Warning: Project Period schedule does not cover the full date range for this CO (from effective through final expiration date)
Capabilities
Use Cases
Comments/Feedback
Reports">Reports
Reports">Reports
Method
listReports
Description
For a given context, list the available reports in that context
Parameters
REF_TYPE
REF_TYPE
The context. Workset, Scenario, Person, Cost Object, Allocation
String
REF_KEY
(optional) A unique identifier for a particular object. For object specific reports
Return
[reportListResultType]
Array list of reports. Returns the ID, Title, and Description for the report
Errors
NO_MATCH
Warning: No reports for specific ref_key found. Returning report list for the general context.
INVALID
Invalid REF_TYPE identified
Capabilities
Use Cases
Comments/Feedback
Method
executeReport
Description
Returns the result document for the report request
Parameters
String
Report_ID
The id for this report
FORMAT_TYPE
FORMAT_TYPE
The format type, one of: XLS,CSV,PDF,HTML,(addional options depend on the backend)
@PARM
PARM
Associative array of parameters
Return
[reportResultType]
Returns the resulting report object
Errors
ERROR
Report processing error (Error passed in body)
Capabilities
Use Cases
Comments/Feedback
Summary">Summary
Method
BvAQueryDay
Description
Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Expenses only.
Parameters
String
GL_Hierarchy
The Hierarchy of GL categories and accounts to use.
String
Budget_version
Which budget to use
String
Scenario_version
Which scenario to use
Cost_collector_key
Cost_collector_key
The identifier for the cost object
Date
Start_Date
The start date for the query window
Date
End_Date
The end_date for the query window
Boolean
with_children
Consolidate the results to include all associated children with the parent
String
Collection_type
When including children, use the following collection for the aggregation
String
Collection_key
When including children, use this particular collection key as the root of the consolidation tree
Return
[coSummaryResultType]
Flattened cube of summary financial information
Errors
NO_MATCH
Either the Cost object or collection key does not exist in the system
Capabilities
Use Cases
Comments/Feedback
Method
RvEQueryDay
Description
Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Revenue & Expenses.
Parameters
String
GL_Hierarchy
The Hierarchy of GL categories and accounts to use.
String
Budget_version
Which budget to use
String
Scenario_version
Which scenario to use
Cost_collector_key
Cost_collector_key
The identifier for the cost object
Date
Start_Date
The start date for the query window
Date
End_Date
The end_date for the query window
Boolean
with_children
Consolidate the results to include all associated children with the parent
String
Collection_type
When including children, use the following collection for the aggregation
String
Collection_key
When including children, use this particular collection key as the root of the consolidation tree
Return
[coSummaryResultType]
Flattened cube of summary financial information
Errors
NO_MATCH
Either the Cost object or collection key does not exist in the system
Capabilities
Use Cases
Comments/Feedback
Method
BvAQueryMonthly
Description
Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Expenses only. Monthly view
Parameters
String
GL_Hierarchy
The Hierarchy of GL categories and accounts to use.
String
Budget_version
Which budget to use
String
Scenario_version
Which scenario to use
Cost_collector_key
Cost_collector_key
The identifier for the cost object
String
Start_Period
The start period for the query window - format = YYYYMM
String
End_Period
The end_date for the query window - format = YYYYMM
Boolean
with_children
Consolidate the results to include all associated children with the parent
String
Collection_type
When including children, use the following collection for the aggregation
String
Collection_key
When including children, use this particular collection key as the root of the consolidation tree
Return
[coSummaryResultType]
Flattened cube of summary financial information
Errors
NO_MATCH
Either the Cost object or collection key does not exist in the system
Capabilities
Use Cases
Comments/Feedback
Method
RvEQueryMonth
Description
Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Revenue & Expenses. Monthly view
Parameters
String
GL_Hierarchy
The Hierarchy of GL categories and accounts to use.
String
Budget_version
Which budget to use
String
Scenario_version
Which scenario to use
Cost_collector_key
Cost_collector_key
The identifier for the cost object
String
Start_Period
The start period for the query window - format = YYYYMM
String
End_Period
The end period for the query window - format = YYYYMM
Boolean
with_children
Consolidate the results to include all associated children with the parent
String
Collection_type
When including children, use the following collection for the aggregation
String
Collection_key
When including children, use this particular collection key as the root of the consolidation tree
Return
[coSummaryResultType]
Flattened cube of summary financial information
Errors
NO_MATCH
Either the Cost object or collection key does not exist in the system
Capabilities
Use Cases
Comments/Feedback
Drill-down">Drill-down
Method
queryActualsSumm
Description
Returns a summary of the totals by GL/CO
Parameters
String
GL_HIER
The gl_hierarchy to use
String
GL_Level
The GL Category or Account to show items from
String
CoArray
The cost_collector_key
Zend_Date
Start_Date
Start date for the query window
Zend_Date
End_Date
End_Date for the query window
Boolean
with_children
Include children?
Integer
Start
Start at record #
Integer
End
Return up to and including record #
String
filter
Return records with string in the body
Array
ordercol
The sorting for the structure
Return
[actSummResultType]
Returns the matching collection of actuals records
Errors
NO_RECORDS
No records found
Capabilities
Use Cases
Comments/Feedback
Method
queryActualsPODetail
Description
Returns matching actuals expense Records (rename?)
Parameters
String
GL_HIER
The gl_hierarchy to use
String
GL_Level
The GL Category or Account to show items from
String
CoArray
The cost_collector_key
Zend_Date
Start_Date
Start date for the query window
Zend_Date
End_Date
End_Date for the query window
Boolean
with_children
Include children?
Integer
Start
Start at record #
Integer
End
Return up to and including record #
String
filter
Return records with string in the body
Array
ordercol
The sorting for the structure
Return
[actPOResultType]
Returns the matching collection of actuals records
Errors
NO_RECORDS
No records found
Capabilities
Use Cases
Comments/Feedback
Method
queryActualsPEDetail
Description
Returns matching actuals personnel Records (rename?)
Parameters
String
GL_HIER
The gl_hierarchy to use
String
GL_Level
The GL Category or Account to show items from
String
CoArray
The cost_collector_key
Zend_Date
Start_Date
Start date for the query window
Zend_Date
End_Date
End_Date for the query window
Boolean
with_children
Include children?
Integer
Start
Start at record #
Integer
End
Return up to and including record #
String
filter
Return records with string in the body
Array
ordercol
The sorting for the structure
Return
[actPEResultType]
Returns the matching collection of actuals records
Errors
NO_RECORDS
No records found
Capabilities
Use Cases
Comments/Feedback
Method
queryBudgetDetail
Description
Returns matching budget records (SAP = GL Level, COEUS = line item level)
Parameters
String
GL_HIER
The gl_hierarchy to use
String
GL_Level
The GL Category or Account to show items from
String
CoArray
The cost_collector_key
String
Budget Version
The plan version for the associated budget
Zend_Date
Start_Date
Start date for the query window
Zend_Date
End_Date
End_Date for the query window
Boolean
with_children
Include children?
Integer
Start
Start at record #
Integer
End
Return up to and including record #
String
filter
Return records with string in the body
Array
ordercol
The sorting for the structure
Return
[budResultType]
Returns the matching collection of actuals records
Errors
NO_RECORDS
No records found
Capabilities
Use Cases
Comments/Feedback
Method
queryCommitmentsSumm
Description
Returns a summary of the commitments information by gl
Parameters
String
GL_HIER
The gl_hierarchy to use
String
GL_Level
The GL Category or Account to show items from
String
CoArray
The cost_collector_key
Zend_Date
Start_Date
Start date for the query window
Zend_Date
End_Date
End_Date for the query window
Boolean
with_children
Include children?
Integer
Start
Start at record #
Integer
End
Return up to and including record #
String
filter
Return records with string in the body
Array
ordercol
The sorting for the structure
Return
[commSummResultType]
Returns the matching collection of actuals records
Errors
NO_RECORDS
No records found
Capabilities
Use Cases
Comments/Feedback
Method
queryCommitmentsPODetail
Description
Returns matching commitments expense Records (rename?)
Parameters
String
GL_HIER
The gl_hierarchy to use
String
GL_Level
The GL Category or Account to show items from
String
CoArray
The cost_collector_key
Zend_Date
Start_Date
Start date for the query window
Zend_Date
End_Date
End_Date for the query window
Boolean
with_children
Include children?
Integer
Start
Start at record #
Integer
End
Return up to and including record #
String
filter
Return records with string in the body
Array
ordercol
The sorting for the structure
Return
[commPOResultType]
Returns the matching collection of actuals records
Errors
NO_RECORDS
No records found
Capabilities
Use Cases
Comments/Feedback
Method
queryCommitmentsPEDetail
Description
Returns matching commitments personnel Records (rename?)
Parameters
String
GL_HIER
The gl_hierarchy to use
String
GL_Level
The GL Category or Account to show items from
String
CoArray
The cost_collector_key
Zend_Date
Start_Date
Start date for the query window
Zend_Date
End_Date
End_Date for the query window
Boolean
with_children
Include children?
Integer
Start
Start at record #
Integer
End
Return up to and including record #
String
filter
Return records with string in the body
Array
ordercol
The sorting for the structure
Return
[commPEResultType]
Returns the matching collection of actuals records
Errors
NO_RECORDS
No records found
Capabilities
Use Cases
Comments/Feedback
Method
queryForecastSumm
Description
Returns a summary of the forecast(scenario) information by gl
Parameters
String
GL_HIER
The gl_hierarchy to use
String
GL_Level
The GL Category or Account to show items from
String
CoArray
The cost_collector_key
String
Scenario_key
The scenario key. Defaults to the Common scenario key (COMMON)
Zend_Date
Start_Date
Start date for the query window
Zend_Date
End_Date
End_Date for the query window
Boolean
with_children
Include children?
Integer
Start
Start at record #
Integer
End
Return up to and including record #
String
filter
Return records with string in the body
Array
ordercol
The sorting for the structure
Return
[forSummResultType]
Returns the matching collection of actuals records
Errors
NO_RECORDS
No records found
Capabilities
Use Cases
Comments/Feedback
Method
queryForecastPODetail
Description
Returns matching forecast (scenario) expense Records (rename?)
Parameters
String
GL_HIER
The gl_hierarchy to use
String
GL_Level
The GL Category or Account to show items from
String
CoArray
The cost_collector_key
String
Scenario_key
The scenario key. Defaults to the Common scenario key (COMMON)
Zend_Date
Start_Date
Start date for the query window
Zend_Date
End_Date
End_Date for the query window
Boolean
with_children
Include children?
Integer
Start
Start at record #
Integer
End
Return up to and including record #
String
filter
Return records with string in the body
Array
ordercol
The sorting for the structure
Return
[commPOResultType]
Returns the matching collection of actuals records
Errors
NO_RECORDS
No records found
Capabilities
Use Cases
Comments/Feedback
Method
queryForecastPEDetail
Description
Returns matching forecast (scenario) personnel Records (rename?)
Parameters
String
GL_HIER
The gl_hierarchy to use
String
GL_Level
The GL Category or Account to show items from
String
CoArray
The cost_collector_key
String
Scenario_key
The scenario key. Defaults to the Common scenario key (COMMON)
Zend_Date
Start_Date
Start date for the query window
Zend_Date
End_Date
End_Date for the query window
Boolean
with_children
Include children?
Integer
Start
Start at record #
Integer
End
Return up to and including record #
String
filter
Return records with string in the body
Array
ordercol
The sorting for the structure
Return
[commPEResultType]
Returns the matching collection of actuals records
Errors
NO_RECORDS
No records found
Capabilities
Use Cases
Comments/Feedback
Workset Management">Workset Management
Workset Management
Method
createWorkset
Description
Define a new, empty, workset
Parameters
String
Workset_key
The short string identifying the workset
String
Workset_Title
The name of the workset
longText
Workset_Desc
Long description of this workset
Return
[confirmResultType]
Returns the confirmation status along with the object reference
Errors
EXISTS
Workset with this workset key already exists
Capabilities
Use Cases
Comments/Feedback
Method
createWorkset
Description
Drop an existing workset
Parameters
String
Workset_key
The short string identifying the workset
CONSTRAINT_TYPE
Constraint type
Identifies whether or not to remove this workset from any parent workset rules
Return
[confirmResultType]
Returns the confirmation status along with the object reference
Errors
NO_MATCH
No workset with this key exists in the system
HAS_CHILDREN
Workset has associated child objects that must be removed first
NO_AUTH
User can not perform this action
Capabilities
Use Cases
Comments/Feedback
Method
archiveWorkset
Description
Archive an existing workset
Parameters
String
Workset_key
The short string identifying the workset
CONSTRAINT_TYPE
Constraint type
Identifies whether or not to archive all children worksets as well
Return
[confirmResultType]
Returns the confirmation status along with the object reference
Errors
NO_MATCH
No workset with this key exists in the system
NO_AUTH
User can not perform this action
PARENT_REQUIRES
This workset is required by another workset that has not been archived
Capabilities
Use Cases
Comments/Feedback
Method
listWorksets
Description
Show details for all worksets accessible by this person
Parameters
Return
[worksetSummaryResultType]
Returns all worksets accessible by the current user
Errors
Capabilities
Use Cases
Comments/Feedback
Method
showWorkset
Description
Returns structure containing all cost objects, people, and scenarios owned by this workset
Parameters
String
Workset_key
The unique identifier for this workset
Return
[worksetDetailResultType]
Returns the objects contained by this workset
Errors
NO_MATCH
No workset with this key exists in the system
Capabilities
Use Cases
Comments/Feedback
Method
addWorksetObjects
Description
Adds cost objects or people to the workset
Parameters
String
Workset_key
The unique identifier for this workset
REF_TYPE
REF_TYPE
The object type to add
Array
REF_KEY
The unique identifiers of object_type to add
Return
[confirmResultType]
Returns the completion status of the identified task along with the associated references
Errors
MISSING
Certain objects identified do not exist in the system
Capabilities
Use Cases
Comments/Feedback
Method
delWorksetObjects
Description
Removes cost objects or people from the workset
Parameters
String
Workset_key
The unique identifier for this workset
REF_TYPE
REF_TYPE
The object type to drop
Array
REF_KEY
The unique identifiers of the object_type to drop
Return
[confirmResultType]
Returns the completion status of the identified task along with the associated references
Errors
MISSING
Certain objects identified do not exist in the system
Capabilities
Use Cases
Comments/Feedback
Method
listWorksetObjects
Description
Show the objects in the workset
Parameters
String
Workset_key
The unique identifier for this workset
REF_TYPE
REF_TYPE
(optional) The object type to restrict by
Return
[confirmResultType]
Returns a structure containing the list of objects, by type, in the workset
Errors
NO_MATCH
No such workset in system
EMPTY
Contains no child objects
NO_AUTH
User does not have access to workset objects
Capabilities
Use Cases
Comments/Feedback
Method
addWorksetRule
Description
Removes cost objects or people from the workset
Parameters
String
Workset_key
The unique identifier for this workset
longText
criteria
Basically, a where clause sql snippet
Return
[confirmResultType]
Returns the completion status of the identified task along with the associated references
Errors
MISSING
Rule has no matches in the system currently
Capabilities
Use Cases
Comments/Feedback
Method
dropWorksetRule
Description
Removes cost objects or people from the workset
Parameters
String
Workset_key
The unique identifier for this workset
Return
[confirmResultType]
Returns the completion status of the identified task along with the associated references
Errors
NO_MATCH
Rule does not exist in system
Capabilities
Use Cases
Comments/Feedback
Method
showWorksetRules
Description
Shows the definition rules in place for the specified workset
Parameters
String
Workset_key
The unique identifier for this workset
Return
[worksetRulesResultType]
Returns the list of defined rules in the system.
Errors
NO_MATCH
Workset does not exist in system
NO_AUTH
User does not have access to objects in this workset
INCORRECT_TYPE
This workset type does not have rules
Capabilities
Use Cases
Comments/Feedback
Method
updateWorksetfromRules
Description
Processes all of the associated workset rules, logging the changes to the change_log
Parameters
String
Workset_key
The unique identifier for this workset
Return
[confirmResultType]
Returns the completion status of the identified task along with the associated references
Errors
NO_MATCH
Rule does not exist in system
NO_CHANGE
No objects added or removed from the workset
Capabilities
Use Cases
Comments/Feedback
Method
convertWorksettoStatic
Description
Converts a workset from dynamic (rules-based) to static
Parameters
String
Workset_key
The unique identifier for this workset
Return
[confirmResultType]
Returns the completion status of the identified task along with the associated references
Errors
NO_MATCH
Rule does not exist in system
NO_AUTH
User cannot perform this action
INCORRECT_TYPE
Workset is already static
Capabilities
Use Cases
Comments/Feedback
Method
showWorksetChanges}
Description
Pull the last set of changes on this workset from the change_log. The change_log will return any changes from the user's last access date.
Parameters
String
Workset_key
The unique identifier for this workset
Return
[changeResultType]
Returns the list of object changes to this workset
Errors
NO_MATCH
Workset does not exist in system
NO_CHANGE
No objects added or removed from the workset
Capabilities
Use Cases
Comments/Feedback
Method
showWorksetAccessChanges}
Description
Pull the last set of authorization changes on this workset from the change_log. The change_log will return any changes from the user's last access date.
Parameters
String
Workset_key
The unique identifier for this workset
Return
[changeResultType]
Returns the list of access changes to this workset
Errors
NO_MATCH
Workset does not exist in system
NO_CHANGE
No objects added or removed from the workset
Capabilities
Use Cases
Comments/Feedback
Method
showWorksetBalanceExceptions}
Description
Show the list of cost objects whose balance < 0 currently or are expected to be < 0 on the project end date.
Parameters
String
Workset_key
The unique identifier for this workset
Return
[changeResultType]
Returns the list of balance exceptions on this workset
Errors
NO_MATCH
Workset does not exist in system
NO_CHANGE
No issues identified
Capabilities
Use Cases
Comments/Feedback
Method
showWorksetCOSummary}
Description
Show summary information about the COs in the workset
Parameters
String
Workset_Key
The unique identifier for this workset
Return
[worksetCOSummaryResultType]
Returns a summary of cost objects in the workset
Errors
NO_MATCH
Workset does not exist in system
NO_AUTH
User cannot access workset information
Capabilities
Use Cases
Comments/Feedback
Method
showWorksetApptSummary}
Description
Shows a summary of People/Appt information in the workset
Parameters
String
Workset_key
The unique identifier for this workset
Return
[worksetApptSummaryResultType]
Returns a summary of people/appts in the workset
Errors
NO_MATCH
Workset does not exist in system
NO_AUTH
User cannot access objects in this workset
Capabilities
Use Cases
Comments/Feedback
Method
showWorksetScenarioSummary}
Description
Show the list of defined of defined Scenarios in the workset
Parameters
String
Workset_key
The unique identifier for this workset
Return
[worksetScenarioResultType]
Returns the list of scenarios in the workset
Errors
NO_MATCH
Workset does not exist in system
NO_AUTH
User cannot access objects in the workset
Capabilities
Use Cases
Comments/Feedback
Scenario Management">Scenario Management
Scenario Management
Method
showCOAttributes}
Description
For a given Cost Object Definition, show all of the speculative adjustments on that Cost Object
Parameters
String
Cost_Collector_key
The unique identifier for the cost object
String
Scenario_Key
The unique identifier for this scenario
Return
[coMetaResultType]
For the given cost object, return the final cost object including all adjustments
Errors
NO_MATCH
Scenario or CO does not exist in system
NO_AUTH
User cannot access objects in the scenario
Capabilities
Use Cases
Comments/Feedback
Method
showApptAttributes}
Description
For a given Person/Appt Definition, show all of the speculative adjustments on that Person/Appt
Parameters
String
Personnel_key
The unique identifier for the cost object
String
Scenario_Key
The unique identifier for this scenario
Return
[apptMetaResultType]
For the given person/Appt, return the final person/appt including all adjustments
Errors
NO_MATCH
Scenario or Appt does not exist in system
NO_AUTH
User cannot access objects in the scenario
Capabilities
Use Cases
Comments/Feedback
Method
showScenarioOverview}
Description
Provide a top level-overview of this scenario including: Pertinent people and expenses for CO and balances
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Return
[scenarioOverviewMetaResultType]
Provides a high-level overview of the scenario, limited by the associated authorizations
Errors
NO_MATCH
Scenario does not exist in system
NO_AUTH
User cannot access objects in the scenario
Capabilities
Use Cases
Comments/Feedback
Method
showScenarioFinImpact}
Description
Shows a CO level summary of the cost object
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Return
[scenarioFinancialImpactMetaResultType]
Provides a high-level of the CO financial impact information
Errors
NO_MATCH
Scenario does not exist in system
NO_AUTH
User cannot access objects in the scenario
Capabilities
Use Cases
Comments/Feedback
Method
showScenarioPersonImpact}
Description
Provide a summary view of the personnel Impact of this Scenario
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Return
[scenarioOverviewMetaResultType]
Provides a high-level overview of the personnel resources and associated financial impact, limited by the associated authorizations
Errors
NO_MATCH
Scenario does not exist in system
NO_AUTH
User cannot access objects in the scenario
Capabilities
Use Cases
Comments/Feedback
Method
showScenarioSpeculations}
Description
Provide a change log showing all of the speculations in the system
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Return
[speclistMetaResultType]
Returns a structure of speculations by type. Only includes type/title/descriptions
Errors
NO_MATCH
Scenario does not exist in system
NO_AUTH
User cannot access objects in the scenario
Capabilities
Use Cases
Comments/Feedback
Method
showScenarioExceptions}
Description
Provide a change log showing all of the validation exceptions for this scenario.
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Return
[scenarioExceptionMetaResultType]
Returns a structure of scenario validation exceptions by type. References the associated speculations
Errors
NO_MATCH
Scenario does not exist in system
NO_AUTH
User cannot access objects in the scenario
Capabilities
Use Cases
Comments/Feedback
Method
showExpenseDetail}
Description
For a given CO, the breakdown of Expense speculations for this account
Parameters
String
Scenario_Key
The unique identifier for the Scenario
tr}
Parameters
String
Cost_Collector_key
The unique identifier for the Scenario
Return
[expenseSpeculationMetaResultType]
Returns the Expense Speculation information as a structure
Errors
NO_MATCH
Scenario does not exist in system
NO_AUTH
User cannot access objects in the scenario
Capabilities
Use Cases
Comments/Feedback
Method
showCOApptDetail}
Description
For a CO, the labor distributions on this account
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Cost_Collector_Key
The unique identifier for the Cost Object
Return
[distributionSpeculationMetaResultType]
Returns the labor distributiuon Speculation information as a structure for this CO
Errors
NO_MATCH
Scenario does not exist in system
NO_AUTH
User cannot access objects in the scenario
Capabilities
Use Cases
Comments/Feedback
Method
showApptDetail}
Description
For a given person/appt, the labor distributions for that person
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Personnel_key
The unique identifier for the Person/Appt
Return
[distributionSpeculationMetaResultType]
Returns the Labor Distribution Speculation information as a structure for this person
Errors
NO_MATCH
Scenario does not exist in system
NO_AUTH
User cannot access objects in the scenario
Capabilities
Use Cases
Comments/Feedback
Method
createScenario
Description
Defines an empty Scenario
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Array
Parm
Scenario parameters (Include commitments so far)
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
EXISTS
Scenario exists in the system
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
updateScenario
Description
Updates the scenario metadata with the identified PARM
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Array
Parm
Scenario parameters (Include commitments so far)
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_EXIST
Scenario does not exist in the system
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
deleteScenario}
Description
D-flags a given scenario. D-flagged scenarios are reaped after 30 days.
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
Scenario does not exist in the system
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
addCOtoScenario}
Description
Adds a collection of COs to a scenario
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Array
CoArray
A collection of cost objects to add to the scenario
Boolean
with_children
Include child cost objects
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
EXISTS
Warning: One or more of the objects specified exist in the scenario
NO_AUTH
User cannot perform actions on this scenario
NO_MATCH
One or more COs specified do not exist
Capabilities
Use Cases
Comments/Feedback
Method
addAppttoScenario}
Description
Adds a collection of Appts to a scenario
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Array
ApptArray
A collection of appointments to add to the scenario
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
EXISTS
Warning: One or more of the objects specified exist in the scenario
NO_AUTH
User cannot perform actions on this scenario
NO_MATCH
One or more COs specified do not exist
Capabilities
Use Cases
Comments/Feedback
Method
dropCOfromScenario}
Description
Removes a CO from a Scenario
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Cost_Collector_key
A cost objects to remove from the scenario
Boolean
with_children
Include child cost objects
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_AUTH
User cannot perform actions on this scenario
NO_MATCH
CO specified does not exist
DEPENDENT_OBJECTS
Warning: CO has speculations
Capabilities
Use Cases
Comments/Feedback
Method
dropApptfromScenario}
Description
Drops an Appts from a scenario
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Personnel_key
An appt to remove from a scenario
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
DEPENDENT_OBJECTS
Warning: Appt has speculations
Errors
DEPENDENT_COS
ERROR: Cannot remove appt due to the fact that it is used in CO labor distribution speculations
NO_AUTH
User cannot perform actions on this scenario
NO_MATCH
One or more COs specified do not exist
Capabilities
Use Cases
Comments/Feedback
Method
archiveScenario}
Description
Archives the specific scenario in question.
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
Scenario does not exist in the system
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
copyScenario}
Description
Copies a Scenario to another scenario
Parameters
String
Source_Scenario_Key
The unique identifier for the source Scenario
String
Destination_Scenario_Key
The unique identifier for the destination Scenario (null if new)
Boolean
Overwrite
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.
Boolean
Update_Objects
If true, add missing target objects (people/cos) to the destination set. Otherwise speculations with no object match are dropped with a warning.
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_SOURCE
Source Scenario does not exist in the system
NO_DESTINATION
Destination scenario does not exist in the system
SET_ISSUE
The collections of target objects(people/appt) in the scenario do not match
SPEC_EXISTS
You are not overwriting speculations and a matching speculation combination exists. Backing out.
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
addAssumption
Description
Adds a global assumption to a scenario. Assumptions can be one of: MERIT_INCREASE, RATE or INFLATION
Parameters
String
Scenario_Key
The unique identifier for the Scenario
ASSUMPTION_TYPE
Assumption_TYPE
One of: MERIT_INCREASE, RATE or INFLATION
String
Assumption_Desc
Short description for the assumption
Double
Assumption_Percent
Adjustment percentage for the assumption
Date
Start_Date
The Start_Date for the Assumption
Date
End_Date
The End_Date for the Assumption
GL_ACCOUNT
Source_GL
The Source GL for the Assumption (the basis for calculations)
GL_ACCOUNT
Target_GL
The target GL for the Assumption (where the resulting line items should land)
Boolean
Merge
Instead of throwing an error on overwrite, merge this change into the associated base assumption
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_SOURCE
Source GL does not exist in the system
NO_DESTINATION
Destination GL does not exist in the system
NO_MATCH
No Match for the scenario key
SET_ISSUE
There exists an assumption of the type/gl identified with a different start/end date range (Merge prevents this error)
EXISTS
There exists an auumption of the type/gl/date range identified with different % valyes (Merge preents this error)
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
dropAssumption
Description
Removes an assumption from the system for the identified scenario
Parameters
String
Scenario_Key
The unique identifier for the Scenario
ASSUMPTION_TYPE
Assumption_TYPE
One of: MERIT_INCREASE, RATE or INFLATION
Integer
Assumption_ID
The unique identifier for the assumption to be removed
Double
Assumption_Percent
Adjustment percentage for the assumption
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_ASSUMPTION
Assumption does not exist in the system
NO_MATCH
No Match for the scenario key
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
updateAssumption
Description
Alter an existing assumption in the system. Assumptions can be one of: MERIT_INCREASE, RATE or INFLATION
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Integer
Assumption_ID
The unique identifier for the assumption
ASSUMPTION_TYPE
Assumption_TYPE
One of: MERIT_INCREASE, RATE or INFLATION
String
Assumption_Desc
Short description for the assumption
Double
Assumption_Percent
Adjustment percentage for the assumption
Date
Start_Date
The Start_Date for the Assumption
Date
End_Date
The End_Date for the Assumption
GL_ACCOUNT
Source_GL
The Source GL for the Assumption (the basis for calculations)
GL_ACCOUNT
Target_GL
The target GL for the Assumption (where the resulting line items should land)
Boolean
Merge
Instead of throwing an error on overwrite, merge this change into the associated base assumption
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_SOURCE
Source GL does not exist in the system
NO_DESTINATION
Destination GL does not exist in the system
NO_MATCH
No Match for the scenario key
NO_Assumption
Assumption does not exist in the system
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
addExpenseAllocSpec
Description
Adds an expense allocation to the system. Expense allocations are by line item for one or more Cost Objects
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Line_Item
Description of the Line_Item to add
Double
Line_Item_Total
The Total cost of the Line Item
Date
Start_Date
The Start_Date for the Speculation
Date
End_Date
The End_Date for the Assumption
[allocationMetaResultType]
Allocation_Obj
For the given Line item, the distribution as follows: CO | GL | Start Date | End Date | %
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
MISSING_CO
COs identified do not exist in the system
EXISTS
Line Item exists for start/end Date range specified
MIS-ALLOC
Allocation does not = 100% and/or total does not equal the Line_Item_Total
NO_MATCH
No Match for the scenario key
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
addApptAllocSpec
Description
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.
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Personnel_key
Personnel_key
The unique identifier for the person/appt
Double
Dist_Total
The Total distribution amount for the person/appt within the timeframe specified
Date
Start_Date
The Start_Date for the Speculation
Date
End_Date
The End_Date for the Assumption
[allocationMetaResultType]
Allocation_Obj
For the given personnel_key, the distribution as follows: CO | GL | Start Date | End Date | %
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
MISSING_CO
COs identified do not exist in the system
EXISTS
Person Allocations exist for start/end date range specified
MIS-ALLOC
Allocation does not = 100% and/or total does not equal the Line_Item_Total
NO_MATCH
No Match for the scenario key
MISSING_Appt
Appt Identifier does not exist in the system
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
updateExpenseAllocSpec
Description
Updates an expense allocation to the system. Expense allocations are by line item for one or more Cost Objects
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Integer
Speculation_ID
Unique identifier for speculation
String
Line_Item
Description of the Line_Item to add
Double
Line_Item_Total
The Total cost of the Line Item
Date
Start_Date
The Start_Date for the Speculation
Date
End_Date
The End_Date for the Assumption
[allocationMetaResultType]
Allocation_Obj
For the given Line item, the distribution as follows: CO | GL | Start Date | End Date | %
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
MISSING_CO
COs identified do not exist in the system
MIS-ALLOC
Allocation does not = 100% and/or total does not equal the Line_Item_Total
NO_MATCH
No Match for the scenario key
NO_Speculation_MATCH
No Match for the speculation
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
updateApptAllocSpec
Description
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.
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Integer
Speculation_ID
The unique identifier for the speculation
Personnel_key
Personnel_key
The unique identifier for the person/appt
Double
Dist_Total
The Total distribution amount for the person/appt within the timeframe specified
Date
Start_Date
The Start_Date for the Speculation
Date
End_Date
The End_Date for the Assumption
[allocationMetaResultType]
Allocation_Obj
For the given personnel_key, the distribution as follows: CO | GL | Start Date | End Date | %
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
MISSING_CO
COs identified do not exist in the system
NO_SPEC_MATCH
Speculation ID does not exist in system
MIS-ALLOC
Allocation does not = 100% and/or total does not equal the Line_Item_Total
NO_MATCH
No Match for the scenario key
MISSING_Appt
Appt Identifier does not exist in the system
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
dropExpenseAllocSpec
Description
Drops an expense allocation from the system.
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Integer
Speculation_ID
Unique identifier for speculation
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
No Match for the scenario key
NO_Speculation_MATCH
No Match for the speculation
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
dropApptAllocSpec
Description
Drops an appt allocation from the system.
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Integer
Speculation_ID
The unique identifier for the speculation
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_SPEC_MATCH
Speculation ID does not exist in system
NO_MATCH
No Match for the scenario key
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
addTBACOSpec
Description
Adds a non-existent CO to a scenario
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Cost_Collector_Key
The unique identifier for the CO
String
Cost_Collector_Title
Description of the cost object. Prefixed with TBA in system.
Double
Total
The authorized total or total institute budget
Sponsor_key
Sponsor_key
The source of funding
Date
Start_Date
The cost object effective date
Date
End_Date
The cost object expiration date
Cost_Collector_key
Cost_Collector_parent_key
The parent of this cost object
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
CO_EXISTS
Cost Collector already exists in scenario
NO_CO_PARENT
Parent CO does not exist in system
NO_MATCH
No Match for the scenario key
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
addTBHApptSpec
Description
Adds a person that does not exist into the scenario as a speculation
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Person
Name/Descriptor for the person
String
Position_Title
The name of the position
Appt_Type
Appt_Type
The Employee Category used for overhead calculations
Date
Start_Date
Start Date for the appointment
End
End_Date
End Date for the appointment
Double
Period_Salary
How much will this person/appt. be paid for the time frame specified?
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
No Match for the scenario key
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
dropTBACOSpec
Description
Removes a TBA CO from a scenario
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Speculation_ID
The unique identifier for the Speculation
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
No Match for the scenario key
NO_SPEC_MATCH
No Match for the speculation_id
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
dropTBHApptSpec
Description
Removes a TBH person from the scenario
Parameters
String
Scenario_Key
The unique identifier for the Scenario
Integer
Speculation_ID
The unique identifier for the speculation
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
No Match for the scenario key
NO_SPEC_MATCH
Speculation does not exist in scenario
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
updateTBACOSpec
Description
Updates CO metadata for a TBA cost object
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Speculation_ID
The unique identifier for the Speculation
String
Cost_Collector_Key
The unique identifier for the CO
String
Cost_Collector_Title
Description of the cost object. Prefixed with TBA in system.
Double
Total
The authorized total or total institute budget
Sponsor_key
Sponsor_key
The source of funding
Date
Start_Date
The cost object effective date
Date
End_Date
The cost object expiration date
Cost_Collector_key
Cost_Collector_parent_key
The parent of this cost object
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_SPEC_MATCH
Speculation does not exist in system
NO_CO_PARENT
Parent CO does not exist in system
NO_MATCH
No Match for the scenario key
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
updateTBHApptSpec
Description
Update metadata for a particular appointment
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Speculation_ID
Unique identifier for the speculation
String
Person
Name/Descriptor for the person
String
Position_Title
The name of the position
Appt_Type
Appt_Type
The Employee Category used for overhead calculations
Date
Start_Date
Start Date for the appointment
End
End_Date
End Date for the appointment
Double
Period_Salary
How much will this person/appt. be paid for the time frame specified?
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
No Match for the scenario key
NO_SPEC_MATCH
No match for the speculation in the system
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
updateCOSpec
Description
Alter the metadata on a real CO. Only one alteration on a CO is allowed, but alterations can be over-ridden
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Cost_Collector_Key
The unique identifier for the CO
Double
Authorized_Total
The authorized total or total institute budget
Sponsor_key
Sponsor_key
The source of funding
Date
Start_Date
The cost object effective date
Date
End_Date
The cost object expiration date
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_CO_MATCH
Cost Object does not exist in system
NO_MATCH
No Match for the scenario key
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
updateApptSpec
Description
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
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Personell_key
Unique identfier for the appointment
String
Position_Title
The name of the position
Appt_Type
Appt_Type
The Employee Category used for overhead calculations
Date
Start_Date
Start Date for the appointment
End
End_Date
End Date for the appointment
Double
Period_Salary
How much will this person/appt. be paid for the time frame specified?
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
No Match for the scenario key
NO_APPT_MATCH
Appt does not exist in the system
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
addAdjSpec
Description
Adds an adjustment to a CO/GL combination
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
cost_collector_key
Unique identfier for the cost object
String
gl_account_key
Unique identifer for the gl account
Date
Start_Date
Start Date for the appointment
End
End_Date
End Date for the appointment
Double
Adjustment_Percent
The positive of negative adjustment to be applied to this gl
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
No Match for the scenario key
NO_CO_MATCH
CO does not exist in the system
NO_AUTH
User cannot define scenarios in this workset
NO_IMPACT
Warning: CO does not currently have entries for the associated GLs
Capabilities
Use Cases
Comments/Feedback
Method
dropAdjSpec
Description
Drop adjustment spec from the scenario
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Speculation_ID
Unique identfier for the speculation
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
No Match for the scenario key
NO_SPEC_MATCH
Speculation does not exist in the system
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
addCORateSpec
Description
Add a new rate onto an existing (Real or TBA) CO. Includes overriding.
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
cost_collector_key
Unique identfier for the cost object
String
gl_account_key
Unique identifer for the gl account
Date
Start_Date
Start Date for the appointment
End
End_Date
End Date for the appointment
RATE_NAME
Rate_name
The name of the rate (from the list of available rates)
Double
Rate_Percent
The positive of negative adjustment to be applied to this gl
GL_Account
Source_GL
The source GL for overhead amounts to be calcluated from
GL_Account
Target_GL
The target GL where the overhead surcharge lands
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
No Match for the scenario key
NO_CO_MATCH
CO does not exist in the system
NO_AUTH
User cannot define scenarios in this workset
NO_GL_MATCH
Either the source or target GLs do not exist
RATE_EXISTS
You are attempting to edit a rate that already exists on this Scenario/CO/GL
Capabilities
Use Cases
Comments/Feedback
Method
updateCORateSpec
Description
Adds an adjustment to a CO/GL combination
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Speculation_ID
Unique identfier for the speculation to adjust
String
cost_collector_key
Unique identfier for the cost object
String
gl_account_key
Unique identifer for the gl account
Date
Start_Date
Start Date for the appointment
End
End_Date
End Date for the appointment
RATE_NAME
Rate_name
The name of the rate (from the list of available rates)
Double
Rate_Percent
The positive of negative adjustment to be applied to this gl
GL_Account
Source_GL
The source GL for overhead amounts to be calcluated from
GL_Account
Target_GL
The target GL where the overhead surcharge lands
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
No Match for the scenario key
NO_CO_MATCH
CO does not exist in the system
NO_AUTH
User cannot define scenarios in this workset
NO_GL_MATCH
Either the source or target GLs do not exist
RATE_EXISTS
You are attempting to edit a rate that already exists on this Scenario/CO/GL
Capabilities
Use Cases
Comments/Feedback
Method
dropCORateSpec
Description
Drop a Speculative rate from the system
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Speculation_ID
Unique identfier for the speculation to adjust
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
No Match for the scenario key
NO_SPEC_MATCH
Speculation does not exist in the system
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
updateFTESpec
Description
Update the FTE breakdown for a person
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Personnel_key
Unique identfier for the person
MonthYear
Start_Period
Start period for changes
MonthYear
End_Period
End Period for changes
[fteEntryType]
FTE_Schedule
For any given person |personnel_key|fiscal_period| FTE %|
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
No Match for the scenario key
NO_APPT_MATCH
Appointment not in system
DATE_MISMATCH
Date in the API request does not match date in the FTE_Schedule
DATE_APPT_MISMATCH
Date outside of Appt date ranges
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
updateFTESpec
Description
Update the Vacation day breakdown for a person
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Personnel_key
Unique identfier for the person
MonthYear
Start_Period
Start period for changes
MonthYear
End_Period
End Period for changes
[fteEntryType]
FTE_Schedule
For any given person |personnel_key|fiscal_period| # of vacation days|
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_MATCH
No Match for the scenario key
NO_APPT_MATCH
Appointment not in system
DATE_MISMATCH
Date in the API request does not match date in the FTE_Schedule
DATE_APPT_MISMATCH
Date outside of Appt date ranges
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
loadExpenseAllocSpecfromExternal
Description
Loads the expense allocation information from a particular external system (SAP,COEUS)
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Cost_Collector_Key
The unique identifier for the CO
Source_System
Source_System
Either SAP or COEUS to represent the source system
String
Plan_Version
Either the SAP plan version to load, or COP for Coeus Proposal Budget or COA for Coeus Award Budget
Date
Start_Date
The start date for the load
Date
End_Date
The cend date for the load
Boolean
Replace
If true, replace the expense allocations in the system. Otherwise attempt to add them to existing structure. Not replacing may result in double entries.
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_CO_MATCH
Cost Object does not exist in system
NO_MATCH
No Match for the scenario key
NO_PLAN_MATCH
No Plan exists of the identified type in the system
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback
Method
loadDistAllocSpecfromExternal
Description
Loads the labor distribution allocation information from a particular external system (SAP,COEUS)
Parameters
String
Scenario_Key
The unique identifier for the Scenario
String
Cost_Collector_Key
The unique identifier for the CO
Source_System
Source_System
Either SAP or COEUS to represent the source system
String
Plan_Version
Either the SAP plan version to load, or COP for Coeus Proposal Budget or COA for Coeus Award Budget
Date
Start_Date
The start date for the load
Date
End_Date
The cend date for the load
Boolean
Replace
If true, replace the expense allocations in the system. Otherwise attempt to add them to existing structure. Not replacing may result in double entries.
Return
[confirmMetaResultType]
Returns the confirmation status of the task along with the object reference
Errors
NO_CO_MATCH
Cost Object does not exist in system
NO_MATCH
No Match for the scenario key
NO_PLAN_MATCH
No Plan exists of the identified type in the system
NO_AUTH
User cannot define scenarios in this workset
Capabilities
Use Cases
Comments/Feedback