Page History

Scenario Service

Include Page

	Interface Style
	Interface Style

HTML Table

id	serviceMetaTable

Table Row (tr)

Table Head (th)

class	h

Name

Table Cell (td)

colspan	2
id	serviceName

Scenario Service

Table Row (tr)

Table Head (th)

class	h

Version

Table Cell (td)

id	serviceVersion

Dev (0.1)

Table Cell (td)

id	serviceVersionHistory

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

Include Page

	Method Table Style Page
	Method Table Style Page

Panel

borderColor	#cccccc
bgColor	#ffffff
titleBGColor	#eeeeee
borderStyle	solid
title	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

#addAdjSpec
#dropAdjSpec

#addCORateSpec
#dropCORateSpec

#updateFTESpec
#updateVacationSpec
#createExpenseAllocSpecfromCOEUS
#createExpenseAllocSpecfromSAP
#createPersonAllocSpecfromCOEUS

#recalcApptDetail
#recalcExpenseDetail
#buildScenarioSummary
#buildWorksetSummary

#checkSystemStatus
#setScenarioVisibility
#setWorksetVisibility

#checkProjectedBalance
#checkGLBudget
#checkMonthlyBurn
#checkPersonAlloc
#checkRemainingGLBalance
#checkRemainingBalance

#showVarianceonScenario

Scenario Management

Include Page

	Method Table Style Page
	Method Table Style Page

Anchor

	showCOAttributes
	showCOAttributes

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showCOAttributes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

For a given Cost Object Definition, show all of the speculative adjustments on that Cost Object

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_Collector_key

Table Cell (td)

class	methodParamDesc

The unique identifier for the cost object

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for this scenario

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

coMetaResultType

Table Cell (td)

class	methodReturnDesc

For the given cost object, return the final cost object including all adjustments

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Scenario or CO does not exist in system, or is flagged for deletion

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot access objects in the scenario

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	showApptAttributes
	showApptAttributes

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showApptAttributes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

For a given Person/Appt Definition, show all of the speculative adjustments on that Person/Appt

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Personnel_key

Table Cell (td)

class	methodParamDesc

The unique identifier for the cost object

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for this scenario

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

apptMetaResultType

Table Cell (td)

class	methodReturnDesc

For the given person/Appt, return the final person/appt including all adjustments

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Scenario or Appt does not exist in system, or is flagged for deletion

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot access objects in the scenario

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	showScenarioOverview
	showScenarioOverview

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showScenarioOverview

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Provide a top level-overview of this scenario including: Pertinent people and expenses for CO and balances

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

scenarioOverviewMetaResultType

Table Cell (td)

class	methodReturnDesc

Provides a high-level overview of the scenario, limited by the associated authorizations

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Scenario does not exist in system, or is flagged for deletion

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot access objects in the scenario

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	showScenarioFinImpact
	showScenarioFinImpact

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showScenarioFinImpact

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Shows a CO level summary of the cost object

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

scenarioFinancialImpactMetaResultType

Table Cell (td)

class	methodReturnDesc

Provides a high-level of the CO financial impact information

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Scenario does not exist in system, or is flagged for deletion

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot access objects in the scenario

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	showScenarioPersonImpact
	showScenarioPersonImpact

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showScenarioPersonImpact

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Provide a summary view of the personnel Impact of this Scenario

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

scenarioOverviewMetaResultType

Table Cell (td)

class	methodReturnDesc

Provides a high-level overview of the personnel resources and associated financial impact, limited by the associated authorizations

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Scenario does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot access objects in the scenario

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	showScenarioSpeculations
	showScenarioSpeculations

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showScenarioSpeculations

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Provide a change log showing all of the speculations in the system

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

speclistMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns a structure of speculations by type. Only includes type/title/descriptions

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Scenario does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot access objects in the scenario

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	showScenarioExceptions
	showScenarioExceptions

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showScenarioExceptions

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Provide a change log showing all of the validation exceptions for this scenario.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

scenarioExceptionMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns a structure of scenario validation exceptions by type. References the associated speculations

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Scenario does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot access objects in the scenario

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	showExpenseDetail
	showExpenseDetail

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showExpenseDetail

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

For a given CO, the breakdown of Expense speculations for this account

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_Collector_key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

expenseSpeculationMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the Expense Speculation information as a structure

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Scenario does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot access objects in the scenario

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	showCOApptDetail
	showCOApptDetail

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showCOApptDetail

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

