Search Results retrieve_target_from_shnms




Overview

BIS_TARGET_PUB is the public PL/SQL API for creating and managing Targets within the Oracle EBS Key Performance Framework (KPF), the subsystem that underpins Balanced Scorecard and performance-measurement functionality. The package header declares AUTHID CURRENT_USER, meaning it executes with the privileges of the calling schema rather than the APPS owner, and it is classified as a PUB API — a supported, externally callable interface that Oracle permits customers and integrators to invoke directly. The header carries a header comment of $Header: BISPTARS.pls 115.30 2003/12/15, and the original creation date of 02-DEC-98, confirming the package has been a stable part of the performance-management stack since the earliest releases and remains present in 12.1.1 and 12.2.2.

The specific search term "retrieve_target_from_shnms" corresponds to the procedure RETRIEVE_TARGET_FROM_SHNMS, which is the variant of target retrieval keyed by short names rather than internal identifiers. The history block indicates that in January 2003 (bug 2715432) the OUT parameters x_Target_Level_Rec and x_Target_Rec were changed to IN OUT, and in December 2003 (enhancement 3148615) the package absorbed change/target-based alerting support. These entries signal that calling code must account for IN OUT semantics and for the post-2003 alerting behaviour.

Key Procedures and Functions

  • CREATE_TARGET — Creates a new target record within the Key Performance Framework, defining the measurement objective for a given target level, plan, and dimensional context.
  • RETRIEVE_TARGETS — Returns a set or collection of targets, typically for display or processing across a range of levels, plans, or dimensions.
  • RETRIEVE_TARGET — Retrieves a single target using its internal identifiers, populating a target record structure.
  • RETRIEVE_TARGET_FROM_SHNMS — Retrieves target details using short names (SHNMS) as the lookup key rather than numeric IDs. Its IN OUT record parameters were reworked under bug 2715432, so callers must supply initialised record variables.
  • UPDATE_TARGET — Modifies an existing target's attributes, including the dimensional and time-level values.
  • DELETE_TARGET — Removes an existing target from the framework.
  • VALIDATE_TARGET — Performs pre-insert or pre-update validation of target data, ensuring referenced levels, plans, and dimension values are consistent before persistence.

All procedures operate on the Target_Rec_Type record defined in the package specification, which carries target and level identifiers, plan identifiers, and ID/name pairs for the org level, time level, and five generic dimensions (DIM1 through DIM5).

Tables Accessed

The documented table references via APPS synonyms are HTP and PLITBLM. HTP is the Oracle HTML/PLSQL Toolkit package used to generate HTML output fragments, which indicates that portions of this API, or its companion reporting paths, emit formatted web output — consistent with the use of this API by HTML-based performance dashboards. PLITBLM is the PL/SQL table-to-BLOB/LONG utility package used for buffering large character data; its presence suggests that target retrieval may return substantial textual content (for example, alert or commentary text) that requires buffering. The underlying target, level, plan, and dimension definitions themselves reside in the BIS schema tables managed through the Key Performance Framework, which this API manipulates indirectly.

Usage Notes

BIS_TARGET_PUB is referenced by 25 other packages, establishing it as a central integration point. It is typically invoked from Oracle EBS performance-management forms that maintain targets, from concurrent programs that batch-create or refresh targets, and from custom code written against the PUB interface. Because the package is a documented public API, direct DML against the underlying BIS tables should be avoided in favour of these procedures, which enforce validation via VALIDATE_TARGET. Developers invoking RETRIEVE_TARGET_FROM_SHNMS must pass pre-populated IN OUT records, and should be aware of the change/target-based alerting behaviour introduced in enhancement 3148615 when interpreting retrieved results.