You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Scenario Service

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Name

Unknown macro: {td}

Scenario Service

Unknown macro: {tr}
Unknown macro: {th}

Version

Unknown macro: {td}

Dev ([0.1])

Unknown macro: {td}

[Release Notes]

References

Operations

Capabilities

Description

The Scenario Service is focused on the management of scenarios. All forecasts in the system are directly related to one or more scenarios. The default scenario is the COMMON scenario. Users have the ability to copy to and from the COMMON scenario. Users enter forecasts by manipulating speculations, including adding or removing allocations.For any given combination (CO/GL/(Line Item/Person/Rate)/SpecType) only one speculation is allowed in a scenario. Speculations can also focus on CO or person Metadata.

Assumptions are used to track global information that effects all cost objects/people in the scenario and can include: Merit Increases (By employee category), Inflation (to handle tuition/stipend inflation) and adjustments to Global base rates.

References

see RAFT Requirements Documentation (RAFT-*)

Operations

Scenario

Scenario Management
showCOAttributes
showApptAttributes
showScenarioOverview
showScenaroFinImpact
showScenarioPersonImpact
showScenarioDetail
showCOExpenseDetail
showCOPersonDetail
showCODetail
showApptDetail
createScenario
deleteScenario
addCOtoScenario
addAppttoScenario
dropCOfromScenario
dropApptfromScenario
copyScenario
archiveScenario
addAssumption
dropAssumption
updateAssumption
addExpenseAllocSpec
addApptAllocSpec
updateExpenseAllocSpec
updateApptAllocSpec
dropExpenseAllocSpec
dropApptAllocSpec
addTBACOSpec
addTBHApptSpec
dropTBACOSpec
dropTBHApptSpec
updateCOSpec
updateApptSpec
addAdjSpec
dropAdjSpec
addCORateSpec
dropCORateSpec
updateFTESpec
updateVacationSpec
createExpenseAllocSpecfromCOEUS
createExpenseAllocSpecfromSAP
createPersonAllocSpecfromCOEUS

recalcApptDetail
recalcExpenseDetail
buildScenarioSummary
buildWorksetSummary

checkSystemStatus
setScenarioVisibility
setWorksetVisibility

checkProjectedBalance
checkGLBudget
checkMonthlyBurn
checkPersonAlloc
checkRemainingGLBalance
checkRemainingBalance

showVarianceonScenario

Scenario Management">Scenario Management

Scenario Management

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

showCOAttributes}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Cost_Collector_key

Unknown macro: {td}

The unique identifier for the cost object

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for this scenario

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[coMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

Scenario or CO does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot access objects in the scenario

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

showApptAttributes}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Personnel_key

Unknown macro: {td}

The unique identifier for the cost object

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for this scenario

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[apptMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

Scenario or Appt does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot access objects in the scenario

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

showScenarioOverview}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[scenarioOverviewMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

Scenario does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot access objects in the scenario

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

showScenarioFinImpact}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Shows a CO level summary of the cost object

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[scenarioFinancialImpactMetaResultType]

Unknown macro: {td}

Provides a high-level of the CO financial impact information

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

Scenario does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot access objects in the scenario

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

showScenarioPersonImpact}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Provide a summary view of the personnel Impact of this Scenario

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[scenarioOverviewMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

Scenario does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot access objects in the scenario

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

showScenarioSpeculations}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[speclistMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

Scenario does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot access objects in the scenario

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

showScenarioExceptions}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[scenarioExceptionMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

Scenario does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot access objects in the scenario

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

showExpenseDetail}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

tr}

Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Cost_Collector_key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[expenseSpeculationMetaResultType]

Unknown macro: {td}

Returns the Expense Speculation information as a structure

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

Scenario does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot access objects in the scenario

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}
Unknown macro: {tr}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

showCOApptDetail}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

For a CO, the labor distributions on this account

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Cost_Collector_Key

Unknown macro: {td}

The unique identifier for the Cost Object

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[distributionSpeculationMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

Scenario does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot access objects in the scenario

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

showApptDetail}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Personnel_key

Unknown macro: {td}