For a CO, the labor distributions on this account

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_Collector_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Cost Object

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

distributionSpeculationMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the labor distributiuon Speculation information as a structure for this CO

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Scenario does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot access objects in the scenario

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	showApptDetail
	showApptDetail

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showApptDetail

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

For a given person/appt, the labor distributions for that person

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Personnel_key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Person/Appt

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

distributionSpeculationMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the Labor Distribution Speculation information as a structure for this person

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Scenario does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot access objects in the scenario

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	createScenario
	createScenario

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

createScenario

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Defines an empty Scenario

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

Parm

Table Cell (td)

class	methodParamDesc

Scenario parameters (Include commitments so far)

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

EXISTS

Table Cell (td)

class	methodErrorDesc

Scenario exists in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	updateScenario
	updateScenario

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateScenario

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Updates the scenario metadata with the identified PARM

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

Parm

Table Cell (td)

class	methodParamDesc

Scenario parameters (Include commitments so far)

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_EXIST

Table Cell (td)

class	methodErrorDesc

Scenario does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Table Row (tr)

Back to Operations

Anchor

	deleteScenario
	deleteScenario

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

deleteScenario

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

D-flags a given scenario. D-flagged scenarios are reaped after 30 days.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Scenario does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	addCOtoScenario
	addCOtoScenario

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

addCOtoScenario

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Adds a collection of COs to a scenario

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

CoArray

Table Cell (td)

class	methodParamDesc

A collection of cost objects to add to the scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

with_children

Table Cell (td)

class	methodParamDesc

Include child cost objects

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

EXISTS

Table Cell (td)

class	methodErrorDesc

Warning: One or more of the objects specified exist in the scenario

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot perform actions on this scenario

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

One or more COs specified do not exist

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	addAppttoScenario
	addAppttoScenario

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

addAppttoScenario

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Adds a collection of Appts to a scenario

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

ApptArray

Table Cell (td)

class	methodParamDesc

A collection of appointments to add to the scenario

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

EXISTS

Table Cell (td)

class	methodErrorDesc

Warning: One or more of the objects specified exist in the scenario

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot perform actions on this scenario

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

One or more COs specified do not exist

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	dropCOfromScenario
	dropCOfromScenario

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

dropCOfromScenario

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Removes a CO from a Scenario

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_Collector_key

Table Cell (td)

class	methodParamDesc

A cost objects to remove from the scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

with_children

Table Cell (td)

class	methodParamDesc

Include child cost objects

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot perform actions on this scenario

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

CO specified does not exist

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DEPENDENT_OBJECTS

Table Cell (td)

class	methodErrorDesc

Warning: CO has speculations

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	dropApptfromScenario
	dropApptfromScenario

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

dropApptfromScenario

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Drops an Appts from a scenario

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Personnel_key

Table Cell (td)

class	methodParamDesc

An appt to remove from a scenario

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DEPENDENT_OBJECTS

Table Cell (td)

class	methodErrorDesc

Warning: Appt has speculations

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DEPENDENT_COS

Table Cell (td)

class	methodErrorDesc

ERROR: Cannot remove appt due to the fact that it is used in CO labor distribution speculations

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot perform actions on this scenario

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

One or more COs specified do not exist

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	archiveScenario
	archiveScenario

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

archiveScenario

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Archives the specific scenario in question.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Scenario does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	copyScenario
	copyScenario

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

copyScenario

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Copies a Scenario to another scenario

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Source_Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the source Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Destination_Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the destination Scenario (null if new)

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

Overwrite

Table Cell (td)

class	methodParamDesc

If true, delete all speculations for associated objects and replace with mine. If false, add my speculations to the existing set. It will add only speculations for object combinations that do not exist as speculations in the destination system.

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

Update_Objects

Table Cell (td)

class	methodParamDesc

If true, add missing target objects (people/cos) to the destination set. Otherwise speculations with no object match are dropped with a warning.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	5
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_SOURCE

Table Cell (td)

class	methodErrorDesc

Source Scenario does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_DESTINATION

Table Cell (td)

class	methodErrorDesc

Destination scenario does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

SET_ISSUE

Table Cell (td)

class	methodErrorDesc

The collections of target objects(people/appt) in the scenario do not match

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

SPEC_EXISTS

