Product documentation
Patchworks services
Patchworks services
  • Services documentation
  • Getting started
    • What is a service?
  • Roles & Permissions
    • Roles & permissions summary (services)
  • Working with Services
    • Accessing services
    • The services list
    • The anatomy of a service
      • Service summary
      • Service canvas
      • Service filters
      • Service trigger
      • Service source
      • Service destination
      • Service mapping
      • Service alerts
      • Payload script
      • Run service
      • Service settings
    • Adding a Patchworks service
      • Add a default service
      • Configure service settings
      • Set the service trigger schedule
      • Define service filters
      • Define field mappings
      • Activate the service
    • Cloning an existing service
    • Updating a service
      • Service notes
      • Using a payload-level custom script in services
    • Removing a service
    • Field mappings & transformations (services)
      • Field mappings (services)
        • Mapping metafields for products (services)
      • Field transformations (services)
        • Transform function reference (services)
        • Using a custom script in field transformations (services)
      • Transform mapping/lookup tables (services)
      • Legacy shipment & payment maps (services)
  • Service connectors
    • What is a service connector?
    • Accessing service connectors
    • The anatomy of a service connector
    • Adding a service connector
    • Updating a service connector
    • Removing a service connector
  • Reporting & logging
    • Service sync reports
      • Viewing the service sync report
      • Handling failed service syncs
      • Sync failure email notifications
    • Service sync logs
    • Viewing logs for custom script activity in services
  • Service systems
    • Service systems
    • Supported service systems
      • Active Ants (service connector)
        • Finding service connector credentials for Active Ants
      • BigCommerce (service connector)
        • Finding service connector credentials for BigCommerce
        • Additional setup notes for BigCommerce (services)
      • Bleckmann (service connector)
        • Finding service connector credentials for Bleckmann (API)
      • Bleckmann Returns (service connector)
        • Finding service connector credentials for Bleckmann (Returns)
      • Bleckmann SFTP (service connector)
        • Finding service connector credentials for Bleckmann (SFTP)
      • Brightpearl (service connector)
        • Finding service connector credentials for Brightpearl
        • Additional setup notes for Brightpearl (services)
      • Business Central (service connector)
        • Finding service connector credentials for Business Central
      • Citrus-Lime (service connector)
        • Finding service connector credentials for Citrus-Lime
      • CommerceTools (service connector)
        • Finding service connector credentials for CommerceTools
      • Cybertill (service connector)
        • Finding service connector credentials for Cybertill
      • Descartes Peoplevox (service connector)
        • Finding service connector credentials for Peoplevox
        • Configuring Peoplevox as a data destination (services)
        • Quick setup CSV files for Peoplevox (services)
      • Dynamics NAV (service connector)
        • Finding service connector credentials for Dynamics NAV
      • Emarsys (service connector)
        • Finding service connector credentials for Emarsys (FTP)
      • EposNow (service connector)
        • Finding service connector credentials for EposNow
      • Global-e (service connector)
        • Finding service connector credentials for Global-e
      • Inventory Planner (service connector)
        • Finding service connector credentials for Inventory Planner
      • Khaos Control (service connector)
        • Finding service connector credentials for Khaos Control
      • Lightspeed Retail R-Series (service connector)
        • Authorising Patchworks to access your Lightspeed Retail R-Series account (services)
      • Lightspeed Retail X-Series (service connector)
      • Linnworks (service connector)
        • Finding service connector credentials for Linnworks
      • Magento 2 (service connector)
        • Finding service connector credentials for Magento 2
        • Required settings for Magento 2.4.4+ (services)
      • Mirakl (service connector)
        • Finding service connector credentials for Mirakl
      • Navision (service connector)
      • NetSuite (service connector)
        • Authorising Patchworks to access your NetSuite account (services)
        • Required NetSuite features (services)
        • Working with NetSuite custom fields (services)
        • Setting unique IDs for NetSuite product syncs (services)
        • NetSuite concurrency (services)
        • Troubleshooting NetSuite connections (services)
        • Additional setup notes for NetSuite (services)
        • Legacy service connector setup for NetSuite
          • Installing the Patchworks bundle for NetSuite (services)
          • Finding connector credentials for NetSuite (services)
      • Odoo (service connector)
        • Finding service connector credentials for Odoo
      • Ometria (service connector)
        • Finding service connector credentials for Ometria
      • Patchworks SFTP (service connector)
        • Finding basic auth service connector credentials for SFTP
        • Finding ssh auth service connector credentials for SFTP
        • Specifying a non-root folder as the file location (services)
        • Adding entity schemas (services)
      • Plytix (service connector)
        • Finding service connector credentials for Plytix
      • Prima (service connector)
        • Finding service connector credentials for Prima
      • ReBound (service connector)
        • Finding service connector credentials for ReBound
      • SAP Business One (service connector)
        • Finding service connector credentials for SAP Business One
      • Seko (service connector)
        • Finding service connector credentials for Seko (API)
        • Finding service connector credentials for Seko (FTP)
      • Shopify / Shopify+ (service connector)
        • Finding service connector credentials for Shopify (token auth)
        • Finding service connector credentials for Shopify (legacy auth)
        • Additional setup notes for Shopify (service connector)
      • Sitoo (service connector)
        • Finding service connector credentials for Sitoo
      • SparkLayer (service connector)
        • Finding service connector credentials for SparkLayer
      • The Edge by John Lewis (service connector)
        • Finding service connector credentials for The Edge by John Lewis
      • TikTok Shop (service connector)
        • Finding service connector credentials for TikTok Shop
      • Torque (service connector)
        • Finding service connector credentials for Torque
      • Veeqo
        • Finding service connector credentials for Veeqo
      • Vend (service connector)
        • Finding service connector credentials for Vend
      • Visualsoft (service connector)
        • Finding service connector credentials for Visualsoft
      • Voyado (service connector)
        • Finding service connector credentials for Voyado
      • WooCommerce (service connector)
        • Finding service connector credentials for WooCommerce
      • ZigZag (service connector)
        • Finding service connector credentials for ZigZag
  • Troubleshooting
    • How to manage failed service syncs
    • How to run a service manually
    • How to deactivate/activate a service
    • How to check the operational status of a service connector
    • What to check if you can't save a new service connector
    • How to handle an empty mapping page
    • What to do if your third-party systems go offline
  • Inbound API
    • Inbound API for services
    • Using the Inbound API connector with Patchworks services
      • Adding an inbound API connector with a custom payload
      • Generating token credentials for API access
      • Adding a Patchworks service for an inbound API connector
        • Add a default service
        • Configure service settings
        • Set the service trigger schedule
        • Define field mappings
        • Activate the service
      • Implementing API requests
  • Support
    • Raising a support ticket
