Search Results ff_function_parameters_api




Overview
Explore in AI Chat

Overview

APPS.FF_FUNCTION_PARAMETERS_API is a public PL/SQL API package that manages the metadata definitions of parameters belonging to Oracle EBS function definitions. In the Oracle E-Business Suite, a function is the lowest-level unit of security and navigable functionality registered against a form, a web page, a JSP, or a concurrent program. Many functions accept runtime parameters, and the definition of each such parameter — its name, class, data type, optionality, continuation behavior, and ordering — is stored in the FF_FUNCTION_PARAMETERS table. This package is the supported programmatic interface for creating, maintaining, and removing those parameter definitions, ensuring that every write enforces the same validation, object-versioning, effective-dating, and auditing rules that the standard Function/Parameter maintenance forms apply.

The package carries the header identifier ffffpapi.pkb 120.0 and follows the standard Oracle EBS API architecture: each public procedure issues a savepoint, invokes a corresponding business logic routine in the companion package FF_FUNCTION_PARAMETERS_BK1, sets a location marker through HR_UTILITY for debugging, and supports a validation-only mode through the p_validate flag. The presence of a documented API classification and only three documented procedures indicates a tightly scoped, single-purpose interface whose sole responsibility is parameter definition maintenance.

Key Procedures and Functions

  • CREATE_PARAMETER — Inserts a new function parameter definition into FF_FUNCTION_PARAMETERS. It accepts the effective date, the owning function identifier, and the parameter attributes (class, data type, name, optional flag, continuing-parameter flag), and returns the generated sequence number and object version number. The procedure truncates the time portion of the supplied effective date before delegating to the before-process hook in FF_FUNCTION_PARAMETERS_BK1.
  • UPDATE_PARAMETER — Modifies an existing parameter definition. It follows the same validation and effective-dating conventions as CREATE_PARAMETER, and relies on the object version number for optimistic locking so that concurrent maintenance does not silently overwrite another user's change.
  • DELETE_PARAMETER — Removes a function parameter record. This is the procedure associated with the search term "delete_parameter." Because the FF_FUNCTION_PARAMETERS table is date-effective and versioned, deletion through the API is the supported alternative to direct DML, and it preserves the integrity of the parameter sequence used when a function is executed.

Tables Accessed

The package operates against a single documented table accessed through its APPS synonym: FF_FUNCTION_PARAMETERS. This table is the repository of parameter definitions for every registered EBS function. CREATE_PARAMETER and UPDATE_PARAMETER write to it, DELETE_PARAMETER removes rows from it, and all three read from it to derive sequence numbers, validate effective dates, and maintain the OBJECT_VERSION_NUMBER column. Because the table is date-effective, callers must supply a valid effective date, and the API truncates any time component so that comparisons against the effective-date range behave consistently.

Usage Notes

FF_FUNCTION_PARAMETERS_API is typically invoked from the Oracle Applications Forms layer when an administrator defines or edits function parameters through the Function/Parameter maintenance screens, and from concurrent programs or upgrade scripts that migrate function and menu configuration between environments. Custom code should call this package rather than inserting into FF_FUNCTION_PARAMETERS directly, since direct DML bypasses the validation, object-version increment, and before-process user hooks implemented in FF_FUNCTION_PARAMETERS_BK1. All public procedures default p_validate to false; setting it to true runs the full validation path without committing, which is useful for pre-flight checks in data-loading routines. The documented metadata records that this package is referenced by one other package, confirming that it is a leaf-level maintenance API rather than a central utility. Callers should always capture and persist the returned sequence number and object version number, because subsequent UPDATE_PARAMETER and DELETE_PARAMETER calls depend on those values to locate the correct row and to detect concurrent modification.