Element <artifact>

Purpose: Additional artifact emitted by an AMA generation run.

Why: Use it to request an additional AMA artifact handled by the configured packaging workflow.

Example

<artifact type="partner_extension" filename="partner___AmaUUID__.dat"/>

Decision guide

Business value: Adds partner-specific files without embedding packaging logic in a template.

• Use when

  • The delivery needs a sidecar, folder, object-storage destination, or registered extension artifact.

• Choose another approach when

  • The content is the primary EDI message or standard package itself.

• Prerequisites

  • Use an artifact type supported by the runtime or its registered extension handler.

• Alternatives

  • Use output for primary rendered messages. (See: <output>)
  • Use package to bundle selected outputs and artifacts. (See: <package>)

Complete examples

Render profiled EDIFACT output and package its artifacts

Use the AMA family when partner-specific EDIFACT separators, templates, output names, side artifacts, and archive packaging must be modeled together.

UNH+__message_id__+ORDERS:D:96A:UN'

<setup rngSeed="42">
    <ama-generate defaultEdifactProfileRef="unoc3" variablePrefix="__" variableSuffix="__">
        <edifactProfiles>
            <profile id="unoc3" decimal="." data="+" comp=":" release="?" term="'"/>
        </edifactProfiles>
        <templates>
            <template id="order_template"
                      path="templates/order.template.edi"
                      edifactProfileRef="unoc3"
                      sourceScripted="True"/>
        </templates>
        <variable name="message_id" generator="IncrementGenerator"/>
        <output type="ORDERS" templateRef="order_template" filename="ORDERS___message_id__"/>
        <artifact type="edi_outputs" folder="edi"/>
        <artifact type="edifact_trace_csv" filename="ORDERS___message_id___trace.csv"/>
        <package type="zip" filename="ORDERS___message_id__.zip"/>
    </ama-generate>
</setup>

Rules and invalid combinations

No additional element-specific rules. Required attributes, types, and supported values are shown below.

Allowed parents / Allowed children

Allowed parents: ama-generate, else, else-if, if, while

Allowed children:

None

Attributes

Show all 7 attributes

bucket

Object-storage bucket that receives the artifact.

optional; string; Default: null.

count

Optional number of artifact files to create.

optional; string; Default: null.

filename

Filename pattern for a file-based artifact.

optional; string; Default: null.

folder

Target folder pattern for a folder-based artifact.

optional; string; Default: null.

path

Project-relative source or target path for the artifact.

optional; string; Default: null.

storageId

Configured object-storage connection used for the artifact.

optional; string; Default: null.

type

Kind of artifact to create.

required; string.