Skip to content

Document Type Mappings

This page provides mapping for document types - document class name from scanner with document type code from PMS. It displays a list of entries having these properties:

  • Document Class Name: Name of the document class as reported by the document scanners

    Example

    Passport, Visa, Identification Card, Driver License, etc...

  • Document Class Code:  A code mapped to the document class

    • This needs to be set to a document code that is defined in the PMS - otherwise the mapping will not work
  • Description: Description of the document type.

//

This list can be modified by editing, adding, or removing document type mappings as needed. When adding or editing a document type mapping, we can see another two properties:

  • Accepted issuing countries: (country codes separated by semicolon) To be used if we want to allow using certain document types only when issued by certain countries. Country codes in Alpha-2 or Alpha-3 format are used for this list (Example: FRA;USA;BR).
    • Nothing specified on the accepted issuing countries list means that the respective document is accepted no matter which is the issuing country.
    • Putting a star ( * ) in the accepted issuing countries list means the same as leaving the accepted issuing countries list empty i.e. the respective document is accepted no matter which is the issuing country.
  • Excluded issuing countries: (country codes separated by semicolon) To be used if we want to reject using certain document types only when issued by certain countries. Country codes in Alpha-2 or Alpha-3 format are used for this list (Example: SGP;FR).
    • Nothing specified on the excluded issuing countries list means the respective document is accepted (i.e. NOT rejected) no matter which is the issuing country.
    • Putting a star ( * ) in the excluded issuing countries list means that the respective document type is rejected no matter which is the issuing country.

Note

  • For a fresh install (meaning a clean Kiosk DB), though, a new document class added as default should be visible from the start.
  • For an update install, you need to Restore Defaults to see a new document class added as default. Because once the DB collection is created it is not touched on an upgrade unless Restore Defaults is used.

The recommended way of working is to start from an empty page, then use the "Restore Defaults" to populate the list with the most encountered document classes in the scanner platforms supported by Kiosk (AssureID and Veridocs)..

Document class AssureID Veridocs
Military_ID X
Driver License X X
Drivers License X
Identification Card X
Identification_Card X
Passport X X
Visa X X
*

You are not constrained to use the default list, it should be merely regarded as a starting point.

  • If your scanner platform reports a Document class which is not among the values listed above, you can add a new entry to the list, specifying that particular document class and the PMS document code to which we the document class should be mapped.
  • If you are sure that the scanner platform will never report a specific document class, you can remove that particular entry. For example, the situations when a guest will use a military ID are pretty limited in real life.
  • And obviously, if the document type code in the Kiosk Admin does not correspond with the PMS type code, you need to edit that entry and provide the correct type code as seen in the PMS.

A special attention should be payed to the star (*) document class. This document class represents a placeholder for all document types that cannot be mapped to a specific document code in the PMS. When a guest scans such a document, it will be mapped to a generic PMS type code, such as UNKNOWN in this example. This generic type code should be set according to what is defined in the PMS, too.