The unique identifier for the Person/Appt

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[distributionSpeculationMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

Scenario does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot access objects in the scenario

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

createScenario

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Defines an empty Scenario

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {td}

Array

Unknown macro: {td}

Parm

Unknown macro: {td}

Scenario parameters (Include commitments so far)

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

EXISTS

Unknown macro: {td}

Scenario exists in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}
Unknown macro: {tr}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

updateScenario

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Updates the scenario metadata with the identified PARM

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {td}

Array

Unknown macro: {td}

Parm

Unknown macro: {td}

Scenario parameters (Include commitments so far)

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_EXIST

Unknown macro: {td}

Scenario does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}
Unknown macro: {tr}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

deleteScenario}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

Scenario does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

addCOtoScenario}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Adds a collection of COs to a scenario

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

Array

Unknown macro: {td}

CoArray

Unknown macro: {td}

A collection of cost objects to add to the scenario

Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

with_children

Unknown macro: {td}

Include child cost objects

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

EXISTS

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot perform actions on this scenario

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

One or more COs specified do not exist

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

addAppttoScenario}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Adds a collection of Appts to a scenario

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

Array

Unknown macro: {td}

ApptArray

Unknown macro: {td}

A collection of appointments to add to the scenario

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

EXISTS

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot perform actions on this scenario

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

One or more COs specified do not exist

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

dropCOfromScenario}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Removes a CO from a Scenario

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Cost_Collector_key

Unknown macro: {td}

A cost objects to remove from the scenario

Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

with_children

Unknown macro: {td}

Include child cost objects

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot perform actions on this scenario

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

CO specified does not exist

Unknown macro: {tr}
Unknown macro: {td}

DEPENDENT_OBJECTS

Unknown macro: {td}

Warning: CO has speculations

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

dropApptfromScenario}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Drops an Appts from a scenario

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Personnel_key

Unknown macro: {td}

An appt to remove from a scenario

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

DEPENDENT_OBJECTS

Unknown macro: {td}

Warning: Appt has speculations

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

DEPENDENT_COS

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot perform actions on this scenario

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

One or more COs specified do not exist

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

archiveScenario}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Archives the specific scenario in question.

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

Scenario does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

copyScenario}

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Copies a Scenario to another scenario

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Source_Scenario_Key

Unknown macro: {td}

The unique identifier for the source Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Destination_Scenario_Key

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

Overwrite

Unknown macro: {td}

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.

Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

Update_Objects

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_SOURCE

Unknown macro: {td}

Source Scenario does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_DESTINATION

Unknown macro: {td}

Destination scenario does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

SET_ISSUE

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}

SPEC_EXISTS

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}
Unknown macro: {tr}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

addAssumption

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

ASSUMPTION_TYPE

Unknown macro: {td}

Assumption_TYPE

Unknown macro: {td}

One of: MERIT_INCREASE, RATE or INFLATION

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Assumption_Desc

Unknown macro: {td}

Short description for the assumption

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Assumption_Percent

Unknown macro: {td}

Adjustment percentage for the assumption

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

The Start_Date for the Assumption

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

End_Date

Unknown macro: {td}

The End_Date for the Assumption

Unknown macro: {tr}
Unknown macro: {td}

GL_ACCOUNT

Unknown macro: {td}

Source_GL

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

GL_ACCOUNT

Unknown macro: {td}

Target_GL

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

Merge

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_SOURCE

Unknown macro: {td}

Source GL does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_DESTINATION

Unknown macro: {td}

Destination GL does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

SET_ISSUE

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

EXISTS

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

dropAssumption

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Removes an assumption from the system for the identified scenario

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

ASSUMPTION_TYPE

Unknown macro: {td}

Assumption_TYPE

Unknown macro: {td}

One of: MERIT_INCREASE, RATE or INFLATION

Unknown macro: {tr}
Unknown macro: {td}

Integer

Unknown macro: {td}

Assumption_ID

Unknown macro: {td}

The unique identifier for the assumption to be removed

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Assumption_Percent

Unknown macro: {td}

Adjustment percentage for the assumption

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_ASSUMPTION

Unknown macro: {td}

Assumption does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

updateAssumption

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

Integer

Unknown macro: {td}

Assumption_ID

Unknown macro: {td}

The unique identifier for the assumption

Unknown macro: {tr}
Unknown macro: {td}

