On This Page

Overview

This filter allows you to include or exclude specific files or folders from the source connection based on the exact path you specify. Paths are case sensitive and should be specified using the proper case as it exists in the folder or file path.

Specifying the File or Folder

1. In the Rule type list, select Specific file or folder.

2. Select the Edit link at the end of the Select a specific file or folder to filter field.

3. A modal appears. Either navigate to the file or folder you want to filter or select Manually enter a path to type the exact path. The path will be relative to the source path and should start with a forward slash (/) as in the example below. Paths are case sensitive and should be specified using the proper case as it exists in the folder or file path.
   

   

4. Once you specify the path, select Use this path.

5. The path displays in the Select a specific file or folder to filter field for your reference.
   

   

6. Select Done to complete adding the filter to the job.

Editing a Filter

1. Select Edit next to the filter.
   

   

2. Select Edit again on the Select a specific file or folder to filter field.

3. Use the modal that appears to edit the path.

4. Once you specify the path, select Use this path.

5. The path displays in the Select a specific file or folder to filter field for your reference.

6. Select Done to finish editing the filter.

Removing a Filter

1. Select Edit next to the filter.

2. Select the Delete rule link that appears under the filter information.

3. Select Yes when prompted to verify you want to delete the filter.
   

   

Using Advanced Scripting in the User Interface

It’s possible to add the filter block to the Advanced Scripting page when creating the job to add the filters. If you choose to use the advanced scripting feature, the Filters toggle must be off, or the scripting will be overwritten by any custom filters added on the Filtering page.

Add the filter block of the JSON message to the Advanced Scripting page.

Filter Using REST API

The example code below shows how to add the filter when creating the job through the REST API. The rules need to be added to the filter block of the message. The information required varies based on your job type--basic transfer or sync job.

Adding Filters to Basic Transfer Jobs

When adding a filter to a transfer job (a job that copies from source to destination only), you only need to specify the information for the source. The code below includes examples for including and excluding files and folders.

{
	"filter": {
		"source": [
			{
				"action": "include",
				"rules": [
					{
						"path": "/design",
						"type": "filter_path"
					}
				],
				"type": "filter_rule"
			},
			{
				"action": "include",
				"rules": [
					{
						"path": "/orders",
						"type": "filter_path"
					}
				],
				"type": "filter_rule"
			},
			{
				"action": "include",
				"rules": [
					{
						"path": "/review/summary.xls",
						"type": "filter_path"
					}
				],
				"type": "filter_rule"
			},
			{
				"action": "exclude",
				"rules": [
					{
						"path": "/design/archive",
						"type": "filter_path"
					}
				],
				"type": "filter_rule"
			}
        ]
    }
}

Adding Filters to a Sync Job

When adding a filter to a sync job (a job that copies content between the source and destination to keep the data the same), you need to specify the information for the source and destination. The code below includes examples for including and excluding files and folders.

{
	"filter": {
		"source": [
			{
				"action": "include",
				"rules": [
					{
						"path": "/design",
						"type": "filter_path"
					}
				],
				"type": "filter_rule"
			},
			{
				"action": "include",
				"rules": [
					{
						"path": "/orders",
						"type": "filter_path"
					}
				],
				"type": "filter_rule"
			},
			{
				"action": "include",
				"rules": [
					{
						"path": "/review/summary.xls",
						"type": "filter_path"
					}
				],
				"type": "filter_rule"
			},
			{
				"action": "exclude",
				"rules": [
					{
						"path": "/design/archive",
						"type": "filter_path"
					}
				],
				"type": "filter_rule"
			}
		],
        "destination": [
			{
				"action": "include",
				"rules": [
					{
						"path": "/design",
						"type": "filter_path"
					}
				],
				"type": "filter_rule"
			},
			{
				"action": "include",
				"rules": [
					{
						"path": "/orders",
						"type": "filter_path"
					}
				],
				"type": "filter_rule"
			},
			{
				"action": "include",
				"rules": [
					{
						"path": "/review/summary.xls",
						"type": "filter_path"
					}
				],
				"type": "filter_rule"
			},
			{
				"action": "exclude",
				"rules": [
					{
						"path": "/design/archive",
						"type": "filter_path"
					}
				],
				"type": "filter_rule"
			}
		]
    }
}