Design recipe

Design recipe

The <recipe> XML element is the root container for describing a complete embroidery design or preview. It describes the placement, decorations, and desired output settings.

XML structure

<recipe>                               <!-- Root element: design recipe -->
      <location ... />               <!-- Placement and positioning -->
      <decorations ... />         <!-- List of design decorations -->
      <output ... />                 <!-- Output options and format -->
</recipe>

Components

The <recipe> is the root element containing all the data required to generate or preview a new embroidery design. Its flexible format allows detailed control over placement, design components, and final output. It consists of three main parts:
ElementDescription
<location>Defines where the design is placed, positioned, or transformed on the hoop or workspace.
<decorations>Describes the actual embroidery elements — lettering, monograms, team names, ornaments, and any recoloring instructions.
<output>Specifies output options for the generated design or TrueView™ image. This includes format, file type, and additional rendering preferences.

Usage

A <recipe> XML is required as input for the following APIs:
  1. For more detail, see EWA Design Recipe.

    • Related Articles

    • Design Library is missing/not displayed in ES 2025

      ISSUE: The Design Library is missing or not displayed. In ES 2025, after clicking Design Library icon, all you can see are your design thumbnails. Solution: 1. Set your monitor/display resolution to 100% [recommended] 2. If after doing so, and the ...

    • How to resize an embroidery design

      To resize an embroidery design in WilcomWorkspace: Log into WilcomWorkspace. Browse to TrueSizer from the left-side menu 3. Open your embroidery design 4. In the right-side Edit panel, change the Width or Height of the design and press Enter the ...

    • Design status

      The design status setting allows you to define workflow stages used to track the progress of designs. Status values help teams manage design workflows, from initial request through approval and production. Design statuses are shared across the ...

    • View design information

      The Design Information pane displays detailed information about a selected design in the Library. From this pane you can review metadata, inspect technical design properties, view available colorways, and manage attachments associated with the ...

    • Update design information

      The update design information feature allows you to modify the metadata associated with a design in Wilcom Library. Keeping design information up to date ensures designs are easy to find, correctly categorized, and ready for production workflows. ...