Search Results iem_rules_engine_pub




Overview
Explore in AI Chat

Overview

IEM_RULES_ENGINE_PUB is the public application programming interface for the Email Processing Engine within Oracle E-Business Suite's Interaction and Email Management (IEM) module, part of the CRM/Advanced Outbound product family. The package evaluates inbound email messages against user-defined processing rules and executes the associated actions, such as auto-acknowledgment, auto-reply, auto-redirect, and document mapping. It is declared with AUTHID CURRENT_USER, meaning that all SQL statements execute under the privileges of the calling schema rather than the package owner, which is standard practice for APPS-owned public APIs that must respect the caller's security context.

The package exposes a strongly typed PL/SQL record and collection model central to its interface. parameter_type is a record mirroring the PARAMETER1, PARAMETER2, and TYPE columns of IEM_ACTION_DTLS, and parameter_tbl_type is a table of that record type, INDEX BY BINARY_INTEGER. This associative array is the channel through which the rules engine returns the key-value parameter set resolved for a matched rule action. The header history indicates the package was created in 2002 and progressively extended through 2003 to add document mapping validation and the auto-redirect rule type.

Key Procedures and Functions

  • AUTO_PROCESS_EMAIL — the principal API entry point. It accepts an API version number, standard initialization and commit flags, a rule type, a key-value table (typed as IEM_ROUTE_PUB.keyVals_tbl_type), and an account identifier. It returns the processing result, the resolved action, a parameter_tbl_type collection of action parameters, and the standard return status, message count, and message data outputs. It drives the overall email-to-rule-to-action cycle.
  • IS_VALID — a validation function returning a VARCHAR2 indicator for a supplied value, used to screen rule or action data before processing.
  • GET_DOCUMENT_TOTAL — returns a NUMBER count of documents associated with a category identifier.
  • IS_DOCUMENT_EXIST — returns a VARCHAR2 indicator confirming whether a given document exists within a given category, supporting the added validation for AUTOACKNOWLEDGE and AUTOREPLYSPECDOC rule types.

Tables Accessed

The package reads and writes through APPS synonyms. Rule definition and evaluation rely on IEM_EMAILPROC_RULES, IEM_ROUTE_RULES, and IEM_ROUTE_CLASS_RULES; the action definitions and their parameter values reside in IEM_ACTIONS and IEM_ACTION_DTLS, which supply the columns behind parameter_type. Account and processing configuration come from IEM_EMAIL_ACCOUNTS, IEM_ACCOUNT_EMAILPROCS, and IEM_EMAILPROCS. Document validation uses AMV_C_CHL_ITEM_MATCH. PLITBLM is the standard EBS message-table mechanism supporting the message count and message data outputs.

Usage Notes

IEM_RULES_ENGINE_PUB is invoked by the standard IEM email processing runtime—typically from concurrent processing or agent-driven inbound email handling—and is referenced by at least one other package, indicating layered use rather than direct end-user invocation. Customizations should call AUTO_PROCESS_EMAIL with the correct API version and account context, then interpret x_result, x_action, and the returned parameter_tbl_type collection; standard message-stack handling should be applied against x_return_status, x_msg_count, and x_msg_data. The NOCOPY hints on OUT parameters reflect performance optimization for the collection payload. This object is documented in ETRM 12.2.2 with the same signature shown for the 12.1.1 code line.