What is OCR?

Optical Character Recognition – or OCR, for short – is a technology that allows you to pull text in the form of digital data from a printed or hand-written source by simply scanning or snapping an image of this text. 

It’s purpose is to speed up data capture – which is why we have added this feature to Amplus Forms.

How it Works

It’s as easy as dragging the OCR field onto the app you are building, and hitting save. When a user opens the app, they can snap a photo and any visible text is extracted and saved as data.

 

Once submitted, the data is returned to the server for effortless data capture.


Watch an example of OCR in work.

https://drive.google.com/file/d/17RgsJ_zFoHjsAjemIJQsqzW14Uoj1ETo/view?usp=sharing


TABLE OF CONTENTS

  • Basic Properties
    1. Data Name
    2. Title Text
    3. Hint Text
    4. Result Mode
    5. On Capture Action

 

  • Layout & Styling
    1. Field Layout
    2. Background Color

 

  • Validation & Behavior
    1. Required
    2. Visibility
    3. Dynamic Value
    4. Read Only
    5. Custom Validation
    6. Validation Message

 

  • Advanced Options
    1. Default Value
    2. Bind to Global Value
    3. Exclude from Export/Display
    4. Is Personal Data
    5. Copy to Device Gallery
    6. Capture Only

 

Basic Properties

Data Name

This is the name of the field that should be referenced in any form logic or API calls. Users will not see this name on the form.

Data names cannot contain spaces or any special characters other than an underscore and must begin with a letter. They are case-sensitive and must be referred to precisely whenever they are referenced.

Title Text

This is the name of the field that will be displayed to users on the app. This property is completely optional; while a field must contain a data name, a field title is optional.

The text color may be chosen with a hex code. The text may be also formatted as Bold or Italic and given a relative size -- Small, Medium (the default) or Large.

Hint Text

This optional field can be used to show secondary information to the user in the app. Consider using this to provide instruction or clarification to the user as they fill out the field.

Formatting options for this property are the same as those given available for the Title Text property.

Result Mode

This property is used to select your result option; Raw or JSON.

Raw Text
When this option is chosen, the raw text (extracted from the image) result will be displayed.

JSON
 When this option is chosen, the full OCR JSON response will be available for reference in other fields via the JSONVAL() formula.

 

On Capture Action

 

The "On Capture Action" option allows you to specify an interaction trigger to occur every time a OCR field successfully scans an image. For example, you could launch a new Screen or you could navigate to another page in a Form when the scan occurs. This opens up many new scenarios to make your apps even more dynamic.

 

Define an action to occur each time the user successfully scans an image with this field. This drop-down determines the action taken when the image is successfully scanned. So, for example, you could launch a new Screen or you could navigate to another page in a Form when the scan occurs. This opens up many new scenarios to make your apps even more dynamic. 

 

  • Create Email To - this will send an email to the address specified in the Pass Parameters field with the app's default email program. The parameter passed can include static text or field values. Pass values from fields in the form using the {{dataname}} syntax.
    /var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/dQ-713lcC9dNK4D7bMn4wlv289WFqAB1Bg.png?1641311144
  • Create SMS To - this will send an SMS message to the address specified in the Pass Parameters field with the app's default messaging program. The parameter passed can include static text or field values. Pass values from fields in the form using the {{dataname}} syntax.
    /var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/gpONPJEiYpA6_49Lc4tSqLpDhZ_BryYgDQ.png?1641311144     Note that this can only be used on a device with messaging capability.


 

  • Dial Phone Number - this will dial the phone number specified in the Pass Parameters field with the app's default phone program. The parameter passed can include static text or field values. Pass values from fields in the form using the {{dataname}} syntax. 
    /var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/MbBU_wGO4blSAuEH5fqF1niojuCQ8sgn-g.png?1641311144     Note that this can only be used on a device with dialing capability.


 

  • Exit & Save Changes - this will save the form as a local draft and exit the form without prompting the user. This essentially saves the user two keystrokes, since going back and clicking "Save and Exit" will not be necessary.
  • Force Sync - this will Force Sync the local device. This is a very useful action as it saves the user several keystrokes, bypassing the need to navigate to return to the device start screen and settings page.
  • Geocode Address - this will convert an address text string into decimal latitude/longitude coordinates. The address must be provided in the "Pass parameter" field below and can be either static text or a form field reference with {{dataname}} syntax and in standard address format - i.e., Street Address, City, State/Province, Postal Code, Country or {{address}}, {{city}}, {{state}}, {{postal}}, {{country}}.

    /var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/hMbp5fTdE4X6Tant8ObQxEl0wX_ylDUXfg.png?1641311144

