On This Page

Overview

To filter items by metadata, the target platform must support metadata. If the target platform does not support metadata, the "Metadata Content" custom filter will be disabled.

To filter metadata content, both the Filtering and Scripting options need to be enabled on the Advanced setting page. The Metadata Mapping option should not be enabled.

The following example excludes the item that is associated with value "Doe1" for the property value LName metadata column on the Source platform.

Format: 

[Property]="Text"

[Property]=Numeric Value

Filter Using REST API

If the target platform does not support metadata, the filter or text definition for the given connection will be ignored.

For metadata filtering, the type attribute can use filter_metadata or metadata. Both configurations work the same. 

In addition, metadata filtering rules (rules block) can be defined using either a filter block or text attribute. Filters (filter blocks) include name, op, and value attributes, name is the metadata field name, op is one of the operators defined in the table below, and value is the metadata value used for the comparison. All three attributes are required, even with the empty and not_empty operators. When empty and not_empty operators are used, ensure to configure the value to represent an empty state (e.g. "value": ""). 

Text (text) values must be in a string format with quotes around the value escaped and brackets around the field name (e.g. "[ProtectionLevel]=\"Sensitive\""). Numeric values do not need to be contained in quotes. 

Attributes

eq

=

"filter": { 
  "name": "ProtectionLevel", 
  "op": "eq", 
  "value": "Sensitive" 
}

ne

<> or !=

"filter": { 
  "name": "ProtectionLevel", 
  "op": "ne", 
  "value": "Sensitive" 
}

lt

<

"filter": { 
  "name": "ProtectionLevel", 
  "op": "lt", 
  "value": 100 
}

le

<=

gt

>

ge

>=

starts_with

not_starts_with

ends_with

not_ends_with

contains

=

not_contains

in

IN

not_in

NOT IN

empty

not_empty

="*" 

Example 1

The following example will exclude any files on the source from being transferred to the destination that have a metadata field named "ProtectionLevel" with value "Sensitive.”

{
  "name": "Metadata Content Filter Include Value Equal To [Value]",
  "kind": "transfer",
  "transfer": {
    "audit_level": "trace",
    "transfer_type": "copy",
    "source": {
        "connection": {"id": "{{source_cloud_connection}}"},
			"target": {
				"path": "/Source Folder"
    	}
	},
	"destination": {
    	"connection": {"id": "{{destination_cloud_connection}}"},
			"target": {
				"path": "/Destination Folder"
    	}
  },
  "filter": {
	"source": [{
      "action": "include",
    	"rules": [{
        	"filter": {
        		"name": "ProtectionLevel",
        		"op": "eq",
        		"value": "Sensitive"
			},
		"type": "filter_metadata"
		}],
		"type": "filter_rule"
        }
      ]
    }
  },
    "schedule": {
        "mode": "manual"
    },
    "stop_policy": {
        "on_success": 5,
        "on_failure": 5,
        "on_execute": 25
    },
    "category": {
      "name": "Report Name"
    }
}

Example 2

The following example results in the same filtering as Example 1. Here the filter block is replaced by the equivalent text attribute.

{
	...
	"transfer": {
		...
		"filter": {
			"source": [{
					"action": "exclude",
					"rules": [{
						"text": "[ProtectionLevel]=\"Sensitive\"",
						"type": "filter_metadata"					
					}],
					"type": "filter_rule"
				}
			]
		}
	}
	...
}

Identify the Columns to Filter on

Populate the property name value that corresponds with metadata content column.

{
"transfer" : {
"metadata_map": {
                "schemas": [
                    {
                        "mappings": [
                            {
                                "source": {
                                    "property": {
                                        "name": "LName",
                                        "type": "string"
                                    }
                                },
                                "destination": {
                                    "property": {
                                        "name": "LName",
                                        "type": "string"
                                    }
                                }
                            }
                        ]
                    }
                ]
            }
}
}