Search Results igs_as_documents_api




Overview
Explore in AI Chat

Overview

IGS_AS_DOCUMENTS_API is a PL/SQL application programming interface package owned by the APPS schema in Oracle E-Business Suite. It belongs to the Oracle Student System (formerly Oracle iLearning/Student Systems, product family IGS) and specifically to the Academic Support (AS) module, which manages the administrative documents that applicants and students must submit, track, and have verified during the admissions and enrolment lifecycle. The package encapsulates the business logic for maintaining document records, linking them to order headers and order items, and recording document-related fee payments.

The package follows the standard EBS API conventions: it depends on FND_API (the public API utility package providing message handling, return status constants, and error-stack management), and on the SYS.STANDARD package. Its status is VALID in the documented release. Being classified as an API, it is intended to be called programmatically rather than executed ad hoc, and it shields callers from the physical structure of the underlying IGS_AS_* tables.

Key Procedures and Functions

The ETRM metadata documents three public procedures or functions within IGS_AS_DOCUMENTS_API:

  • UPDATE_ORDER_ITEM_STATUS — Updates the status of an order item associated with a document. This supports workflows in which a document's progress (for example, receipt, verification, or rejection) must be reflected against the corresponding order line so that downstream billing, fulfilment, or admissions processing recognises the change.
  • UPDATE_DOCUMENT_DETAILS — Maintains the descriptive and attribute data of a document record held in the document details table. It is the general-purpose maintenance routine for document master/detail information.
  • UPD_DOC_FEE_PMNT — Records or updates fee-payment information tied to a document, working against the document fee-payment table. This supports scenarios in which submission or processing of a document incurs a charge that must be captured and reconciled.

All three routines are invoked with the standard EBS API calling pattern, returning a status and using FND_API error handling; the exact parameter lists are not reproduced here, and callers should obtain signatures from the package specification in the target instance.

Tables Accessed

The package reads and writes the following tables through APPS synonyms:

  • IGS_AS_DOC_DETAILS — the primary document detail table maintained by UPDATE_DOCUMENT_DETAILS.
  • IGS_AS_DOC_FEE_PMNT — document fee-payment records maintained by UPD_DOC_FEE_PMNT.
  • IGS_AS_DUP_DOCS — duplicate document records, relevant to consolidation or duplicate-detection processing.
  • IGS_AS_ORDER_HDR — the document/order header, providing the header context for order item updates.
  • IGS_AS_ORD_ITM_INT — order item interface rows, used when order item status changes must be staged for downstream processing.
  • IGS_AS_SERVIC_PLAN — service plan definitions that govern the services or charges associated with documents.

Usage Notes

IGS_AS_DOCUMENTS_API is typically invoked by the Academic Support forms and concurrent programs that manage applicant and student documents. The documented reference list confirms this: it is referenced by IGS_AS_DOC_DETAILS_PKG, IGS_AS_DUP_DOCS_PKG, and IGS_AS_SS_DOC_REQUEST, as well as by itself. Customisations and integrations that need to update document details, order item status, or document fee payments should call these routines rather than issuing direct DML against the IGS_AS tables, so that validation, FND_API message propagation, and any future schema changes are handled consistently. As with all EBS APIs, the package should be invoked within a properly initialised session (FND_GLOBAL.APPS_INITIALIZE) and its return status checked before commit.