Table Cell (td)

class	methodErrorDesc

You are not overwriting speculations and a matching speculation combination exists. Backing out.

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	addAssumption
	addAssumption

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

addAssumption

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Adds a global assumption to a scenario. Assumptions can be one of: MERIT_INCREASE, RATE or INFLATION

Table Row (tr)

Table Head (th)

rowspan	9
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

ASSUMPTION_TYPE

Table Cell (td)

class	methodParamName

Assumption_TYPE

Table Cell (td)

class	methodParamDesc

One of: MERIT_INCREASE, RATE or INFLATION

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Assumption_Desc

Table Cell (td)

class	methodParamDesc

Short description for the assumption

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Assumption_Percent

Table Cell (td)

class	methodParamDesc

Adjustment percentage for the assumption

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

The Start_Date for the Assumption

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

The End_Date for the Assumption

Table Row (tr)

Table Cell (td)

class	methodParamType

GL_ACCOUNT

Table Cell (td)

class	methodParamName

Source_GL

Table Cell (td)

class	methodParamDesc

The Source GL for the Assumption (the basis for calculations)

Table Row (tr)

Table Cell (td)

class	methodParamType

GL_ACCOUNT

Table Cell (td)

class	methodParamName

Target_GL

Table Cell (td)

class	methodParamDesc

The target GL for the Assumption (where the resulting line items should land)

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

Merge

Table Cell (td)

class	methodParamDesc

Instead of throwing an error on overwrite, merge this change into the associated base assumption

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_SOURCE

Table Cell (td)

class	methodErrorDesc

Source GL does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_DESTINATION

Table Cell (td)

class	methodErrorDesc

Destination GL does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

SET_ISSUE

Table Cell (td)

class	methodErrorDesc

There exists an assumption of the type/gl identified with a different start/end date range (Merge prevents this error)

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

EXISTS

Table Cell (td)

class	methodErrorDesc

There exists an auumption of the type/gl/date range identified with different % valyes (Merge preents this error)

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	dropAssumption
	dropAssumption

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

dropAssumption

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Removes an assumption from the system for the identified scenario

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

ASSUMPTION_TYPE

Table Cell (td)

class	methodParamName

Assumption_TYPE

Table Cell (td)

class	methodParamDesc

One of: MERIT_INCREASE, RATE or INFLATION

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Assumption_ID

Table Cell (td)

class	methodParamDesc

The unique identifier for the assumption to be removed

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Assumption_Percent

Table Cell (td)

class	methodParamDesc

Adjustment percentage for the assumption

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_ASSUMPTION

Table Cell (td)

class	methodErrorDesc

Assumption does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	updateAssumption
	updateAssumption

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateAssumption

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Alter an existing assumption in the system. Assumptions can be one of: MERIT_INCREASE, RATE or INFLATION

Table Row (tr)

Table Head (th)

rowspan	10
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Assumption_ID

Table Cell (td)

class	methodParamDesc

The unique identifier for the assumption

Table Row (tr)

Table Cell (td)

class	methodParamType

ASSUMPTION_TYPE

Table Cell (td)

class	methodParamName

Assumption_TYPE

Table Cell (td)

class	methodParamDesc

One of: MERIT_INCREASE, RATE or INFLATION

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Assumption_Desc

Table Cell (td)

class	methodParamDesc

Short description for the assumption

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Assumption_Percent

Table Cell (td)

class	methodParamDesc

Adjustment percentage for the assumption

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

The Start_Date for the Assumption

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

The End_Date for the Assumption

Table Row (tr)

Table Cell (td)

class	methodParamType

GL_ACCOUNT

Table Cell (td)

class	methodParamName

Source_GL

Table Cell (td)

class	methodParamDesc

The Source GL for the Assumption (the basis for calculations)

Table Row (tr)

Table Cell (td)

class	methodParamType

GL_ACCOUNT

Table Cell (td)

class	methodParamName

Target_GL

Table Cell (td)

class	methodParamDesc

The target GL for the Assumption (where the resulting line items should land)

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

Merge

Table Cell (td)

class	methodParamDesc

Instead of throwing an error on overwrite, merge this change into the associated base assumption

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	5
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_SOURCE

Table Cell (td)

class	methodErrorDesc

Source GL does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_DESTINATION

Table Cell (td)

class	methodErrorDesc

Destination GL does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_Assumption

