APIs Custom APIs

Podcast

Play an AI-generated podcast conversation about this lesson

Questions and Answers

What is the purpose of modifying a custom view template in the custom PDF implementation?

To create a button that triggers the PDF generation. (correct)

To add a new API endpoint for PDF retrieval.

To define the styling of the generated PDF.

To handle user authentication for PDF access.

Which method must be added to the TypeScript controller to facilitate the PDF generation?

getPdf() (correct)

createPdf()

fetchPdf()

generatePdf()

What is returned by the GetPdf() method in the custom API controller?

A stream of HTML content.

A PDF file stored in the server.

A JSON response with PDF metadata.

An HTTP response containing a PDF stream. (correct)

What is the purpose of the PdfGeneratorHelper.GeneratePdf() method?

To convert HTML into a PDF format. Signup and view all the answers

What information does the ContentDisposition header include in the response to the PDF request?

The name of the generated PDF file. Signup and view all the answers

What is the first step required for implementing a custom PDF?

Modify the custom view template. Signup and view all the answers

Which scenario is NOT a use case for generating custom PDFs?

Create a PDF for user credentials. Signup and view all the answers

What should the GetPdfHtml() method return?

The HTML representation of the PDF layout. Signup and view all the answers

What is the purpose of the method GetPdfHtml() in the provided code?

To generate a PDF HTML representation of the cart. Signup and view all the answers

In which format does the custom PDF view template need to be generated?

DotLiquid format Signup and view all the answers

Where should the custom PDF template be located in the project directory?

~/frontendresources/{themeSourceName}/{theme.Name}/pdfviews/CartPdfTemplate.cshtml Signup and view all the answers

What type of object is cartModelDynamic in the provided code?

Dynamic object Signup and view all the answers

Which repository method is called to obtain the current theme's details?

GetRepository() Signup and view all the answers

What does the variable themeSourceName represent in the method GetPdfHtml()?

The name of the theme source. Signup and view all the answers

What conditions are checked to determine if the logo should be included in the PDF template?

If Model.LogoImagePath is not null and not empty. Signup and view all the answers

What service is used to parse the template content in the GetPdfHtml() method?

EmailService Signup and view all the answers

Study Notes

Custom PDF Implementation

Optimizely Commerce Cloud platform provides a way to generate custom PDF documents.
Use Cases:
- Generating a PDF of the current items in the cart.
- Creating a PDF that shows the top ten most purchased products for a given category.
- Creating a PDF that shows a category’s marketing content.
To create a custom PDF, developers need to modify the following:
- Custom view template: Adds a line to trigger the PDF generation via a button or other action.
- Custom TypeScript controller: Includes the getPdf() method which calls the custom API controller.
- Custom API controller: A method that is called asynchronously, handles PDF generation and returns the output.
The getPdf() method in the TypeScript controller opens a new window to display the PDF.
The custom API controller includes a GetPdf() method that:
- Generates a PDF stream from rendered HTML using PdfGeneratorHelper.
- Returns the PDF stream as a response with the appropriate content type and file name.
GetPdfHtml() method returns the HTML content for the PDF view:
- It fetches the template from the appropriate path based on the theme.
- Parses the template with the cart model data.
- Returns the rendered HTML.
Custom PDF view template (e.g., CartPdfTemplate.cshtml):
- Needs to be in DotLiquid format and have the .cshtml extension.
- Located in the PdfViews folder within the theme directory.
- Uses DotLiquid syntax to render the PDF content.
The provided C# code samples demonstrate how to implement these components.

Studying That Suits You

Use AI to generate personalized quizzes and flashcards to suit your learning preferences.

Description

Explore how to implement custom PDF generation in the Optimizely Commerce Cloud platform. This quiz covers use cases, the modification of templates, and methods necessary for generating PDFs, including TypeScript and API integration. Test your knowledge on creating interactive and dynamic PDF documents based on e-commerce data.