Output

Output

The <output> element defines what files your design function will generate and how they’re named.

XML structure

<output
      trueview_file="final_design_trueview.png"        <!-- TrueView preview image -->      
      design_file="final_design.emb"                            <!-- Final embroidery design file (GenerateDesign only) -->
      design_version=""                                                 <!-- Optional design version string -->
      dpi="120"                                                              <!-- Optional TrueView image DPI -->
/>

Key attributes

Attribute
Description
trueview_file
Filename for the TrueView™ preview bitmap.
  1. Required for api/newDesignTrueview
  2. Required for api/newLetteringPreview
  3. Optional for api/newDesign
design_file
Filename for the final embroidery design.
  1. Required for api/newDesign.
  2. Ignored for api/newDesignTrueview and api/newLetteringPreview.
design_version
Version format for the EMB design file.
  1. Optional: if empty or missing, defaults to latest (e4.5).
  2. Must match supported Wilcom format strings (see below).
dpi
Image resolution (DPI) for the TrueView preview.
  1. Default: 96
  2. Max: 300
  3. If ≤ 0 → defaults to 96

Filename rules

  1. Allowed characters: 0-9, a-z, A-Z, -, _ and space.
  2. No Unicode or special symbols — if used, you’ll get an error.

Design versions

Optional. Specifies the version for the saved embroidery file. Use exact strings from the EmbroideryStudio Save As dialog:
Version string
Saves as
Wilcom All-in-One Designs 26.0 (Digital Edition) (*.EMB)
Latest Digital Edition
Wilcom All-in-One Designs e4.5 (*.EMB)
e4.5 format
Wilcom All-in-One Designs e4.2 (*.EMB)
e4.2 format
Wilcom All-in-One Designs e4.1 (*.EMB)
e4.1 format
Wilcom All-in-One Designs e4.0 (*.EMB)
e4.0 format
Wilcom All-in-One Designs e3.6 (*.EMB)
Hatch compatible
Wilcom All-in-One Designs e3.5 (*.EMB)
Hatch compatible
Wilcom All-in-One Designs e3 (*.EMB)
e3 format
Wilcom All-in-One Designs e2 (*.EMB)
e2 format

Remarks

  1. Backward saving to older versions is not supported beyond e2.
  2. If absent or empty, the latest version is used.
  3. Must match the file type specified in design_file.
  4. Valid only for Wilcom native formats — e.g. EMB.
  5. Not supported for machine formats — e.g. DST.

Example

<output
      trueview_file="TeamLogoPreview.png"
      design_file="TeamLogo.emb"
      design_version="Wilcom All-in-One Designs e4.5 (*.EMB)"
      dpi="150"
/>
  1. EWA design recipe
  2. EWA API methods overview
  3. EWA data packages overview

    • Related Articles

    • Remove artwork background

      This note explains how the Remove Artwork Background option works in the Design Image Concept web application. Developers often expect this setting to also affect TrueView outputs from EMB files, but it only applies to artwork input images. Key ...

    • Embroidery formats in API calls

      Most API calls in the EWA API return an embroidery file. This article explains the difference between file types and how to request or upload them. Native vs machine formats Native format (EMB): Wilcom’s own design format is EMB – e.g. ...

    • Print production worksheets

      WilcomWorkspace allows you to print production worksheets. This is the link between designer and embroidery machine operator. It contains a design preview as well as essential production information, including design size, color sequence and special ...

    • Supported file formats

      The Wilcom Embroidery Web API supports a wide range of embroidery-specific and artwork input/output formats to ensure compatibility with professional embroidery workflows and machine types. This format support enables seamless integration across ...

    • EWA API technical notes

      Wilcom’s Embroidery Web API is a cloud-hosted, RESTful interface that enables developers to integrate professional embroidery design and personalization features into websites, e-commerce platforms, or internal systems. The API supports rendering, ...