The geocoded coordinate result (if any) is populated into the field, with the result being "lat lon" - e.g., -13.3823724 153.9832837. The result will not be visible to the user unless the "Display Result to User" property is enabled (see Advanced Options further in this article).

  • Jump to Form Location - this will allow the user to navigate to various parts of the form based on the target chosen in the "Target for interaction" field. These targets can be relative or specific - i.e., the next or previous page, or a specific page somewhere on the form.

    /var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/_cqtdqkSZYYiWMtjuDO617O2HxiFde3Nrg.png?1641311144

A common and recommended use for this is within repeating tables, using the Repeat Row targets to allow users to quickly add new rows or navigate to other rows without needing to leave the table.

Note that although by default the app goes to the first repeat if one exists when jumping to a repeatable page, the app can instead always create a new repeat, skipping over any pre-existing repeats, if the "Always Jump to New Repeat" checkbox is enabled.

 /var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/wvhvC-4uDC5y2h9lcMD3vJTcfeXT1Cd2ZA.png?1639349315

  • Open Doc - this will open a document from your document library (read more about this here). The target document can be a specific reference from the drop-down or a dynamic value determined by a passed parameter. For the latter, you may pass values from form fields using {{dataname}} syntax or specify the unique ID or external ID of the Doc to open using static text or field values.

    /var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/AvrrxUAwiQHCOSIClNeg_WDLqXgxCqFjAw.png?1639349315

  • Open Entry - this will open the form entry specified in from the "Pass parameters" field below. This parameter can be static text or dynamic reference based on a form field such as a choices field linked to the App: Entry History data source. Note that the latter will only work if previous form entries have been submitted on the local device. If none have been submitted, the user will receive an error message when opening the screen since the linked data source will be empty.

    /var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/6DPaH7U2iipNtc9AcEUmOSrN5esls07qFA.png?1639349316


  • Open Screen - this will open another screen. The target screen can be chosen in the drop-down, with parameters optionally passed in the field below. These parameters can be static text or dynamic values from the form using the {{dataname}} syntax.

For Form targets, you can preset target fields with "dataname:value," pipe-separated.
 E.g., field1:{{city}}|field4:hello

 For Listing and Mapping screen targets, you can pass in a formula for filtering the target rows. Use {{target[column]}} for target columns.
 E.g., {{target[3]}} >= {{price}}

 For Detail and Task Details targets, pass the identifier of the target data row or Task. For data rows, the identifier must match the first column's value.
 E.g., {{mychoice}}

 /var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/zH7lDg6G-Q_LQGeWuHnaF51L8VgIiW6oZw.png?1639349316
 Once the user has submitted or exited the target screen, they will be returned to the original form with their progress retained.

  • Open Task - this will open a task as defined by the "Pass parameters" field below, where the Task ID for the target Task should be specified. Columns from the App Tasks data source can be referenced using {{this[column]}} syntax - e.g., {{this[2]}} will pass the 3rd column's value for the current selected row.

         /var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/cM91uZiJMP22MF5HUjmf5PtVgGq1r7H9ww.png?1639349316


