Integration Log Health Report

Owned by Hunter Schaeffer
Last updated: Feb 15, 2022
3 min read

 

About

Integrations are critical for the smooth operation of your ecommerce business. While most merchants have at least one integration, it's not uncommon to have a half dozen. Ensuring the health of all your integrations leads to an optimal business and happy customers.

The Problem
UltraCart historically used integration specific logging accompanied by limited notifications for problematic events. While logging alone can provide diagnostic information, you are generally unaware of a problem until you hear from a customer wondering about a shipment or because data isn't flowing into a system. The old adage "out of sight out of mind" often resulted in overly reactive problem solving.

The Solution
UltraCart has unified all integration event logging into a single system. Whether the integration is fulfillment, email marketing, or content management, the event logging will all be the same.

All log buttons within the system will take you to the new integration logging interface. Quickly access logs for an integration and segment out event types — especially errors — within the intuitive new user interface. We've also made it possible to see all the integration logs associated with a particular order.

"It's another one of those super high leverage operational advantages" - Chris Guill

Configuration

To enable the report, edit your user and then select the checkbox in the Email Notifications section titled “Integration Log Health Report” then save the changes:

Important Notice regarding email notification delivery

Daily Integration Health Report Delivery

The report will only be sent if there are 1 or more critical issues in the log reports. The report is sent in the morning based on logged issues from the previous day.

PLEASE NOTE: Starting on August 1, 2021, if your account does not have at least one user with the notification enabled, UltraCart will send the notification to all users on the account with edit settings permissions.

Examples

Understanding Event Types

These are some common examples:

  • Error

    • A communication problem talking to the external system.

    • A configuration problem preventing data from flowing between the external system.

    • Order transmitted more than 7 days ago to your fulfillment house, but not acknowledged as shipped.

    • Order paid for, but sitting untransmitted to your fulfillment house for 7 days or more.

  • Critical

    • Credentials are incorrect for the external system.

    • Order transmitted more than 14 days ago to your fulfillment house, but not acknowledged as shipped.

    • Order paid for, but sitting untransmitted to your fulfillment house for 14 days or more.

 

Understanding Event Types

These are some common examples:

  • Error

    • A communication problem talking to the external system.

    • A configuration problem preventing data from flowing between the external system.

    • Order transmitted more than 7 days ago to your fulfillment house, but not acknowledged as shipped.

    • Order paid for, but sitting untransmitted to your fulfillment house for 7 days or more.

  • Critical

    • Credentials are incorrect for the external system.

    • Order transmitted more than 14 days ago to your fulfillment house, but not acknowledged as shipped.

    • Order paid for, but sitting untransmitted to your fulfillment house for 14 days or more.

 

Viewing the Integration Logs while logged into UltraCart

Navigation: Main Menu → Operations → Reporting

You can also review the Integration Logs by logging into your account then navigating to the Reporting area:

 

  • Integration Logs - All Provides a snapshot view of the integration logs unfiltered.

  • Integration Logs - Critical Provides a snapshot view of the integration logs filtered on critical errors.

  • Integration Logs - Errors Provides a snapshot view of the integration logs filtered on all errors/warnings.