WoodWing Connect - PDF Manager Introduction – Help Center

Overview

The WoodWing PDF Manager [ConnectAutomation] Server Plugin is an integration tool that provides a flexible, configuration-driven approach to creating Adobe InDesign Server automation jobs. Job parameters are expressed in a Workato recipe, allowing complex publishing workflows to be automated without modifying core script logic.

Adobe InDesign Server is the primary automation engine, rendering and exporting documents across multiple output formats including PDF, JPEG, PNG, and packaged InDesign layouts.

One key thing to note is that PDF Manager and its associated tools are for the WoodWing Cloud only.

Integrated Systems

WoodWing Studio Server — hosts the PDF Manager [ConnectAutomation] Server Plugin
WoodWing Connect (Workato) — orchestrates recipes and job parameters
Adobe InDesign Server — executes the generic IDS script and produces output
WoodWing Assets — receives and stores archived output files
Third-party systems — optional upload endpoints and external services

Integration Workflow

Studio Server publishes a webhook event.
Workato trigger recipe listens for the incoming webhook.
Workato recipe extracts, transforms, and loads data into InDesign Server job parameters.
Workato action creates an InDesign Server job operation.
The job is created, queued, and awaits processing in Studio Server.
Studio Server submits the job to InDesign Server for execution.
InDesign Server runs the job script and renders the document into the requested output format.
InDesign Server distributes the output across configured channels (local path, Assets, URL endpoint).
Job completion status is written back to Studio Server InDesign Jobs.

PDF Manager [ConnectAutomation] Server Plugin

The ConnectAutomation Server Plugin uses the CreateObjectOperations and InDesignServerJob connectors to create InDesign Server jobs. It depends on the secondary plugin IdsAutomation for the create object operations service.

When an InDesign Server job is triggered, the plugin:

Intercepts the InDesignServerJob connector's beforeCreateJob function.
Retrieves the last created object operation of type CONNECT_AUTOMATION.
Maps the following job parameter values from the operation: JobType, Ticket, JobScript, JobPriority, JobParams.
Studio Server creates the InDesign Server job based on the mapped parameters.

Generic IDS Script

The generic InDesign Server script (generic_ids_script.jsx) is an Adobe ExtendScript file built to automate InDesign Server workflow integration. It is designed to be reusable across most customer environments while providing well-defined placeholder functions for client-specific customisation.

The script reads its behaviour entirely from job parameters configured in the Workato recipe. The file is stored in the ConnectAutomation idscripts folder.

Standard Job Parameters

The following parameters control how the InDesign Server job runs. They are configured in the Workato recipe and passed directly to the generic IDS script.

Parameter	Description
`layout`	Layout document object ID to process.
`logToDevices`	Logging devices to enable. Options: `console`, `jobqueue`, `sclog`, `workspace`.
`Lock`	Whether to check out the layout document before processing.
`ScriptFile`	Filename of the InDesign Server script to execute.
`JobType`	Job type suffix shown in the InDesign Server Jobs admin page.
`JobPriority`	Job priority level. Range: 2 (High) to 5 (Very Low).
`TempExportPath`	Temporary folder path for the export process. Defaults to the system temp path.
`ErrorProperty`	Custom property field name used to log error messages.
`ProcessName`	Process name written to the error property. Default: PDF Manager InDesign layout process automation.
`SuccessStateId`	Status ID to assign when the job completes successfully.
`FailedStateId`	Status ID to assign when the job fails.
`WaitTime`	Number of seconds to wait before script execution begins.
`RetryFailedJob`	When enabled, retries a failed job up to 3 times.
`LogEnvironmentInfo`	Logs environment information including installed plugins and job parameters.
`CmsSettings`	Color management system settings configuration name.
`PdfExportParams`	PDF export parameters in JSON string format.
`JpegExportParams`	JPEG document export parameters in JSON string format.
`PngExportParams`	PNG document export parameters in JSON string format.
`PackageExportParams`	Package layout export parameters in JSON string format.
`ImageJpegExportParams`	Placed JPEG image export parameters in JSON string format.
`ImagePngExportParams`	Placed PNG image export parameters in JSON string format.
`XmlExportParams`	XML content export parameters in JSON string format.
`LayoutColorProfileParams`	Layout document color profile and policy parameters in JSON string format.
`ImageColorProfileParams`	Layout images color profile parameters in JSON string format.

