Uploading & Downloading Large Size Asset Renditions

We recommend using the Vault File Manager desktop application for Windows to upload and download Large Size Asset rendition files up to 500GB in size. If you’re not using a Windows machine or are unable to install Vault File Manager, you can upload your file to the File Staging Server and use the Add Multiple Document Renditions API endpoint to load the files into Vault. You can continue to download large rendition files in your web browser.

Uploading Large Size Assets Using Vault File Manager

To upload Large Size Asset renditions to Vault using Vault File Manager:

  1. In Vault, click Add Rendition on the Doc Info page.
  2. Select the Large Size Asset rendition type.
  3. Click the Upload using Vault File Manager link.
  4. In Vault File Manager, select a file to upload.
  5. Click Start Upload.
  6. Double click the rendition item to view the document in your Vault.

Uploading Large Size Assets Using the File Staging Server

You can upload Large Size Asset renditions up to 500GB in size to the File Staging Server, which you can then upload to an existing document using the Add Multiple Document Renditions API endpoint, passing in the largeSizeAsset query parameter to avoid using migration mode. To upload a rendition of this type, an Admin must associate the Large Size Asset rendition type with the document’s type.

To add or update renditions:

  1. Open your FTP client and upload the rendition files to any directory. For the best performance, we recommend FileZilla.
  2. Create a CSV input file, then use Vault Loader or the Vault REST API’s Add Multiple Document Renditions endpoint to add the renditions.
  3. Add the largeSizeAsset query parameter.

You can also add or update renditions using the Vault REST API’s File Staging API. Learn more in the Developer Portal.

How to Access the File Staging Server

See Accessing Your Vault File Staging Server for details.

Downloading Large Size Renditions

To download the rendition using Vault File Manager, navigate to Renditions in the Files panel on the Doc Info page, and select Download to Vault File Manager from the Actions menu next to the rendition.

When you download rendition files above 1 GB in size, Vault prompts you to use Vault File Manager for improved speed and performance. This applies to both Large Size Asset renditions and regular renditions.

The following permissions control the actions described in this article:

Permission Type Permission Label Controls
Security Profile Download Document Ability to download the Large Size Asset rendition; note that this is different from other renditions because Large Size Asset is treated like a secondary source file.
Security Profile Application: Document: Download Rendition Ability to download large rendition files using Vault File Manager.
Security Profile File Staging: Access Ability to access your Vault’s file staging server. You must have this permission to upload Large Size Asset renditions using Vault File Manager.
Security Profile Vault Owner Actions: Re-render Ability to manage and add viewable renditions to existing documents without the Manage Viewable Rendition document role permission; users with the Vault Owner security profile do not need to be assigned to any role on the document.
Security Profile Vault Owner Actions: Document Migration Ability to select the Document Migration Mode checkbox to upload Large Size Asset files using Vault Loader.
Security Profile API: Access API Ability to access the Vault REST API.
Security Profile Document: Vault File Manager Ability to check out documents to Vault File Manager using the Check Out to File Manager action or Document Check Out bulk action and upload and download renditions.
Document Role Download Source Ability to download the Large Size Asset rendition; note that this is different from other renditions because Large Size Asset is treated like a secondary source file.
Document Role Manage Viewable Rendition Ability to add viewable renditions to existing documents.
Document Role View Document Ability to upload Large Size Asset renditions to existing documents. You must have this permission for the latest version of the document.
Document Role View Content Ability to upload Large Size Asset renditions to existing documents. You must have this permission for the latest version of the document.
Document Role Edit Fields Ability to upload Large Size Asset renditions and other rendition types (other than Viewable Rendition) to existing documents. You must have this permission for the latest version of the document.

See Accessing Your Vault File Staging Server for details on permissions required for file staging server access.