zopyx.surveyjs

Overview

zopyx.surveyjs integrates SurveyJS with Plone. It lets you design surveys/forms with the SurveyJS Creator, store submissions in Plone, and distribute or export results in multiple formats.

Key capabilities:

• SurveyJS Creator-backed form designer stored as JSON.
• Submission handling with configurable actions: store in Plone, email exports, or POST to an endpoint.
• Export formats for results (text, Markdown, HTML, PDF, CSV, XLSX, XML, DOCX, JSON).
• Optional validation on submission (experimental Python validator and/or external SurveyJS validator binary).
• Per-form payload size limits.

SurveyJS licensing: the Creator is not free for commercial usage. Refer to the SurveyJS license for details.

Installation

This package is intended for Buildout-based Plone projects.

Python version requirement: Python 3.12 or 3.13 is required. Python 3.14 is currently unsupported due to a Rust dependency that does not yet provide wheels for Python 3.14.

1. Add zopyx.surveyjs to your buildout eggs and run buildout.

   [buildout]
   eggs +=
       zopyx.surveyjs
   

2. Restart Plone and install the add-on in the Add-ons control panel.

3. Optional: server-side SurveyJS validation (external binary)

   • Build the Deno binary in data-validation/ and place it in data-validation/dist.
   • See data-validation/README.md for details.

Usage

1. Create a new Survey content item in Plone.
2. Use the SurveyJS Creator to design the form; the form definition is stored as JSON.
3. Configure actions and settings on the Survey (see configuration section below).
4. Submit the form and access results from the Survey item.
5. Export results using the configured formats or send them via email.

Survey Configuration (Per-Survey Fields)

All configuration is per Survey item.

Actions

Actions in depth

Actions are evaluated for every submission and can be combined.

• store: persists the submission (poll data plus metadata such as poll ID, timestamp, form version, and sequence number). Stored results power the results view and export endpoints. When store is disabled, submissions return success but are not persisted.
• mail: sends a result export email for every submission. Attachments are generated in the formats selected under Formats. Requires E-Mail recipient and Subject, and uses the Body template with {created}, {creator}, and {formats}.
• mail-notification: sends a notification-only email per submission with a link to the result detail view. Uses Subject for notifications and Body for notifications templates with {title}, {detail_url}, {poll_id}.
• post: performs an HTTP POST to the configured endpoint with a payload containing the poll data, the current form JSON, and the survey URL. Uses a 10-second timeout and logs failures.

Mail

Mail Notifications

Form Settings

Global Settings (Site Setup > Forms)

Storage Backends

Survey results can be stored in the ZODB (default) or in a relational database via SQLModel. Relational rows include the Plone site id (site.getId()) and the survey identifier to support multi-site deployments on the same DB.

To migrate existing ZODB results to a relational database, run a Zope/Plone console script and call:

from zopyx.surveyjs.storage_migration import migrate_zodb_results_to_rdbms

migrate_zodb_results_to_rdbms(context)

Views and Endpoints

The Survey type exposes UI views and service endpoints. View names are appended to the Survey URL (for example: /my-survey/@@viewer).

UI Views

Service Endpoints

External SurveyJS Validation (Optional)

When Force Server Side Validation is enabled, the submission handler invokes the compiled Deno validator from data-validation/dist:

• macOS: data-validation/dist/survey-validate-macos-deno
• Linux: data-validation/dist/survey-validate-linux-deno

See data-validation/README.md for build and usage details.

Author

Andreas Jung | info@zopyx.com | www.zopyx.com

Paid service for zopyx.surveyjs is available on request.

Contributors

• Andreas Jung, info@zopyx.com

Changelog

1.0a2 (unreleased)

• Nothing changed yet.

1.0a1 (unreleased)

• Initial release. [zopyx]