Export Features

The generic IDS script supports seven primary export features. Each feature activates only when its corresponding job parameter is defined. If the parameter is absent or undefined, no export takes place for that feature.

Export PDF
Export JPEG
Export PNG
Package Layout
Export Placed Images — JPEG
Export Placed Images — PNG
Export XML Content

Export PDF

PDF export is controlled by the PdfExportParams job parameter, which accepts a JSON string grouping all PDF export preferences.

Filename Placeholders

Placeholder	Replaced with
`{{PAGESEQUENCE}}`	Sequential page number within the export run.
`{{PAGENUMBER}}`	Actual page number of the layout.
`{{FIRST_PAGENUMBER}}`	First page number of the layout.
`{{EDITIONID}}`	Numeric ID of the edition.
`{{EDITIONNAME}}`	Display name of the edition.

Page Range

Format	Result
`1-5`	Exports pages 1 through 5 (consecutive range).
`1,3,5`	Exports selected pages 1, 3, and 5.

Export Format

Value	Description
`PDF_TYPE`	Standard PDF export (default).
`INTERACTIVE_PDF`	Exports as an Interactive PDF.

Multi-Page PDF

Value	Description
`true`	Single PDF file containing all pages.
`false`	Separate single-page PDF files (one per page).

Preflight Options

Parameter	Description
`skipPreflight`	Set to `true` to skip preflight entirely.
`preflightProfileFile`	Path to an `.idpp` preflight profile. If omitted, checks for missing fonts and links only.
`preflightErrorExclusion`	Set to `true` to invoke the `runPreflightErrorExclusion` hook for selective error suppression.

PdfExportParams — Full Parameter Reference

Parameter	Description	Required / Default
`filename`	PDF filename. Supports placeholders.	Mandatory
`editions`	Export a separate PDF per edition.	Optional
`pageRange`	Page range or selection. E.g. `1-3` or `1,3,5`.	Optional
`exportPath`	Local export path on the InDesign Server machine.	Optional
`assetPath`	Target folder path in WoodWing Assets.	Optional
`assetProductionZonePath`	Production zone path; triggers an asset update if the file exists there.	Optional
`assetMetadata`	Asset metadata key-value pairs (JSON).	Optional
`assetDeleteOldVersions`	Delete all previous versions of the asset in Assets Server.	Optional — Default: `false`
`uploadApiName`	API name for Connect API Proxy token retrieval.	Optional
`uploadUrl`	Upload destination URL.	Optional
`uploadType`	Upload encoding: `binary` or `form`.	Optional — Default: `form`
`uploadPath`	Root path for the upload.	Optional
`exportFormat`	`PDF_TYPE` or `INTERACTIVE_PDF`.	Optional — Default: `PDF_TYPE`
`multiPagePdf`	`true` = single multi-page file; `false` = one file per page.	Optional — Default: `false`
`pdfPreset`	Named Adobe PDF preset.	Optional
`preflightProfileFile`	Path to `.idpp` preflight profile.	Optional
`skipPreflight`	Skip preflight checking.	Optional — Default: `false`
`preflightErrorExclusion`	Allow selective preflight error exclusion.	Optional — Default: `false`
`continueOnError`	Skip current error and continue to next export.	Optional — Default: `false`

Sample PdfExportParams

{
  "filename": "LayoutName_{{PAGESEQUENCE}}_{{PAGENUMBER}}",
  "editions": [
    { "id": "1", "name": "North" },
    { "id": "2", "name": "South" }
  ],
  "pageRange": "1-5",
  "exportPath": "C:/Publication/Issue/LayoutName/PDF",
  "assetPath": "/Publication/Issue/LayoutName/PDF",
  "assetProductionZonePath": "/Production",
  "assetMetadata": { "description": "Archive PDF from ConnectAutomation" },
  "assetDeleteOldVersions": "false",
  "uploadApiName": "Workato_PDF",
  "uploadUrl": "https://upload.test.com/pdf",
  "uploadType": "binary",
  "exportFormat": "PDF_TYPE",
  "multiPagePdf": "true",
  "pdfPreset": "[Press Quality]",
  "preflightProfileFile": "C:/PreflightProfile/NewsPrint.idpp",
  "skipPreflight": "false",
  "preflightErrorExclusion": "false",
  "continueOnError": "false"
}

