Top Image Systems v1.0

This package provides capabilities that extend the Avoka Transact platform for users wishing to scan and extract data from driver licence image using the Top Image Systems mobiFLOW platform.


This package provides the following components

  1. TIS Drivers Licence Upload

    A native widget to upload a driver's licence image

  2. TIS Drivers Licence Prefill

    A Maestro component that includes the TIS Drivers Licence Upload button, the upload image button and a processing message.

Licensing

Clients must ensure they are appropriately licenses in order to use this package. Organisations who wish to use this package are required to setup account and create application with Top Image Systems directly.

Compatibility

This package has the following compatibility requirements:

Module Compatibility Notes
Transact Manager 5.0.1 or above
Transact Maestro 5.0.14 or above

Installation Instructions

To install this package please walk through the following procedure:

  1. Unzip the package to a directory on your computer
  2. Import each zip archive found in the services folder to Transact Manager under the Services >> All Services menu item.
  3. Review the Help Doc tab for each of the imported services and make any required adjustments to service parameters.
  4. Review the Service Connection requirements under the same Help Doc tab for each of the imported services and make any required configurations to the Service Connection. Service Connections can be configured in Transact Manager under the Services >> Service Connections menu item.
  5. Import each archive found in the libraries folder to Maestro. Importing these into the Organisation level libraries folder is recommended as this will make the components available to all projects, however they can be imported at the Project level if required.

Usage Instructions

To configure this component please walk through the following procedure:

  1. Open your form in Maestro and drag and drop the 'TIS - Driver Licence' component from the Palette
  2. Open the properties section of the 'Driver Licence' field.
  3. Under 'Prefill Mappings' section, map the field name to the field path. (For example 'Licence Number' is mapped to field path 'data.licenceNumber')

Supported Fields

The below fields are fetched from the scanned driver licence

Name Description
Licence Number The driver's licence number
Full Name The driver's full name
First Name The driver's first name
Last Name The driver's last name
Date of Birth The driver's date of birth
Full Address The driver's full address
Address Line 1 The driver's address line 1
Address Line 2 The driver's address line 2

Maestro Assets

TIS Drivers Licence Prefill Library: exchange.tis Category: Top Image Systems

Provides Australian Driver's License scan and Prefill using the Top Image Systems OCR engine

Uses

TIS Drivers Licence Upload Library: exchange.tis Category: Top Image Systems

Provides Drivers Licence upload capabilities for the Top Image Systems prefill component

Used In

Service Calls

Properties

Property Category Description Type Default
Prefill Mappings Prefill Mappings

Map the field name to the field path. (For example 'Licence Number' is mapped to field path 'data.licenceNumber')

Field Refs:

  • licenceNumber : Licence Number
  • fullName : Full Name
  • firstName : First Name
  • lastName : Last Name
  • dateofBirth : Date of Birth
  • fullAddress : Full Address
  • addressLine1 : Address Line 1
  • addressLine2 : Address Line 2

You may add your own field mappings as required.

fieldRefMap

Services

Top Image Systems - Drivers Licence Scan
This service provides OCR capabilities for reading and parsing driver licence using the Top Image Systems mobiFLOW platform.

Service Connection

Compatibility

Module Compatibility
Manager 5.0.1

Service Parameters

Name Description Required Default
applicationName The TIS application name. Yes
identifier The TIS identifier. Yes amigo
pollMaxAttempts Max attempts to fetch transaction data No 25
pollWait Poll sleep time in milliseconds No 500

Inputs

Name Description Required
identifier Should contain your TIS identifier key Yes
licenceType The licence state origin (e.g. NSW, ACT, VIC) Yes
deviceType The device type (default: 0) No
imageData The driver licence image data in base64. Yes
attachmentKey The driver licence attachment key. No
applicationName The application name. The system will set the default application name based on the provided state. No
pollMaxAttempts The maximum number of attempts to fetch the result (default: 25) No
pollWait The number of millisecond interval to re-run the request until the result is ready (default: 500) No

Outputs

Name Description
licenceNumber The driver licence number as captured by the service
firstName The driver first name as captured by the service
lastName The driver last name as captured by the service
fullName The driver full name as captured by the service
dateofBirth The driver date of birth as captured by the service
fullAddress The driver full address as captured by the service
addressLine1 The driver address line1 as captured by the service
addressLine2 The driver address line2 as captured by the service
executionStatus The status of the service execution [ SUCCESS | DATA_ERROR | SYSTEM_ERROR ].

Successful execution will be denoted by a SUCCESS value. DATA_ERROR will indicate that there was an issue identified with the input data that may be resolved and potentially retried by the user. SYSTEM_ERROR indicates that there was an unrecoverable system fault and the form should fall-back gracefully to an alternative path.
errorMessage When a DATA_ERROR is experienced, this value may provide more detail on the nature of the error.

Service Connections

The following service connections are used by this package.

Top Image Systems
Property Name Description Required
Type HTTP Endpoint Yes
Endpoint Must point to the TIS Mobiflow endpoint. For example

http://mobileau.tisa.io/MobileWebServices/MobiFlowService.svc

Yes
Username Clients to get their own user credentials from TIS. Yes
Password Clients to get their own user credentials from TIS. Yes
Auth Key Auth Key is a token that clients get from TIS. Yes