In the event that you have a sync query but there are no failures in your sync report, you may wish to run the associated service manually. To do this, follow the steps on this page.
Information on this page is for admin users only - screens shown here are not available to general users.
Step 1 Access the services page.
Please see accessing services if you're not sure how to get to this point.
Step 2 Select the required service:
Step 3 Select the run service tab:
This tab is only available to admin users, for active services.
...the run service page is displayed:
Step 4 A range of options is available in different panels so you can control how this sync is run - set these as required. Key areas are highlighted in the screenshot above and summarised below:
| Ref # | Panel / Option | Summary |
|---|---|---|
1 | Service filters | Any filters defined for this service are shown here by default. If required, you can change these settings. Available filters vary by source system however, you can always filter by ID. This is useful if you need to run the service for a specific item (e.g. an order, product, customer, stock item, etc.). Unless you choose otherwise (by using the save settings to this service option), these filters will only apply when the service is run from this tab. |
2 | From options | Define settings relating to the service source - i.e. the 'pull' operation:
|
3 | To options | Define settings relating to the service destination - i.e. the 'push' operation:
|
4 | Service options | These options are most likely to be used (or suggested) by the Patchworks support team, for troubleshooting a sync issue:
For further information please see the about payloads section below. |
5 | Stop service | Use this button to stop a service that is currently running. |
6 | Save settings to this service | Use this button to apply from options and to options defined here to any scheduled syncs going forward. |
7 | Run service | Use this button to run the service. |
8 | Service log | Shows the status of this run. If auto-refresh is switched on (the default state) the log updates every five seconds, giving a live view of the sync. For further information about logs, please see the service logs page. |
9 | Payloads | If you previously set options to store pull payload and/or store push payload, one or both of these buttons becomes active when the service run is completed. |
10 | Custom script payload | If you previously set the option to store custom script payload, this button becomes active when the service run is completed. |
Step 5 When you're ready, click the run service button.
Any update may not be immediate as this run needs to take its place in the processing queue.
When you exit from this page, current settings, logs and download options are cleared - make sure you have what you need before navigating elsewhere.
Payloads are stored in an S3 bucket within a Patchworks AWS instance, for 24 hours.
Having exited the run service page, you can access these files via links in the service log. These links remain active for 24 hours after the service run is completed.
Remember that all settings, logs and download options are cleared when you exit the page.
Payloads are downloaded as a zip file containing the raw, translated payload.
The service log shows the status of the run that was just completed.
