Skip to main content

Gateway Reconciliation dashboard

Zuora

Gateway Reconciliation dashboard

Zuora System Health dashboard for Gateway Reconciliation collects and displays real-time usage and failure data. Through the Gateway Reconciliation dashboard, you can view data about gateway reconciliation reports in your Zuora tenant within the last seven days. You can use this dashboard to detect Gateway Reconciliation issues and troubleshoot.

This article contains the following information about the Gateway Reconciliation dashboard:

  • Definition of the Gateway Reconciliation metrics
  • How to filter, view, and drill down the data in the dashboard

For more information about the System Health feature, see Zuora System Health.

Prerequisites

To access this dashboard, ensure that the following requirements are met:

  • System Health is enabled for your Zuora tenant.
  • You are assigned the Access System Health Dashboard permission.

For more information, see Zuora System Health prerequisites.
If you cannot access this dashboard, check with your administrators.

Gateway Reconciliation metrics

The following table provides descriptions of the Gateway Reconciliation metrics.

Metric Description

Gateway Reconciliation Overview
(Status Breakdown)
 

The number of reports sent within a specified time range and details of each request, including completed and error runs.

When hovering over each time interval bar, you can view the breakdown data of that time range.

  • Completed Sync: The number of successful runs. 
  • Error Sync: The number of failed runs.

Gateway Reconciliation Failures

The number of failed reports within a specified time range.

When hovering over each time interval bar, you can view the breakdown data of that time range.

View data in the Gateway Reconciliation dashboard

The Gateway Reconciliation dashboard is located under the System Health section in the left navigation. It contains a data summary section and two tabs that display the usage and failure data related to Gateway Reconciliation separately. 

This section is located at the top of this dashboard, encompassing the following data boxes that display data summaries within the last seven days.

  • Data Summary section: This section is located at the top of this dashboard, encompassing the following data boxes that display data summaries within the last seven days
    • Jobs Completed: This data box displays the gateway reconciliation jobs completed duration (measured in hours) of jobs within the last seven days.
    • Jobs Processing: This data box displays the total number of jobs processing and the week-over-week change in the number.
    • Jobs Failed: This data box displays the total job failures generated within the last seven days and the week-over-week change in the number.
  • Overview tab: This tab displays the data of the Gateway Reconciliation Overview Status Breakdown metric.
  • Failures tab: This tab displays the data of the Gateway Reconciliation Failures metric.

After you open a tab in the dashboard, take the following steps to view the data:

  1. Configure filters.

    You can customize the data to be displayed by configuring filters.

    1. In the upper right of the dashboard, click the Filters icon.
    2. Use the Timeframe, Start Time, and End Time
    3. Click Apply to apply the filter or click Reset to go back to the default filter configuration.
  2. View the trend chart.
    • Select the time interval of the charts using the interval radio buttons (Day, Hour, and Minute) in the upper right of the chart.
      Note that available interval options vary based on the length of the selected time range. Only the Day Interval is enabled when the range exceeds 60 hours.
    • When hovering over each bar or point, you can view the breakdown data of that time range, which contains the change percentage compared to the previous interval.
  3. Use the table below the trend chart to view detailed data within the selected time range. The detailed tables are available under the Overview and Failures tabs. 
    • By default, the table displays all the items within the specified time range. You can narrow the scope down to a specific interval by clicking a bar in the chart.
    • To go back to the global time-range set in the filter, you can click Reset next to the specific time range displayed above the bar chart.
    • You can use the Filter icon in the upper right of the table to list the data that you want to view. When you finish configuring the filter, click Apply. Click Reset to go back to the default filter configuration.
    • On the Overview tab, you can view the below details:
      • Job Number
      • Period Start
      • Period End
      • Gateway Name
      • Status
      • Last Attempt
      • Completed On
    • On the Failures tab, you can view the below details:
      • Job Number
      • Attempt
      • Start Date
      • End Date
      • Source
      • Gateway
      • Result
      • Reason
    • Click the failure Job Number to view the detailed failure message in the Failures tab
    • You can download the table as a CSV file by clicking the download icon  in the upper right of the table.