Note that this will only work if open tasks are present. If none are available, the data source will be empty, and the user will receive an error message when opening the form.

  • Open URL in App - this will load the URL specified in the "Pass parameters" field below within the app, provided the device has network connectivity. The app will be used rather than a web browser. The parameter may be static or dynamic, based on a form field reference. Pass values from fields in the form using {{dataname}} syntax -- e.g., http://www.example.com?val1={{city}}.

    /var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/AQKq-XzsrPfBOpFchtr1T0y2CbUElTdHDA.png?1639349316
  • Open Link in Web Browser - this will load the URL specified in the "Pass parameters" field below within the app's default web browser, provided the device has network connectivity. The parameter may be static or dynamic, based on a form field reference. Pass values from fields in the form using {{dataname}} syntax -- e.g., http://www.example.com?val1={{city}}.

    /var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/UhkX4xCxLWIMaYxD8N7MwBJOyihJYPWD8w.png?1639349316
  • Show Address on Map - this will show a map featuring the address specified in the "Pass parameters" field below. The address can be either static text or a form field reference with {{dataname}} syntax and in standard address format - i.e., Street Address, City, State/Province, Postal Code, Country or {{address}}, {{city}}, {{state}}, {{postal}}, {{country}}.

    /var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/735Aki6C0bLbt1EfWqR4Pa6m_w6fBm-Qbw.png?1639349316
  • Show Coordinates on Map - this will show a map featuring the latitude and longitude coordinates specified in the "Pass parameters" field below. The coordinates can be either static text or a form field reference, space-separated and using the {{dataname}} syntax - e.g., -12.345678 76.54321 or {{mylocationfield}}.

    /var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/HqDY3ilxp8F2VACk6pVyQ573iz6FhYjCAQ.png?1639349316
  • Upload Form and Print - this will submit/upload the form and print an output report based on the HTML template provided in the App Printing section within the form Settings page. The print job will be sent via the device's default printing service. Please see this article for more detail.


  • Upload Form - this will submit/upload the form. This serves as an alternative to the usual navigation to the end of the form to press the Upload button there.

 

  • Create Email To - this will send an email to the address specified in the Pass Parameters field with the app's default email program. The parameter passed can include static text or field values. Pass values from fields in the form using the {{dataname}} syntax.

  • Create SMS To - this will send an SMS message to the address specified in the Pass Parameters field with the app's default messaging program. The parameter passed can include static text or field values. Pass values from fields in the form using the {{dataname}} syntax.

     

         Note that this can only be used on a device with messaging capability.
  • Dial Phone Number - this will dial the phone number specified in the Pass Parameters field with the app's default phone program. The parameter passed can include static text or field values. Pass values from fields in the form using the {{dataname}} syntax. 

     

         Note that this can only be used on a device with dialing capability.
  • Exit Without Saving - this will prompt the user to exit the form without saving the entry as a local draft. This essentially saves the user two keystrokes, since going back and clicking "Exit without Saving" will not be necessary.
  • Exit & Save Changes - this will save the form as a local draft and exit the form without prompting the user. This essentially saves the user two keystrokes, since going back and clicking "Save and Exit" will not be necessary.
  • Force Sync - this will Force Sync the local device. This is a very useful action as it saves the user several keystrokes, bypassing the need to navigate to return to the device start screen and settings page.
  • Geocode Address - this will convert an address text string into decimal latitude/longitude coordinates. The address must be provided in the "Pass parameter" field below and can be either static text or a form field reference with {{dataname}} syntax and in standard address format - i.e., Street Address, City, State/Province, Postal Code, Country or {{address}}, {{city}}, {{state}}, {{postal}}, {{country}}.

     

The geocoded coordinate result (if any) is populated into the field, with the result being "lat lon" - e.g., -13.3823724 153.9832837. The result will not be visible to the user unless the "Display Result to User" property is enabled (see Advanced Options further in this article).

  • Jump to Form Location - this will allow the user to navigate to various parts of the form based on the target chosen in the "Target for interaction" field. These targets can be relative or specific - i.e., the next or previous page, or a specific page somewhere on the form.

     

