Scenario Service
| Name | Scenario Service | |
|---|---|---|
| Version | Dev (0.1) | Release Notes |
Description
The Scenario Service is focused on the management of scenarios. All forecasts in the system are directly related to one or more scenarios. The default scenario is the COMMON scenario. Users have the ability to copy to and from the COMMON scenario. Users enter forecasts by manipulating speculations, including adding or removing allocations.For any given combination (CO/GL/(Line Item/Person/Rate)/SpecType) only one speculation is allowed in a scenario. Speculations can also focus on CO or person Metadata.
Assumptions are used to track global information that effects all cost objects/people in the scenario and can include: Merit Increases (By employee category), Inflation (to handle tuition/stipend inflation) and adjustments to Global base rates.
References
see RAFT Requirements Documentation (RAFT-*)
Operations
Scenario
Scenario Management
#showCOAttributes
#showApptAttributes
#showScenarioOverview
#showScenaroFinImpact
#showScenarioPersonImpact
#showScenarioDetail
#showCOExpenseDetail
#showCOPersonDetail
#showCODetail
#showApptDetail
#createScenario
#deleteScenario
#addCOtoScenario
#dropCOfromScenario
#addAppttoScenario
#dropApptfromScenario
#copyScenario
#archiveScenario
#addAssumption
#dropAssumption
#updateAssumption
#addExpenseAllocSpec
#dropExpenseAllocSpec
#updateExpenseAllocSpec
#addApptAllocSpec
#dropApptAllocSpec
#updateApptAllocSpec
#addTBACOSpec
#dropTBACOSpec
#updateCOSpec
#addTBHApptSpec
#dropTBHApptSpec
#updateApptSpec
#addCORateSpec
#dropCORateSpec
#updateFTESpec
#updateVacationSpec
#createExpenseAllocSpecfromCOEUS
#createExpenseAllocSpecfromSAP
#createPersonAllocSpecfromCOEUS
#recalcApptDetail
#recalcExpenseDetail
#buildScenarioSummary
#buildWorksetSummary
#checkSystemStatus
#setScenarioVisibility
#setWorksetVisibility
#checkProjectedBalance
#checkGLBudget
#checkMonthlyBurn
#checkPersonAlloc
#checkRemainingGLBalance
#checkRemainingBalance
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, or is flagged for deletion | |
| 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, or is flagged for deletion | |
| 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, or is flagged for deletion | |
| 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, or is flagged for deletion | |
| 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 |
| 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 | |
| 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_SPEC_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 | |||