This project has moved. For the latest updates, please go here.

Getting Started

Creating A Template

Starting a Template

To get started with the OMR template download TemplateDesigner from the downloads. Launching the template designer will allow you to create a new template.



To create a template you’ll need a source image. The image is used as a guide for designing your answer and barcode regions and should have four marker bubbles located where you’d like the OMR engine to look for answers.

  • The guidance circles should encompass the sum-total of your scan sheet and may or may not match the edges of the paper.
  • The guidance circles should be large (> 35 pixels wide or 1/4”)
  • Any bubble guiding circles (for example tick boxes or circles) where you expect marks to be detected should be light gray.

There are several sample images available in the Templates directory of the designer.

The template designer can also perform form validation and bulk scanning operations if the form is identified with a Code128 barcode starting with OMR:ID: on the form. You can also pass parameter to the output program by using additional data. The form below shows a form with ID “BURGERS” and a date encoded into such a barcode (as: OMR:ID:BURGERS:2015-03-04)



Now we have to get this image into the designer. There are two ways of doing this:

  1. Acquiring from Scan (Preferred) : In this method you print off one page of the form and re-scan it in using the tool. To do this click on “File > New Template From Scanner” and choose the scanner image_thumb[4]
  2. Saving as an Image: The other for template design is to acquire a 300 dpi JPG of the form. You can print to PDF from work and use a tool like PDF2JPG ( to do this. This method is only recommended if you don’t have access to a scanner as the printed image may not match the input image.

Once this is completed, the template scanner will construct a new template with the outlines detected.


To verify that the barcode is setup appropriately and that template will be successfully used

  1. Verify that the binging box is correctly found
  2. Verify that the Template ID in the properties grid is the value set in the Barcode


Adding Form Fields

Now that you have a form it is time to design the input fields. There are two types of input fields:

  • Barcodes: Which can be QR, Code39, Code128 or PDF417 barcodes that will appear as identifiers in the output
  • Bubbles: Which can be used to indicate a response.

To add bubble fields to the YES/NO options press the “Single Bubble” answer button from the palette and move the scan area to the bubble resizing so that the entire guide is covered.


Now set the properties of the bubble. Properties are as follows:


  • AnswerRowGroup – Indicates the group to which the answer belongs. The OMR engine can be used to group responses and this is how you do it. For example, if we wanted to have a HOTDOGS and BURGERS grouping of answers we’d group all questions related to “"BURGERS” in the “BURGERS” group
  • Behavior – Indicates the behavior of the bubble processing for questions
  • Id – A unique identifier for the response. Most of the time you can ignore this, except for barcode inputs where this is the only identifying piece of information
  • IsQuestionRequired – Indicates if the question needs to be answered
  • Question – A key which indicates the question to which the bubble belongs. This is different than AnswerRowGroup in that a Question will have multiple bubbles with the logic indicated by Behavior, whereas a group will contain multiple questions.
  • Value – The value of the question key if the bubble is shaded

We repeat this process for the NO option.


Now you can save the template.


Testing The Template

To test the template you can simply print off a form and scan it via the “Test –> From Scanner” (or, if you have a directory of already scanned JPG/BMP files “Test –> From Image”). Once complete, you’ll see that your scanned images appear in the “Test Input” window with a validation result and an exploration of the data scanned.


You can also adjust form fields and view the results as the scanning engine “Sees” them (indicated in green)



Last edited Apr 18, 2015 at 3:47 PM by fyfesoftware_oss, version 2