1. Overview
This guide explains how to add and configure custom PDF templates for PitStop reports within the Infigo web-to-print platform. Custom templates allow for tailored branding, including unique headers, icons, and other design elements. This guide outlines the steps to configure, test, and troubleshoot custom PDF templates linked to PitStop profiles.
For additional information and detailed tutorials, the Infigo Academy offers extensive resources on a wide variety of topics. Visit the Infigo Academy to search and browse our content.
2. Contents
- Overview
- Contents
- Key Points and Takeaways
- Key Settings
- Scenario-Based Guide
- Scenario 1: Adding a Custom PDF Template to a PitStop Report
- Scenario 2: Troubleshooting Display Issues with Custom PDF Templates
- FAQs
- Alternate Search Terms
3. Key Points and Takeaways
- Custom PDF templates enhance PitStop reports with branded headers and icons.
- The custom template file must be uploaded alongside a
.prefs
file that references it.
- File naming conventions, such as "CustomReport.pdf," are critical for proper recognition.
- Ensuring both files are in the same directory avoids path-related issues.
4. Key Settings
Custom Report Template
- Path: Admin > Configuration > Resources > PDF Profile Setup > Create New Profile OR Edit Profile Data > Custom Report Template section
- Explanation: This section allows uploading a custom PDF that includes branding elements like headers and icons. The
.prefs
file (uploaded to the PDF Reports Template section) must reference this PDF using the exact file name, typically "CustomReport.pdf".
Prefs File Upload
- Path: Admin > Configuration > Resources > PDF Profile Setup > Create New Profile OR Edit Profile Data > PDF Reports Template section
- Explanation: This option uploads the
.prefs
file, which determines the structure and appearance of the report using paths to the custom template file.
5. Scenario-Based Guide
Scenario 1: Adding a Custom PDF Template to a PitStop Report
Problem: You want to create a custom-branded PitStop report with unique headers and icons.
Solution:
- Navigate to Admin > Configuration > Resources > PDF Profile Setup in the Infigo software.
- Select Create New Profile or edit an existing profile.
- In the Custom Report Template section, upload your custom PDF file. This file should contain any branding, headers, or icons you intend to use.
- Upload the associated
.prefs
file into the PDF Reports Template section that references your custom PDF. Ensure it contains paths such as:
"PageTemplatePath" "CustomReport.pdf"
"IconTemplatesPath" “CustomReport.pdf”
- The Custom Report Template should be referenced as "CustomReport.pdf" inside the 'prefs' file.
- Save the profile and generate a test report to verify that the custom elements are displayed correctly.
Scenario 2: Troubleshooting Display Issues with Custom PDF Templates
Problem: The custom headers or icons do not appear in the generated PitStop report.
Solution:
- Verify that both the
.prefs
file and the custom PDF file are uploaded and named correctly. The PDF must be referred to as "CustomReport.pdf" in the .prefs
file.
- Check the
.prefs
file for correct paths. Paths should be relative rather than absolute unless specifically required.
- If the issue persists, consider updating the absolute path references within the
.prefs
file (e.g., replacing "CustomReport.pdf" with the full file path).
6. FAQs
Q: What file format should be used for the custom report template?
A: The custom report must be a PDF file and named "CustomReport.pdf" as referenced in the .prefs
file.
Q: Why isn't my custom header appearing?
A: Ensure the .prefs
file correctly references the custom PDF. Check for any typos in the file paths.
Q: Can I use absolute paths in the .prefs
file?
A: It's recommended to use relative paths. However, if relative paths do not work, you can replace references with absolute paths.
For additional information and detailed tutorials, the Infigo Academy offers extensive resources on a wide variety of topics. Visit the Infigo Academy to search and browse our content.