ASSUMPTION_TYPE

Unknown macro: {td}

Assumption_TYPE

Unknown macro: {td}

One of: MERIT_INCREASE, RATE or INFLATION

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Assumption_Desc

Unknown macro: {td}

Short description for the assumption

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Assumption_Percent

Unknown macro: {td}

Adjustment percentage for the assumption

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

The Start_Date for the Assumption

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

End_Date

Unknown macro: {td}

The End_Date for the Assumption

Unknown macro: {tr}
Unknown macro: {td}

GL_ACCOUNT

Unknown macro: {td}

Source_GL

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

GL_ACCOUNT

Unknown macro: {td}

Target_GL

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

Merge

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_SOURCE

Unknown macro: {td}

Source GL does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_DESTINATION

Unknown macro: {td}

Destination GL does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_Assumption

Unknown macro: {td}

Assumption does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

addExpenseAllocSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Line_Item

Unknown macro: {td}

Description of the Line_Item to add

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Line_Item_Total

Unknown macro: {td}

The Total cost of the Line Item

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

The Start_Date for the Speculation

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

End_Date

Unknown macro: {td}

The End_Date for the Assumption

Unknown macro: {tr}
Unknown macro: {td}

[allocationMetaResultType]

Unknown macro: {td}

Allocation_Obj

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

MISSING_CO

Unknown macro: {td}

COs identified do not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

EXISTS

Unknown macro: {td}

Line Item exists for start/end Date range specified

Unknown macro: {tr}
Unknown macro: {td}

MIS-ALLOC

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

addApptAllocSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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.

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

Personnel_key

Unknown macro: {td}

Personnel_key

Unknown macro: {td}

The unique identifier for the person/appt

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Dist_Total

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

The Start_Date for the Speculation

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

End_Date

Unknown macro: {td}

The End_Date for the Assumption

Unknown macro: {tr}
Unknown macro: {td}

[allocationMetaResultType]

Unknown macro: {td}

Allocation_Obj

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

MISSING_CO

Unknown macro: {td}

COs identified do not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

EXISTS

Unknown macro: {td}

Person Allocations exist for start/end date range specified

Unknown macro: {tr}
Unknown macro: {td}

MIS-ALLOC

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

MISSING_Appt

Unknown macro: {td}

Appt Identifier does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

updateExpenseAllocSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

Integer

Unknown macro: {td}

Speculation_ID

Unknown macro: {td}

Unique identifier for speculation

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Line_Item

Unknown macro: {td}

Description of the Line_Item to add

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Line_Item_Total

Unknown macro: {td}

The Total cost of the Line Item

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

The Start_Date for the Speculation

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

End_Date

Unknown macro: {td}

The End_Date for the Assumption

Unknown macro: {tr}
Unknown macro: {td}

[allocationMetaResultType]

Unknown macro: {td}

Allocation_Obj

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

MISSING_CO

Unknown macro: {td}

COs identified do not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

MIS-ALLOC

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_Speculation_MATCH

Unknown macro: {td}

No Match for the speculation

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

updateApptAllocSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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.

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

Integer

Unknown macro: {td}

Speculation_ID

Unknown macro: {td}

The unique identifier for the speculation

Unknown macro: {tr}
Unknown macro: {td}

Personnel_key

Unknown macro: {td}

Personnel_key

Unknown macro: {td}

The unique identifier for the person/appt

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Dist_Total

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

The Start_Date for the Speculation

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

End_Date

Unknown macro: {td}

The End_Date for the Assumption

Unknown macro: {tr}
Unknown macro: {td}

[allocationMetaResultType]

Unknown macro: {td}

Allocation_Obj

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

MISSING_CO

Unknown macro: {td}

COs identified do not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_SPEC_MATCH

Unknown macro: {td}

Speculation ID does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

MIS-ALLOC

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

MISSING_Appt

Unknown macro: {td}

Appt Identifier does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

dropExpenseAllocSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Drops an expense allocation from the system.

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

Integer

Unknown macro: {td}

Speculation_ID

Unknown macro: {td}

Unique identifier for speculation

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_Speculation_MATCH

Unknown macro: {td}

No Match for the speculation

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

dropApptAllocSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Drops an appt allocation from the system.

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

