Supporting Backwards Compatibility for HTML Content

CLM as Document Model supports backwards compatibility for existing HTML content, whether the content was built for Veeva CRM or for CLM as Object Model in Vault CRM. This ensures content remains accurate and available to end users without requiring content redevelopment. Content developed for Veeva CRM is automatically translated for compatibility with Vault CRM, and any queries pointing to the Object Model retrieve the correct data from the Document Model instead.

Who can use this feature?

Configuring Backwards Compatibility for

To configure this feature:

  1. Ensure Configuring CLM as Document Model is complete.
  2. Navigate to Admin > Configuration > Objects.
  3. Create a custom document reference field corresponding to each custom object reference field referencing the clm_presentation__v or key_message__v objects. The API name of the document reference field must match the object reference field, with an additional prefix of doc_. For example, if there is an object reference field clm_presentation__c referencing a CLM Presentation record, create the document reference field doc_clm_presentation__v to reference the Presentation binder.

Supporting Backwards Compatibility as

To allow HTML content to display correctly in Vault CRM, content admin users must set the content target platform on each Slide document in a Presentation binder. This ensures content created for Veeva CRM is automatically translated for Vault CRM, and any queries for the Object Model are translated for the Document Model.

To set the content target platform for a Slide document:

  1. Navigate to All > Library.
  2. Select the appropriate Slide document.
  3. Select Edit Details.
  4. Select the appropriate option for the Target Platform field in the Legacy Information section of the Information panel:
    • Vault – The slide was created using the Vault CRM JavaScript library and Vault CRM API names. Queries for the object model are translated for the Document Model.
    • Salesforce – The slide was created using the Veeva CRM JavaScript library and Veeva CRM API names. API names and JavaScript methods are translated to the Vault CRM format, and queries for the object model are translated for the Document Model.
  5. Select Save.

The table below describes the translations for queries from the Object Model to the Document Model. See Querying Documents and Records from CLM for more information about the supported JavaScript methods for querying.

With the 25R3.5 release, only backwards compatibility for querying records is supported. Backwards compatibility for creating and updating records will be supported in a future release.

Object Model

Document Model

clm_presentation__v or clm_presentation_vod__c

Queries are always translated to return presentation__v Binders and the document fields corresponding to the object fields.

key_message__v or key_message_vod__c

Queries are translated to return slide__v and shared_resource__v Documents and the document fields corresponding to the object fields, only if the query contains at least one of the following fields, indicating the query is for CLM Key Messages:

  • media_file_name__v
  • cdn_path__v
  • clm_id__v
  • target_platform__v
  • custom_reaction__v
  • disable_actions__v
  • ios_resolution__v
  • ios_viewer__v
  • is_shared_resource__v
  • isi_document__v
  • keywords__v
  • media_file_crc__v
  • media_file_size__v
  • media_type__v
  • pi_document__v
  • rendition_md5__v
  • shared_resource__v
  • hq_slide_notes__v
  • slide_notes_version__v
  • slide_version__v
  • url__v
  • vault_dns__v
  • vault_doc_id__v
  • vault_external_id__v
  • vault_guid__v
  • vault_last_modified_date_time__v

If none of these fields are included in the query, Key Message records are returned.

clm_presentation_slide__v or clm_presentation_slide_vod__c

Queries to the CLM Presentation Slide object are not translated. There is not an equivalent record to this object in the Document Model. 

To query the order of the slide in the presentation, update the content to query the Binder Nodes in the document model directly.

To query the Sub Presentation of the slide, update the content to query the Document Relationship in the document model directly.

Standard object fields referencing the CLM Object Model

Queries to standard object reference fields in the CLM Object Model are translated to return the values from the corresponding document reference fields, for example, querying for the clm_presentation__v field on the call2_key_message__v object returns the value from the presentation_binder__v field.

Custom object fields referencing the CLM Object Model

Queries to custom object reference fields to the CLM Object Model are translated to return the values from the corresponding document reference fields, when available.

If a corresponding document reference field is not available, the query returns the value of the object reference field.

Custom fields on the CLM Presentation and Key Message objects are not translated. Any custom field names defined for the Object Model must match custom field names in the Document Model.

Related Topics

Managing CLM Content as Documents in Vault CRM

Customizing Slide Navigation for HTML Content