combine-with-cut-pattern

• Last updated on December 29, 2023
• •
• 1 minute to read

This task applies a mask with cutting lines to the print file. If the file consists of multiple pages, the specified cut pattern is applied to each page.

To apply a separate mask to each page, split the print file into single pages and add a separate combine-with-cut-pattern task to the processing pipeline for each page.

Parameters

• inputArtifacts (array of strings) - The rendering results in the PDF format.
• cutPatternId (string) - The ID of a PSD file with cut lines stored in the Assets > Images section.
• cutPatternName (string) - The name of a PSD file with cut lines stored in the Assets > Images section. This value is used if the cutPatternId parameter was not specified.
• cutPatternFolder (string) - The location of a PSD file with cut lines in the Assets > Images section. This value is used if the cutPatternId parameter was not specified.
• cutPatternCenterPointX (number) - Explicitly specifies the center of the mask along the X-axis in points.
• cutPatternCenterPointY (number) - Explicitly specifies the center of the mask along the Y-axis in points.

If the cut pattern file has the custom fields CenterPointX and CenterPointY, they will be used instead of the cutPatternCenterPointX and cutPatternCenterPointY parameters.

If the cutPatternCenterPointX and cutPatternCenterPointY values are not specified, and the cut pattern file does not have the custom fields CenterPointX and CenterPointY, the geometric center of the cut pattern will be used as the center.

Example

{
    "description": "Combine rendered design with cut pattern",
    "name": "combine-with-cut-pattern",
    "type": "combine-with-cut-pattern",
    "inputArtifacts": [
        "rendered-design"
    ],
    "parameters": {
        "cutPatternName": "Cut-pattern-1.pdf",
        "cutPatternFolder": "/"
    },
    "outputArtifacts": [
        "combined"
    ]
}

To apply a cut pattern to multiple pages, repeat this block for each page.