Skip to main content

Renditions

If the formatting and spacing of a document version file renders strangely in the document viewer, you can upload a rendition. A rendition is a high quality, high fidelity file that you manually associate with a document version record and that usually takes the form of a PDF. Komodo Publications Planning uses renditions whenever possible. For example, when a document version has a rendition, the document viewer displays the rendition rather than the document version file. The content in a rendition should be identical to the content in the document version file.

The Document Version Rendition (CM_Document_Version_Rendition__c) custom object stores metadata for renditions and is on the detail side of a master-detail relationship with the Document Version custom object. This relationship ensures that if you have access to a Document Version record, you also have access to its Document Version Rendition child records.

Configure renditions

Users are required to select a Rendition Type when adding a rendition to a Document Version record. To configure different types of renditions, create or modify Rendition Type (mvn__CM_Rendition_Type__mdt) records.

User interface workflows

With the Renditions component, you can add, delete, and download renditions in the user interface. The Renditions component is located on the Document Version detail page.

Add rendition

To add a rendition:

  1. Navigate to the Document Version detail page.

  2. Click New in the Renditions component. The New Rendition modal opens.

  3. Attach the file that you want to add as a rendition. To attach a file, use one of these methods:

    • Click Upload Files, and select a file.

    • Drag and drop a file into the modal.

  4. Select a Rendition Type.

  5. Click Save. The uploaded document appears in the Renditions component, the document viewer displays the rendition.

Delete rendition

To delete a rendition:

  1. Navigate to the Document Version detail page.

  2. Click the Dropdown ICON_Down.png menu in the Renditions component.

  3. Click Delete. The rendition is deleted and removed from the Renditions component. The preview of the document version reverts to what it was before the deleted rendition was originally attached.

Download rendition

To download a rendition:

  1. Navigate to the Document Version detail page.

  2. Click the Dropdown ICON_Down.png menu in the Renditions component.

  3. Click Download.