Export JPEG

JPEG export is controlled by the JpegExportParams job parameter. The feature activates only when this parameter is defined.

Filename Placeholders

Placeholder	Replaced with
`{{FIRST_SPREAD_PAGENUMBER}}`	First page number of the current spread.
`{{LAST_SPREAD_PAGENUMBER}}`	Last page number of the current spread.
`{{EDITIONID}}`	Numeric edition ID.
`{{EDITIONNAME}}`	Edition display name.

JpegExportParams — Full Parameter Reference

Parameter	Description	Required / Default
`filename`	JPEG filename. Supports placeholders.	Optional
`editions`	Export a separate JPEG per edition.	Optional
`exportPath`	Local export path.	Optional
`assetPath`	Assets Server archive folder.	Optional
`assetMetadata`	Asset metadata key-value pairs (JSON).	Optional
`assetDeleteOldVersions`	Delete previous asset versions.	Optional — Default: `false`
`uploadApiName`	API name for Connect API Proxy token.	Optional
`uploadUrl`	Upload destination URL.	Optional
`uploadType`	Upload format: `binary` or `form`.	Optional — Default: `form`
`uploadPath`	Root path for the upload.	Optional
`jpegSuffix`	Suffix for each file: `^#` (incremental), `^P` (page number), `^S` (page size).	Optional
`pageString`	Pages to export. E.g. `SP003-SP004,P06,010-011`.	Optional
`exportResolution`	Export resolution in DPI.	Optional
`antiAlias`	Apply anti-aliasing to text and vectors.	Optional — Default: `false`
`embedColorProfile`	Embed the color profile in the exported file.	Optional — Default: `false`
`exportingSpread`	Export each spread as a single JPEG.	Optional — Default: `false`
`simulateOverprint`	Simulate overprinting of spot and process colors.	Optional — Default: `false`
`useDocumentBleeds`	Apply document bleed settings to the export.	Optional — Default: `false`
`exportingHiddenSpread`	Include hidden spreads.	Optional — Default: `false`
`jpegQuality`	Compression quality: `LOW`, `MEDIUM`, `HIGH`, `MAXIMUM`.	Optional — Default: `HIGH`
`jpegColorSpace`	Color space: `RGB`, `CMYK`, or `GRAY`.	Optional — Default: `RGB`
`jpegExportRange`	`EXPORT_ALL` or `EXPORT_RANGE`.	Optional — Default: `EXPORT_ALL`
`jpegRenderingStyle`	`BASELINE_ENCODING` or `PROGRESSIVE_ENCODING`.	Optional — Default: `BASELINE_ENCODING`
`continueOnError`	Skip current error and continue.	Optional — Default: `false`

Sample JpegExportParams

{
  "filename": "JpegDocumentName_{{FIRST_SPREAD_PAGENUMBER}}_{{LAST_SPREAD_PAGENUMBER}}",
  "editions": [
    { "id": "1", "name": "North" },
    { "id": "2", "name": "South" }
  ],
  "exportPath": "C:/Publication/Issue/LayoutName/JPEGDocument",
  "assetPath": "/Publication/Issue/LayoutName/JPEGDocument",
  "assetMetadata": { "description": "Archive JPEG document from ConnectAutomation" },
  "assetDeleteOldVersions": "false",
  "uploadApiName": "Workato_Image",
  "uploadUrl": "https://upload.test.com/jpegdocument",
  "uploadType": "binary",
  "jpegSuffix": "^#",
  "pageString": "SP003-SP004,P06,010-011",
  "exportResolution": "300",
  "antiAlias": "true",
  "embedColorProfile": "true",
  "exportingSpread": "false",
  "jpegQuality": "HIGH",
  "jpegColorSpace": "RGB",
  "jpegExportRange": "EXPORT_ALL",
  "jpegRenderingStyle": "BASELINE_ENCODING",
  "continueOnError": "false"
}

