# Configuring CLM Integration

Vault automatically creates most of the configuration elements that you need to use the CLM integration. This article explains the additional steps you'll need to complete and provides information on some of the configurations that are automatically provided.

## Configuration Steps

To use CLM Integration, an Admin (with a security profile that grants the necessary access) must complete these configurations:

  * **Create object data records**: Create <a href="/en/gr/18769/">object data records</a> for the <a href="/en/gr/18957/#product">_Product_</a> object. If you are using the <a href="/en/gr/18957/#survey_directory">_Survey_</a>, <a href="/en/gr/18957/#survey_directory">_Directory_</a>, or <a href="/en/gr/18957/#Keyword_Mapping">_Keyword_</a> objects, create records for these as well. These records correspond to entities in CRM, so you must verify that the object fields used to match records between Vault and CRM are correct.
  * **Set up manual send actions**: Vault automatically sends documents to CRM when they meet the necessary criteria. You may need to configure additional user actions that allow users to manually push a document if the automatic send fails. The default _CRM Content Lifecycle_ already includes user actions for some states.
  * **Set up lifecycle state send actions**: Configure lifecycle state entry actions that send a document to CLM. Vault automatically sends _Multichannel Slide_ documents when the distribution package or certain metadata change, but does not automatically send when the document changes states. To ensure that approved content is sent to the production environment, we recommend that you set up this entry action on the _Steady_ state.
  * **Set up withdraw actions**: Configure lifecycle state entry actions that automatically withdraw documents from CLM. For withdrawal, you must specify the environment. Vault automatically makes **Withdraw from Stage CLM** and **Withdraw from Production CLM** user actions available once a document version is published, so you do not need to configure those actions. We recommend that you <a href="/en/gr/12399/">configure entry actions</a> for the _Superseded_ and/or _Obsolete_ state to withdraw from both stage and production environments. This ensures that old versions are removed, even if users forget to do so manually.

## Associated Configuration Options

<div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: Some configuration options must be enabled by Veeva Services. To import and activate all multichannel components in Vault, contact Veeva Services.</p>
    </div>
  </div>
</div>



The following are available in your Vault:

  * **Document Types**: Users can apply the _Multichannel Slide_ and _Multichannel Presentation_ document types to content that will be sent to CLM.
  * <a href="/en/gr/18956/#fields">**Document Fields**</a>: CLM Integration includes a robust set of document fields that control the options on a document once it's published in CRM.
  * **Vault Objects**: The _Survey_ and _Directory_ objects hold metadata that corresponds to records in CLM. The _Distribution_ object tracks send to CLM actions for documents. Vault automatically creates _Distribution_ object records and uses them to store details like where and when a particular document was sent to CLM, as well as error messages when auto-sending fails. The _CRM Message Template_ object holds approved messages that CRM users can select when sharing content as web links.
  * **Rendition Types**: To successfully publish presentations and slides, a document must have a distribution package in a format appropriate to CRM. For this, users have various distribution <a href="/en/gr/25892/">package rendition types</a>.
  * **Distribution to China**: If your organization distributes content to Chinese customers, you can enable the shared document field <a href="/en/gr/63412/">_Use China CDN_</a> which can be used to indicate that Vault should replicate the content to the China-hosted CDN.
  * **Lifecycle**: You can choose to use the _CRM Content_ lifecycle or another for _Multichannel Slide_ documents.
  * **User Actions for Sending**: Vault automatically adds the _Send to CLM_ user actions to _CRM Content Lifecycle_ states, but you can also configure this action for other lifecycles. Because the feature automatically sends content, manual user actions serve to allow re-sending in case of errors during the automatic send.
  * **User Actions for Creating Presentations**: Add the **Create Presentation** user action to any lifecycle states from which users should be able to <a href="/en/gr/28786/#generate">auto-generate a presentation</a>.
  * **User Actions for Obsolete State Types:** Initiate the _Obsolete related presentation and slides_ user action to automatically move _Multichannel Slides_ and _Multichannel Presentations_ to their lifecycle's obsolete state when the document they were generated from moves to an obsolete state. The _Obsolete dropped slides_ user action moves _Multichannel Slides_ removed from a _Multichannel_ presentation to their lifecycle's obsolete state.

## Survey & Directory Mapping {#survey_directory}

Data records that you create for the _Directory_ and _Survey_ objects must correspond to entities that exist in CRM. CRM uses the _External ID_ object field to match data records from Vault. Verify that the values for _External ID_ match the values in CRM.

## Product Mapping {#product}

When using CLM Integration, it's important that <a href="/en/gr/25318/">products are set up properly</a> in both Vault and CRM.

## Keyword Mapping {#Keyword_Mapping}

Data Records created for the _Keyword_ object maps to a _Keyword_ field which already exists in CRM. The _Keyword_ field must be active in Vault and enabled in CRM. CRM does not use the _External ID_ (like Survey and Directory) but "Copy to Another Vault" uses the External ID.

## Enabling CLM Preview {#preview}

CLM Preview allows users to preview content from a browser window to quickly see how the content will look and how the interactive HTML elements behave. However, there are several limitations to rendering CLM content in a browser. We recommend that you review this information before enabling.

To enable, navigate to **Admin** > **Settings** > **Application Settings** and select the **Enable CLM Preview** checkbox.

### Rendering Limitations

The Preview action has several limitations:

  * CLM Preview is only available in English at this time.
  * You must use a browser that supports HTML5, for example, the latest versions of Chrome, Firefox, and Safari, or Internet Explorer 11+.
  * Preview does not display browser controls in the same way that some native browsers will.
  * Some HTML files will not render properly, depending on how the HTML is coded.
  * Content CSS cannot use 100% width and 100% height.
  * PPTX presentations are not supported.
  * PDF content embedded in HTML is not supported.
  * Video content embedded in HTML is not supported.
  * Links in PDF content are not supported.

For preview, content must include a new JavaScript library (see code below) to support automatic content scaling. If the library is not included, users can manually scale the content inside the preview window.

`<script type="text/javascript" src="//cdnmc10.vod309.com/multichannel/veeva/js/clm/clm-preview.js"> </script>`

### HTML File Name Field

HTML content in some Vaults uses an older packaging structure. In these packages, the main HTML page is not called _index.html_.

If your Vault uses this packaging structure, add the shared _HTML File Name_ field to the _Multichannel Slide_ document type. Users will need to populate the _HTML File Name_ field on slides in order for previews to work.

### Permissions for Preview & Email Options

The CLM Preview action only requires the _View Document_ lifecycle role permission. Users with the ability to preview can also use the email option inside the preview window to send content links to any email address.

Users who open the content link without an active session on the Vault cannot use the email option.