Documentation Center

IBackgroundTaskHandler - SetThumbnail

Adds the latest version of an image to the Thumbnail metadata field at logical level. When you click Thumbnails in an image folder in the web client, the corresponding image content is displayed as thumbnails.

Input data

The input data XML identifies an image. If the image given in the input data is the latest version of the image that has the resolution given in the FRESOLUTION field, the Thumbnail field is set so the image can be rendered as a thumbnail.
ishobject
Input data root element.
  • Required: yes
ishobject @ishref
Logical identifier of the object.
  • Required: yes
ishobject @ishtype
Defines the object type. This background task handles only images; therefore, the expected object type is ISHIllustration.
  • Required: yes
ishfields
Object metadata fields container. The fields container can have one or more ishfield elements. .
  • Required: yes
ishfield
Object metadata field.
  • Required: yes
  • Required ishfield elements for this background task:
    • VERSION
    • DOC-LANGUAGE
    • FRESOLUTION
ishfield @name
Defines the name of the ishfield metadata element.
  • Required: yes
ishfield @level
Defines the level of the ishfield metadata element.
  • Required: yes
  • Allowed values:
    • logical
    • version
    • lng

Background task configuration

There are no configurable parameters.

Input data example

This XML example shows typical event input data for this background task:

<ishobject ishref="GUID-0B3EA307-72CC-4B25-B9E8-D6479068DD7A" ishtype="ISHIllustration">
  <ishfields>
    <ishfield name="VERSION" level="version">2</ishfield>
    <ishfield name="DOC-LANGUAGE" level="lng">en</ishfield>
    <ishfield name="FRESOLUTION" level="lng">Thumbnail</ishfield>
  </ishfields>
</ishobject>

Default background task configuration example

The following configuration gets and handles a THUMBNAILSUBMIT event from the background task queue:

<handler eventType="THUMBNAILSUBMIT">
  <scheduler executeSynchronously="false" />
  <authorization type="authenticationContext" />
  <execution timeout="01:00:00" recoveryGracePeriod="00:10:00" isolationLevel="None" useSingleThreadApartment="false" />
  <activator>
    <net name="SetThumbnail"/>
  </activator>
  <errorHandler maximumRetries="3">
    <actions>
      <add errorNumber="-140" action="Retry" delay="00:01:00" />
    </actions>
  </errorHandler>
</handler>