On This Page
Overview
Each item is a package, consisting of the media itself, version history, author, sharing, and any other metadata. SkySync ensures all pieces of the item package are transferred to the destination to preserve data integrity. If SkySync can't transfer an item, the item is set to retry. By default, SkySync will attempt three times to reconcile items that are in pending/retry status. Depending on your job configuration, this may occur with the defined schedule, or you can start the job manually. When an item is in a "flagged" status, this means SkySync has made all attempts to transfer the file without success, and it requires manual remediation. These items can be retried or ignored on subsequent job runs. If retried and successfully transferred, the item will be removed from the flagged items. You can identify the flagged items in the user interface through the flagged item reporting, or you can pull flagged item reports through the REST API.
When viewing flagged items in the application, long item names may not fit in the list. If an item name is too long to display fully, you can hover on the name. This will display a pop-up that displays the full name of the item.
For more information, see: |
Viewing Flagged Items
You have the option of viewing flagged items for all jobs using the Flagged items option on the menu, for a single job through the jobs menu option, or for a group of jobs through the reports.
Flagged Items Menu Option
The Flagged items menu option will display the flagged items across all jobs. Use the export option to export the report to a csv file. You can then use the file to remediate issues by correcting issues that are preventing items from transferring and identifying flagged items that don't need to be transferred. Once you’ve worked through the export, return to the Flagged items page to set the job to retry an item or ignore it on the next job run. You can also choose to view the history of the item. You can work with one item at a time or select multiple items and select the appropriate action.
Flagged Items in Roll-up Job Reports
Selecting Flagged in the chart on the Overview tab of the report will automatically take you to the Items tab and filter it to show just the flagged items for the jobs included on the report. The same options are available here to export the lists to a csv file, ignore items, retry items, and view the item history.
Flagged Items in Individual Job Reports
When viewing information for an individual job, you view the flagged items for the job by selecting Flagged in the chart on the Overview page. This will take you to the Items tab and filter it to show just the flagged items for the jobs included on the report. You can use the filter options on the Items tab to view the flagged items. Again, the same options are available here to export the lists to a csv file, ignore items, retry items, and view the item history.
Flagged Items Using the REST API
List All Flagged Items
List all items from all jobs that have the flagged status. After review, items can be set to retry or ignore on subsequent job runs.
GET {{url}}v1/transfers/items/flagged
Set Single Item to Retry or Ignore
When an item is flagged you can reset the status to either retry or ignore on the next job run.
Set Flagged Item for Retry
PATCH {{url}}v1/transfers/items/{{item_id}}?retry=1
Set Flagged Item to Ignore
PATCH {{url}}v1/transfers/items/{{item_id}}?ignore=1
Set Multiple Items to Retry or Ignore
When items are flagged you can reset the status to either retry or ignore on multiple items for the next job run using the same filter options available for viewing those items.
Set Flagged Items for Retry
PATCH {{url}}v1/transfers/items?parent={{parentId}}&retry
Set Flagged Items to Ignore
PATCH {{url}}v1/transfers/items?id={{itemId}},{{itemId}},{{itemId}}&ignore
Set Flagged Items to Ignore
PATCH {{url}}v1/transfers/items?jobs={{jobId}}&ignore
Set Flagged Items to Ignore
PATCH {{url}}v1/transfers/{{jobdid}}/items?ignore
List All Items Set to Retry or Ignore
List all items from all jobs that are set for retry on subsequent runs.
List All Items Set to Retry
GET {{url}}v1/transfers/items?status=retry
List All Items Set to Ignore
GET {{url}}v1/transfers/items?status=skipped
Show All Items for Remediation
GET {{url}}v1/transfers/{{job}}/items?status=remediation&include=all
Show All System Error Categories
When issues occur during transfer, SkySync will categorize the issues based on the error and flag for manual remediation. This allows you to easily identify areas for review.
GET {{url}}v1/transfers/categories?priority=all
Create Custom Error Category by Audit Type
SkySync allows you to create your own custom error category by audit type. For example, you could group several error codes together to create a broader category to ignore.
POST {{url}}v1/transfers/categories |
{ "name": "Unknown", "description": "Items with unknown errors", "filter": { "rules": [{ "text": "[audit_type]=5001", "type": "filter_context" }] }, "action": "retry", "max_retry": 3 } |
Create Custom Error Category by Event Type
SkySync allows you to create your own custom error category by event type. For example, you could group several events such as rename and update to create a broader category to retry.
POST {{url}}v1/transfers/categories |
{ "name": "Event Type Rename", "description": "The event source of the original transfer operation = Rename", "filter": { "rules": [{ "text": "[event_type]=rename", "type": "filter_context" }] }, "action": "retry", "max_retry": 3 } |