Search Results rulp_val_desc_rgi




Overview

IGS_RU_GEN_006 is a PL/SQL package owned by the APPS schema within the Oracle E-Business Suite, classified under the ETRM "OTHER" API category. It belongs to the IGS product family (Oracle Student System / Higher Education) and its object prefix "RU" ties it to the rules engine component that supports flexible rule definition, description validation, and rule text generation. The package is declared with AUTHID CURRENT_USER, meaning its unqualified references resolve through the invoking schema's privileges, which is consistent with the APPS synonym model used across EBS 12.1.1 and 12.2.2.

Functionally, the package provides a set of utility entry points for validating and retrieving rule descriptions, inserting rule definitions, and formatting date-related tokens used by the rules engine. The header comment (IGSRU12S.pls, revision 115.1, dated 2002) indicates it is a legacy utility package that has remained stable across releases.

Key Procedures and Functions

  • RULP_VAL_DESC_RGI — A function that validates a rule description identified by a description number and description type. It returns a VARCHAR2 result and emits a message name through an OUT NOCOPY parameter to communicate validation outcome to the caller. A PRAGMA RESTRICT_REFERENCES declaration (WNDS) restricts it from writing database state, confirming it is a read-only validation routine.
  • RULP_INS_MAKE_RULE — A procedure that inserts or constructs a rule definition, accepting the rule description, return type, turing function, rule text, message rule text, description text, and grouping attributes. This is the primary data-manipulation routine in the package.
  • RULP_GET_RULE — A function that retrieves the rule text for a given rule number, declared read-only via PRAGMA RESTRICT_REFERENCES (WNDS).
  • SET_TOKEN — A procedure that establishes a token value for use by subsequent package calls, supporting session-scoped state during rule processing.
  • JBSP_GET_DT_PICTURE — A function that returns a BOOLEAN indicating success and outputs a date picture (format mask) derived from a character date input, used to interpret date formats within rule text.

Tables Accessed

The package reads and writes the core rules engine tables: IGS_RU_DESCRIPTION and its sequence IGS_RU_DESCRIPTION_SEQ_NUM_S store rule description definitions; IGS_RU_GROUP, IGS_RU_GROUP_ITEM, and IGS_RU_ITEM hold rule grouping and item metadata; IGS_RU_NAMED_RULE stores named rule text; IGS_RU_RET_TYPE defines return data types; IGS_RU_SET and IGS_RU_SET_MEMBER define rule sets and membership; and IGS_RU_TURIN_FNC stores reference definitions for rule functions. DUAL is used for scalar evaluation. These accesses support the validation, insertion, and retrieval operations exposed by the package's procedures.

Usage Notes

IGS_RU_GEN_006 is referenced by 23 other packages, indicating it is an internal utility layer in the rules engine rather than a directly user-invoked API. It is typically called from other IGS rule processing packages and from form-level logic in the Student System rules setup windows, where description validation and rule retrieval occur before rules are persisted. Custom code extending the rules engine may call RULP_GET_RULE or RULP_VAL_DESC_RGI directly, but RULP_INS_MAKE_RULE should be used with care because it writes rule definitions used by downstream evaluation logic. The package is not documented as a public concurrent program entry point, and because it relies on APPS synonyms, callers must run with a valid APPS session context. Date formatting behavior via JBSP_GET_DT_PICTURE depends on session NLS settings.