Search Results get_pluginfo_params

Overview

The APPS.BSC_PORTLET_KPILISTCUST package is a component of the Oracle Balanced Scorecard (BSC) module within Oracle E-Business Suite. Its primary responsibility is to manage the customization and display of KPI (Key Performance Indicator) list portlets that appear on the Oracle EBS Portal homepage. The package belongs to the Other API classification and is owned by the APPS schema. The package is registered under APPLICATION_ID 271, which corresponds to the Balanced Scorecard application. The header comment ($Header: BSCPKCS.pls 120.3 2007/02/08) indicates the file has been under version control since at least 2007, reflecting a stable, long-lived codebase whose behavior remains consistent across Oracle EBS 12.1.1 and 12.2.2 releases.

Functionally, the package enables users to personalize how KPI list portlets render on their portal pages. It supports retrieving portlet configuration parameters, persisting user-specific customization settings, updating the indicators associated with a responsibility, and decoding previously saved customizations from a cookie or encrypted identifier. This customization layer is essential because different users and responsibilities require different KPI views, and the portal must persist and recall each user's choices across sessions.

Key Procedures and Functions

• GET_PLUGINFO_PARAMS — A function that accepts a responsibility identifier and returns the portlet plug-in information parameters as a VARCHAR2. This is the entry point most commonly associated with administrative or debugging queries against the package, and it feeds the portal engine the configuration needed to render the KPI list.
• UPDATE_INDICATORS — A procedure that updates the set of indicators linked to a given responsibility. It accepts the responsibility ID, audit columns (last update date and last updated by), and an array of numbers representing the indicator set to be persisted.
• SET_CUSTOMIZED_DATA_PRIVATE_N — A function that writes a user's private portlet customization to persistent storage. It captures the user, plug, reference path, responsibility, display flag settings (details, group, and KPI measure details), audit information, portlet name, and the numeric array of selected items, returning a status string via an OUT parameter.
• GET_CUSTOMIZATION — A function that reads stored customization data using a cookie value and encrypted plug identifier. It returns a numeric status and populates OUT parameters describing the resolved responsibility, plug, user, display flags, display name, KPI selection state, and measure-detail flag.

Tables Accessed

The package reads and writes several Balanced Scorecard and portal tables through APPS synonyms. BSC_KPIS_B holds KPI base definitions, while BSC_TAB_INDICATORS stores the indicator-to-tab relationships maintained by UPDATE_INDICATORS. User-specific selections are persisted in BSC_USER_KPILIST_KPIS and BSC_USER_KPILIST_PLUGS. Access control is enforced through BSC_USER_KPI_ACCESS and BSC_USER_TAB_ACCESS, and general user portlet preferences are held in BSC_USER_PARAMETERS_B. Finally, ICX_PORTLET_CUSTOMIZATIONS stores the portal-level customization records that GET_CUSTOMIZATION and SET_CUSTOMIZED_DATA_PRIVATE_N interact with.

Usage Notes

This package is invoked indirectly by the Oracle EBS Portal framework when a user views or edits a KPI list portlet. It is not typically exposed through standard concurrent programs or Forms; instead, the portlet rendering engine and the ICX portal infrastructure call it at runtime. Customizations are keyed by cookie and encrypted plug identifier so that user settings persist across sessions without requiring explicit login context at read time. Because the package is referenced by one other package, developers extending BSC portlet behavior should trace that dependency before modifying signatures. Direct calls from custom code are possible but should preserve the existing parameter contracts, particularly the NOCOPY OUT parameters, to avoid performance regressions.