Search Results retain_am




Overview
Explore in AI Chat

Overview

CS_KB_INTEG_CONSTANTS_PKG is a compile-time constants package in the Oracle E-Business Suite Service (Customer Support / Knowledge Base) product family, owned by APPS and classified as OTHER for API purposes. Its declared role, taken directly from the source header, is to publish a fixed set of integration constants for forms belonging to other development teams to use. The package therefore acts as the shared contract between the Knowledge Base search and integration screens (the "csk" prefix denotes CS Knowledge) and any external form, OAF page, or framework component that must hand parameters to, or read parameters from, those screens.

Rather than allowing each caller to hard-code literal parameter names, the package centralises them as named PL/SQL constants. This guarantees that the string keys exchanged between the Knowledge Base integration forms and their callers remain consistent across releases, and that a rename or addition is performed in a single location. Because every constant is declared VARCHAR2(30) and the package is compiled AUTHID CURRENT_USER, callers reference the values without needing definer's-rights privileges.

Key Procedures and Functions

ETRM documents a single callable program unit for this package:

  • GETPARAMETERNAME — reverts a stored constant value back to its parameter name, giving callers a lookup from the runtime string (for example the value held in MSG_PARAM_NAME) to the identifier used by the integration framework. It is the only function exposed by the package; the remaining 24 declarations are constants, not procedures, and are consumed by reference rather than invoked.

The constants themselves, which form the substantive content of the package, include the calling-object descriptors OBJECT_CODE, OBJECT_ID, OBJECT_NAME, and OBJECT_NUM; the search and summary payload keys SEARCH_TEXT and SUMMARY_TEXT; the item/organisation identifier pairs PRODUCT_IDS/PRODUCT_ORG_IDS and PLATFORM_IDS/PLATFORM_ORG_IDS; navigation keys RETURN_URL, RETURN_LABEL, TASK_RETURN_URL, and HIDE_BREAD_CRUMB; display and behaviour switches CALLER_MESSAGE, SHOW_CREATE_SOL_BUTTON, SHOW_NOT_USEFUL_TYPE, and RETAIN_AM; workflow/task linkage keys TASK_PAGE_FUNC, TASK_GROUP_ID, INTEGRATION_EVENT, and SOLUTION_NUM; and the confirmation-message key MSG_PARAM_NAME, which is the item surfaced by the search term "msg_param_name".

Tables Accessed

No base tables, views, or APPS synonyms are documented as referenced by this package. This is expected: the package body consists solely of constant declarations and a single name-resolution function, so it performs no SQL against the E-Business Suite data model. Any persistence occurs in the calling forms, which pass these parameter names to the Knowledge Base integration infrastructure.

Usage Notes

The package is intended for compile-time inclusion by other PL/SQL units and by Oracle Forms libraries belonging to teams outside the Knowledge Base group. Typical invocation patterns are:

  • Forms and OAF integration code that must populate a parameter block before invoking a Knowledge Base search or solution-creation flow, referencing constants such as SEARCH_TEXT, PRODUCT_IDS, or SHOW_CREATE_SOL_BUTTON instead of literal strings.
  • Callers that need to translate a stored value back to its logical name by calling GETPARAMETERNAME.
  • Customisations and extensions that must remain compatible with the standard Knowledge Base parameter contract; ETRM records the package as referenced by one other package, indicating dependant framework code within APPS.

The $Header revision (115.2, dated 2003) indicates a stable, long-lived interface carried forward unchanged into EBS 12.1.1 and 12.2.2. Because it is a constants package and not a business API, it carries no concurrency, transaction, or error-handling semantics of its own; developers should treat it strictly as a read-only dictionary of parameter names.