Skip to content

RealObjects/pdfreactor-brightspot

Repository files navigation

PDFreactor

PDFreactor Integration for Brightspot (Beta)

Print-grade PDF generation for Brightspot CMS, powered by integrating RealObjects PDFreactor. Editors preview their content as a paged PDF right in the CMS, generate and download PDFs on demand, and get them regenerated automatically on publish — with the typographic fidelity, CSS Paged Media support, and PDF/A / PDF/UA / PDF/X conformance PDFreactor is built for.

Features

  • Editor PDF preview — a preview-pane mode that renders the current draft as the finished, paged PDF, with refresh, share, and an optional schedule-date control (preview the content as of a future date).
  • On-demand generation — a right-rail widget with Show PDF, Download, and Convert again; generated PDFs are stored and cached, and served while content and configuration are unchanged.
  • Publish automation — publishing marked content generates its PDF in the background, with a three-level opt-in (developer marker, per-site admin toggle, per-document editor checkbox) and failure notifications.
  • Per-site configuration — global defaults with per-site overrides in Sites & Settings, layered with clear precedence and "currently in effect" hints, plus a raw-configuration JSON escape hatch for the full PDFreactor Configuration API.
  • ICC color management & conformance — reusable, validated ICC profile records, output intents, automatic color conversion, and PDF/A / PDF/UA / PDF/X conformance with optional validation.
  • Document metadata, features & viewer preferences — creator/ subject/keywords, bookmarks/links/accessibility tags, and PDF viewer presentation defaults, configurable down to the individual document.
  • Operations — a dashboard health widget with live status and license-state detection, publish-failure notifications, surfaced conversion logs, and admin-gated debug/inspectable troubleshooting builds.

Requirements

  • Brightspot CMS — developed and verified against brightspot-bom 5.0.2.4 (Java 11 target)
  • A PDFreactor 12.6 Web Service instance (e.g. the official realobjects/pdfreactor Docker image); without a license it runs in evaluation mode (watermarked output)
  • JDK 21 to build (the build targets Java 11 bytecode)

Getting started

Follow the quick start — about 15 minutes from zero to a PDF preview, including a docker run for PDFreactor, three ways to wire the plugin into your project, and the one required setting.

Documentation

You are… Start with
A Brightspot administrator configuring and operating the plugin Admin guide
A developer integrating the plugin into a project Quick start, then the integration guide
A template developer styling the print output Template guide

Shared by all three: the configuration reference (every setting, the precedence model), the PDFreactor concepts glossary, and the architecture overview.

Repository layout

  • plugin/ — the distributable plugin (com.realobjects.brightspot:pdfreactor-brightspot). This is what you consume.
  • core/ + web/ — a development harness and runnable example: a minimal Brightspot app with a sample article type wired to the plugin, used by the UI test suite and the quick start's "see it without your own project" path. Not part of the plugin artifact.

Build and test setup, the three test suites, and contribution conventions are described in CONTRIBUTING.md.

License

MIT — Copyright (c) RealObjects GmbH.

Trademarks & third-party attributions

This plugin integrates two third-party products that are not covered by the MIT grant above; they remain the property of their respective owners:

  • PDFreactor® is a product and registered trademark of RealObjects GmbH. The PDFreactor logo (plugin/src/main/resources/com/realobjects/brightspot/pdfreactor/web/pdfreactor-logo.svg) is RealObjects' artwork — Copyright (c) RealObjects GmbH, all rights reserved — and may not be used outside this plugin without RealObjects' permission.
  • Brightspot® is a CMS and trademark of Perfect Sense, Inc. (d.b.a. Brightspot). This is an independent, unaffiliated integration; it is not produced, endorsed, or supported by Perfect Sense, Inc. The Brightspot and Dari libraries it builds on (the com.psddev / com.brightspot artifacts) are licensed by their owner under their own terms.

All other trademarks are the property of their respective owners.

PDFreactor licenses & support

PDFreactor itself is a separate commercial product; licenses and trials are available from RealObjects, and product support via pdfreactor.com/support.

About

No description, website, or topics provided.

Resources

License

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors