configure-artifacts

• Last updated on August 26, 2025
• •
• 1 minute to read

This task defines parameters for an artifact or an artifact collection. It sets the same values for all specified artifacts as defined in the parameters.

Parameters

• name (string) – A new file name for the artifact or artifact collection. When processing a collection of artifacts, the artifact index in the collection is added to the name (resulting in "item name (1)", "item name (2)", etc.).
  • Supports argument interpolation. For example:
    • Composite name: {{project.orderNumber}}_{{project.id}}
    • Artifact filename: {{file}}
    • Static name: "brochure_pages"
• final (string) – If "true", the artifact will be marked as final. Accepts "true" or "false".
• anonymousAccess (string) – If "true", the artifact will support anonymous access. Accepts "true" or "false".

Note

The file extension is automatically determined based on the artifact's MIME type. If no new name is specified, the existing name is retained.

Examples

Composite naming

This example demonstrates how to use interpolation to create a composite name from project data, such as combining an order number and project ID.

{
    "description": "Rename artifacts using order number and project ID",
    "name": "rename-artifacts-composite",
    "type": "configure-artifacts",
    "inputArtifacts": [
        "design",
        "pages*"
    ],
    "parameters": {
        "name": "{{project.orderNumber}}_{{project.id}}",
        "final": "true",
        "anonymousAccess": "false"
    }
}

Using artifact filenames

This example shows how to reference the original filename of an artifact for consistency or logging purposes.

{
    "description": "Configure artifacts using their original filenames",
    "name": "configure-artifacts-filenames",
    "type": "configure-artifacts",
    "inputArtifacts": [
        "template",
        "images*"
    ],
    "parameters": {
        "name": "{{template}}_processed",
        "final": "false",
        "anonymousAccess": "true"
    }
}

Static naming

This example assigns a static name to a collection, such as "brochure_pages".

{
    "description": "Set a static name for a collection of artifacts",
    "name": "set-static-name",
    "type": "configure-artifacts",
    "inputArtifacts": [
        "brochure*"
    ],
    "parameters": {
        "name": "brochure_pages",
        "final": "true",
        "anonymousAccess": "false"
    }
}