Table Cell (td)

class	methodErrorDesc

Assumption does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	addExpenseAllocSpec
	addExpenseAllocSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

addExpenseAllocSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Adds an expense allocation to the system. Expense allocations are by line item for one or more Cost Objects

Table Row (tr)

Table Head (th)

rowspan	5
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Line_Item

Table Cell (td)

class	methodParamDesc

Description of the Line_Item to add

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Line_Item_Total

Table Cell (td)

class	methodParamDesc

The Total cost of the Line Item

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

The Start_Date for the Speculation

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

The End_Date for the Assumption

Table Row (tr)

Table Cell (td)

class	methodParamType

allocationMetaResultType

Table Cell (td)

class	methodParamName

Allocation_Obj

Table Cell (td)

class	methodParamDesc

For the given Line item, the distribution as follows: CO | GL | Start Date | End Date | %

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	5
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_CO

Table Cell (td)

class	methodErrorDesc

COs identified do not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

EXISTS

Table Cell (td)

class	methodErrorDesc

Line Item exists for start/end Date range specified

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MIS-ALLOC

Table Cell (td)

class	methodErrorDesc

Allocation does not = 100% and/or total does not equal the Line_Item_Total

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	addApptAllocSpec
	addApptAllocSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

addApptAllocSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

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.

Table Row (tr)

Table Head (th)

rowspan	5
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

Personnel_key

Table Cell (td)

class	methodParamName

Personnel_key

Table Cell (td)

class	methodParamDesc

The unique identifier for the person/appt

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Dist_Total

Table Cell (td)

class	methodParamDesc

The Total distribution amount for the person/appt within the timeframe specified

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

The Start_Date for the Speculation

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

The End_Date for the Assumption

Table Row (tr)

Table Cell (td)

class	methodParamType

allocationMetaResultType

Table Cell (td)

class	methodParamName

Allocation_Obj

Table Cell (td)

class	methodParamDesc

For the given personnel_key, the distribution as follows: CO | GL | Start Date | End Date | %

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_CO

Table Cell (td)

class	methodErrorDesc

COs identified do not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

EXISTS

Table Cell (td)

class	methodErrorDesc

Person Allocations exist for start/end date range specified

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MIS-ALLOC

Table Cell (td)

class	methodErrorDesc

Allocation does not = 100% and/or total does not equal the Line_Item_Total

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_Appt

Table Cell (td)

class	methodErrorDesc

Appt Identifier does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	updateExpenseAllocSpec
	updateExpenseAllocSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateExpenseAllocSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Updates an expense allocation to the system. Expense allocations are by line item for one or more Cost Objects

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Speculation_ID

Table Cell (td)

class	methodParamDesc

Unique identifier for speculation

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Line_Item

Table Cell (td)

class	methodParamDesc

Description of the Line_Item to add

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Line_Item_Total

Table Cell (td)

class	methodParamDesc

The Total cost of the Line Item

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

The Start_Date for the Speculation

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

The End_Date for the Assumption

Table Row (tr)

Table Cell (td)

class	methodParamType

allocationMetaResultType

Table Cell (td)

class	methodParamName

Allocation_Obj

Table Cell (td)

class	methodParamDesc

For the given Line item, the distribution as follows: CO | GL | Start Date | End Date | %

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	5
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_CO

Table Cell (td)

class	methodErrorDesc

COs identified do not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MIS-ALLOC

Table Cell (td)

class	methodErrorDesc

Allocation does not = 100% and/or total does not equal the Line_Item_Total

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_SPEC_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the speculation

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	updateApptAllocSpec
	updateApptAllocSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateApptAllocSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

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.

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Speculation_ID

Table Cell (td)

class	methodParamDesc

The unique identifier for the speculation

Table Row (tr)

Table Cell (td)

class	methodParamType

Personnel_key

Table Cell (td)

class	methodParamName

Personnel_key

Table Cell (td)

class	methodParamDesc

The unique identifier for the person/appt

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Dist_Total

Table Cell (td)

class	methodParamDesc

The Total distribution amount for the person/appt within the timeframe specified

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

The Start_Date for the Speculation

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

The End_Date for the Assumption

Table Row (tr)

Table Cell (td)

class	methodParamType

allocationMetaResultType

Table Cell (td)

class	methodParamName

Allocation_Obj

Table Cell (td)

class	methodParamDesc

