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


Receiver 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.


Receiver Attribute's Property Keys

Receiver Property Keys define the position and styling 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.


Dynamic File and Directory Config Tabs

For the ImageTemplateReceiver, the File Config Tab is used to configure the naming configuration for generated output files. Users can add up to 10 configuration lines to the Dynamic File Name Configuration. Each configuration line can be one of the following: 

  • Constant Value - Enter a constant value to be included in the file name (e.g., Image, Output, Check)
  • Counter - Add a counter and set the starting value. The value will increase by 1 for each new file, starting from the entered value. 
  • Timestamp - Add a timestamp to the file. 
  • Reference - Reference an Attribute in the output file name. The generated data value for each record is included in the file name. 


An example is shown below. In this example, each output file name will appear like this: CheckSchultz1.jpg, CheckJones2.jpg.


The Directory Config Tab can be used to configure what event will trigger subdirectory creation and the naming configuration for generated subdirectories. A new subdirectory can be created based on a selected creation event: 

  • No Event - The Receiver's parameters will be used for subdirectory creation.
  • Random - The subdirectory will be created randomly based on a defined startRange and endRange value. 
  • Constant Value - A new subdirectory will be created for a specified number of files (e.g., 50, 100, 1,000).
  • Reference - References an Attribute that returns a True/False value to trigger the creation event. When "true", a subdirectory will be created. When "false", a subdirectory will not be created. 


Please note that the Dynamic Subdirectory Name Configuration options are the same as those provided in the File Config Tab.


In the example below, a subdirectory will be created randomly for 50 to 100 files. Each new subdirectory will have the following naming convention: CheckImages1, CheckImages2, CheckImages3, and so on.


Please take a look at this article for more information and examples: How to use Dynamic File and Directory Configuration for Receivers?


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 below. Click here to see the complete use case.


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. Click here to see the complete use case.