Syncplicity Support

Search our knowledgebase to get the help you need, today

Submit a request
Follow

Transfer audit remediation categories

When issues occur during transfer, DataHub will categorize the issues based on the error and flag for manual remediation. This allows you to easily identify areas for review

Related:

General Format

{
    "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
}

Action Options

Action

Description
retry Retry the item transfer. max_retry defines the number of times the item is retried before it is ignored
ignore Ignore the item, places it in manual remediation
halt Halt the job; prevent the job from subsequent executions

Value Options

Value

Optional/Required

Description
name required The name of the category
description optional An optional description for the category
filter required

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

  1. Context metadata: Includes audit information about what caused the item to fail to transfer have a warning during transfer .
  2. Pattern: includes match by item name/path pattern (e.g. *.txt)
max_retry optional The number of retries to do before the item is ignored.

Defaults to 3

Filter by context metadata

Context Metadata Columns

Options:

Name

Type

Description

Example

 
audit_type

Integer

The audit type:

Value

Description

Default Category
4001 Conflict copy created True, Priority 12
4002 Invalid security identifier True, Priority 13
4003 Unsupported access rule True, Priority 14
4004 Unsupported access rule target True, Priority 14
4005 Access rule ignored True, Priority 14
4006 Property value warning True, Priority 15
4007 Restricted content skipped True, Priority 16
4008 Item locked warning True, Priority 17
4050 Convention skipped True, Priority 18
4100 Property value import failure True, Priority 19
4101 Access rule import failure True, Priority 20
5001 Unknown failure True, Priority 1
5002 Connectivity failure True, Priority 2
5003 Access failure True, Priority 3
5004 Permission failure True, Priority 4
5005 Policy failure True, Priority 5
5006 Not found failure True, Priority 6
5007 Duplicate item failure True, Priority 7
5008 Invalid item failure True, Priority 8
5009 IO failure True, Priority 9
5010 Conflict failure True, Priority 10
5011 License failure True, 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:

Value

Description
0-999 None
1000-1999 Trace

2000-2999

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

The example below includes any items with warnings.

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

 
message
 String The 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
unlock
conflict_copy
  
hresult
 String The system hresult code, if the error was generated by an exception   
exception
 String The exception type, if the error was generated by an exception  

Filter by name pattern

You can also match categories by file path pattern.

Example 1

The example below includes any container (e.g. directory) with 'secret' as any part of its name.

{
    ...
    "filter": {
        "rules": [{
            "text": "*secret*",
            "targets": [
                "container"
            ],
            "type": "filter_pattern"
        }],
    }
    ...
}
Powered by Zendesk