Skip to main content

PDF Watermarks

Open a print template and configure Watermark in template information. For a PDF canvas it appears below canvas orientation. For Word and Excel templates it appears below print format only when PDF is selected. Native DOCX/XLSX exports do not receive watermarks.

Choose Text to enter multiline text, or Image to upload an image. The image appears directly in its container, with its filename below. Choose no watermark to disable it. Save the template, then preview or print a permitted record to check the final PDF.

SettingMeaning and range
Font colorHex color, #RRGGBB or #RRGGBBAA; default #000000
Font size8–200; default 18
Font stylenone, normal, italic, oblique; default normal
Font weightnormal, lighter, bold, bolder, or integer 1–1000
Image width / height1–1000; defaults 160 × 80
Watermark width / heightRepeated watermark cell size, 20–1000; defaults 180 × 100
Angle−180° to 180°; default −22°
TransparencyHigher percentages are more transparent. The stored opacity is 0–1: 80% transparency means opacity: 0.2
Horizontal / vertical spacinggapX / gapY, 0–1000 px, default 100. Smaller gaps make the watermark denser

Preview overlays and exported PDFs use the saved configuration. Font appearance can depend on the fonts available to the exporter. Image watermarks use a tenant File Bag asset that the caller can access.

CLI definition​

Read the template with system.form.print-template.get, then use its revision:

sl system form print-template update --template-id "$TEMPLATE_ID" --expected-revision 2 --definition-file watermark.json --json

watermark.json contains a top-level watermark, which Runtime stores in settings.watermark:

{
"watermark": {
"type": "text",
"text": "Confidential\nInternal use",
"fontColor": "#505050",
"fontSize": 18,
"fontStyle": "normal",
"fontWeight": "bold",
"width": 180,
"height": 100,
"gapX": 80,
"gapY": 100,
"rotate": -22,
"opacity": 0.2
}
}

For an image, set type: "image", image: {"fileAssetId": "<uploaded-asset-uuid>", "fileName": "seal.png"}, imageWidth and imageHeight. Use {"watermark":{"type":null}} to disable. Supply the complete intended watermark configuration; omitted watermark fields take defaults. Omitting watermark entirely preserves the current configuration. Office source settings and canvas layout are preserved by a watermark-only update. A stale template revision is rejected.