Export PNG

PNG export is controlled by the PngExportParams job parameter. The feature activates only when this parameter is defined.

Filename Placeholders

Placeholder	Replaced with
`{{FIRST_SPREAD_PAGENUMBER}}`	First page number of the current spread.
`{{LAST_SPREAD_PAGENUMBER}}`	Last page number of the current spread.
`{{EDITIONID}}`	Numeric edition ID.
`{{EDITIONNAME}}`	Edition display name.

PngExportParams — Full Parameter Reference

Parameter	Description	Required / Default
`filename`	PNG filename. Supports placeholders.	Optional
`editions`	Export a separate PNG per edition.	Optional
`exportPath`	Local export path.	Optional
`assetPath`	Assets Server archive folder.	Optional
`assetMetadata`	Asset metadata key-value pairs (JSON).	Optional
`assetDeleteOldVersions`	Delete previous asset versions.	Optional — Default: `false`
`uploadApiName`	API name for Connect API Proxy token.	Optional
`uploadUrl`	Upload destination URL.	Optional
`uploadType`	Upload format: `binary` or `form`.	Optional — Default: `form`
`uploadPath`	Root path for the upload.	Optional
`pngSuffix`	Suffix for each file: `^#` (incremental), `^P` (page number), `^S` (page size).	Optional
`pageString`	Pages to export. E.g. `SP003-SP004,P06,010-011`.	Optional
`exportResolution`	Export resolution in DPI.	Optional
`antiAlias`	Apply anti-aliasing to text and vectors.	Optional — Default: `false`
`exportingSpread`	Export each spread as a single PNG.	Optional — Default: `false`
`simulateOverprint`	Simulate overprinting of spot and process colors.	Optional — Default: `false`
`useDocumentBleeds`	Apply document bleed settings to the export.	Optional — Default: `false`
`exportingHiddenSpread`	Include hidden spreads.	Optional — Default: `false`
`transparentBackground`	Export with a transparent background.	Optional — Default: `false`
`pngQuality`	Compression quality: `LOW`, `MEDIUM`, `HIGH`, `MAXIMUM`.	Optional — Default: `HIGH`
`pngColorSpace`	Color space: `RGB`, `CMYK`, or `GRAY`.	Optional — Default: `RGB`
`pngExportRange`	`EXPORT_ALL` or `EXPORT_RANGE`.	Optional — Default: `EXPORT_ALL`
`continueOnError`	Skip current error and continue.	Optional — Default: `false`

Sample PngExportParams

{
  "filename": "PngDocumentName_{{FIRST_SPREAD_PAGENUMBER}}_{{LAST_SPREAD_PAGENUMBER}}",
  "editions": [
    { "id": "1", "name": "North" },
    { "id": "2", "name": "South" }
  ],
  "exportPath": "C:/Publication/Issue/LayoutName/PNGDocument",
  "assetPath": "/Publication/Issue/LayoutName/PNGDocument",
  "assetMetadata": { "description": "Archive PNG document from ConnectAutomation" },
  "assetDeleteOldVersions": "false",
  "uploadApiName": "Workato_Image",
  "uploadUrl": "https://upload.test.com/pngdocument",
  "uploadType": "binary",
  "pngSuffix": "_^P_^S",
  "pageString": "SP003-SP004,P06,010-011",
  "exportResolution": "300",
  "antiAlias": "true",
  "exportingSpread": "false",
  "transparentBackground": "false",
  "pngQuality": "HIGH",
  "pngColorSpace": "RGB",
  "pngExportRange": "EXPORT_ALL",
  "continueOnError": "false"
}

Package Layout

Package export is controlled by the PackageExportParams job parameter. The script packages the InDesign layout, optionally including fonts, linked graphics, and color profiles, then distributes the result to configured destinations. The feature activates only when PackageExportParams is defined.

Filename Placeholders

