Installation

Installing processor dependencies

If you want to use Gotenberg as processor, you need to install additional dependencies. For more information about installation, see Document Types and Available PDF Processors

Installation Process

After installing the bundle and the required dependencies of the processor you wish to use, configure the settings under Experience & E-commerce > Web-to-Print Settings in the Pimcore Studio main menu.

If the Save button on bottom right is disabled, your config location configuration does not allow changing the config in Pimcore Studio. Change this by editing <Pimcore root>/config/config.yaml:

pimcore_web_to_print:
    config_location:
        web_to_print:
            write_target:
                type: 'settings-store'

The settings form documents the options available for the processor you selected.

Permissions

The installer registers the web2print_settings permission under the category Pimcore Web2Print Bundle. Assign it in Pimcore Studio under user and role management.

Permission	Effect
web2print_settings	Grants access to the Web-to-Print settings. Without it, the settings entry is hidden from the Studio main menu and the settings endpoints are rejected.
documents (Pimcore core)	Required to generate, cancel, download and stream PDFs from a print document.

Generating a PDF therefore needs the standard documents permission, not web2print_settings.

Uninstallation

Uninstalling the bundle removes the permission and the print document types. It does not clean up printpages or printcontainers. Before uninstalling, remove or archive all dependent documents.

To clean up the database afterwards, run the command below. Create a backup first, all data of these document types will be lost.

bin/console pimcore:documents:cleanup printpage printcontainer