Description

The ImageTemplateReceiver augments an original image with the Attribute values configured by the user. The image can be a GIF, JPEG, or PNG. 


In This Article


Parameters

The following parameters can be defined for the ImgeTemplateReceiver. Items with an asterisk (*) are required: 

  • contentType* - Defines the content type of the image (PNG, JPEG, GIF).
  • path* - Defines the path to save the image file to. 
  • subDir - Defines the subdirectory name under the output path. 
  • filesPerDirectory* - Defines the number of files to be generated per output subdirectory. 
  • fileNamePrefix - Defines what the file name should start with. The suffix is defined by the fileIndex Property Key. If no prefix is defined, then "image" will be used. 
  • templatePath* - Defines the path to locate the image template file. 
  • templateSubDir - Defines the subdirectory name under the image template directory. 
  • templateName*- Defines the name of the image template file. 
  • threadCount* - Defines the number of image files that may be processed simultaneously.
  • rotateImage - Defines a reference to an image or a constant value whose value will be used to rotate the image when the value is greater than 0 or less than 0.


Attribute's Receiver Property Keys

Receiver Property Keys are used to determine the position and styling information of Domain Attributes on the generated image. 

  • xCoordinate - Indicates x-coordinate of the Attribute position in the image. 
  • yCoordinate - Indicates y-coordinate of the Attribute position in the image. 
  • width - Indicates the width of the Attribute position in the image. 
  • height - Indicates the height of the Attribute position in the image. 
  • background - Indicates the background styling of the Attribute position in the image (Color or Transparent). 
  • fontFamily - Indicates the font family of the Attribute's value in the image. 
  • fontSize - Numeric value, which indicates the font size (in pixels) of the Attribute's value in the image. 
  • fontColor - Indicates the font color of the Attribute's value in the image. 
  • fontType - Indicates the font type of the Attribute's value in the image (Normal, Bold, or Italic).
  • dataType - The type of data generated by the Attribute. Possible values are Blob and Text. 
  • grBackground - Specifies an Attribute whose Generator will modify the background.
  • grFontColor - Specifies an Attribute whose Generator will modify the fontColor.
  • grFontFamily - Specifies an Attribute whose Generator will modify the fontFamily.
  • grFontSize - Specifies an Attribute whose Generator will modify the fontSize.
  • grFontType - Specifies an Attribute whose Generator will modify the fontType.
  • grHeight - Specifies an Attribute whose Generator will modify the height.
  • grWidth - Specifies an Attribute whose Generator will modify the width.
  • grXCoordinate - Specifies an Attribute whose Generator will modify the xCoordinate.
  • grYCoordinate - Specifies an Attribute whose Generator will modify the yCoordinate.


ImageTemplateReceiver Management Dashboard

The ImageTemplateReceiver Management Dashboard is used to configure the details for the augmented image. Each Domain can be added to the image. The data generated by the Receiver will appear in that location.



Icon

Description

The Return to Receiver button can be used to return to the Receiver configuration within the Receiver Dashboard.
The Upload Image button can be used to upload the image that will be augmented. 
The Download Metadata button can be used to download the image's metadata to the user's local machine.
The Save icon can be used to save changes for each Attribute used to augment the image. 
The Remove icon can be used to remove an Attribute from the Attribute Pane.
The Move icon can be used to change the order of Attributes within the Attribute Pane.


The ImageTemplateReceiver Management Dashboard can be used to select Attributes, add them to an uploaded image, and configure Attribute Receiver Property Keys. 


Use Case 1: Generate a Check Filled with Synthetic Data

This use case will show how to generate a filled check using the blank image shown below. To see the full use case, click here.


The generated check will appear similar to the image shown below. 


Use Case 2: Generate Checks with Different Colored Signatures

Use Case 2 will show how the gr Property Keys for the ImageTemplateReceiver can be used to dynamically generate different signature colors (red, blue, and black) when generating the filled check image. 


The use case builds on Use Case 1 above, and the results are shown below. To see the full use case, click here.