Placeholder	Replaced with
`{{FIRST_PAGENUMBER}}`	First page number of the layout.
`{{LAST_PAGENUMBER}}`	Last page number of the layout.

When zippedFolder is set to true, the InDesign package folder is compressed into a ZIP archive before being exported, archived, or uploaded.

PackageExportParams — Full Parameter Reference

Parameter	Description	Required / Default
`filename`	Package filename. Supports placeholders.	Optional
`editions`	Export a separate package per edition.	Optional
`exportPath`	Local export path.	Optional
`assetPath`	Assets Server archive folder.	Optional
`assetMetadata`	Asset metadata key-value pairs (JSON).	Optional
`assetDeleteOldVersions`	Delete previous asset versions.	Optional — Default: `false`
`uploadApiName`	API name for Connect API Proxy token.	Optional
`uploadUrl`	Upload destination URL.	Optional
`uploadPath`	Root path for the upload.	Optional
`uploadType`	Upload format: `binary` or `form`.	Optional — Default: `form`
`copyingFonts`	Copy fonts used in the document to the package folder.	Optional — Default: `false`
`copyingLinkedGraphics`	Copy linked graphics to the package folder.	Optional — Default: `false`
`copyingProfiles`	Copy color profiles to the package folder.	Optional — Default: `false`
`updatingGraphics`	Update graphics links to point to the package folder.	Optional — Default: `false`
`includingHiddenLayers`	Include fonts and links from hidden layers.	Optional — Default: `false`
`ignorePreflightErrors`	Ignore preflight errors and proceed with packaging.	Optional — Default: `false`
`creatingReport`	Generate a package report with print settings and asset details.	Optional — Default: `false`
`includeIdml`	Generate and include an IDML file in the package.	Optional — Default: `false`
`includePdf`	Generate and include a PDF file in the package.	Optional — Default: `false`
`zippedFolder`	Compress the package folder into a ZIP archive.	Optional — Default: `false`
`skipPreflight`	Skip preflight checking before packaging.	Optional — Default: `false`
`preflightErrorExclusion`	Allow selective preflight error exclusion.	Optional — Default: `false`
`preflightProfileFile`	Path to `.idpp` preflight profile.	Optional
`exportFormat`	`PDF_TYPE` or `INTERACTIVE_PDF` (applies to included PDF).	Optional — Default: `PDF_TYPE`
`multiPagePdf`	`true` = single multi-page PDF; `false` = one file per page.	Optional — Default: `false`
`continueOnError`	Skip current error and continue.	Optional — Default: `false`

Sample PackageExportParams

{
  "filename": "PackageName_{{FIRST_PAGENUMBER}}_{{LAST_PAGENUMBER}}",
  "editions": [
    { "id": "1", "name": "North" },
    { "id": "2", "name": "South" }
  ],
  "exportPath": "C:/Publication/Issue/LayoutName/Package",
  "assetPath": "/Publication/Issue/LayoutName/Package",
  "assetMetadata": { "description": "Archive package from ConnectAutomation" },
  "copyingFonts": "true",
  "copyingLinkedGraphics": "true",
  "includeIdml": "false",
  "includePdf": "false",
  "zippedFolder": "false",
  "skipPreflight": "false",
  "continueOnError": "false"
}

Export Placed Images — JPEG

This feature exports all placed images from the InDesign layout as JPEG files. It activates only when the ImageJpegExportParams job parameter is defined.

Supported source file types: Photoshop, TIFF, JPEG, HEIC/HEIF

Upload Headers

The following custom HTTP headers are included with each image upload to enable downstream integrations to identify the source asset:

Header	Description
`woodwing_connect_filename`	Image filename.
`woodwing_connect_operation_id`	Job operation ID.
`woodwing_connect_publication`	Publication name.
`woodwing_connect_issue`	Issue name.
`woodwing_connect_category`	Category name.
`woodwing_connect_layout_id`	Layout object ID.
`woodwing_connect_image_id`	Image object ID.
`woodwing_connect_frame_id`	Frame ID where the image is placed.
`woodwing_connect_page_number`	Page number where the image appears.
`woodwing_connect_page_sequence`	Page sequence where the image appears.