Integer

Unknown macro: {td}

Speculation_ID

Unknown macro: {td}

The unique identifier for the speculation

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_SPEC_MATCH

Unknown macro: {td}

Speculation ID does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

addTBACOSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Adds a non-existent CO to a scenario

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Cost_Collector_Key

Unknown macro: {td}

The unique identifier for the CO

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Cost_Collector_Title

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Total

Unknown macro: {td}

The authorized total or total institute budget

Unknown macro: {tr}
Unknown macro: {td}

Sponsor_key

Unknown macro: {td}

Sponsor_key

Unknown macro: {td}

The source of funding

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

The cost object effective date

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

End_Date

Unknown macro: {td}

The cost object expiration date

Unknown macro: {tr}
Unknown macro: {td}

Cost_Collector_key

Unknown macro: {td}

Cost_Collector_parent_key

Unknown macro: {td}

The parent of this cost object

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

CO_EXISTS

Unknown macro: {td}

Cost Collector already exists in scenario

Unknown macro: {tr}
Unknown macro: {td}

NO_CO_PARENT

Unknown macro: {td}

Parent CO does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

addTBHApptSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Person

Unknown macro: {td}

Name/Descriptor for the person

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Position_Title

Unknown macro: {td}

The name of the position

Unknown macro: {tr}
Unknown macro: {td}

Appt_Type

Unknown macro: {td}

Appt_Type

Unknown macro: {td}

The Employee Category used for overhead calculations

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

Start Date for the appointment

Unknown macro: {tr}
Unknown macro: {td}

End

Unknown macro: {td}

End_Date

Unknown macro: {td}

End Date for the appointment

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Period_Salary

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

dropTBACOSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Removes a TBA CO from a scenario

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Speculation_ID

Unknown macro: {td}

The unique identifier for the Speculation

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_SPEC_MATCH

Unknown macro: {td}

No Match for the speculation_id

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

dropTBHApptSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Removes a TBH person from the scenario

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

Integer

Unknown macro: {td}

Speculation_ID

Unknown macro: {td}

The unique identifier for the speculation

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_SPEC_MATCH

Unknown macro: {td}

Speculation does not exist in scenario

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

updateTBACOSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Updates CO metadata for a TBA cost object

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Speculation_ID

Unknown macro: {td}

The unique identifier for the Speculation

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Cost_Collector_Key

Unknown macro: {td}

The unique identifier for the CO

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Cost_Collector_Title

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Total

Unknown macro: {td}

The authorized total or total institute budget

Unknown macro: {tr}
Unknown macro: {td}

Sponsor_key

Unknown macro: {td}

Sponsor_key

Unknown macro: {td}

The source of funding

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

The cost object effective date

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

End_Date

Unknown macro: {td}

The cost object expiration date

Unknown macro: {tr}
Unknown macro: {td}

Cost_Collector_key

Unknown macro: {td}

Cost_Collector_parent_key

Unknown macro: {td}

The parent of this cost object

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_SPEC_MATCH

Unknown macro: {td}

Speculation does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_CO_PARENT

Unknown macro: {td}

Parent CO does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

updateTBHApptSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Update metadata for a particular appointment

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Speculation_ID

Unknown macro: {td}

Unique identifier for the speculation

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Person

Unknown macro: {td}

Name/Descriptor for the person

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Position_Title

Unknown macro: {td}

The name of the position

Unknown macro: {tr}
Unknown macro: {td}

Appt_Type

Unknown macro: {td}

Appt_Type

Unknown macro: {td}

The Employee Category used for overhead calculations

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

Start Date for the appointment

Unknown macro: {tr}
Unknown macro: {td}

End

Unknown macro: {td}

End_Date

Unknown macro: {td}

End Date for the appointment

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Period_Salary

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_SPEC_MATCH

Unknown macro: {td}

No match for the speculation in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

updateCOSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Cost_Collector_Key

Unknown macro: {td}

The unique identifier for the CO

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Authorized_Total

Unknown macro: {td}

The authorized total or total institute budget

Unknown macro: {tr}
Unknown macro: {td}

Sponsor_key

Unknown macro: {td}

Sponsor_key

Unknown macro: {td}

The source of funding

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