For the given personnel_key, the distribution as follows: CO | GL | Start Date | End Date | %

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_CO

Table Cell (td)

class	methodErrorDesc

COs identified do not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_SPEC_MATCH

Table Cell (td)

class	methodErrorDesc

Speculation ID does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MIS-ALLOC

Table Cell (td)

class	methodErrorDesc

Allocation does not = 100% and/or total does not equal the Line_Item_Total

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_Appt

Table Cell (td)

class	methodErrorDesc

Appt Identifier does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	dropExpenseAllocSpec
	dropExpenseAllocSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

dropExpenseAllocSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Drops an expense allocation from the system.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Speculation_ID

Table Cell (td)

class	methodParamDesc

Unique identifier for speculation

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_Speculation_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the speculation

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	dropApptAllocSpec
	dropApptAllocSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

dropApptAllocSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Drops an appt allocation from the system.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Speculation_ID

Table Cell (td)

class	methodParamDesc

The unique identifier for the speculation

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_SPEC_MATCH

Table Cell (td)

class	methodErrorDesc

Speculation ID does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	addTBACOSpec
	addTBACOSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

addTBACOSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Adds a non-existent CO to a scenario

Table Row (tr)

Table Head (th)

rowspan	8
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_Collector_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the CO

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_Collector_Title

Table Cell (td)

class	methodParamDesc

Description of the cost object. Prefixed with TBA in system.

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Total

Table Cell (td)

class	methodParamDesc

The authorized total or total institute budget

Table Row (tr)

Table Cell (td)

class	methodParamType

Sponsor_key

Table Cell (td)

class	methodParamName

Sponsor_key

Table Cell (td)

class	methodParamDesc

The source of funding

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

The cost object effective date

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

The cost object expiration date

Table Row (tr)

Table Cell (td)

class	methodParamType

Cost_Collector_key

Table Cell (td)

class	methodParamName

Cost_Collector_parent_key

Table Cell (td)

class	methodParamDesc

The parent of this cost object

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

CO_EXISTS

Table Cell (td)

class	methodErrorDesc

Cost Collector already exists in scenario

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_CO_PARENT

Table Cell (td)

class	methodErrorDesc

Parent CO does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	addTBHApptSpec
	addTBHApptSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

addTBHApptSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Adds a person that does not exist into the scenario as a speculation

Table Row (tr)

Table Head (th)

rowspan	7
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Person

Table Cell (td)

class	methodParamDesc

Name/Descriptor for the person

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Position_Title

Table Cell (td)

class	methodParamDesc

The name of the position

Table Row (tr)

Table Cell (td)

class	methodParamType

Appt_Type

Table Cell (td)

class	methodParamName

Appt_Type

Table Cell (td)

class	methodParamDesc

The Employee Category used for overhead calculations

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start Date for the appointment

Table Row (tr)

Table Cell (td)

class	methodParamType

End

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End Date for the appointment

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Period_Salary

Table Cell (td)

class	methodParamDesc

How much will this person/appt. be paid for the time frame specified?

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	dropTBACOSpec
	dropTBACOSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

dropTBACOSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Removes a TBA CO from a scenario

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Speculation_ID

Table Cell (td)

class	methodParamDesc

The unique identifier for the Speculation

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_SPEC_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the speculation_id

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	dropTBHApptSpec
	dropTBHApptSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

dropTBHApptSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Removes a TBH person from the scenario

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Speculation_ID

Table Cell (td)

class	methodParamDesc

The unique identifier for the speculation

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_SPEC_MATCH

Table Cell (td)

class	methodErrorDesc

Speculation does not exist in scenario

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	updateTBACOSpec
	updateTBACOSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateTBACOSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Updates CO metadata for a TBA cost object

Table Row (tr)

Table Head (th)

rowspan	9
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Speculation_ID

Table Cell (td)

class	methodParamDesc

The unique identifier for the Speculation

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_Collector_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the CO

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_Collector_Title

Table Cell (td)

class	methodParamDesc

Description of the cost object. Prefixed with TBA in system.

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Total

Table Cell (td)

class	methodParamDesc

The authorized total or total institute budget

Table Row (tr)

Table Cell (td)

class	methodParamType

Sponsor_key

Table Cell (td)

class	methodParamName

Sponsor_key

Table Cell (td)

class	methodParamDesc

The source of funding

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

The cost object effective date

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

The cost object expiration date

