Image Upload with a Control File - Fluid Topics - 3.3 - Technical Notes

Manage Images in Fluid Topics

Product
Fluid Topics
FT_Version
3.3
Category
Technical Notes
audience
public

When uploading Unstructured Documents, you can give instructions to Fluid Topics through an XML file. This file named FluidTopicsControlFile.xml contains all processing instructions to upload your unstructured documents into Fluid Topics. In this file, you can give, for each image, the following information:
  • The filename of the image file to upload from the archive

  • Some additional information, e.g., a title, to display in Fluid Topics

Tip: When importing an image database, e.g., a set of electrical wiring diagrams, into Fluid Topics, uploading with a Control File can be a long-term time-saving solution even though the preparation might first seem long. It enables you to quickly change the title of your images without editing each file manually.

All the images to upload and the FluidTopicsControlFile.xml must be sent within a one and only ZIP archive.

Once published, it is possible to search these standalone images by their new title, if one was defined in the Control File. The new title, given in the ft:dispName element in the Control File, is automatically converted into an ft:publication facet value. This facet gathers all publication names on the portal. It is displayed for filtering for instance in the left panel of the Search Results page.
ft:displayName converted in Publications facet in the Search panel

To send the two images cat.jpeg and pufferfish.png with related information:

  • cat.jpeg
    • Title: "Little Cat in the Courtyard"
    • Description: "This cat is lying down in a courtyard."
  • pufferfish.png
    • Title: "Little Pufferfish in the Ocean"
    • Description: "This pufferfish is swimming in the ocean."
  1. Add the images to the FluidTopicsControlFile.xml control file.
    <?xml version="1.0" encoding="UTF-8"?>
    <ft:resources xmlns:ft="http://ref.fluidtopics.com/v2/ft#" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:schemaLocation="http://ref.fluidtopics.com/v2/udControlFile.xsd">
                             
       <ft:resource xml:lang="en-US" id="cat_image" status="visible">
          <ft:file>cat.jpeg</ft:file>
          <ft:dispName>Little Cat in the Courtyard</ft:dispName>
          <ft:description>This cat is lying down in a courtyard.</ft:description>
       </ft:resource>
       <ft:resource xml:lang="en-US" id="pufferfish_image" status="visible">
          <ft:file>pufferfish.png</ft:file>
          <ft:dispName>Little Pufferfish in the Ocean</ft:dispName>
          <ft:description>This pufferfish is swimming in the ocean.</ft:description>
       </ft:resource>
    </ft:resources>
  2. Prepare the ZIP archive. All files must be at the root level:
    images.zip/
      ├── FluidTopicsControlFile.xml
      ├── cat.jpeg
      └── pufferfish.png
  3. Publish the archive through the Unstructured Documents processing pipeline.

    These two images are displayed with their display name and their description in the Search Results page:
    Images displayed in the Search Results page

  4. Click on an image title to open it in the Document Viewer page.