Using SharinPix to PDF Component in Salesforce Community
This component is only available in the Enterprise license plan of SharinPix. For more info, please contact [email protected]
The SharinPix To PDF component allows users to generate a PDF using preselected images from a SharinPix Album.
This is a great way for you to generate reports and send them as attachments in email. In addition, the PDF generated will be saved on the record as Content Document.
This article demonstrates how to use this component in Salesforce Communities.
Getting Started
Note:
In order to use this component, you should ensure:
- That Image Sync is enabled for the SharinPix Album component. To do so, check the Enable Image Sync checkbox in the SharinPix Album's parameters. This step is required to enable the creation of SharinPix Image Objects upon image uploads.
You can click here for more information about how to set up the SharinPix Image Sync.
- Enabled the usage of SharinPix in Salesforce Community
You can click here for more information on how to enable the usage of SharinPix in Communities.
To use the SharinPix To PDF component, you simply need to drag and drop the component from the Components section onto your community page layout.
Lightning Component Parameters
Note:
- All Salesforce fields used as parameters in the SharinPix to PDF component are available on the SharinPix Image object.
- All custom fields used on the component should be added to the SharinPix Image object.
- Generate PDF Button Label: Used to set the custom button's label. The default value is Generate PDF.
-
Image URL field: The the API name of the Image URL field to be used for the type of image. Image sizes will depend on the field chosen. The default value is sharinpix__ImageURLFull__c
- Some values already included in the SharinPix Package are:
- sharinpix__ImageURLFull__c
- sharinpix__ImageURLOriginal__c
- sharinpix__ImageURLThumbnail__c
- sharinpix__ImageURLMini__c
- Some values already included in the SharinPix Package are:
- Image Caption Text: The API name of the field storing the text to be displayed alongside the image. The default value is None.
- Number Of Columns: The the maximum number of images to be displayed per row.
- First Page Content: This API name of the rich-text field to be used as first page content. The default value is None.
- Last Page Content: This API name of the rich-text field to be used as last page content. The default value is None.
- Images' Pre-description: The API name of the rich-text field to be used for the pre-description of images.The default value is None.
- Images' Post-description: The API name of the rich-text field will be used for the post-description of images. The default value is None.
- Page Orientation: Orientation of the generated PDF. The default value is portrait.
- Single Image Per Page: Used to display only one image per page.
- Footer format: A html format to display in the footer section of each page. Merge field such as {pagenumber} and {pagecount} can be used to include page number and total pages of the PDF.
Demo
To generated the PDF, select some images from the SharinPix Album and click on Generate PDF button as shown below:
The PDF generated can be found under the Notes & Attachments section in the Related tab:
Below is an instance of the PDF generated:
Tip:
For best results, use the SharinPix Transformations to have custom image size.
More information on transformation can be found here: SharinPix Transformation - get your images automatically resized!
Below are some references for optimal image transformations for you to have a visually appealing PDF:
| Layout | Columns | Transformation type | Value |
|---|---|---|---|
| Portrait 4 images per page | 2 | Pad to size | 1000x1500 |
| Portrait 6 images per page |
2 | Pad to size |
1000x1000 |
| Portrait 8 images per page |
2 | Pad to size |
1000x650 |
| Portrait 10 images per page |
2 | Pad to size |
1000x580 |
| Landscape 3 images per page | 1 | Pad to size | 1000x1500 |
The SharinPix to PDF component is also available in Salesforce Lightning. For more information about how to use this component in Lightning, refer to the following article:
0 Comments
Add your comment