Results for “create_prof_color_code”

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

Overview

CSC_PROF_COLOR_CODE_PUB is a public PL/SQL API package owned by the APPS schema in Oracle E-Business Suite. Its documented purpose is to manage the relationship between color codes and rating codes used in profile-related processing, most notably within Oracle's Customer Relationship Management (CRM) and Trade Management (formerly ETRM) product family. The package exposes a small, tightly scoped set of public APIs that allow callers to create and update color code records programmatically, ensuring that the underlying data is validated and maintained through a supported interface rather than through direct table manipulation.

The package is declared with AUTHID CURRENT_USER, meaning its procedures execute with the privileges of the invoking user rather than the defining user. This is significant for security and for the way it is typically invoked from other PL/SQL layers, forms, or concurrent programs running under the APPS schema context. The package header dates to 2002 (version 115.6), indicating it is a long-standing component of the EBS data model and is carried forward unchanged into 12.1.1 and 12.2.2.

Key Procedures and Functions

The ETRM metadata documents four procedures and functions in total, with two explicitly named in the excerpt:

• CREATE_PROF_COLOR_CODE — The primary creation API. It accepts a profile color record (defined by the prof_color_Rec_Type record type) containing fields such as COLOR_CODE, RATING_CODE, and the standard audit columns (LAST_UPDATE_DATE, LAST_UPDATED_BY, CREATION_DATE, CREATED_BY, LAST_UPDATE_LOGIN), and inserts a new color code mapping into the underlying data store. It follows the standard Oracle API conventions with an API version number, init message list, commit flag, and an output return status.
• UPDATE_PROF_COLOR_CODE — The corresponding modification API, used to change the RATING_CODE or other attributes associated with an existing COLOR_CODE record. Like the create API, it validates input, checks the record's existence, and updates audit columns accordingly.

The remaining two documented procedures/functions are companion routines (commonly a version/validation helper and a lock or delete routine in this API family), but their specific names are not enumerated in the excerpt. The package also defines the record type prof_color_Rec_Type, a table type prof_color_rec_type_Tbl_Type using BINARY_INTEGER indexing, and a sort record type color_rec_sort_rec_type, plus the constant G_DEFAULT_NUM_REC_FETCH (30) controlling default fetch size. All procedures should be treated as returning x_return_status to signal success, expected error, or unexpected error.

Tables Accessed

The ETRM metadata lists no directly referenced tables via APPS synonyms for this package, which typically indicates that the DML is executed against private or less commonly exposed objects, or that table references were not captured in the extraction. Based on the documented record structure and the package name, the API operates on the profile color code repository — an underlying table that stores the COLOR_CODE / RATING_CODE mapping along with the audit columns. The API reads and writes this record set: creation inserts rows, update modifies them, and any query routine retrieves them in fetch batches governed by G_DEFAULT_NUM_REC_FETCH. Because no tables are documented, direct table-level integration should be avoided; use only the public API.

Usage Notes

CSC_PROF_COLOR_CODE_PUB is referenced by zero other packages in the ETRM metadata, confirming it is a terminal API that is called directly rather than through an internal wrapper. It is typically invoked from Oracle Forms or OA Framework pages that maintain color code setup, from concurrent programs that bulk-load color/rating mappings, and from custom PL/SQL integration code needing to seed or adjust these records. Callers should pass FND_API.G_FALSE for the commit flag to participate in an outer transaction, or FND_API.G_TRUE to commit independently, and must always inspect x_return_status. The 2002 header and static version stamp mean the API signature can be treated as stable across 12.1.1 and 12.2.2.