ImageJpegExportParams — Full Parameter Reference

Parameter	Description	Required / Default
`exportPath`	Local export path.	Optional
`assetPath`	Assets Server archive folder.	Optional
`assetMetadata`	Asset metadata key-value pairs (JSON).	Optional
`assetDeleteOldVersions`	Delete previous asset versions.	Optional — Default: `false`
`uploadApiName`	API name for Connect API Proxy token.	Optional
`uploadUrl`	Upload destination URL.	Optional
`uploadType`	Upload format: `binary` or `form`.	Optional — Default: `form`
`filenamePrefix`	Prefix added to each exported image filename.	Optional
`filenameSuffix`	Suffix added to each exported image filename.	Optional
`exportResolution`	Export resolution in DPI.	Optional — Default: `300`
`antiAlias`	Apply anti-aliasing to text and vectors.	Optional — Default: `false`
`embedColorProfile`	Embed the color profile in the exported file.	Optional — Default: `false`
`jpegColorSpace`	Color space: `RGB`, `CMYK`, or `GRAY`.	Optional — Default: `RGB`
`jpegQuality`	Compression quality: `LOW`, `MEDIUM`, `HIGH`, `MAXIMUM`.	Optional — Default: `HIGH`
`jpegRenderingStyle`	`BASELINE_ENCODING` or `PROGRESSIVE_ENCODING`.	Optional — Default: `BASELINE_ENCODING`
`continueOnError`	Skip current error and continue.	Optional — Default: `false`

Export Placed Images — PNG

This feature exports all placed images from the InDesign layout as PNG files. It activates only when the ImagePngExportParams job parameter is defined.

Supported source file types: EPS, PDF, PNG, SVG

The same upload headers described in the JPEG section above apply to PNG image uploads.

ImagePngExportParams — Full Parameter Reference

Parameter	Description	Required / Default
`exportPath`	Local export path.	Optional
`assetPath`	Assets Server archive folder.	Optional
`assetMetadata`	Asset metadata key-value pairs (JSON).	Optional
`assetDeleteOldVersions`	Delete previous asset versions.	Optional — Default: `false`
`uploadApiName`	API name for Connect API Proxy token.	Optional
`uploadUrl`	Upload destination URL.	Optional
`uploadType`	Upload format: `binary` or `form`.	Optional — Default: `form`
`filenamePrefix`	Prefix added to each exported image filename.	Optional
`filenameSuffix`	Suffix added to each exported image filename.	Optional
`exportResolution`	Export resolution in DPI.	Optional
`antiAlias`	Apply anti-aliasing to text and vectors.	Optional
`pngColorSpace`	Color space: `RGB`, `CMYK`, or `GRAY`.	Optional — Default: `RGB`
`pngQuality`	Compression quality: `LOW`, `MEDIUM`, `HIGH`, `MAXIMUM`.	Optional — Default: `HIGH`
`transparentBackground`	Export with a transparent background.	Optional — Default: `false`
`continueOnError`	Skip current error and continue.	Optional — Default: `false`

Export XML Content

XML export extracts the structured XML content from the InDesign layout. It activates only when the XmlExportParams job parameter is defined.

XmlExportParams — Full Parameter Reference

Parameter	Description	Required / Default
`exportPath`	Local export path.	Optional
`assetPath`	Assets Server archive folder.	Optional
`assetMetadata`	Asset metadata key-value pairs (JSON).	Optional
`assetDeleteOldVersions`	Delete previous asset versions.	Optional — Default: `false`
`uploadApiName`	API name for Connect API Proxy token.	Optional
`uploadUrl`	Upload destination URL.	Optional
`uploadType`	Upload format: `binary` or `form`.	Optional — Default: `form`
`exportFromSelected`	Export from the selected XML element only. `false` exports the entire document.	Optional — Default: `false`
`excludeDtd`	Exclude the DTD from the exported XML.	Optional — Default: `false`
`continueOnError`	Skip current error and continue.	Optional — Default: `false`

Sample XmlExportParams

