Search Results get_header_actions

Overview

APPS.PO_DOCUMENT_CONTROL_PVT is a private PL/SQL package within the Oracle Purchasing module of Oracle E-Business Suite, present in both 12.1.1 and 12.2.2. It implements the core document control engine that governs the allowable actions a user may perform against a purchasing document at any point in its lifecycle. In Oracle Purchasing, "document control" covers operations such as approving, cancelling, closing, finally closing, freezing, holding, printing, returning, and reopening a document. Which of these actions are permitted depends on the document's type, status, approval history, and encumbrance conditions, and PO_DOCUMENT_CONTROL_PVT centralises the logic that resolves those rules.

The package is classified as a PVT (private) API. It is not intended for direct invocation by external or customer-written code; the public entry point is PO_DOCUMENT_CONTROL_PUB, which is the documented API wrapper. PO_DOCUMENT_CONTROL_PVT supplies the internal validation, action-resolution, date-handling, and workflow-stopping logic that the public layer and several sibling packages depend upon.

Key Procedures and Functions

The package exposes twenty-four documented procedures and functions. Their responsibilities group as follows:

• CONTROL_DOCUMENT — the central driver that evaluates and executes the requested control action against a document.
• INIT_ACTION_DATE and GET_ACTION_DATE — establish and retrieve the effective action date used when recording a control action.
• VAL_ACTION_DATE and VAL_CONTROL_ACTION — validation routines that verify the supplied action date and confirm that the requested control action is legal for the document.
• PO_STOP_WF_PROCESS and REL_STOP_WF_PROCESS — halt and later release Oracle Workflow processes associated with purchase orders and releases.
• CREATE_PRINT_REQUEST — generate a print request for the document.
• UPDATE_NOTE_TO_VENDOR — maintain the note-to-vendor text on the document.
• PASS_SECURITY_CHECK — enforce document security authorisation prior to action execution.
• HAS_SHIPMENTS and HAS_UNENCUMBERED_SHIPMENTS — determine whether the document contains shipment lines and whether any shipment remains unencumbered, gating close and cancel operations.
• IN_OPEN_GL_PERIOD — check whether the relevant general ledger period is open before an action proceeds.
• ADD_ONLINE_REPORT_MSGS — append online report messages to the control result set.
• GET_HEADER_ACTIONS, GET_LINE_ACTIONS, GET_SHIPMENT_ACTIONS, GET_REL_HEADER_ACTIONS, GET_REL_SHIPMENT_ACTIONS — return the set of valid actions available at header, line, shipment, release header, and release shipment level respectively.
• GET_VALID_CONTROL_ACTIONS — aggregate and return all control actions valid for the document.

Tables Accessed

The package reads and writes several core Purchasing and shared tables. PO_DOCUMENT_TYPES and PO_DOCUMENT_TYPES_ALL_B supply document type attributes that influence which actions are permitted. PO_HEADERS, PO_HEADERS_ALL, PO_HEADERS_ARCHIVE, and PO_HEADERS_ARCHIVE_ALL provide header status and detail, including archival copies. PO_LINES, PO_LINES_ALL, and PO_LINES_ARCHIVE supply line data, while PO_LINE_LOCATIONS and PO_LINE_LOCATIONS_ALL provide shipment scheduling and quantity information. PO_DISTRIBUTIONS_ALL is accessed to evaluate encumbrance state via the unencumbered-shipment checks. FINANCIALS_SYSTEM_PARAMETERS and FND_PROFILE_OPTION_VALUES supply system setup and profile option values, and GL_PERIOD_STATUSES is queried to confirm open period status. The package also uses the APPS synonym types PO_TBL_VARCHAR30 and PO_TBL_VARCHAR2000 for its PL/SQL collection parameters.

Usage Notes

PO_DOCUMENT_CONTROL_PVT is invoked indirectly. Its primary caller is PO_DOCUMENT_CONTROL_PUB, the supported control API, and it is referenced by PO_CONTROL_ACTION_VALIDATIONS, PO_DOCUMENT_CANCEL_PVT, PO_DOCUMENT_CONTROL_GRP, PO_MODIFY_REQUISITION_PVT, and PO_MOD_CONTROL_PVT. The Purchasing forms and related concurrent programs ultimately reach this package through those callers when a user approves, cancels, closes, or otherwise acts on a document. Customisations should target PO_DOCUMENT_CONTROL_PUB rather than this private package, since Oracle may change private package signatures between releases without notice.