Table Row (tr)

Table Cell (td)

class	methodParamType

Cost_Collector_key

Table Cell (td)

class	methodParamName

Cost_Collector_parent_key

Table Cell (td)

class	methodParamDesc

The parent of this cost object

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_SPEC_MATCH

Table Cell (td)

class	methodErrorDesc

Speculation does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_CO_PARENT

Table Cell (td)

class	methodErrorDesc

Parent CO does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	updateTBHApptSpec
	updateTBHApptSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateTBHApptSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Update metadata for a particular appointment

Table Row (tr)

Table Head (th)

rowspan	8
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Speculation_ID

Table Cell (td)

class	methodParamDesc

Unique identifier for the speculation

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Person

Table Cell (td)

class	methodParamDesc

Name/Descriptor for the person

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Position_Title

Table Cell (td)

class	methodParamDesc

The name of the position

Table Row (tr)

Table Cell (td)

class	methodParamType

Appt_Type

Table Cell (td)

class	methodParamName

Appt_Type

Table Cell (td)

class	methodParamDesc

The Employee Category used for overhead calculations

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start Date for the appointment

Table Row (tr)

Table Cell (td)

class	methodParamType

End

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End Date for the appointment

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Period_Salary

Table Cell (td)

class	methodParamDesc

How much will this person/appt. be paid for the time frame specified?

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_SPEC_MATCH

Table Cell (td)

class	methodErrorDesc

No match for the speculation in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	updateCOSpec
	updateCOSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateCOSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Alter the metadata on a real CO. Only one alteration on a CO is allowed, but alterations can be over-ridden

Table Row (tr)

Table Head (th)

rowspan	7
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_Collector_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the CO

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Authorized_Total

Table Cell (td)

class	methodParamDesc

The authorized total or total institute budget

Table Row (tr)

Table Cell (td)

class	methodParamType

Sponsor_key

Table Cell (td)

class	methodParamName

Sponsor_key

Table Cell (td)

class	methodParamDesc

The source of funding

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

The cost object effective date

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

The cost object expiration date

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_CO_MATCH

Table Cell (td)

class	methodErrorDesc

Cost Object does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	updateApptSpec
	updateApptSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateApptSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

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

Table Row (tr)

Table Head (th)

rowspan	8
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Personell_key

Table Cell (td)

class	methodParamDesc

Unique identfier for the appointment

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Position_Title

Table Cell (td)

class	methodParamDesc

The name of the position

Table Row (tr)

Table Cell (td)

class	methodParamType

Appt_Type

Table Cell (td)

class	methodParamName

Appt_Type

Table Cell (td)

class	methodParamDesc

The Employee Category used for overhead calculations

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start Date for the appointment

Table Row (tr)

Table Cell (td)

class	methodParamType

End

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End Date for the appointment

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Period_Salary

Table Cell (td)

class	methodParamDesc

How much will this person/appt. be paid for the time frame specified?

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_APPT_MATCH

Table Cell (td)

class	methodErrorDesc

Appt does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	addAdjSpec
	addAdjSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

addAdjSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Adds an adjustment to a CO/GL combination

Table Row (tr)

Table Head (th)

rowspan	8
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

cost_collector_key

Table Cell (td)

class	methodParamDesc

Unique identfier for the cost object

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

gl_account_key

Table Cell (td)

class	methodParamDesc

Unique identifer for the gl account

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start Date for the appointment

Table Row (tr)

Table Cell (td)

class	methodParamType

End

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End Date for the appointment

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Adjustment_Percent

Table Cell (td)

class	methodParamDesc

The positive of negative adjustment to be applied to this gl

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_CO_MATCH

Table Cell (td)

class	methodErrorDesc

CO does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_IMPACT

Table Cell (td)

class	methodErrorDesc

Warning: CO does not currently have entries for the associated GLs

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	dropAdjSpec
	dropAdjSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

dropAdjSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Drop adjustment spec from the scenario

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Speculation_ID

Table Cell (td)

class	methodParamDesc

Unique identfier for the speculation

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_SPEC_MATCH

Table Cell (td)

class	methodErrorDesc

Speculation does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	addCORateSpec
	addCORateSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

addCORateSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Add a new rate onto an existing (Real or TBA) CO. Includes overriding.

Table Row (tr)

Table Head (th)

rowspan	9
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

cost_collector_key

