Create Fixed-Form Projects with RecoStar Design Studio

Revision 3 — March 16, 2020


Ephesoft Transact supports fixed-form extraction to capture handprint, constrained text, checkboxes, and signature detection. This page explains how to use RecoStar Design Studio to create a fixed-form project to be used in conjunction with an Ephesoft Transact batch class and document type. The following is a general outline:

  • Create the RecoStar Design Studio project.
  • Set up individual fields for extraction.
  • Create an Ephesoft Transact batch class and document type.
  • Integrate the RecoStar Design Studio project file into Ephesoft Transact.

Steps of Execution

  1. Navigate to the following folder: <Ephesoft Transact Installation Folder>\Application\native\RecostarPlugin\RecoStarDesignStudio
  2. Double-click RecoStarDesignStudio.exe to launch the RecoStar Design Studio application.

Figure 1. RecoStar Design Studio Application

  1. Click File > New Project.

Figure 2. Create New Project

  1. Select Single Form. Click Next.

Figure 3. Select Single Form

The following screen displays.

Figure 4. New Project File Name

  1. Enter a name for the project and click Browse to select a location where the project will be saved. The system will automatically build out the project directory based on the project name. For this tutorial, we’re using the IRS 2018 1040 schedule 1 tax form.

Figure 5. Creating New Project File

  1. Click Next. The Working Image Files screen displays.

Figure 6. Working Image Files

  1. Right-click the panel on the right to choose the Add Files command or click the Add Files button. Select a sample file of good quality that is populated with data.  Click Next.

Figure 7. Add Files

  1. On the next screen, verify that USA is selected as the country. Click Next.

Figure 8. Verify Country

  1. Verify the displayed information is correct.  Click Finish.

Figure 9. Verify Declarations

  1. The project will open inside the application with your sample file centered in the top panel.

Figure 10. Setup Image

  1. Right-click the form name and click Rename to rename the form.

Figure 11. Rename Form

  1. View the renamed form.

Figure 12. Renamed Form View

  1. Right-click IcrField and rename this operator “SSN”. This name MUST match the name of the corresponding index field in your Transact batch class where this extracted value will be displayed in Transact.

Figure 13. Rename IcrField

  1. Resize the dotted box on the preview so that it roughly surrounds the SSN field.

Figure 14. Focus SSN Field

  1. Press Ctrl + W or right-click the image and choose Fit Width to zoom in on the document.

Figure 15. Fit Document to Screen Width

  1. Now that you can see the details of the document more clearly, resize the dotted box so that it more closely surrounds the SSN value.

Figure 16. Fix Box to SSN Value

  1. Right-click BinaryImageSequence and select Add > Remove Line System.

Figure 17. BinaryImageSequence > Add > Remove Line System

  1. Confirm that BinaryImageSequence has been added.

Figure 18. View BinaryImageSequence

  1. Select File > Save Project to save your work.

Figure 19. Save Project

  1. Click Run Selected Image (►).

Figure 20. Run Selected Image

  1. Verify that the SSN value has been extracted correctly.

A screenshot of a cell phone Description automatically generated

Figure 21. Verify SSN Value

  1. Create a project in Transact and configure it to use this RecoStar Design Studio project file. Launch Ephesoft Transact and log in as a batch class administrator.

Figure 22. Launch Ephesoft Transact as Administrator

  1. Click Add to create a new batch class. The batch class name does not need to match the RecoStar Design Studio project.

Figure 23. Create New Batch Class

  1. Confirm that the new batch class has been created in the Batch Class Management screen.
  2. Select the new batch class and click Open to begin editing.

Figure 24. Open New Batch Class

  1. Click Doc Type and select Create New.

Figure 25. Create New Doc Type

  1. Select the Description field and edit the description of the new document type accordingly.

Figure 26. Edit Document Type Description

  1. Select the Minimum Confidence field and reduce the Minimum Confidence value to 8. Click Apply.

Figure 27. Reduce Minimum Confidence Value

  1. Select the new document type and click Upload Learn Files.

Figure 28. Upload Learn Files

  1. In the Open window, choose a blank template of the document and click Open. This will train Ephesoft Transact to recognize this document type.

Figure 29. Open Blank Template

  1. From the Document Types folder, navigate to <New Document Type> > Index Fields.

Figure 30. Index Fields of New Document Type

  1. Select Add to create a new index field. Name the index field SSN.  This name must match the name of the field you defined in the RecoStar project.  Click Apply.

Figure 31. Create SSN Index Field

  1. In the Additional Configuration column, click the down arrow ( ▼ ) to expand the drop-down list. Select the Force Review check box. This will force all batches to stop in the Validation module so we can verify the results of our extraction rules.

Note: In Ephesoft Transact 2020.1 and above, this check box is labeled Force Validation.

Figure 32. Select Force Review

  1. Click Apply to save your changes.

Figure 33. Save Changes

  1. Navigate to Modules > Extraction > RECOSTAR_EXTRACTION and set RecoStar Extraction Switch to ON. Click Apply to save your changes.

Figure 34. Enable RecoStar Extraction Switch

  1. Open File Explorer (previously Windows Explorer) and navigate to the location of your RecoStar project (Step 5). Copy (CTRL + C) the RecoStar (.rsp) file from that folder.

Figure 35. Copy the RecoStar Project File

  1. Navigate to the location of your batch class in Ephesoft Transact. Continue to fixed-form-extraction and open the folder for your new document type.

Figure 36. Navigate to Document Type

  1. Paste (CTRL + V) the .rsp file into the document type folder.

Figure 37. Add .rsp File

  1. In Ephesoft Transact, navigate to <New Document Type> > Index Fields > Fixed Form Extraction. This is where you can map specific pages of a document type to a RecoStar project file.

Figure 38. Navigate to Fixed Form Extraction

  1. Click Add. Set the Page Number field to “1”.  The File Name field should auto-populate because you only have a single .rsp file in that folder. Click Apply to save your changes.

Figure 39. Edit Fixed Form Extraction Fields

  1. Navigate to Operator > Upload Batch.

Figure 40. Operator > Upload Batch

  1. Click the Batch Class drop-down ( ▼ ). Select your new batch class from the provided list.

Figure 41. Select New Batch Class

  1. Under Upload Files, click Select Files. This opens the following screen. Choose a populated version of your document to be processed.

Figure 42. Upload Populated File

  1. The file will display in the Upload Batch screen.

Figure 43. File Displays

  1. Click Start Batch.

Figure 44. Start Batch

  1. Navigate to Batch Instance Management screen and wait for the batch to stop in Validation.

Figure 45. Match Instance Management

  1. When the batch stops in Validation, open it for editing. Note that in the provided example, the SSN value has been extracted correctly. The highlighting on the preview shows from where the value was extracted.

Figure 46. Validation Module

  1. Repeat the steps above to add new index fields in RecoStar Design Studio, along with matching index fields in Ephesoft Transact.

Note: Each time you make changes to the RecoStar project file, you must copy the .rsp file from the RecoStar project area into your batch class’s fixed-form folder (refer to Steps 35-37) for the changes to be recognized by Ephesoft Transact.