Search Results generate_faculty_header




Overview

IGS_PS_WF_EVENT_PKG is an Oracle E-Business Suite PL/SQL package owned by the APPS schema and classified as OTHER in the ETRM repository. Its documented purpose is to raise Oracle Workflow business events in support of the DLD Unit Section Enrollment Information build, which is part of the Student Systems (IGS) product family addressing unit section enrollment and faculty workload processing. The package operates with AUTHID CURRENT_USER, meaning that name resolution and privilege checking execute under the invoking schema rather than the package owner. The header comment records creation by smanglm at Oracle IDC on 19-JUL-2001, with later change history from jdeekoll on 06-May-2003 adding four procedures to support HR Integration under bug 2833853. The file revision visible in the header is 115.5, dated 2003/06/20. The package is referenced by one other package, indicating that its event-raising and document-generation procedures are consumed elsewhere in the Enrollment and Workflow integration layer rather than being a top-level entry point. Its responsibilities fall into two broad categories: raising workflow events tied to unit section occurrence and enrollment activity, and generating faculty-related workflow notification documents.

Key Procedures and Functions

  • WF_CREATE_EVENT — The core event-raising procedure. It accepts a unit occurrence occurrence identifier, an optional unit section occurrence identifier, and an event type, and returns a message through an OUT NOCOPY parameter. This is the procedure described in the original 2001 build comment as the package's primary function.
  • FAC_EXCEED_WL_EVENT — A concurrent-program style procedure with the standard errbuf and retcode OUT parameters plus a calendar instance parameter. It raises an event related to faculty exceeding workload limits, and is one of the four procedures added in the 2003 HR Integration change.
  • GENERATE_FACULTY_LIST — A workflow activity function conforming to the standard itemtype, itemkey, actid, funcmode, resultout signature. It produces the faculty list used within a workflow process, returning a result to the workflow engine.
  • GENERATE_FACULTY_HEADER — Generates the header portion of a faculty document. It takes a document identifier and display type, and returns the document as a CLOB plus a document type, using OUT NOCOPY parameters. This is the procedure associated with the search term "generate_faculty_header".
  • GENERATE_FACULTY_BODY — The companion to GENERATE_FACULTY_HEADER, producing the body content of the same faculty document with an identical parameter signature: document identifier, display type, CLOB document, and document type.

Tables Accessed

The package reads and writes a documented set of tables through APPS synonyms. Workflow and identity data are drawn from FND_USER, HZ_PARTIES, WF_ITEM_ATTRIBUTE_VALUES, PER_PERSON_TYPE_USAGES_F, IGS_PE_PERSON_TYPES, and IGS_PE_PER_TYPE_MAP. Person and person-type instance information is resolved through IGS_PE_TYP_INSTANCES_ALL. Faculty workload and enrollment processing use IGS_PS_EMP_CATS_WL (employee categories for workload), IGS_PS_EXCEED_FAC_WL_S (faculty exceeding workload limits, consistent with FAC_EXCEED_WL_EVENT), and IGS_PS_SH_USEC_OCCURS (unit section occurrence scheduling). Workflow item key mapping is stored in IGS_PS_USEC_WF_ITEM_KEY_S, which links unit section occurrences to their workflow item keys. DUAL is referenced for simple value selection. These tables collectively support both the event-raising path and the document-generation path.

Usage Notes

IGS_PS_WF_EVENT_PKG is not a user-facing API. It is invoked in three typical ways. First, GENERATE_FACULTY_LIST is called by the Oracle Workflow engine as a function activity, since its signature follows the standard itemtype/itemkey/actid/funcmode/resultout contract. Second, GENERATE_FACULTY_HEADER and GENERATE_FACULTY_BODY are called by whatever workflow notification or document assembly process requires a faculty document, supplying a document identifier and display type and receiving the rendered CLOB and document type. Third, FAC_EXCEED_WL_EVENT is suitable for invocation from a concurrent program because of its errbuf and retcode parameters. WF_CREATE_EVENT is called programmatically by other Student Systems code, including the one package documented as referencing this package, whenever an enrollment or unit section occurrence event must be raised. Because the package executes with AUTHID CURRENT_USER, callers must ensure that the invoking schema has the necessary object privileges on the referenced tables. The procedures use NOCOPY OUT parameters for performance on larger CLOB payloads, which is relevant when generating faculty documents at volume.