Powered by GitBook
On this page
  • Accessing the sync report
  • Understanding the sync report
  • Sync report status indicators
  1. Reporting & logging
  2. Service sync reports

Viewing the service sync report

PreviousService sync reportsNextHandling failed service syncs

Accessing the sync report

To access the latest sync report for your Patchworks services, select sync reports from the left-hand navigation bar:

...the sync reports page is displayed:

Understanding the sync report

Each time a Patchworks service runs, it is attempting to sync data between source and destination connectors. When this happens, an entry is added to the sync report so you can see - at a glance - every item that has been synced and the outcome (i.e. status) of that operation. The example below highlights key features of this report:

By default, reports are shown for the last 5 days. You can use the to increase this number up to a maximum of 15 days.

Items to note are summarised below:

Ref
Function
Summary

1

Report entries

The main part of the display area shows rows of report entries - you will find one entry for every attempted sync (i.e. one entry for each item synced, irrespective of whether the sync was successful).

2

Ellipses actions

3

Additional filters

  • the show additional sync data option adds a latest sync information column to the table

  • the show additional fields option adds source and endpoint id fields (relating to source and destination connectors)

This extra information is only likely to be required by Patchworks support, in the event of a sync query.

4

Search

Search for specific sync reports based on:

  • system (e.g. Shopify)

  • sync id (e.g. 12345678)

  • Reference (e.g. DEMOTEST-SS-YELLOW)

5

Filters

6

Sort report

Use checkboxes to select specific entries for an action - typically, a resync. You can select a single entry or multiple entries and then choose a mass action.

7 & 8

Select entries/entry for further action

9

Sync status

Sync report status indicators

Every sync report entry has an associated status, so you can see whether or not the sync succeeded. As you scan down a report, you may encounter the following status indicators:

Status indicator

OK

Source data has synced to the destination system successfully.

Sent

Typically applied for SFTP or file-based services where source data files are pushed to a destination endpoint successfully. If the destination endpoint confirms that the data is received, the sent status is updated to OK.

Pending

Source data has been pushed but has not yet reached the destination system. The most common reason for this status is where the destination endpoint is down. Typically, a pending entry will be retried up to four times before being set to failed. The number of retries may vary, depending on how the service is configured.

Failed

Click the ellipses to access actions that can be taken for current selections - for example, you can download as CSV: The download will include all sync report entries matching the currently defined filters.

Click the additional filters option to access options for displaying more information: Here:

Click the filter icon associated with a table heading to access associated filter options - for example:

You can select all or individual report entries and then click the ellipses actions option to choose an action to perform - for example:

Every sync report entry has an associated status, so you can see whether or not the sync succeeded. For further information please see the section.

Sync failures may occur for a number of reasons - for example, if a mapped field in the source/destination system has changed unexpectedly, or if there was a communication issue when the service ran. Please see for further information about managing these cases.

sync status indicators
Handling a failed sync