Toggle menu

iCM and Delivery Servers

iCM/API Servers

The iCM/API Servers home page lists all hosts serving iCM, the details of the gateway messages they process, any errors that have occurred and any cluster locks they hold.

Servers add themselves to the list automatically when their scheduled task processes gateway messages. Removing a server will delete all of its messages and reset the counters. If the server is active it will add itself back into the list after a short delay.

This section also lists all installed API Servers, which you can read about in Creating and Configuring an API Server.

Access to this section of iCM can be granted to an iCM user via their System Configuration Privileges.

iCM Servers

The list of iCM servers shows every server in this cluster that hosts an iCM installation connected to the current iCM database.

The "Any host" iCM Server shows messages that can be processed by any host in the cluster.

Each server includes the following information.

ItemDescription
HostHost name of the server. The host you are currently connected to has a green tick
Server IDA unique ID for the server
QueueThe number of gateway messages waiting to be processed by this sever, see Queue Statistics
DoneThe number of gateway messages that have been processed since this server was installed (or the counter reset)
LastThe date and time the last gateway message was processed
RunningThe length of time the current message has taken to process
ErrorsThe number of errors that have occurred when processing messages
TimeoutsThe number of gateway messages that took an excessive amount of time to process
LocksThe current number of locks held by the server

Locks

The locks held by an iCM server are nothing to worry about. They are not the same as content locks applied to items in iCM visible in the Locked Items section. Rather they are locks applied by iCM preventing concurrent access to certain database resources.

Context Actions

Right-click on an iCM Server to do the following.

iCM Server Context Menu

Reset Counters

Resets the counters.

Clear Locks

Clears any current locks.

Queue Statistics

View information about queued gateway messages including message types, actions, origin server and the oldest messages in the queue. See Queue Statistics.

Remove Server

If you remove a server, it will be automatically added back in the next time it processes a message.

Delivery Servers

The delivery servers section should list all servers serving iCM subsites managed by this installation. The URLs entered for these subsites can be used by iCM to clear the cache on those servers. Further functionality may be added to this area in future releases.

Creating Delivery Servers

To add a delivery server to the list click "Create a delivery server" in the action panel. You'll need to set the following:

ItemDescription
HostThe host name of the server
Server IDiCM will assign a random ID to the server
URLA URL iCM can use to connect to the server

Actions Menu

The action panel lets you send a ping message to the iCM Servers to check iCM's ability to communicate with them, refresh the server lists and update the icons iCM uses.

It also links to the History Digest Queue Statistics.

Last modified on 24 June 2025