Renditions
- Andrea Harvey
On This Page
Overview
This option is only available for certain platforms. When enabled, it takes native file formats from the source and converts them into supported file formats on the destination. This ensures you retain the files and can access the information on the destination. If you don't enable this behavior, the file will still be transferred, but the contents of the file may not be formatted as expected. Refer to the information below to understand how native formats are handled per platform.
Box Notes
Currently, the rendition feature is only available for Box to convert Box Notes.
Enabled: Box Notes will be transferred to other platforms as docx files.
Disabled: Box Notes will be transferred in JSON format.
Job Behavior
The job will handle Box Notes in the following way to ensure job performance.
The first job run will pick up all box notes.
Delta job runs use Box native event detection to identify changes. Since Box doesn’t support native event detection for Box Notes, Box Notes files will be ignored. There may be exceptions where Box reports changes to Box Notes. When this occurs, the job will pick up the changes.
If you want to migrate updated Box Notes, you will need to perform a soft reset on the job. The job will perform a full crawl of the content, which will migrate the updated Box Notes. This is recommended at the end of a job to ensure all Box Notes updates are transferred.
You can choose to have DryvIQ always transfer all versions of Box Notes by editing the Box suppress_notes_versions configuration option. See Configuration Options for more information.
Unsupported Box Notes Features
Preview images are not supported when converting Box Notes to .docx files since there is not enough information available for DryvIQ to download the image.
Edits to the .docx file on the destination are not transferred to the original Box Note on the source for sync jobs.
Enabling Renditions Through REST API
When creating the job through the REST API, you can enable the rendition behavior in the transfer block.
POST {{url}}v1/jobs |
|---|
{
"name":"Job Name",
"kind": "transfer",
"transfer": {
"transfer_type": "copy",
"source": {
"connection": { "id": "source_connection_id" },
"target": {
"path": "source_connection_path"
}
},
"destination": {
"connection": { "id": "destination_connection_id" },
"target": {
"path": "destination_connection_path"
}
},
"rendition": "rendition"
}
} |
Disabling Renditions Through REST API
When creating the job through the REST API, you can disable the rendition behavior in the transfer block.
POST {{url}}v1/jobs |
|---|
{
"name":"Job Name",
"kind": "transfer",
"transfer": {
"transfer_type": "copy",
"source": {
"connection": { "id": "source_connection_id" },
"target": {
"path": "source_connection_path"
}
},
"destination": {
"connection": { "id": "destination_connection_id" },
"target": {
"path": "destination_connection_path"
}
},
"rendition": "original"
}
} |
Even though the rendition feature can be enabled through the REST API, you cannot enable it using the scripting block when creating the job. Instead, use the toggle in the UI to enable the feature.