{
  "exportPath": "C:/Publication/Issue/LayoutName/XML",
  "assetPath": "/Publication/Issue/LayoutName/XML",
  "assetMetadata": { "description": "Archive XML from ConnectAutomation" },
  "uploadApiName": "Workato_XML",
  "uploadUrl": "https://upload.test.com/xml",
  "uploadType": "binary",
  "exportFromSelected": "true",
  "excludeDtd": "true",
  "continueOnError": "false"
}

Logging

Enabling Logging

Logging is controlled by the logToDevices standard job parameter. The script logs only when at least one device is specified. Clearing the value disables logging without requiring a Studio Server restart.

Value	Description
`console`	Logs to the InDesign Server console output.
`jobqueue`	Logs to the job queue log.
`sclog`	Logs to the server connector log.
`workspace`	Logs to the InDesign Server workspace.

Log File Path

The LogFilePath job parameter specifies a custom file path for the log file. If omitted, the default system path is used.

Environment Information Logging

When LogEnvironmentInfo is set to true, the script logs the following, which is useful for diagnosing configuration issues:

System information about InDesign Server and its installed plugins.
Configured log file path.
All job parameter key-value pairs passed to the script.
All PDF Export Preset paths and names available in InDesign Server.
All Color Management System (CMS) settings configurations.

Customisation

The generic IDS script provides three extension points for client- and partner-specific logic. Customisation code added to these areas does not break standard script behaviour and remains compatible with future WoodWing updates.

runBefore Hooks

These functions are called before each core feature executes. Use them for pre-export validation, metadata lookups, filename overrides, or layout checks.

Function	Called before
`generatePdf_runBefore`	PDF generation begins.
`exportPdfsToFolder_runBefore`	PDFs are exported to a local folder.
`archivePdfsToAssets_runBefore`	PDFs are archived to WoodWing Assets.
`uploadPdfsToWorkato_runBefore`	PDFs are uploaded to a URL endpoint.
`packageForPrint_runBefore`	The layout is packaged.
`exportImages_runBefore`	Image export begins.
`exportImageToJpeg_runBefore`	Each individual JPEG image export.
`exportImageToPng_runBefore`	Each individual PNG image export.
`exportXml_runBefore`	XML export begins.

runAfter Hooks

These functions are called after each core feature completes. Use them to post-process output, trigger downstream notifications, or validate results.

Function	Called after
`generatePdf_runAfter`	PDF generation completes.
`exportPdfsToFolder_runAfter`	PDFs are exported to a local folder.
`archivePdfsToAssets_runAfter`	PDFs are archived to WoodWing Assets.
`uploadPdfsToWorkato_runAfter`	PDFs are uploaded to a URL endpoint.
`packageForPrint_runAfter`	The layout is packaged.
`exportImages_runAfter`	Image export completes.
`exportImageToJpeg_runAfter`	Each individual JPEG image export.
`exportImageToPng_runAfter`	Each individual PNG image export.
`exportXml_runAfter`	XML export completes.

customScriptActions

The customScriptActions placeholder function is invoked during script execution and can be overridden to replace or supplement standard WoodWing export behaviour with entirely custom logic.

Adding Custom Script Parameters

Use the getExtraParamKeys function to register additional job parameters. Add the key name (capitalised first letter) to the extraParamKeys array, then configure a matching parameter in the InDesign Server job.

// Register custom keys in getExtraParamKeys
const extraParamKeys = [
  "LogFilePath",
  "Name",
  "Issue",
  "Category",
  "NewScriptParam"   // custom key
];

// Access the value in the script
const newScriptParamValue = operationObj.pNewScriptParam;

Expected Behaviour — When No Job Is Created

Under certain configurations, an InDesign Server automation job is intentionally not created. This is expected behaviour, not an error.

Status Configured to Skip Automation

In the Workflow Maintenance page, if a layout status has the option Skip InDesign Server Automation enabled, no IDS job will be created when the layout moves into that status.

Planned Pages Processing Disabled

When the IDSA_PLANNED_PAGES_PROCESSING constant is set to false in the server configuration, InDesign Server jobs are not created for pages generated by a third-party planning tool.

define('IDSA_PLANNED_PAGES_PROCESSING', false);