Results for “imc_bookmark_pub”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

IMC_BOOKMARK_PUB is a public PL/SQL API within the Oracle E-Business Suite Applications (APPS) schema that governs the "bookmark" feature of the Oracle Customers Online / Trading Community Architecture (TCA) user interface. A bookmark allows an end user to flag a specific party record — an organization, a person, or a party relationship (contact) — so that it can be quickly recalled later from the user's personal bookmark list. The package provides the programmatic substrate for that UI affordance: it creates, removes, queries, and disables bookmarks, and it enforces the site-level profile option that caps the maximum number of bookmarks a user may hold. The internal module identifier is IMC_BOOKMARKS, and the header revision (120.0, dated 2004) reflects the origin of the API in the earlier IMC (Interaction Center / Customers Online) code line, subsequently carried forward into the 12.1.1 and 12.2.2 releases.

A key design characteristic is that bookmarks are stored as party preferences rather than in a dedicated transactional table. The package writes rows into HZ_PARTY_PREFERENCES under the preference code PARTY_ID, using one of three category constants — BOOKMARKED_ORGANIZATION, BOOKMARKED_PERSON, or BOOKMARKED_PARTY_RELATIONSHIP — to distinguish the nature of the bookmarked entity. The API also distinguishes the owning user type through the constants FND_USER_TYPE ('FND') and PARTY_USER_TYPE ('PARTY'), allowing bookmarks to be held either by an EBS application user or by a party identity. The object version number constant is fixed at 1, matching the default used by TCA APIs.

Key Procedures and Functions

• ADD_BOOKMARK — Adds a bookmark associating a party with a bookmarked party. The routine first checks the maximum-bookmark profile option and returns an error code if the addition would breach that limit. If the bookmark already exists, the call performs no action.
• REMOVE_BOOKMARK — Deletes an existing bookmark record for the specified party pairing.
• GET_BOOKMARKED_PARTIES — Returns the set of bookmarked parties, exposed through a weakly typed reference cursor declared as ref_cursor_bookmarks, suitable for populating a UI list or LOV.
• BOOKMARK_EXISTS — A boolean-style test that indicates whether a bookmark already exists, used to drive toggle behaviour in the UI and to short-circuit duplicate inserts.
• DISABLE_BOOKMARK — Removes or inactivates a bookmark, supporting the "un-flag" action in the Customers Online interface.

All state-changing routines follow the standard EBS PL/SQL API return convention, emitting x_return_status values of 'S' (success), 'L' (over the maximum bookmark limit), 'E' (error), and 'U' (unexpected error), with messages queued on the FND_MESSAGE stack and retrievable via FND_MESSAGE.GET_ENCODED().

Tables Accessed

• FND_USER — identifies the EBS application user that owns a bookmark, supporting the 'FND' user type.
• HZ_PARTIES — the master party entity; both the owning party and the bookmarked party are validated against it.
• HZ_PARTY_NUMBER_S — the sequence used to generate party numbers where new party context is required.
• HZ_PARTY_PREFERENCES — the physical store for bookmark rows, keyed by category and preference code.
• HZ_RELATIONSHIPS — resolved when the bookmark targets a contact relationship (the BOOKMARKED_PARTY_RELATIONSHIP category).
• PER_ALL_PEOPLE_F — provides the person/employee context used when a bookmark is held against a party identity.
• DUAL — used for scalar lookups and profile option evaluation.

Usage Notes

IMC_BOOKMARK_PUB is intended for invocation from the Customers Online JSP/UI layer, from Oracle Forms personalisations that expose bookmark actions, or from custom concurrent programs and PL/SQL extensions that pre-seed or migrate user bookmark lists. ETRM records no dependent packages, so it may be called directly without concern for layered API prerequisites. Callers must always inspect x_return_status, since the special 'L' code signals a soft business-rule failure (bookmark limit exceeded) rather than a technical fault. Because bookmarks are persisted as party preferences, any custom code that reads bookmark data should query HZ_PARTY_PREFERENCES through the same category constants exposed in the package specification rather than hard-coding literals. As with all APPS public APIs, the package should be invoked with the standard FND_GLOBAL initialisation of user and responsibility context.