Using the wildcard key map feature

The wildcard feature provides all required images from a location, and passes in the image name to be pulled dynamically through the data using EngageOne™ Interactive or a custom application.
Note: Key words are case sensitive. Make sure you do not modify key words or delete attributes while editing the key map XML file.

To use wildcard feature in a key map archive:

  1. Create the key map archive. See the instructions on Using the EngageOne™ Key Map Generator.
    Note that you do not need all images in the input directory when creating the key map archive, but you must have at least one.
  2. After creating the key map archive, open the archive and edit the key map XML file using an XML editor.
  3. Locate the first <KeyEntry> element, and note the values for the attributes highlighted in this example:

    <KeyEntry Key="Samaritn">

    <Image Width="354" Height="325" Resolution="72" >

    <EOImageDeviceInfo Device="DOC1InteractiveEditor" DeviceType="DOC1INTERACTIVEEDITOR" Resolution="72" ImageType="PNG" FileName="Samaritn.PNG" />

    <EOImageDeviceInfo Device="PDFNC" DeviceType="PDF" Resolution="72" ImageType="BMP" FileName="Samaritn.BMP" />

    </Image>

    </KeyEntry>

  4. Modify the first <KeyEntry> element:

    KeyEntry Wildcard="%"

    FileName="%.PNG"

    FileName="%.BMP"

  5. Add the ResourceName attribute to the <EOImageDeviceInfo> element for each device:

    ResourceName="%"

  6. Each device has an <EOImageDeviceInfo> element in the <Image> element. For each <EOImageDeviceInfo> element, the FileName and ResourceName attribute, as shown in steps 4ii, 4iii, and 5i.

    If you are targeting a PDF device and using JPEGs, you must also add the ColorSpace attribute to the PDF <EOImageDeviceInfo> element. Without this keyword in the key map file, the PDF will contain the incorrect value /ColorSpace /DeviceRGB in the PDF output file. Value 2 indicates DeviceRGB, and 3 indicates DeviceGray. For example, <EOImageDeviceInfo Device="Default PDF" DeviceType="PDF" ColorSpace="2" Embed="true" Disposal="Retain" ImageType="JPEG" ResourceName="%" FileName="%.JPG" PDFPixelWidth="364" PDFPixelHeight="480" />

  7. Search for all remaining <KeyEntry> elements, and delete them.

    The resulting key map XML file should be similar to this example:

    <KeyEntry Wildcard="%">

    <Image Width="354" Height="325" Resolution="72" >

    <EOImageDeviceInfo Device="DOC1InteractiveEditor" DeviceType="DOC1INTERACTIVEEDITOR" Resolution="72" ImageType="PNG" FileName="%.PNG" ResourceName="%"/>

    <EOImageDeviceInfo Device="PDFNC" DeviceType="PDF" ColorSpace="2" Resolution="72" ImageType="BMP" FileName="%.BMP" ResourceName="%"/>

    </Image>

    </KeyEntry>

  8. Save the key map XML file.
  9. Update the key map archive with the modified key map XML file.
  10. Import the key map archive in EngageOne™ Administration. For more information, see Using key maps.