Search Results copy_scenario_data
Overview
FPA_SCENARIO_PVT is a private PL/SQL package owned by APPS within the Oracle Enterprise Business Suite Financial Planning and Analysis (FPA) module. Unlike a public API, a PVT classification indicates the package is intended for internal use by other FPA packages and forms, not for direct invocation by external or customer-written code. The package encapsulates the core business logic for managing "scenarios" — planning constructs that hold proposed projects, capital values, discount rates, and funding availability used during budgeting and capital planning cycles.
The package exposes a record type, scenario_rec_type, that bundles scenario attributes such as short name, name, description, status, planning cycle, organization ID, an indicator for new-capital scenarios, and a flag distinguishing new scenarios. This structure is used for locking and validating scenario rows, providing a consistent in-memory representation of a scenario throughout the package. The package header is versioned at 120.1, a relatively stable object reflecting long-standing functionality in the FPA schema.
Key Procedures and Functions
- CREATE_SCENARIO — Creates a new scenario record, taking the API version, scenario name, description, and planning cycle ID, and returning the newly generated scenario identifier plus standard API return-status outputs.
- COPY_SCENARIO_DATA — Copies data from a source scenario to a target scenario, with a control flag governing whether proposed projects are included in the copy.
- LOCK_SCENARIO — Locks a scenario using the scenario record type, supporting the standard commit flag and API return-status conventions for concurrency control.
- CHECK_SCENARIO_NAME — A function that validates scenario name uniqueness within a planning cycle, returning a numeric indicator.
- UPDATE_SCEN_APPROVED_FLAG — Sets the approval flag on a scenario, defaulting to "NA" if not supplied.
- UPDATE_SCENARIO_DISC_RATE — Updates the discount rate associated with a scenario.
- UPDATE_SCENARIO_FUNDS_AVAIL — Updates the funding availability attribute of a scenario.
- UPDATE_SCENARIO_INITIAL_FLAG — Toggles the "initial" flag on a scenario.
- UPDATE_SCENARIO_WORKING_FLAG — Toggles the "working" flag on a scenario.
- UPDATE_SCENARIO_RECCOM_FLAG — Updates the recommendation flag on a scenario.
- UPDATE_SCENARIO_RECCOM_STATUS — Updates the recommendation status on a scenario (this is the procedure the search term references).
- COPY_SCE_PROJECT_DATA — Copies project-level data associated with a scenario.
- REMOVE_PROJECT_FROM_SCENARIO — Detaches a project from a scenario.
- UPDATE_PROJ_USER_RANKS — Updates per-user ranking values for projects.
- CALC_SCENARIO_DATA — Performs calculation logic over scenario data.
Tables Accessed
The package references the following tables via APPS synonyms: FPA_SCENARIO_S is the primary base table where scenario records are stored and manipulated; FPA_OBJECTS_TL holds translatable object names and descriptions; FND_LANGUAGES and NLS_SESSION_PARAMETERS provide language and locale context for translations; DBMS_AW indicates use of Oracle's Analytic Workspace functionality (typically for analytic/OLAP calculations); DUAL is used for single-row queries; and PLITBLM is a standard error/message-handling utility table.
Usage Notes
Because FPA_SCENARIO_PVT is a private package, it is normally invoked indirectly by other FPA packages (the metadata shows it is referenced by two other packages) rather than called directly from forms or concurrent programs. The recommended integration point for external customization is the corresponding public API layer. When extending scenarios, developers should call the public wrapper that eventually delegates to these private procedures. The presence of standard API parameters — p_api_version, x_return_status, x_msg_count, and x_msg_data — confirms alignment with the Oracle Application Object Library API conventions for error reporting.