Troubleshoot using the Genesys Cloud Operational Console

Prerequisites
  • Admin role
  • usage > events > View permission

Operational events are actionable in nature and provide administrators with the necessary details to diagnose and troubleshoot issues. Administrators can either view these events in the Operational Console page in Genesys Cloud or subscribe to operational events using an Amazon EventBridge integration. The Event Catalog provides additional guidance for administrators to troubleshoot operational events. 

View operational events in the Operational Console page in Genesys Cloud

  1. Click Admin.
  2. Under Troubleshooting, click Operational Console.

The Operational Console page opens with the last occurred events. Operational events are available for 10 days.

Click the image to enlarge.Image of the operational console page

Begin filtering operational events by date range. After filtering the events by date range, you can filter by the Entity Name or ID and/or Event Definition ID fields.

Operational events are available for 10 days. By default, the start date of the calendar displays the date before the last occurred event and the end date displays the current date.

  1. To filter operational events by date range, follow these steps:
    1. Click within the Start or End date field. The calendar appears.
    2. Click to select a start date, and then click to select an end date. 

Click the image to enlarge.Image of the start and end date fields and the calendar

  1. Filter operational events by entity name or ID and/or event definition ID.
    • To filter by event definition ID, do one of the following:
      • Enter a value in the Event Definition ID field, select one or more suggested event definition IDs from the drop-down, and click outside the list.
      • Click the Event Definition ID field, select one or more values from the drop-down, and click outside the list.

Click the image to enlarge.Image of the event definition ID field

To clear the event definition ID filter, click the Event Definition ID drop-down, clear the required check boxes, and click outside the list. To clear the entire selection, click the Clear icon that appears with the number of values selected on the Event Definition ID drop-down and click outside the list.

    • To filter by entity name or ID, follow these steps:

Enter an entity name or ID in the Entity Name or ID search field. To clear the value that you entered and the filter, click Clear on the Entity Name or ID field.

Click the image to enlarge.Image of the clear icon in the Entity Name or ID field

      1. Click Additional Event Details for an operational event on the Operational Console page to view more details. The Additional Event Details window appears.
        Note: The details that appear in the Additional Event Details window vary based on the event definition ID.

      Click the image to enlarge.Additional event details in the operational console

      1. To view further troubleshooting details for the operational event, click Supporting link.
        Note: This link is not available for all operational events. When the link is available, click the link to navigate to a relevant view. For example, the ARCHITECT-0002 event takes you to the Architect Replay mode, which shows the area of the flow that is broken.

      Click the event definition ID of an operational event to dynamically view related content from the Event Catalog. A reading pane opens to the left with details that include troubleshooting steps, context on potential causes, and testing recommendations.

      Click the image to enlarge.Image of how the troubleshooting information is dynamically fetched from the event catalog and displayed in the Operational Console page

      Configure triggers for operational events

      A trigger is a method within Genesys Cloud that allows customers to configure a response to specific events that occur within Genesys Cloud, such as those in the Operational Console. For more information about the requirements to create and configure triggers, see Requirements for triggers.

      With triggers, users can:

      • Send an email to a user when a specific operational event occurs. For more information, refer to this example.
      • Use one or more data actions to retrieve relevant information from an external data store.
      • Use a data action to invoke the agentless SMS endpoint to send an SMS.

      Set up an Amazon EventBridge integration and receive operational events

      To receive operational events using the Amazon EventBridge integration, on the Integration tab, subscribe to v2.operations.events.{id}.

      After you receive operational events, you can access the Event Catalog in the Genesys Cloud Developer Center for recommendations on how to get started, read about additional context for events, and review associated diagnosis and troubleshooting steps.
      1. Open the Event Catalog.
      2. To open the documentation for an event, either click the event name on the left navigation pane or scroll down on the Event Catalog and click an EventID.
      3. Read through the documentation for the event, proceed through the recommended diagnosis steps, and apply the troubleshooting steps as needed.
      4. Follow the directions that indicate the best points to evaluate if the event scenario resolves and how to proceed if the scenario does not resolve.

      Some events are voluminous in nature, or a single event does not always indicate an issue. For these events, check the suggested configuration steps for alerting or thresholding available in the Event Catalog. As you review the events to subscribe to, take a moment to review their recommended configuration settings.