On This Page

Overview

Each platform has limits for path and segment lengths. During transfer, if an item’s path or segment length exceeds the platform limits, the item will not transfer and be flagged for remediation. When creating a job, you have the option of turning on truncation to shorten a path or segment name when it exceed the maximum number of characters allowed based on the platform.  Truncation removes the right-most characters until the path meets the length requirements. By default, this feature is not enabled for a job. Enabling it reduces the potential for flagged items.

Enabling Truncation

The truncation option can be enabled when creating the job in the user interface on the Behaviors page. By default, the Allow truncation toggle is disabled and will be gray. To enable truncation, select the toggle. It will be green when the feature is enabled.

REST API

When creating a job through the REST API, you can set the job to use truncation as part of the transfers block. The truncation policy options are true and false (default). This element is the same as the Allow truncation option in the user interface. 

Truncation On

To enable truncation, set the segment_truncate parameter to true.

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

Truncation Off

To disable truncation, set the segment_truncate parameter to false. Truncation is off by default, so if you do not include the truncation parameter in the transfer block, it will default to off for the job.

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