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
Child Services
| SearchService | Search Service |
| CommentService | Comment Service |
| AuthorizationService | Authorization Service |
| ReportService | Report Service |
| COMetadataService | CO Metadata Service |
| CubeService | Cube Service |
| WorksetService | Workset Service |
| Scenario+Service | Scenario Service |
References
see RAFT Requirements Documentation (RAFT-*)
Operations
Setup
Domain Operations
#getModelTypes
Search
searchbyParm(&parm)
searchCollectionbyParm(&collection,&parm)
Listinfo about user sets
getSearchLists
listSupervisor(#count)
listAddressee(#count)
listSponsor(#count)
listPrimeSponsor(#count)
listId(#count)
listWorksets(#count)
listFlaggedCostObjects(#count)
Maintenance
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
querySummary
queryMonthSummary
Query
queryActualsSummary
queryActualsExpense
queryActualsPeople
queryBudgetDay
queryCommitmentsSummary
queryCommitmentsExpense
queryCommitmentsPeople
queryForecastSummary
queryForecastExpense
queryForecastPeople
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
| 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
| 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
| 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
| 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
| 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
| 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
| 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 | |||