Search Results post_signatureparameters




Overview

EDR_EVIDENCESTORE_PUB is a public PL/SQL package body owned by APPS within the Oracle E-Business Suite EDR (Electronic Document Repository / eSignature evidence) module. Its source header (EDRPEVRB.pls, version 120.0.12000000.1, dated 2007/01/18) identifies the package as the Evidence Store public API. The package provides the transactional interface through which electronic signature evidence is captured, stored, and retrieved. It is classified as a PUB API, meaning that its procedures and functions are intended to be called by external components — forms, workflow, concurrent programs, or custom extensions — rather than being restricted to internal use. In business terms, the package drives the lifecycle of a "document" as an evidence-bearing entity: a document instance is opened for signature, signatures and signature parameters are posted against it, its status and content are updated, and it is ultimately closed or cancelled. The package also exposes retrieval functions so that callers can inspect documents, signatures, and captured evidence details after the fact.

Key Procedures and Functions

The package exposes twelve documented procedures and functions:

  • OPEN_DOCUMENT — Creates a document instance that is eligible for signature and permits signatures to be associated before the document is closed. The source excerpt specifies input parameters relating to the signature XML, source document, document format, requester, source platform, event name, event key, and workflow notification id, and returns the opened document id. The API version constant (l_api_version) is declared locally for version validation against p_api_version.
  • CHANGE_DOCUMENTSTATUS — Moves an existing document through its allowed status transitions as evidence is accumulated.
  • UPDATE_DOCUMENT — Modifies the stored representation of a document already held in the evidence store.
  • POST_DOCUMENTPARAMETERS — Persists document-level parameters that qualify the evidence record, associating parameter values with a specific document instance.
  • CLOSE_DOCUMENT — Finalizes a document, ending the window during which signatures may be attached.
  • CANCEL_DOCUMENT — Aborts a document that should not be treated as completed evidence.
  • REQUEST_SIGNATURE — Initiates a signature request against an open document, driving the signing workflow.
  • POST_SIGNATURE — Writes an executed signature to the evidence store and attaches it to its document.
  • POST_SIGNATUREPARAMETERS — Persists parameters that qualify an individual signature, complementing the document-level parameter API.
  • GET_DOCUMENTDETAILS — Returns the stored details of a document for display, audit, or downstream processing.
  • GET_SIGNATUREDETAILS — Returns the stored details of a signature, including its relationship to the parent document.
  • CAPTURE_SIGNATURE — Records signature evidence as captured from the signing source, forming the basis of the stored signature record.

The procedures follow standard Oracle PL/SQL API conventions, including a version parameter and return status, message count, and message data outputs as shown for OPEN_DOCUMENT.

Tables Accessed

The package references the following tables through APPS synonyms:

  • EDR_PSIG_DOCUMENTS — The primary repository for document instances in the eSignature evidence model; OPEN_DOCUMENT, UPDATE_DOCUMENT, CLOSE_DOCUMENT, CANCEL_DOCUMENT, and GET_DOCUMENTDETAILS operate against it.
  • EDR_PSIG_DETAILS — Stores the detail records associated with documents and signatures; POST_SIGNATURE, POST_SIGNATUREPARAMETERS, and the GET_* functions read and write here.
  • PLITBLM — An Oracle Applications PL/SQL table type used for message and data handling within the API's internal plumbing.

Usage Notes

EDR_EVIDENCESTORE_PUB is the supported entry point for external callers; the metadata records that it is referenced by five other packages, indicating that additional EDR and dependent modules build on this API rather than accessing the underlying EDR_PSIG tables directly. Typical invocations originate from EDR forms during interactive signing, from workflow notification processing where a p_wf_notif_id is supplied to OPEN_DOCUMENT, and from concurrent programs or custom PL/SQL that must record or retrieve signature evidence programmatically. Callers should invoke the OPEN_DOCUMENT / REQUEST_SIGNATURE / POST_SIGNATURE / CLOSE_DOCUMENT sequence to preserve the document lifecycle contract, use CANCEL_DOCUMENT to void incomplete evidence, and rely on the GET_* functions for read access. As with all EBS public APIs, the standard API version, initialization, commit, and message-handling parameters should be honored, and direct DML against the underlying tables should be avoided.