Publish scripts

Key point: Specify the actual instructions to execute for a publish action.

An administrator can define publish actions for groups, folders, and documents. The actual instructions that correspond to these actions are defined in publish scripts.

Publish scripts are essential components in PageSeeder that control how content gets published or exported from the system. They are also used to generate reports and specify how to process data to import into PageSeeder.

A publish script is a file that contains instructions for how PageSeeder should transform, process, or export your content. These instructions include common basic operations such as copying, deleting or moving files as well as more specialized operations to export, process or transform documents using the PageSeeder API or report the progress to UI.

PageSeeder includes several default publish actions in its default template.

Managing publish scripts

You can view and manage all your publish scripts from the publish scripts page, where you can do the following:

  • See which scripts are configured and which aren’t.
  • Create new scripts.
  • Edit existing scripts.
  • Validate your script configurations.

Each type of publish action is defined in specific configuration files within your project, making it possible to organize different publishing workflows for different needs.

For developers

Publish scripts use the Apache Ant framework to give you more flexibility in the type of tasks you want to write, and to let you write code outside PageSeeder.

When running with PageSeeder, the system creates a safe temporary workspace for your Ant script to run and includes multiple predefined Ant tasks for common operations such as exporting data, processing PSML, or using the API.

For more technical details, refer to the developer documentation. The following articles might be useful: