Experience - Pdf - Create

Type identifier: experience:pdf:create Category: Flow Operations

Description

Renders a published Experience with the app target in headless Chromium using print media mode, then creates and uploads a PDF file. The node emits the created PDF as a file handle for downstream nodes.

Input Handles

Input Handle Details

trigger

• Type: trigger
• Notes: Starts PDF generation when received.

Dynamic Datum Input Handles

• Type: generated from configured datum references

• Notes:

  • Handles are generated when datumInputs are configured.
  • Each handle id is the configured input value key.

Output Handles

Output Handle Details

file

• Type: file entry with Flow context

• Notes:

  • mimeTypeId is pdf

Configuration Options

* Required to run; a missing value takes the error path.

Behaviour

Execution Flow

1. Validates that experienceId resolves to a published Experience path.
2. Resolves configured datum inputs.

3. Establishes render authentication:

   • If the run context includes a user-backed Space identity for the Flow's Space (such as the built-in USER and ADMIN roles for a signed-in Ligantic user), the Experience is rendered via cloud as that user, so the Experience does not need to be publicly accessible.
   • Otherwise (no identity, an identity for a different Space, or an identity not backed by a user, such as a guest or magic-link session), the Space must have a guest authentication strategy, and the app endpoint Experience is rendered anonymously.
4. Renders the page in print media mode, waits for the page to load (waiting for network idle is best-effort), and produces the PDF.
5. Saves the PDF and emits the resulting file entry on file.
6. Emits success on completion or error on failure.

Authentication and Prerequisites

• One of the following must hold:

  • the run context carries a user-backed Space identity for the Flow's Space (for example, a Flow triggered by a signed-in Ligantic user with the built-in USER or ADMIN role) — rendered via cloud, or
  • the Space has a guest authentication strategy — rendered anonymously via the app endpoint.
• The rendering session is subject to normal Experience access control: the identity's role must grant access to the target Experience, otherwise the render returns not-found and the node fails. Built-in USER/ADMIN roles can access any Experience in the Space via cloud.

Header and Footer Blocks

When displayHeaderFooter is enabled, headerBlockId and footerBlockId select blocks from the experience that are rendered into Chromium header/footer templates. Template classes like pageNumber/totalPages/date/title are not injected automatically by this node.

Examples

Basic PDF Export

{
  "type": "experience:pdf:create",
  "data": {
    "label": "Experience - Pdf - Create",
    "experienceId": "exp_1234567890abcdef123456",
    "format": "A4",
    "orientation": "portrait",
    "printBackground": true,
    "timeoutSeconds": 30
  }
}

PDF Export With Margins and Footer

{
  "type": "experience:pdf:create",
  "data": {
    "label": "Invoice PDF",
    "experienceId": "exp_1234567890abcdef123456",
    "fileName": "invoice.pdf",
    "format": "Letter",
    "orientation": "portrait",
    "margin": {
      "top": "12mm",
      "right": "10mm",
      "bottom": "14mm",
      "left": "10mm"
    },
    "displayHeaderFooter": true,
    "footerBlockId": "footer-block-id",
    "timeoutSeconds": 45
  }
}