Search Results g_doc_type_automatic




Overview
Explore in AI Chat

Overview

GMO_DOCUMENT_NUMBERS_GRP is a public PL/SQL package in the APPS schema that centralizes document number generation and validation logic for Oracle E-Business Suite process manufacturing transactions. It is classified in the ETRM metadata as a "GRP" (group) API, indicating that it exposes a related set of public procedures rather than a single narrow interface. The package header carries the version identifier GMOGDNMS.pls 120.4, dated January 2006, and is marked "noship," meaning it is not shipped as a standalone patchable object but is delivered as part of the broader application codebase.

The business purpose of the package is to determine how document numbers are assigned to transactions and to retrieve or verify those numbers. It supports both automatic and manual document numbering by defining constants such as G_DOC_TYPE_AUTOMATIC ('A') and G_DOC_TYPE_MANUAL ('M'), and by providing a zero-pad option flag (G_ZERO_PAD_YES = 'Y', G_ZERO_PAD_NO = 'N'). These constants govern whether a generated number is prefixed with zeros to a fixed length. The package therefore underpins consistent, controlled numbering of quality and process manufacturing documents across organizations.

Key Procedures and Functions

  • GET_DOCUMENT_NUMBER_TYPE — A public procedure that returns the document number type associated with a specified organization ID and transaction type. It accepts an API version, an optional message-list initialization flag, and an optional organization ID together with a required transaction type, returning the document number type along with the standard FND_API return status, message count, and message data. This procedure lets callers determine whether numbering for a given context is automatic or manual before attempting generation.
  • GET_NEXT_VALUE — Retrieves the next available document number for the applicable numbering sequence. This is the core generation routine invoked when a caller needs a fresh, sequential document number consistent with the organization's configured numbering rules and padding option.
  • DOES_DOCUMENT_NUMBER_EXIST — Performs an existence check for a supplied document number. Callers use this procedure to validate that a candidate number is unique and not already allocated before committing it, or to confirm that a manually entered number is legitimate.

The ETRM metadata documents three public procedures in total and does not enumerate further private helpers.

Tables Accessed

The documented metadata for this package does not list specific base tables accessed via APPS synonyms. Based on the package's stated function, its operations logically depend on the document numbering setup and transaction type configuration tables that store organization-level numbering rules, sequence definitions, and the zero-pad option. Because the ETRM excerpt omits the table list, no specific table names are asserted here; the authoritative source remains the package body.

Usage Notes

GMO_DOCUMENT_NUMBERS_GRP is designed for server-side invocation from Oracle Forms, concurrent programs, and custom PL/SQL code that must assign or verify document numbers for process manufacturing transactions. The metadata records that the package is referenced by one other package, confirming it is used as a shared utility rather than being terminal. Callers should supply P_API_VERSION when invoking the procedures and inspect X_RETURN_STATUS together with X_MSG_COUNT and X_MSG_DATA to handle errors consistently with the FND_API message framework. The optional P_INIT_MSG_LIST flag should be set to FND_API.G_TRUE only when the caller has not already initialized the message list. The package is present in both EBS 12.1.1 and 12.2.2, with the same header lineage.