A common and recommended use for this is within repeating tables, using the Repeat Row targets to allow users to quickly add new rows or navigate to other rows without needing to leave the table.

 Note that although by default the app goes to the first repeat if one exists when jumping to a repeatable page, the app can instead always create a new repeat, skipping over any pre-existing repeats, if the "Always Jump to New Repeat" checkbox is enabled.

 

  • Open Doc - this will open a document from your document library (read more about this here). The target document can be a specific reference from the drop-down or a dynamic value determined by a passed parameter. For the latter, you may pass values from form fields using {{dataname}} syntax or specify the unique ID or external ID of the Doc to open using static text or field values.

     
  • Open Entry - this will open the form entry specified in from the "Pass parameters" field below. This parameter can be static text or dynamic reference based on a form field such as a choices field linked to the App: Entry History data source. Note that the latter will only work if previous form entries have been submitted on the local device. If none have been submitted, the user will receive an error message when opening the screen since the linked data source will be empty.

     
  • Open Screen - this will open another screen. The target screen can be chosen in the drop-down, with parameters optionally passed in the field below. These parameters can be static text or dynamic values from the form using the {{dataname}} syntax.
     

For Form targets, you can preset target fields with "dataname:value," pipe-separated.
 E.g., field1:{{city}}|field4:hello

 For Listing and Mapping screen targets, you can pass in a formula for filtering the target rows. Use {{target[column]}} for target columns.
 E.g., {{target[3]}} >= {{price}}

 For Detail and Task Details targets, pass the identifier of the target data row or Task. For data rows, the identifier must match the first column's value.
 E.g., {{mychoice}}

 
 Once the user has submitted or exited the target screen, they will be returned to the original form with their progress retained.

  • Open Task - this will open a task as defined by the "Pass parameters" field below, where the Task ID for the target Task should be specified. Columns from the App Tasks data source can be referenced using {{this[column]}} syntax - e.g., {{this[2]}} will pass the 3rd column's value for the current selected row.

     


Note that this will only work if open tasks are present. If none are available, the data source will be empty, and the user will receive an error message when opening the form.
 

  • Open URL in App - this will load the URL specified in the "Pass parameters" field below within the app, provided the device has network connectivity. The app will be used rather than a web browser. The parameter may be static or dynamic, based on a form field reference. Pass values from fields in the form using {{dataname}} syntax -- e.g., http://www.example.com?val1={{city}}.

     
  • Open Link in Web Browser - this will load the URL specified in the "Pass parameters" field below within the app's default web browser, provided the device has network connectivity. The parameter may be static or dynamic, based on a form field reference. Pass values from fields in the form using {{dataname}} syntax -- e.g., http://www.example.com?val1={{city}}.

     
  • Show Address on Map - this will show a map featuring the address specified in the "Pass parameters" field below. The address can be either static text or a form field reference with {{dataname}} syntax and in standard address format - i.e., Street Address, City, State/Province, Postal Code, Country or {{address}}, {{city}}, {{state}}, {{postal}}, {{country}}.

     
  • Show Coordinates on Map - this will show a map featuring the latitude and longitude coordinates specified in the "Pass parameters" field below. The coordinates can be either static text or a form field reference, space-separated and using the {{dataname}} syntax - e.g., -12.345678 76.54321 or {{mylocationfield}}.

     
  • Upload Form and Print - this will submit/upload the form and print an output report based on the HTML template provided in the App Printing section within the form Settings page. The print job will be sent via the device's default printing service. Please see this article for more detail.
  • Upload Form - this will submit/upload the form. This serves as an alternative to the usual navigation to the end of the form to press the Upload button there.

Go to Top


Layout & Styling

Field Layout

This drop-down determines how this field is shown on the screen.

  • Vertical places the Title and Hint vertically above the entry field.


 

 

  • Horizontal will stack the entry field to the right of the Title and Hint text.


 

 

  • Horizontal (Tablets Only) will use Vertical layout for phones and Horizontal for tablets.

 