Table Cell (td)

class	methodParamDesc

Unique identfier for the cost object

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

gl_account_key

Table Cell (td)

class	methodParamDesc

Unique identifer for the gl account

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start Date for the appointment

Table Row (tr)

Table Cell (td)

class	methodParamType

End

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End Date for the appointment

Table Row (tr)

Table Cell (td)

class	methodParamType

RATE_NAME

Table Cell (td)

class	methodParamName

Rate_name

Table Cell (td)

class	methodParamDesc

The name of the rate (from the list of available rates)

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Rate_Percent

Table Cell (td)

class	methodParamDesc

The positive of negative adjustment to be applied to this gl

Table Row (tr)

Table Cell (td)

class	methodParamType

GL_Account

Table Cell (td)

class	methodParamName

Source_GL

Table Cell (td)

class	methodParamDesc

The source GL for overhead amounts to be calcluated from

Table Row (tr)

Table Cell (td)

class	methodParamType

GL_Account

Table Cell (td)

class	methodParamName

Target_GL

Table Cell (td)

class	methodParamDesc

The target GL where the overhead surcharge lands

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	5
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_CO_MATCH

Table Cell (td)

class	methodErrorDesc

CO does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_GL_MATCH

Table Cell (td)

class	methodErrorDesc

Either the source or target GLs do not exist

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

RATE_EXISTS

Table Cell (td)

class	methodErrorDesc

You are attempting to edit a rate that already exists on this Scenario/CO/GL

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	updateCORateSpec
	updateCORateSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateCORateSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Adds an adjustment to a CO/GL combination

Table Row (tr)

Table Head (th)

rowspan	10
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Speculation_ID

Table Cell (td)

class	methodParamDesc

Unique identfier for the speculation to adjust

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

cost_collector_key

Table Cell (td)

class	methodParamDesc

Unique identfier for the cost object

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

gl_account_key

Table Cell (td)

class	methodParamDesc

Unique identifer for the gl account

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start Date for the appointment

Table Row (tr)

Table Cell (td)

class	methodParamType

End

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End Date for the appointment

Table Row (tr)

Table Cell (td)

class	methodParamType

RATE_NAME

Table Cell (td)

class	methodParamName

Rate_name

Table Cell (td)

class	methodParamDesc

The name of the rate (from the list of available rates)

Table Row (tr)

Table Cell (td)

class	methodParamType

Double

Table Cell (td)

class	methodParamName

Rate_Percent

Table Cell (td)

class	methodParamDesc

The positive of negative adjustment to be applied to this gl

Table Row (tr)

Table Cell (td)

class	methodParamType

GL_Account

Table Cell (td)

class	methodParamName

Source_GL

Table Cell (td)

class	methodParamDesc

The source GL for overhead amounts to be calcluated from

Table Row (tr)

Table Cell (td)

class	methodParamType

GL_Account

Table Cell (td)

class	methodParamName

Target_GL

Table Cell (td)

class	methodParamDesc

The target GL where the overhead surcharge lands

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_CO_MATCH

Table Cell (td)

class	methodErrorDesc

CO does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_GL_MATCH

Table Cell (td)

class	methodErrorDesc

Either the source or target GLs do not exist

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

RATE_EXISTS

Table Cell (td)

class	methodErrorDesc

You are attempting to edit a rate that already exists on this Scenario/CO/GL

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	dropCORateSpec
	dropCORateSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

dropCORateSpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Drop a Speculative rate from the system

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Speculation_ID

Table Cell (td)

class	methodParamDesc

Unique identfier for the speculation to adjust

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_SPEC_MATCH

Table Cell (td)

class	methodErrorDesc

Speculation does not exist in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	updateFTESpec
	updateFTESpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateFTESpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Update the FTE breakdown for a person

Table Row (tr)

Table Head (th)

rowspan	5
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Personnel_key

Table Cell (td)

class	methodParamDesc

Unique identfier for the person

Table Row (tr)

Table Cell (td)

class	methodParamType

MonthYear

Table Cell (td)

class	methodParamName

Start_Period

Table Cell (td)

class	methodParamDesc

Start period for changes

Table Row (tr)

Table Cell (td)

class	methodParamType

MonthYear

Table Cell (td)

class	methodParamName

End_Period

Table Cell (td)

class	methodParamDesc

End Period for changes

Table Row (tr)

Table Cell (td)

