Versions Compared

Old Version 11

changes.mady.by.user Andrea Harvey

Saved on

compared with

New Version 12

changes.mady.by.user Andrea Harvey

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


On This Page

Table of Contents


Overview

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. SkySync will retry an item three times by default. You can change the retry limit for different error messages. 


Format

Code Block
{
    "name": "Zips File Errors",
    "description": "Files with extension *.zip that failed.",
    "filter": {
        "rules": [
            {
            	"text": "[audit_type] >= 5000",
                "type": "filter_context"
            },
            {
            	"text": "*.zip",
            	"targets": [
            		"item"
            	],
                "type": "filter_pattern"
            }
        ]
    },
    "action": "retry",
	"max_retry": 3,
    "level": "error",
    "priority": 10000
}


Parameters


ParameterDescriptionRequired
nameThe name of the categoryRequired
descriptionAn optional description for the categoryOptional
filter

The criteria used to match an item to the category. There are two kinds:

  • Context metadata: Includes audit information about what caused the item to fail to transfer have a warning during transfer.
  • Pattern: includes match by item name/path pattern (e.g. *.txt)
Required
action

This identifies the action to take. There are three option:

  • retry: Retry the item transfer. The max_retry defines the number of times the item is retried before it is ignored.
  • ignore: Ignore the item. This places it in manual remediation.
  • halt: Halt the job; prevent the job from subsequent executions
Required
max_retryThe number of retries to attempt before the item is ignored. The default value is 3Optional


Filter by Context

Metadata

Metadata 
Anchor

Filter

metadata

Filter

metadata

The table below lists your options for filtering based on context metadata. 

NameType

Description

Example
audit_type

Integer

The audit type:

ValueDescriptionDefault Category
4001Conflict copy createdTrue, Priority 12
4002Invalid security identifierTrue, Priority 13
4003Unsupported access ruleTrue, Priority 14
4004Unsupported access rule targetTrue, Priority 14
4005Access rule ignoredTrue, Priority 14
4006Property value warningTrue, Priority 15
4007Restricted content skippedTrue, Priority 16
4008

Item locked warning

See Lock Propagation for more information.

True, Priority 17
4050Convention skippedTrue, Priority 18
4100Property value import failureTrue, Priority 19
4101Access rule import failureTrue, Priority 20
5001Unknown failureTrue, Priority 1
5002Connectivity failureTrue, Priority 2
5003Access failureTrue, Priority 3
5004Permission failureTrue, Priority 4
5005Policy failureTrue, Priority 5
5006Not found failureTrue, Priority 6
5007Duplicate item failureTrue, Priority 7
5008Invalid item failureTrue, Priority 8
5009IO failureTrue, Priority 9
5010Conflict failureTrue, Priority 10
5011License failureTrue, Priority 11


The example below includes any items with unknown errors.


{
    ...
    "filter": {
        "rules": [{
            "text": "[audit_type]=5001",
            "type": "filter_context"
        }],
    }
    ...
}


audit_level

Integer

The audit level:

ValueDescription
0-999None
1000-1999Trace

2000-2999

Debug
3000-3999Information
4000-4999Warning
5000+Error


The example below includes any items with warnings.


{
    ...
    "filter": {
        "rules": [{
            "text": "[audit_level]>=4000 AND [audit_level]<5000",
            "type": "filter_context"
        }],
    }
    ...
}


message
StringThe error message that cause of the item failure.
event_type
String

The event source of the original transfer operation:

Event Types
add
update
copy
move
rename
restore
delete
delete_items
value_changed

lock

See Lock Propagation for more information.

unlock
conflict_copy



hresult
StringThe system hresult code, if the error was generated by an exception
exception
StringThe exception type, if the error was generated by an exception


Filter by

name pattern 

Name Pattern 
Anchor

Filter

pattern

Filter

pattern

You can also match categories by file path pattern. The example below includes any container (e.g. directory) with "secret" as any part of its name.


Code Block
{
    ...
    "filter": {
        "rules": [{
            "text": "*secret*",
            "targets": [
                "container"
            ],
            "type": "filter_pattern"
        }],
    }
    ...
}