...

...

On This Page

Overview

The Segment Transformation policy controls if SkySync can change folder and file names to comply to platform restrictions. This behavior allows SkySync to change the names of folders and files that don't comply with the platform rules for leading and trailing characters or that contain characters that are not supported by the destination. This will be done instead of flagging the file for manual remediation and preventing it from being transferred.

When creating a job in the user interface, segment transformation is enabled using the Allow unsupported file names to be changed toggle on the Jobs Behaviors page. By default, this option is enabled. There are two options for supporting characters that are not supported by the destination.

Replace with underscore

This option replaces invalid characters with underscores. For example, if you attempted to transfer the file "Congrats!.txt" from Box to NFS, SkySync would rename the file to "Congrats_.txt" on the destination. 

...

Encode invalid character

This option encodes invalid characters instead of replacing them with an underscore. The UTF8 bytes for invalid characters are used and converted to a hex string. For example, a file names "123白雜.txt" would be converted to "123E799BDE99B9CE8.txt."

...

Disabling Segment Transformation

This option is on by default when creating a new job. If you prefer SkySync not to automatically handle invalid characters, you can turn this feature off by selecting the Allow unsupported file names to be changed toggle. A gray toggle indicates the feature is off. 

...

Using REST API

If you are creating jobs through the REST API, you can set the segment transform and invalid character policy in the element. The Segment Transformation Policy options are true (default) and false. This element is the same as the Allow Unsupported File Names to be Changed option in the user interface. 

Transfer Segment Off

By default, segment_transfer is enabled and will use underscores to replace unsupported characters. In the example below, the segment_transform feature will be off for the job. This means SkySync will not modify the file or folder name to remove unsupported characters (including leading and trailing characters). Instead, items with unsupported characters will be flagged. 

{
	"name":"Simple Transfer Job with Segment Transform Policy",
	"kind": "transfer",
	"transfer": {
		"segment_transform": false,
    	"transfer_type": "copy",
	    "source": {
    		"connection": { "id": "{{nfs_connection}}" },
			"target": {
                "path": "/SourcePath"
			}
    	},
    	"destination": {
    		"connection": { "id": "{{cloud_connection}}" },
    		"target": {
    			"path": "/DestinationPath"
    		}
    	}
	},
	"schedule": {
		"mode": "manual"
	}
}

Encoding On

Enabling encoding by setting the encode_invalid_characters parameter to true. In the example below, the job will sanitize files and folders according to the destination platform rules AND use encoding for invalid characters. (This is because segment_transform is missing from json, so it defaults to true/on.) 

{
	"name":"Simple Transfer Job with Segment Transform Policy",
	"kind": "transfer",
	"transfer": {
		"encode_invalid_characters": true,
    	"transfer_type": "copy",
	    "source": {
    		"connection": { "id": "{{nfs_connection}}" },
			"target": {
                "path": "/SourcePath"
			}
    	},
    	"destination": {
    		"connection": { "id": "{{cloud_connection}}" },
    		"target": {
    			"path": "/DestinationPath"
    		}
    	}
	},
	"schedule": {
		"mode": "manual"
	}
}