Search Results ff_functions_api




Overview
Explore in AI Chat

Overview

The APPS.FF_FUNCTIONS_API package is a public PL/SQL API within the Oracle E-Business Suite (EBS) 12.1.1 and 12.2.2 releases, owned by the APPS schema and classified as an API. It provides a programmatic interface for the maintenance of Oracle FastFormula functions — the user-defined and seeded functions that can be referenced inside FastFormula expressions used across Oracle HRMS, Payroll, and related modules. Rather than manipulating the underlying function definition tables directly, developers and integrators are expected to invoke the supported procedures in this package so that validation, context handling, parameter parsing, and derived data are maintained consistently with the FastFormula engine.

The package is part of the broader FastFormula framework alongside function, context, and parameter definitions. Its dependencies confirm this role: it references HR_API (the HRMS generic API utility package) and the SYS.STANDARD package, and it is itself referenced by the APPS.FF_FUNCTIONS_API package body, indicating a self-contained implementation with no external package dependents documented in the ETRM metadata.

Key Procedures and Functions

The package exposes three documented entry points:

  • CREATE_FUNCTION — Creates a new FastFormula function definition. It is used when a function must be introduced into the FastFormula environment so that formulas can call it. The procedure writes the function header and its associated context usages and parameters into the function tables.
  • UPDATE_FUNCTION — Modifies an existing function definition, allowing changes to the function's attributes, context usage, and parameter definitions. This is the supported path for correcting or extending a function already in use.
  • DELETE_FUNCTION — Removes a previously defined function from the FastFormula environment, typically after confirming that no active formulas still depend on it.

No parameter lists are reproduced here; the documented procedure names and their intents are as listed above. Each procedure follows the standard EBS API convention of accepting a row identifier (for update and delete) and returning a standard success or error status.

Tables Accessed

The package operates on three documented tables, accessed through APPS synonyms:

  • FF_FUNCTIONS — The primary table storing function headers, including the function name, description, and definition attributes. This is the core object created, updated, and deleted by the API.
  • FF_FUNCTION_CONTEXT_USAGES — Records the contexts in which each function may be used. The API maintains these rows so the FastFormula compiler knows where a function is valid.
  • FF_FUNCTION_PARAMETERS — Stores the parameter definitions attached to each function, including parameter identity and ordering. These rows are written and maintained as part of function creation and update.

All three tables form the persistence layer for FastFormula functions, and direct DML against them is not a supported integration approach.

Usage Notes

In typical EBS deployments, FF_FUNCTIONS_API is invoked from HRMS configuration forms, setup migration scripts, and custom concurrent programs that seed or maintain FastFormula functions. Custom code and third-party integrations that need to introduce functions should call these procedures rather than inserting into the base tables, ensuring the same validation applied by the application forms. Because the package is documented as being referenced by zero other packages, it represents a leaf-level API that is called directly by forms or custom PL/SQL, not chained through another product package. As with all EBS public APIs, callers should honor the standard API return status and commit after successful completion.