---
title: "render-vdp-hires | Customer's Canvas Hub"
canonical: "https://customerscanvas.com/docs/hub/printer-guide/pipelines/tasks/render-vdp-hires/"
---

# render-vdp-hires

> Learn how the render-vdp-hires task renders designs using variable data printing data.

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

### General

- **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): 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`. The default value is `False`.
- **hiResOutputArchiveType** (string): If specified, the rendering result will be packed into an archive. Possible values are `Zip` | `SevenZip`. By default, it is not specified.
- **hiResOutputArchiveCompressionType** (string): Supported types are `none`, `copy`, `default`, `deflate`, `deflate64`, `lzma`, and `lzma2`. The default value is `default`.

### Rendering Parameters

- **hiResOutputDpi** (number): The DPI value of the resulting file. The default value is `300`.
- **hiResOutputFileFormat** (string): The output file format, one of `jpeg`, `bmp`, `png`, `tiff`, or `pdf`. The default value is `pdf`.
- **hiResOutputColorSpace** (string): The color space of the output file, one of `Rgb`, `Grayscale`, or `Cmyk`. The default value is `Cmyk`.
- **hiResOutputBackgroundColor** (string): The background color in a CSS-compatible format.
- **hiResOutputCompression** (string): The compression method for data inside the resulting file; it must match the output file format. For PDF files, the supported methods are `jpeg` and `zip`. For TIFF files, the supported method is `lzw`.
- **hiResOutputJpegCompressionQuality** (number): 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` is minimum quality and file size. The default value is `90`.
- **hiResOutputFlipMode** (string): Flips the resulting image before saving. Possible values are `None`, `Vertical`, `Horizontal`, and `Both`. The default value is `None`.
- **hiResOutputInStringPlaceholderHintsEnabled** (boolean): If `true`, displays hints for unfilled in-string placeholders. Possible values are `true` and `false`. The default value is `false`.
- **hiResOutputPdfFormat** (string): 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.

### Color Profiles

- **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.

### Multipage Products

- **hiResOutputToSeparateFiles** (boolean): 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.

### Channel Containers

- **hiResOutputChannelContainersToSeparateFiles** (boolean): 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): 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 `true`.
- **hiResOutputExplicitContainerVisibility** (object): 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:

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

### Setting up PDF Metadata

- **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.

## Input Artifacts

- A design file containing a VDP (Variable Data Printing) dataset. **Note:** Only a single artifact can be provided as input. Collections are not supported (though the file itself can be single-page or multi-page).

## Output Artifacts

- A set of graphical files in the specified format. Output artifacts can be defined in the following ways:
    - As a list of individual artifacts (e.g., `["result1", "result2"]`). Any extra results are discarded.
    - As a collection of artifacts (e.g., `["result*"]`). **Note:** Only one collection can be specified in this task.

:::note
- If a single artifact (`result`) is expected as the archived output, all generated print files will be packed into one archive.
- If a collection of artifacts (`result*`) is expected as the archived output, each generated print file will be packed into a separate archive.
:::

## Example

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