Background Color

The color chosen in the hex code field here will apply to the field. The Transparent box can also be chosen instead for making this transparent instead of a solid color.

 

Validation & Behavior

Required

Checking this box will enforce validation against this field to make the field required, disallowing the user from progressing to the next page or submitting the form if it is left blank. If the user tries, they will be prompted with an error to return to the field and make a selection. When this validation occurs is determined by the "Validation Property" chosen on the page level; please see this article for more detail on this.

This property can also be made conditional based on a formula. To enable this, click "add condition" below the checkbox and enter a formula into the field that populates. The formula serves as the basic of the required-ness of this field.

Please see this article for more information on conditionally-required fields.

Visibility

The contents of this field will determine whether the field will be visible to the user. For more detail on visibility rules, please see this article.

Read Only

If this checkbox is checked, users will be able to see the contents of the field but will be unable to make edits.

Similar to the Required property, the Read Only property also includes the ability to define a conditional formula determining whether the read-only property is enabled. Click "add condition" to define such a formula.

Custom Validation

 

Add your own custom formula to this property for validating numbers entered into this field by users. The formula is only applied when the field has an answer. Enforcement will be done according to the "Validation Property" chosen on the page level; please see this article for more detail on this.

 

/var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/7KYw2iauaqAH3BQvI5mrzrlEWA8UKG-LWw.png?1641307464

 

Validation Message

The contents of this property will serve as a custom message to display to the user if their input fails validation.

Advanced Options

Default Value

 

The value entered in this property serves as the initial value of the field prior to manual input. Please see this article for details on the relationship between Default Value and Dynamic Value.

 

/var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/-TMMBiDIvMtT0QJpNcSAuJLym6uCG77_sQ.png?1641307463

Bind to Data Source Column

This property allows for the binding of the contents of the field to a data source that is linked to either a choices field or data field on the form. For details, please see the screenshot below:

  1. The data source can be selected with this dropdown. More than one will be available if multiple data source control fields (choices fields or data fields) have been added to the form.
  2. The data source control field can be selected from this dropdown. More than one will be available if multiple data source control fields for the same data source have been added to the form.
  3. The column on the data source to be bound can be selected from this dropdown.

Data Source binding allows you to create forms that can load data from, and update data to, any given data source. This opens up amazing opportunities to have dynamic data that is updated on the move (e.g., adding contacts or clients). For more information, please see this article.

Bind to Global Value

Global Values are a local key/value store that is available to any Screen on the app. Use this property to allow the user to view and save defaults for use across the app (e.g., a default project or customer). Please see this article for more information.

Exclude from Export/Display

By default, every field is displayed on Form entries in the Data area, and is included in non-templated exports (e.g., generic pdf, CSV, spreadsheet, database connectors). Use this property to prevent this field from showing on all such display and exports.

Is Personal Data

 

Indicates that data captured in this field may contain personal or sensitive data, which in turn can be anonymized when exported from the platform when then the "Anonymize Personal Data" option is checked on a form connector. Please see this article for more on this. 

 

NOTE: Use of this option does not grant or imply additional security, protection and privacy of data.

 

/var/folders/yf/4dbjhxmx3xx657c5cbgdx0kc0000gn/T/com.microsoft.Word/WebArchiveCopyPasteTempFiles/WMOPJATAM3rjMgxw70dgwrHb-Q_yTyRXzA.png?1641307464

This field provides the user with a "Scan" button that launches the device camera to perform barcode capture.

 

Copy to Device Gallery

 

By default the app stores captured photos, videos and audit files in a private app location. This option causes the app to copy captured files into the device's Album/Gallery area for general access.

 

 

Capture Only

 

Users normally have the option to capture media or to choose an existing file. Ticking this option will remove the "Choose" button, forcing the user to capture only.