Skip to main content
Feedback

Listeners panel

View and manage listeners, which are deployed processes having a Start step with the Listen action or a Start step with the Trading Partner option.

The Listeners panel appears in the Runtime Management page (Manage > Runtime Management).

note

You must have the Runtime Management privilege to manage listeners. If you have the Runtime Management Read Access privilege, you can only filter the list of listeners and view information about a listener; you cannot pause, resume, or restart listeners. Additionally, if the selected runtime is inactive, its deployed listeners cannot be viewed or managed.

After updating extensions, all listeners restart.

Listeners panel

Listener groups (Connectors and Trading Partners)

When you select a runtime in Runtime Management and click Listeners, the list of deployed listeners appears.

  • Listeners using connectors are grouped by connector type:

    • AS2 Shared Server

    • Atom Queue

    • Flow Services Server

    • JMS

    • MLLP Server

    • Salesforce Platform Events

    • SAP

    • Web Services Server — This grouping includes deployed API Service components. Deployed API Proxy components are not included in this grouping.

  • Listeners using trading partners are grouped by EDI standard:

    • x12 — Accredited Standards Committee (ASC) X12 standard

    • edifact — UN/EDIFACT (United Nations/Electronic Data Interchange For Administration, Commerce and Transport) standard

    • hl7 — HL7 (Health Level Seven International) standard

    • odette — ODETTE (Organisation for Data Exchange by Tele Transmission in Europe) standard

    • edicustom — User specified standard

    • rosettanet — ROSETTANET 1.1 and 2.0 standard

    • tradacoms — The UK-based Tradacoms standard

    • edimulti — trading partners are configured in the Start step for multiple EDI standards

Managing listeners

The following properties and tools are available to manage listeners:

Restart | Pause | Resume
Use these menus to restart, pause, or resume all listeners or selected listeners.

All Listeners
Initiates a request to restart, pause, or resume all listeners with an eligible status.

For example, you can restart all listeners regardless of their status, but only listeners that are currently paused can be resumed.

If you restart a paused listener, the status remains the same after the restart.

Selected Listeners
Initiates a request to restart, pause, or resume each listener whose check box is turned on in the list.

note

Toggling the check box for a connector type grouping simultaneously toggles the check boxes for all listeners of that connector type. The Selected Listeners option is disabled until at least one listener is selected in the list.

A message appears when the Platform receives a restart, pause, or resume request. However, the list of listeners does not refresh automatically. You must manually refresh to view the updated status of listeners. The toolbar displays a Last Update timestamp showing when the data was last refreshed.

Selected listener

Filter listeners Use filters and search criteria to find the listeners that you want.

You can filter by a status of Listening, Paused, Errored or Degraded. To add a filter, click Filter and select the filters that you want.

To search, enter all or part of a listener name. The filters are applied as you type. If you applied a filter, a search returns only those items that meet the filter criteria.

Listeners are organized in a tree grouped by connector type. Each connector group row displays status count badges showing the number of listeners in each state — hover over a badge to see the status label.

To act on an individual listener, hover over its row to reveal the options menu (hamburger icon). Click it to expand the menu, which includes:

  • View in Process Reporting — The Process Reporting page opens a new tab or window with the Executions list filtered by the listener process.

  • View Deployed Version of Process — The Build page opens a new tab or window where the deployed version of the listener process appears.

  • View Error Message — The Error Message dialog opens, if the listener has an error state. You can view the error message and stack trace.

  • View Details — Opens the Listener Details panel, which displays the listener's status and instance-level status for each node in a multi-node environment.

  • Pause — Pauses the listener.

  • Resume — Resumes the listener, if it is paused.

  • Restart — Restarts the listener.

note

Menu items shown depend on the listener's current status. For example, Pause is hidden when the listener is already paused, and View Error Message only appears when the listener has an error.

Listener panel status

Listener Details drawer

The Listener Details drawer is a side panel that provides detailed status information for an individual listener, including per-node instance-level status in multi-node environments. It is accessible from the options menu on a listener row by selecting View Details.

note

View Details only appears in the options menu when instance-level data is available from the runtime.

Listener Details drawer

Summary card:

The top section of the drawer shows the following fields:

Listener NameThe name of the listener
Connector TypeThe connector type associated with the listener
StatusThe current listener status displayed as a color-coded badge
Last UpdatedTimestamp of the last date refresh

Actions

Available only to non-read-only users:

  • Restart — Primary button. Displays as Resume when the listener is currently Paused.

  • More options menu:

    • Pause — Hidden when the listener is already paused

    • View in Process Reporting — Navigates to Process Reporting filtered to this listener

    • View Deployed Version of Process — Opens the deployed version of the process

    • View Error Message — Only shown when the listener has an error

Instance Level Status table:

Shows the status of the listener on each node in a multi-node environment.

Columns (Columns are sortable if you click on the header):

ColumnDescription
Instance NameThe identifier of the node
StatusColor-coded badge: Online/Started/Pending (green), Errored (red), Offline/Unknown (yellow), Paused (gray)
ActionsOptions menu per instance

Per-instance actions menu:

View Message — Shown for Online, Started, or Paused instances that have a status message

View Error Message — Shown for Errored, Offline, or Unknown instances that have an error; displayed as a destructive action.

Per-instance actions menu

note
  • If there are more than 10 instances, the table paginates. If no instance-level data is available, the table displays "No instance level status data available".
  • Read-only access: Users with read-only access can view the summary card and instance table but the action buttons and more options menu are not shown.
On this Page