render-vdp-hires

• Last updated on February 29, 2024
• •
• 3-4 minutes to read

This task renders a state file from the Design Editor based on its VDP (Variable Data Printing) data.

Note

The rendering is performed based on the settings specified in this task. The rendering settings configured in the editor will be ignored.

Parameters

• hiResOutputToSeparateFiles (boolean) - (optional) If true, renders pages of a multipage result into separate files. Possible values are true and false. The default value is false, and the multipage result is output to a single file.

• hiResOutputChannelContainersToSeparateFiles (boolean) - (optional) If true, renders channels of spot colors and textures into separate files. Possible values are true and false. The default value is false.

• hiResOutputChannelContainersRenderEmptyPage (boolean) - (optional) If true, adds empty pages for product pages without channels of spot colors and textures. Possible values are true and false. The default value is false.

• hiResOutputColorSpace (string) - (optional) The color space of the output file, one of Rgb, Grayscale, or Cmyk. The default value is Cmyk.

• hiResOutputCmykColorProfileName (string) - The name of the profile to be used if Cmyk color space is selected.

• hiResOutputGrayscaleColorProfileName (string) - The name of the profile to be used if Grayscale color space is selected.

• hiResOutputRgbColorProfileName (string) - The name of the profile to be used if Rgb color space is selected.

• hiResOutputBackgroundColor (string) - The background color in a CSS-compatible format.

• hiResOutputDpi (number) - (optional) The DPI value of the resulting file. The default value is 300.

• hiResOutputFileFormat (string) - (optional) The output file format, one of jpeg, png, tiff, or pdf. The default value is pdf.

• hiResOutputCompression (string) - The compression method for data inside the result file; it must match the output file format. For more details, refer to the Compression types.

• hiResOutputJpegCompressionQuality (number) - (optional) The compression level for the content inside the resulting file. This value only applies to the pdf, jpeg, and tiff formats. 100 corresponds to maximum quality and file size, 0 - minimum quality and file size. The default value is 90.

• hiResOutputFlipMode (string) - (optional) Flips the resulting image before saving. Possible values are None, Vertical, Horizontal, and Both. The default value is None.

• hiResOutputInStringPlaceholderHintsEnabled (boolean) - (optional) If true, displays hints for unfilled in-string placeholders. Possible values are true and false. The default value is false.

• hiResOutputPdfFormat (string) - (optional) The PDF format, either Default or X4. If X4, it enables DeviceCMYK and does not embed color profiles in the resulting PDF. By default, color profiles are embedded.

• hiResOutputPdfAuthor (string) - Metadata property "Author" for the PDF format.

• hiResOutputPdfCreator (string) - Metadata property "Creator" for the PDF format.

• hiResOutputPdfKeywords (string) - Metadata property "Keywords" for the PDF format.

• hiResOutputPdfSubject (string) - Metadata property "Subject" for the PDF format.

• hiResOutputPdfTitle (string) - Metadata property "Title" for the PDF format.

• hiResOutputPdfTextMode (string) - If Text, saves text elements as text. By default, this property is Outlines, and text is rendered as a set of vector paths.

• hiResOutputPdfKeepOriginalColors (boolean) - (optional) When True, the color profile is ignored, and the original colors of the images loaded into the design are preserved. Possible values: True or False. Default is False.

• hiResOutputArchiveType (string) - (optional) If specified, the rendering result will be packed into an archive. Possible values are Zip | SevenZip. By default, it is not specified.

• hiResOutputArchiveCompressionType (string) - (optional) Supported types are none | copy | default | deflate | deflate64 | lzma | lzma2. The default value is default.

• hiResOutputExplicitContainerVisibility (object) - (optional) Defines what containers must be hidden or shown during rendering. For example, you can hide the Background container and render the Main container as follows:

  "hiResOutputExplicitContainerVisibility": {
      "Background": false,
      "Main": true
  }
  

For other rendering properties, refer to the Hi-res print files topic.

Note

If a single artifact (result) is expected as the output, all generated print files will be packed into one archive.

If a collection of artifacts (result*) is expected as the output, each generated print file will be packed into a separate archive.

Example

{
    "description": "Prepare print file",
    "name": "vdp rendering",
    "type": "render-vdp-hires",
    "inputArtifacts": [
        "design"
    ],
    "parameters": {
        "hiResOutputDpi": 72,
        "hiResOutputFileFormat": "pdf",
        "hiResOutputColorSpace": "rgb",
        "hiResOutputRgbColorProfileName": "",
        "hiResOutputCmykColorProfileName": "",
        "hiResOutputGrayscaleColorProfileName": "",
        "hiResOutputToSeparateFiles": true,
        "hiResOutputChannelContainersToSeparateFiles": false,
        "hiResOutputChannelContainersRenderEmptyPage": true,
        "hiResOutputBackgroundColor": "White",
        "hiResOutputCompression": "Zip",
        "hiResOutputJpegCompressionQuality": 90,
        "hiResOutputFlipMode": "None",
        "hiResOutputPdfAuthor": "",
        "hiResOutputPdfCreator": "",
        "hiResOutputPdfKeywords": "",
        "hiResOutputPdfSubject": "",
        "hiResOutputPdfTitle": "",
        "hiResOutputInStringPlaceholderHintsEnabled": false,
        "hiResOutputArchiveType": "zip"
    },
    "outputArtifacts": [
        "result*"
    ]
}