The cost object effective date

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

End_Date

Unknown macro: {td}

The cost object expiration date

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_CO_MATCH

Unknown macro: {td}

Cost Object does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

updateApptSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Personell_key

Unknown macro: {td}

Unique identfier for the appointment

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Position_Title

Unknown macro: {td}

The name of the position

Unknown macro: {tr}
Unknown macro: {td}

Appt_Type

Unknown macro: {td}

Appt_Type

Unknown macro: {td}

The Employee Category used for overhead calculations

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

Start Date for the appointment

Unknown macro: {tr}
Unknown macro: {td}

End

Unknown macro: {td}

End_Date

Unknown macro: {td}

End Date for the appointment

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Period_Salary

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_APPT_MATCH

Unknown macro: {td}

Appt does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

addAdjSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Adds an adjustment to a CO/GL combination

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

cost_collector_key

Unknown macro: {td}

Unique identfier for the cost object

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

gl_account_key

Unknown macro: {td}

Unique identifer for the gl account

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

Start Date for the appointment

Unknown macro: {tr}
Unknown macro: {td}

End

Unknown macro: {td}

End_Date

Unknown macro: {td}

End Date for the appointment

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Adjustment_Percent

Unknown macro: {td}

The positive of negative adjustment to be applied to this gl

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_CO_MATCH

Unknown macro: {td}

CO does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {td}

NO_IMPACT

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

dropAdjSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Drop adjustment spec from the scenario

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Speculation_ID

Unknown macro: {td}

Unique identfier for the speculation

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_SPEC_MATCH

Unknown macro: {td}

Speculation does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

addCORateSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

cost_collector_key

Unknown macro: {td}

Unique identfier for the cost object

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

gl_account_key

Unknown macro: {td}

Unique identifer for the gl account

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

Start Date for the appointment

Unknown macro: {tr}
Unknown macro: {td}

End

Unknown macro: {td}

End_Date

Unknown macro: {td}

End Date for the appointment

Unknown macro: {tr}
Unknown macro: {td}

RATE_NAME

Unknown macro: {td}

Rate_name

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Rate_Percent

Unknown macro: {td}

The positive of negative adjustment to be applied to this gl

Unknown macro: {tr}
Unknown macro: {td}

GL_Account

Unknown macro: {td}

Source_GL

Unknown macro: {td}

The source GL for overhead amounts to be calcluated from

Unknown macro: {tr}
Unknown macro: {td}

GL_Account

Unknown macro: {td}

Target_GL

Unknown macro: {td}

The target GL where the overhead surcharge lands

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_CO_MATCH

Unknown macro: {td}

CO does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {td}

NO_GL_MATCH

Unknown macro: {td}

Either the source or target GLs do not exist

Unknown macro: {tr}
Unknown macro: {td}

RATE_EXISTS

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

updateCORateSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Adds an adjustment to a CO/GL combination

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Speculation_ID

Unknown macro: {td}

Unique identfier for the speculation to adjust

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

cost_collector_key

Unknown macro: {td}

Unique identfier for the cost object

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

gl_account_key

Unknown macro: {td}

Unique identifer for the gl account

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

Start Date for the appointment

Unknown macro: {tr}
Unknown macro: {td}

End

Unknown macro: {td}

End_Date

Unknown macro: {td}

End Date for the appointment

Unknown macro: {tr}
Unknown macro: {td}

RATE_NAME

Unknown macro: {td}

Rate_name

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

Double

Unknown macro: {td}

Rate_Percent

Unknown macro: {td}

The positive of negative adjustment to be applied to this gl

Unknown macro: {tr}
Unknown macro: {td}

GL_Account

Unknown macro: {td}

Source_GL

Unknown macro: {td}

The source GL for overhead amounts to be calcluated from

Unknown macro: {tr}
Unknown macro: {td}

GL_Account

Unknown macro: {td}

Target_GL

Unknown macro: {td}

The target GL where the overhead surcharge lands

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_CO_MATCH

Unknown macro: {td}

CO does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {td}

NO_GL_MATCH

Unknown macro: {td}

Either the source or target GLs do not exist

Unknown macro: {tr}
Unknown macro: {td}

RATE_EXISTS

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

dropCORateSpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Drop a Speculative rate from the system

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Speculation_ID

Unknown macro: {td}

Unique identfier for the speculation to adjust

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_SPEC_MATCH

Unknown macro: {td}

Speculation does not exist in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

updateFTESpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Update the FTE breakdown for a person

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Personnel_key

Unknown macro: {td}

Unique identfier for the person

Unknown macro: {tr}
Unknown macro: {td}

MonthYear

Unknown macro: {td}

Start_Period

Unknown macro: {td}

Start period for changes

Unknown macro: {tr}
Unknown macro: {td}

MonthYear

Unknown macro: {td}

End_Period

Unknown macro: {td}

End Period for changes

Unknown macro: {tr}
Unknown macro: {td}

[fteEntryType]

Unknown macro: {td}

FTE_Schedule

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_APPT_MATCH

Unknown macro: {td}

Appointment not in system

Unknown macro: {tr}
Unknown macro: {td}

DATE_MISMATCH

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

DATE_APPT_MISMATCH

Unknown macro: {td}

Date outside of Appt date ranges

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

updateFTESpec

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

Update the Vacation day breakdown for a person

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Personnel_key

Unknown macro: {td}

Unique identfier for the person

Unknown macro: {tr}
Unknown macro: {td}

MonthYear

Unknown macro: {td}

Start_Period

Unknown macro: {td}

Start period for changes

Unknown macro: {tr}
Unknown macro: {td}

MonthYear

Unknown macro: {td}

End_Period

Unknown macro: {td}

End Period for changes

Unknown macro: {tr}
Unknown macro: {td}

[fteEntryType]

Unknown macro: {td}

FTE_Schedule

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_APPT_MATCH

Unknown macro: {td}

Appointment not in system

Unknown macro: {tr}
Unknown macro: {td}

DATE_MISMATCH

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

DATE_APPT_MISMATCH

Unknown macro: {td}

Date outside of Appt date ranges

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

loadExpenseAllocSpecfromExternal

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Cost_Collector_Key

Unknown macro: {td}

The unique identifier for the CO

Unknown macro: {tr}
Unknown macro: {td}

Source_System

Unknown macro: {td}

Source_System

Unknown macro: {td}

Either SAP or COEUS to represent the source system

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Plan_Version

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

The start date for the load

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

End_Date

Unknown macro: {td}

The cend date for the load

Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

Replace

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_CO_MATCH

Unknown macro: {td}

Cost Object does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_PLAN_MATCH

Unknown macro: {td}

No Plan exists of the identified type in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Method

Unknown macro: {td}

loadDistAllocSpecfromExternal

Unknown macro: {tr}
Unknown macro: {th}

Description

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Parameters

Unknown macro: {td}

String

Unknown macro: {td}

Scenario_Key

Unknown macro: {td}

The unique identifier for the Scenario

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Cost_Collector_Key

Unknown macro: {td}

The unique identifier for the CO

Unknown macro: {tr}
Unknown macro: {td}

Source_System

Unknown macro: {td}

Source_System

Unknown macro: {td}

Either SAP or COEUS to represent the source system

Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

Plan_Version

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

Start_Date

Unknown macro: {td}

The start date for the load

Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

End_Date

Unknown macro: {td}

The cend date for the load

Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

Replace

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Return

Unknown macro: {td}

[confirmMetaResultType]

Unknown macro: {td}

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

Unknown macro: {tr}
Unknown macro: {th}

Errors

Unknown macro: {td}

NO_CO_MATCH

Unknown macro: {td}

Cost Object does not exist in system

Unknown macro: {tr}
Unknown macro: {td}

NO_MATCH

Unknown macro: {td}

No Match for the scenario key

Unknown macro: {tr}
Unknown macro: {td}

NO_PLAN_MATCH

Unknown macro: {td}

No Plan exists of the identified type in the system

Unknown macro: {tr}
Unknown macro: {td}

NO_AUTH

Unknown macro: {td}

User cannot define scenarios in this workset

Unknown macro: {tr}
Unknown macro: {th}

Capabilities

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Use Cases

Unknown macro: {td}
Unknown macro: {tr}
Unknown macro: {th}

Comments/Feedback

Unknown macro: {td}

Back to Operations

  • No labels