Skip to content

Element <package>

Purpose: Package definition for generated AMA artifacts.

Why: Use it to package generated AMA artifacts into the built-in ZIP delivery format.

Example

1
<package type="zip" filename="iAUV0___AmaUUID__.zip"/>

Decision guide

Business value: Produces one distributable delivery artifact with explicit content selection.

  • Use when

    • Generated AMA outputs must be delivered together as a ZIP.

  • Choose another approach when

    • Only individual EDI files or sidecars are required.

  • Prerequisites

    • Choose the supported zip type and a deterministic filename pattern.

  • Alternatives

    • Use artifact for one additional unbundled file. (See: <artifact>)

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.

ama-edifact-package/templates/order.template.edi
1
UNH+__message_id__+ORDERS:D:96A:UN'
ama-edifact-package/datamimic.xml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
<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 6 attributes

bucket

Optional object-storage bucket for the generated package.

optional; string; Default: null.

filename

Filename pattern for the generated package.

required; string.

includes

Comma-separated artifact kinds to include in the package.

optional; string; Default: null; Values: edi, edi_outputs, tiff_from_edi, tiff_auto.

tiffCount

Optional number of TIFF files to include in the package.

optional; string; Default: null.

tiffFolder

Optional folder pattern for TIFF files included in the package.

optional; string; Default: null.

type

Format of the generated package.

required; string; Values: zip.