You are here:
Quip Document Component
With the Quip Document Lightning component you can work with fully functional documents and spreadsheets directly within Salesforce records. All of your favorite features are there—comments, @mentions, live apps, and more. It's all the collaboration that you need, right where you need it.
Required Editions
| Available in: Lightning Experience |
The Quip Document component is part of the original Aura Lightning Components programming model.
Quip Document Component Configuration Options
Use the Lightning App Builder to add the Quip Document component to a Salesforce Lightning page. You can choose whether to use the same or different documents for each record, or whether users can use templates to create documents. Depending on the chosen option, you also create one or two custom fields on the associated object to store the document or template URLs.
| Configuration Option in Lightning App Builder | Description | Required Custom Fields |
|---|---|---|
| Use the same document for every record | Admins can choose a single, pre-existing document that is embedded on every record associated with a given object. | None |
| Allow different documents for each record | Users can attach different documents to different records, or create and embed new documents from scratch or from the Quip Template Library. Admins can also programmatically attach pre-selected documents to different records on the same object. | One field to store the Quip Document URL |
| Use a template to create documents for each record | Admins specify a template from which users can create and embed new documents on a per-record basis. You can use any document as a template. You can use mail-merge syntax in the template to prefill documents with information from the record. | One field to store the Quip Document URL |
| Use different templates for different records | Admins can specify different templates for different records on the same object. This option requires admins to programmatically prepopulate the component field with different template URLs rather than manually choose a single template URL. | Two fields, one to store the Quip Document URL and the other to store the Quip Template URL |
Size Recommendations for Embedded Documents
For best performance, use the recommended sizes for the different document types embedded in Salesforce Lightning page layouts.
| Quip Document Type | Location | Size |
|---|---|---|
| Document | Main page section | 900 pixels |
| Document | Page sidebar | 600 pixels |
| Slide Deck | Main page section | 900 pixels |
| Chat Room | Main page section | 600 pixels |
| Chat Room | Page sidebar | 600 pixels |
Next Steps
- If necessary, create a custom field to hold the document or template URL.
- Optionally, create a template or mark a document as a template.
- Use Lightning App Builder to add the Quip Document component to a Lightning page.
- To make sure that your template is properly configured before you share it with your users, validate it, and address any errors.
- If necessary, create an Apex trigger on the custom field that stores the document or template.
Your users can now work with documents without leaving Salesforce.
- Create Custom Fields for the Document and Template URL
If you want to use different documents or templates for your Salesforce records, create a custom field. Quip stores the URL of the embedded document or template in the custom field of the Salesforce object. If each record uses the same document, you don’t need to create the fields. - Templates and Dynamic Fields
Templates save time copying and pasting, standardize your business practices, and help you get the most out of your Salesforce data. To auto-fill your embedded templates with data from a Salesforce record, you can use Salesforce Template Data Mentions or mail merge syntax. - Mail Merge Examples
Use templates to prepopulate documents with content that’s specific to the Salesforce record they’re embedded in. For example, you want to use a document to store an Account Plan for each account. When a user creates an Account Plan, you want it to include the same boilerplate content for every account. But you also want to include specific field values from the account, such as the account name and description. - Add the Quip Document Component to a Lightning Page
You can use the Lightning App Builder to add the Quip Document component to a Salesforce Lightning page. - Sample Apex Trigger to Specify Documents or Templates
Use an Apex trigger to programmatically specify a document or template in a custom URL field. You must add a field if you selected the Different templates for different records option when you added the Quip Document component to a Lightning page. - Use the Quip Document Component
After you add the Quip Document component to a Lightning page, your users can create and edit documents directly in Salesforce. If they prefer, users can also edit the document on your Quip site. Both options provide the same rich collaborative environment.
Did this article solve your issue?
Let us know so we can improve!
