Search Results get_node_status

Overview

APPS.IEO_ICSM_CMD_PUB is a public PL/SQL package body that forms part of the Oracle E-Business Suite Integrated Communication Services Manager (ICSM) infrastructure. ICSM is the middleware layer within the iStore and Internet Commerce applications that coordinates communication between concurrently running application servers, dispatch nodes, and the servlet-based components that drive storefront activity. The package provides the programmatic command interface through which administrators and dependent APIs start, stop, ping, and shut down ICSM server instances, execute operating-system level commands against registered nodes, and query the real-time status of those nodes and servers.

The package follows the standard EBS API design conventions, including the use of FND_API compatibility checking, message list initialization, and standardized return status values. It is classified as a public API, meaning it is intended to be called from outside the owning module rather than being restricted to internal use, and the ETRM metadata for 12.2.2 confirms it is referenced by two other packages.

Key Procedures and Functions

• GET_NODE_STATUS — Returns the numeric status of a node identified by its node identifier, reading directly from the node registry.
• GET_SERVER_STATUS — Returns the numeric status of an ICSM server from the server runtime information table; returns 1 when no runtime record is found.
• EXECUTE_SERVER_CMD — The primary command dispatcher. It validates the API version through FND_API.Compatible_API_Call, initializes the message list when requested, verifies the target server is running, applies the server mask, and enqueues the request through the Advanced Queuing interface.
• EXECUTE_ICSM_CMD — Executes a command against the ICSM layer itself rather than a single registered server.
• TEST_IP — Verifies reachability of a target IP address, typically used before issuing a command to confirm connectivity.
• START_SERVER — Initiates startup of a registered ICSM server instance.
• STOP_SERVER — Initiates shutdown of a specific registered server.
• PING_SERVER — Sends a liveness probe to a server and reports the response.
• SHUTDOWN_ICSM — Performs a coordinated shutdown of the ICSM middleware as a whole.
• STOP_ALL_SERVER — Stops every registered server in the environment, used during maintenance windows.
• GET_LOG_FILES — Returns the list of log files associated with an ICSM component for diagnostics.
• DELETE_FILE — Removes a specified file, supporting log rotation and cleanup.

Tables Accessed

The package reads from two registered tables accessed through APPS synonyms. IEO_NODES holds the registry of nodes and their current status values; GET_NODE_STATUS queries it by node identifier. IEO_SVR_RT_INFO stores runtime information for each ICSM server, including the status value examined by GET_SERVER_STATUS to determine whether a server is available to accept commands. No other persistent tables are documented as being written by this package; command dispatch is instead handed off asynchronously through the Advanced Queuing enqueue routine in IEO_ICSM_AQ_PUB.

Usage Notes

These APIs are normally invoked from the ICSM administration responsibilities in Oracle Applications, from concurrent programs that manage server lifecycle tasks, or from custom PL/SQL that needs to query or control the ICSM runtime. Because EXECUTE_SERVER_CMD is asynchronous, callers should not expect immediate command completion and should poll GET_SERVER_STATUS or the runtime tables to confirm the result. Applications integrating with this package should honor the standard p_api_version, p_init_msg_list, and p_commit conventions and always inspect the returned x_return_status and message data. The package is compatible with EBS 12.1.1 and 12.2.2.