Search Results retrieve_user

Overview

APPS.BIS_UTILITIES_PUB is a public PL/SQL package body in Oracle E-Business Suite Business Intelligence System (BIS) that provides shared utility services for the BIS product family, including the Daily Business Intelligence (DBI) reporting infrastructure. The body is versioned as BISPUTLB.pls 120.0 and is marked "noship," indicating an internal, non-shipped customization component in the ETRM documentation capture. The package centralizes common helper routines — user resolution, organization and time-dimension lookups, dynamic WHERE-clause construction, workflow entity name resolution, NLS and image-server configuration, and HTML report header generation — so that individual DBI report programs and dashboards avoid duplicating this logic.

The package is significant within the dependency graph: it is referenced by 127 other packages, making it a foundational shared component across the BIS/DBI codebase. The symbol that most commonly brings adopters to this object is RETRIEVE_USER, the entry point through which calling programs resolve an FND_USER identifier or name into a canonical user_id/user_name pair.

Key Procedures and Functions

• RETRIEVE_USER — Resolves a user from FND_USER using either a supplied user_id or user_name, returning the matched user_id and user_name along with a standard FND_API return status and an error table. The documented body shows a priority rule: if a valid user_id is passed, lookup occurs by user_id; otherwise, if a valid user_name is passed, lookup occurs by user_name.
• RETRIEVE_ORGANIZATION / RETRIEVE_ORG_WHERE_CLAUSE — Resolves organization identifiers and builds the corresponding organization filter predicates against HR organization structures.
• RETRIEVE_WHERE_CLAUSE, RETRIEVE_TIME_WHERE_CLAUSE, RETRIEVE_DIMX_WHERE_CLAUSE — Dynamically generate SQL WHERE-clause fragments for general, time-dimension, and dimension-crossing filters used by DBI report queries.
• RESOLVE_ROLE_NAME, RESOLVE_FUNCTION_NAME, RESOLVE_FULL_FUNCTION_NAME, RESOLVE_FULL_ACTIVITY_NAME — Translate role, menu function, and workflow activity identifiers into their displayed names, drawing on the FND and WF tables.
• RETRIEVE_SEGMENT — Returns a key flexfield segment identifier for reporting and filter construction.
• VALUE_MISSING, VALUE_NOT_MISSING, VALUE_NULL, VALUE_NOT_NULL — Null-handling predicates used throughout the package to distinguish "missing" (defaulted) values from genuine NULLs. RETRIEVE_USER itself calls VALUE_NOT_MISSING to choose its lookup path.
• BUILD_HTML_BANNER, GET_IMAGES_SERVER, GET_NLS_LANGUAGE, GET_REPORT_TITLE, BUILD_REPORT_HEADER — Presentation-layer utilities that assemble HTML banners and report headers, retrieve the configured images server URL, and determine the session NLS language for localized output.

The ETRM metadata documents 64 procedures and functions in total; the list above reflects the documented set most relevant to routine report construction and the RETRIEVE_USER search.

Tables Accessed

• FND_USER — Source of user_id/user_name resolution in RETRIEVE_USER.
• FND_FORM_FUNCTIONS, FND_FORM_FUNCTIONS_TL, FND_MENUS, AK_REGIONS — Function, menu, and region metadata used by the name-resolution and banner/header routines.
• HR_ALL_ORGANIZATION_UNITS — Organization definition source for organization retrieval and org WHERE-clause generation.
• WF_ACTIVITIES, WF_ACTIVITIES_TL — Workflow activity names for RESOLVE_FULL_ACTIVITY_NAME.
• BSC_SYS_INIT — BSC system initialization/configuration values used for report setup.
• V$INSTANCE, PLITBLM, UTL_RAW — Database instance identification and raw/LOB utility access supporting output formatting.

Usage Notes

BIS_UTILITIES_PUB is an internal public API intended for invocation from other BIS/DBI PL/SQL packages, Oracle Forms-based dashboard components, and concurrent report programs rather than from end-user interfaces directly. With 127 dependent packages, changes to its signature or behavior carry broad impact and should be treated as a shared-component modification.

RETRIEVE_USER is typically called when a DBI report or dashboard must convert the logged-in user or a selected user into a canonical identity for filtering. Callers should supply exactly one of the two input parameters and always inspect the returned x_return_status against FND_API.G_RET_STS_SUCCESS; documented exception handlers return G_RET_STS_ERROR for NO_DATA_FOUND and unexpected exceptions, and populate the error table for diagnostics. Because retrieval is performed through an unguarded SELECT INTO, callers must handle the error status rather than assume a row is always returned. The package reads FND, HR, WF, and BSC configuration tables, so its results reflect the current application configuration as of call time.