class	methodParamType

fteEntryType

Table Cell (td)

class	methodParamName

FTE_Schedule

Table Cell (td)

class	methodParamDesc

For any given person |personnel_key|fiscal_period| FTE %|

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	5
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_APPT_MATCH

Table Cell (td)

class	methodErrorDesc

Appointment not in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DATE_MISMATCH

Table Cell (td)

class	methodErrorDesc

Date in the API request does not match date in the FTE_Schedule

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DATE_APPT_MISMATCH

Table Cell (td)

class	methodErrorDesc

Date outside of Appt date ranges

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	updateVacationSpec
	updateVacationSpec

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateFTESpec

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Update the Vacation day breakdown for a person

Table Row (tr)

Table Head (th)

rowspan	5
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Personnel_key

Table Cell (td)

class	methodParamDesc

Unique identfier for the person

Table Row (tr)

Table Cell (td)

class	methodParamType

MonthYear

Table Cell (td)

class	methodParamName

Start_Period

Table Cell (td)

class	methodParamDesc

Start period for changes

Table Row (tr)

Table Cell (td)

class	methodParamType

MonthYear

Table Cell (td)

class	methodParamName

End_Period

Table Cell (td)

class	methodParamDesc

End Period for changes

Table Row (tr)

Table Cell (td)

class	methodParamType

fteEntryType

Table Cell (td)

class	methodParamName

FTE_Schedule

Table Cell (td)

class	methodParamDesc

For any given person |personnel_key|fiscal_period| # of vacation days|

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	5
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_APPT_MATCH

Table Cell (td)

class	methodErrorDesc

Appointment not in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DATE_MISMATCH

Table Cell (td)

class	methodErrorDesc

Date in the API request does not match date in the FTE_Schedule

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DATE_APPT_MISMATCH

Table Cell (td)

class	methodErrorDesc

Date outside of Appt date ranges

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	loadExpenseAllocSpecfromExternal
	loadExpenseAllocSpecfromExternal

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

loadExpenseAllocSpecfromExternal

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Loads the expense allocation information from a particular external system (SAP,COEUS)

Table Row (tr)

Table Head (th)

rowspan	7
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_Collector_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the CO

Table Row (tr)

Table Cell (td)

class	methodParamType

Source_System

Table Cell (td)

class	methodParamName

Source_System

Table Cell (td)

class	methodParamDesc

Either SAP or COEUS to represent the source system

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Plan_Version

Table Cell (td)

class	methodParamDesc

Either the SAP plan version to load, or COP for Coeus Proposal Budget or COA for Coeus Award Budget

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

The start date for the load

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

The cend date for the load

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

Replace

Table Cell (td)

class	methodParamDesc

If true, replace the expense allocations in the system. Otherwise attempt to add them to existing structure. Not replacing may result in double entries.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_CO_MATCH

Table Cell (td)

class	methodErrorDesc

Cost Object does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_PLAN_MATCH

Table Cell (td)

class	methodErrorDesc

No Plan exists of the identified type in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	loadDistAllocSpecfromExternal
	loadDistAllocSpecfromExternal

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

loadDistAllocSpecfromExternal

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Loads the labor distribution allocation information from a particular external system (SAP,COEUS)

Table Row (tr)

Table Head (th)

rowspan	7
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the Scenario

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_Collector_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for the CO

Table Row (tr)

Table Cell (td)

class	methodParamType

Source_System

Table Cell (td)

class	methodParamName

Source_System

Table Cell (td)

class	methodParamDesc

Either SAP or COEUS to represent the source system

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Plan_Version

Table Cell (td)

class	methodParamDesc

Either the SAP plan version to load, or COP for Coeus Proposal Budget or COA for Coeus Award Budget

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

The start date for the load

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

The cend date for the load

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

Replace

Table Cell (td)

class	methodParamDesc

If true, replace the expense allocations in the system. Otherwise attempt to add them to existing structure. Not replacing may result in double entries.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmMetaResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status of the task along with the object reference

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_CO_MATCH

Table Cell (td)

class	methodErrorDesc

Cost Object does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No Match for the scenario key

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_PLAN_MATCH

Table Cell (td)

class	methodErrorDesc

No Plan exists of the identified type in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot define scenarios in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Child pages

Versions Compared

Old Version 16

New Version Current

Key

Scenario Service

Description

References

Operations

Scenario Management