Search Results p_ret_status




Overview

IGS_EN_GEN_017 is a Student System enrollment utility package in the Oracle E-Business Suite, owned by APPS and deployed under the IGS (Student Systems) product family. It is one of the IGS_EN_GEN_0xx series of generic wrapper packages that expose enrollment self-service and IVR-oriented logic through a PL/SQL API. The package is declared with AUTHID CURRENT_USER and captures the calling context in the global variable G_INVOKE_SOURCE, defaulted to 'SS' (self-service), which allows downstream enrollment logic to behave differently depending on whether the request originates from a self-service screen, a call center, or an IVR channel. The procedures support core registration transactions — adding a student to a course section waitlist, dropping a section, resolving default terms and enrollment methods, validating a call number, and converting encoded message strings into message lists. ETRM classifies the package as API classification OTHER, indicating it is not a formally published open interface but is consumed internally by Oracle's enrollment flows and occasionally by extensions.

Key Procedures and Functions

The documented API surface contains eleven procedures and functions, most of which accept a conventional enrollment key composed of person number, career, program code, term code, and call number, and return an error message together with a status indicator. The user's search term, p_ret_status, is the standard OUT status parameter used by ADD_TO_CART_WAITLIST, ENRP_GET_DEFAULT_TERM, ENRP_GET_ENR_METHOD, ENRP_GET_TERM_IVR_LIST, and ENRP_VALIDATE_CALL_NUMBER; DROP_SECTION uses the identically purposed parameter p_return_stat, while ENRP_VALIDATE_STUDENT, ENRP_VALIDATE_INPUT_PARAMETERS, and ENRP_VALIDATE_TERM_ALT_CODE follow the same convention. Callers must inspect this value to determine success or failure rather than relying on exceptions.

  • ADD_TO_CART_WAITLIST — places a student into a section waitlist, returning waitlist and audit indicators along with status and error text.
  • DROP_SECTION — processes a section drop for a given term and call number, accepting a drop reason and administrative status and returning a return status and error message.
  • ENRP_GET_DEFAULT_TERM — resolves the default enrollment term for the calling context.
  • ENRP_GET_ENR_METHOD — returns the applicable enrollment method type.
  • ENRP_GET_TERM_IVR_LIST — populates a term table (IGS_EN_IVR_PUB.term_tbl_type) for IVR term selection.
  • ENRP_GET_INVOKE_SOURCE — function returning the stored invocation source.
  • ENRP_MSG_STRING_TO_LIST — parses a delimited message string (default delimiter ';') into a message count and message data payload.
  • ENRP_VALIDATE_CALL_NUMBER — validates a call number and returns the associated unit offering option, calendar type, and calendar instance sequence.
  • ENRP_VALIDATE_INPUT_PARAMETERS — performs generic parameter validation prior to enrollment processing.
  • ENRP_VALIDATE_STUDENT — confirms that the person is a valid student for the requested enrollment context.
  • ENRP_VALIDATE_TERM_ALT_CODE — validates the supplied term alternative code.

Tables Accessed

The package references eight APPS synonyms. Person and security data are read from IGS_PE_PERSON_TYPES and FND_USER. Calendar and term validation draws on IGS_CA_TYPE, IGS_CA_STAT, IGS_CA_DA_INST, and IGS_EN_CAL_CONF. Enrollment configuration and student records are sourced from IGS_EN_METHOD_TYPE and IGS_EN_SU_ATTEMPT_ALL. These accesses are read-oriented and support validation, defaulting, and eligibility checks rather than direct DML against enrollment tables; the actual insert, update, and delete operations are delegated to underlying enrollment engine APIs.

Usage Notes

IGS_EN_GEN_017 is invoked internally by sixteen other packages and is typically reached from Student Self-Service registration pages, call center enrollment forms, and IVR or web enrollment flows that require waitlist and drop functionality. Because the package is not a published open interface, customizations should call it only where no supported API exists, and must always check p_ret_status (or p_return_stat) before proceeding. The G_INVOKE_SOURCE variable should not be altered directly; ENRP_GET_INVOKE_SOURCE provides the supported read accessor. Error text returned in the error message parameters is normally passed to ENRP_MSG_STRING_TO_LIST for display.