Installation and Configuration

Published on February 23, 2026 Lightning PDF Generator



Lightning PDF Generator - Installation and Configuration Guide

What is Lightning PDF Generator?
A managed package that adds a configurable Lightning component to any record page so users can download a window, full page, component, or CSS-selected area as a PDF. It also lets users download email threads as PDF.

Part 1: Installation and Setup

1. Install the Managed Package

Use the installation URL provided, choose Install for All Users, and complete the installation.

Installation URL and package details

2. Verify the License is Active

Navigate to Setup and confirm the license status is active. Ensure all intended users have a license assigned.

License verification in Setup

3. Configure Custom Settings

Go to Setup > Custom Settings > PDF Elements > Manage and click New to create the Default Organization Level Value.

4. Set Required Custom Setting Values

Enter the following values, then click Save:

CL_normalViewElement: windowViewMode-normal
CL_consoleViewElement: windowViewMode-maximized
CL_flexipageComponentName: flexipage-component2

Custom settings configuration form

Completed custom settings values

Part 2: Add the Component to Lightning App Builder

5. Open Any Object Record Page

Navigate to the record where you want to add the PDF Generator and open Edit Page.

6. Find the Component in App Builder

Find the Lightning PDF Generator component in the App Builder sidebar under Custom Managed Components.

Lightning PDF Generator in Custom Managed Components section

7. Add the Component to the Page

Drag and drop the component to your desired location on the record page.

8. Configure Component Settings

Apply the design attributes described in Part 3 below.

9. Save and Activate

Click Save and activate or publish the page.

Part 3: Design Attributes and Configuration

The component includes the following configurable design attributes:

AttributeRequiredDefaultDescription
What you want to download?YesWindowOptions: Window, Full Page, Component, or CSS Selector.
Component Display IndexIf "Component" is selected-Which component on the page to download.
CSS SelectorIf "CSS Selector" is selected-CSS selector of the specific content to download.
File NameYespage.pdfName of the downloaded PDF file.
Label of ButtonNoGenerate PDFText shown on the PDF generation button.

Component Display Index example

Component Display Index configuration example

CSS Selector example

CSS Selector configuration example

Part 4: Email Thread as PDF Configuration

To enable downloading email threads as PDF, follow these steps:

1. Open Object Manager

Go to Setup > Object Manager > Email Message.

2. Create a New Action

  1. Click Buttons, Links and Actions > New Action.
  2. Name the action (e.g., "Download Email as PDF").
  3. Select Lightning Component as the action type.
  4. Choose CL_EmailMessageAsPDF from the available components.
  5. Click Save.

Creating a new Lightning Component action for email PDF download

3. Add the Button to the Page Layout

Add the new button to the relevant Email Message page layout and save the layout.

Adding the button to the Email Message page layout

4. Test the Functionality

Open an email message and verify the "Download Email as PDF" button appears and works.

Summary

You now have the Lightning PDF Generator installed and configured. Users can generate PDFs from any record page using the customizable component, and download email threads as PDF through the dedicated action button.

Knowledge Article Number: KA-00201

View more articles in the knowledge base