Computer Vision Settings

The Computer Vision settings are defined in JSON format as key-value pairs. The following settings are available:

Setting	JSON Key	Description
Workflow entity	SourceEntityName	The entity associated with the business workflow (digital journey) that calls the OCR process.Needed only if the OCR process is used on an edit form (to alter an existing record) to update the workflow entity's business status after the scan (see BusinessStatusSuccess and BusinessStatusFail).If the OCR process is used on an insert form (to create a new record), this key is not needed.
Populated entities	Entities	Indicates the entities that will be populated with the scanned values. DestinationEntityName – Name of the entity that is populated with the scanned data. SourceEntityName – Entity associated with the business workflow (digital journey) that uses the automation processor. If this is the same entity that is populated, this value will be identical to DestinationEntityName. SourceLookupDestinationName – Name of the SourceEntityName lookup key that points to DestinationEntityName. If they are the same entity, enter the primary key.
User confirmation	WaitUserConfirmation	The default value is `true`. If `true`, the user takes or uploads a photo and then clicks Process the Photo to continue the OCR process. If `false`, the photo processing is automatically triggered.
Show Upload Photo button	ShowUploadPhotoButton	If `true`, the Upload Photo button is displayed. If `false`, the Upload Photo button is hidden.
Show Take Picture button	ShowTakePictureButton	If `true`, the Take Picture button is displayed. If `false`, the camera on your device will not be enabled.
Register face from OCR	RegisterFaceFromOCR	If `true`, the OCR process is successful only if the person's face from their ID is registered. If `false`, there is not attempt to also register the person's face from their ID.
Session expired minutes	SessionExpiredMins	The time in minutes after which, if no navigation to another screen is done, the session expires. In this case, it redirects the user to a session expired page. NOTE Make sure your main entity's business status is updated to the business status you have set in your flow settings for b`usinessStatusSessionExpired`.
Rotate image	RotateImage	Rotates the image to an angle that is multiple of 90° (180, 270 etc.), based on the orientation of the text from the OCR. If the text from the image has an angle smaller than 45°, the image remains the same. If the image doesn't need to be rotated the `Base64File` field from `RotatedImage` will be null. The rotated image is stored in the `FTOS_DFP_OCR.RotatedImage` entity.
Crop image	CropImage	If `true`, it extracts the person's face in an image and returns the data in the following structure: Copy `"CroppedImage" : "your_document_field_here", "MatchFound": "your_bit_field_here", "Confidence": "your_text_field_here"`
Maximum number of scan attempts	MaxRetry	The maximum number of scan attempts. If this number of failed scans is reached, the user will be redirected according to the specifications in the MaskNextStepUrlFail.
Option set based validation and replacement	OptionSets	Replaces values returned by the OCR process with entries from an option set. OptionSetName – Name of the option set that stores the valid replacement values. MappingName – Name of the field as returned by the OCR processor. For details, see OCR Processor Field Names. OptionSetItems – Key-value pairs that map the value returned by the OCR processor (the key) to the replacement value from the option set (the value). If the value returned by the OCR processor is not found in the OptionSetItems keys, the entry will not be populated. The user will be able to manually select only values from OptionSetName.
Entity based validation	LookupEntities	Validates values returned by the OCR processor based on records in an entity. MappingName – Name of the field as returned by the OCR processor. For details, see OCR Processor Field Names. EntityName – Name of the entity that stores the valid values. AttributeKey – Name of the attribute in EntityName that stores the valid values. Parent – Defines hierarchical relationships between lookup entities. For instance, you can check if a city name belongs to a valid county name. MappingParentName – Name of the parent field as returned by the OCR processor. For details, see OCR Processor Field Names. AttributeParentKey – Name of the EntityName lookup key linked to the parent entity. If the value returned by the OCR processor is not found in the lookup entity, the entry will not be populated. The user will be able to manually select only values from the lookup entity.
Advanced validations	Validations	Defines advanced validations based on predefined validation codes. Type – Type of scanned document on which the validation is applied (see AvailableDocumentTypes). Validations – Validation codes. The following validations are available for Romanian identity cards: V01 – Compares the Personal Numeric Code (CNP) control digits extracted from the CNP and MRZ. V05 – Compares the birth dates extracted from the CNP and MRZ. V06 – Compares the last 6 CNP digits extracted from the CNP and MRZ. V07 – Checks if the identity card's expiration date matches the person's birthday. Dates are extracted from the MRZ. V08 – Checks if the age is above 18 years old. The date of birth is extracted from the MRZ. V10 – Checks the MRZ integrity per ICAO Document 9303. If the name from the uploaded document image cannot be read from the body or MRZ, an exception is thrown and the following response is returned from DCS: Copy `{ "IsSuccess": false, "ErrorMessage": "ValidatorException - Could not detect name in given document. Please load a valid document", "ExternalErrorMessage": null, "ExternalErrorCode": null }`
Available document types	AvailableDocumentTypes	Defines classifications for the document scans based on the document type and service provider. Type – Assign a name for the class of documents, such as IdRom or passport. DocumentType – Type of document. Supported values are IdentityCard, MRZ, and DrivingLicence. Country – Optional parameter for the country code of the document. Currently, supported values are RO and BG. Provider – OCR provider. Supported value is Azure
Redirect in case of success	MaskNextStepUrlSuccess	Location in the user interface where the user is redirected after a successful scan. entity – Entity name. form – Form name of the above entity. section – Optional parameter for the section name of the above form.
Redirect in case of failure	MaskNextStepUrlFail	Location in the user interface where the user is redirected after the maximum number of failed scan attempts (see MaxRetry). entity – Entity name. form – Form name of the above entity. section – Optional parameter for the section name of the above form.
Business status update in case of success	BusinessStatusSuccess	Business workflow status update of the Workflow entity if the scan is successful. Needed only if the OCR process is used on an edit form (to alter an existing record). If the OCR process is used on an insert form (to create a new record), this key is not needed.
Business status update in case of failure	BusinessStatusFail	Business workflow status update of the Workflow entity if the scan fails. Needed only if the OCR process is used on an edit form (to alter an existing record). If the OCR process is used on an insert form (to create a new record), this key is not needed.
Document type	DocumentType	Indicates the type of scanning the OCR processor will perform based on the values defined in the AvailableDocumentTypes setting. Only one document type can be enabled per automation processor.

Examples

Computer Vision settings for an edit form

Copy

{
    "SourceEntityName": "FTOS_BARET_AccountApplication",
    "Entities": [
        {
            "DestinationEntityName": "FTOS_BNKAP_RetailApplicantData",
            "SourceEntityName": "FTOS_BARET_AccountApplication",
            "SourceLookupDestinationName": "retailApplicantId"
        },
        {
            "DestinationEntityName": "FTOS_BNKAP_RetailApplicantAddress",
            "SourceEntityName": "FTOS_BARET_AccountApplication",
            "SourceLookupDestinationName": "FTOS_BNKAP_RetailApplicantAddressId"
        }
    ],
    "WaitUserConfirmation" : true,
    "ShowUploadPhotoButton" : true,
    "ShowTakePictureButton" : true,
    "RegisterFaceFromOCR" : false,
    "SessionExpiredMins" : 15,
    "RotateImage" : false,
    "CropImage" : false, 
    "MaxRetry": 5,
    "OptionSets": [
        {
            "OptionSetName": "FTOS_DFP_GenderOptionSet",
            "MappingName": "Sex",
            "OptionSetItems": {
                "M": "M",
                "F": "F"
            }
        }
    ],
    "LookupEntities":[  
      {  
         "MappingName":"DistrictCode",
         "EntityName":"District",
         "AttributeKey":"Code"
      },
      {  
         "MappingName":"BirthDistrictBody",
         "EntityName":"District",
         "AttributeKey":"Code"
      },
      {  
         "MappingName":"IssuingCountry",
         "EntityName":"FTOS_CMB_Country",
         "AttributeKey":"code"
      },
      {  
         "MappingName":"City",
         "EntityName":"City",
         "AttributeKey":"Name",
         "Parent":{  
            "AttributeParentKey":"DistrictId",
            "MappingParentName":"DistrictCode"
         }
      }
   ],
    "Validations": [
        {
            "type": "IdROM",
            "Validations": "V01,V05,V06,V07,V08",
            "CheckScriptName": "ValidateIdROM"
        },
        {
            "type": "Passport",
            "Validations": "V05",
            "CheckScriptName": "ValidateIdPass"
        }
    ],
    "AvailableDocumentTypes": [
        {  
         "type":"IdRom",
         "DocumentType":"IdentityCard",
         "Country":"RO",
         "Provider":"Azure"
      },
      {  
         "type":"IdBG",
         "DocumentType":"IdentityCard",
         "Country":"BG",
         "Provider":"Abbyy"
      },
      {  
         "type":"Passport",
         "DocumentType":"MRZ",
         "Provider":"Azure"
      },
      {  
         "type":"DrivingLicence",
         "DocumentType":"DrivingLicence",
         "Provider":"Azure"
      }
    ],
    "maskNextStepURLSuccess": {
        "entity": "FTOS_BARET_AccountApplication",
        "form": "FTOS_BARET_AccountApplication_UserJourney",
        "section": "Personal Data"
    },
    "maskNextStepURLFail": {
        "entity": "FTOS_BARET_AccountApplication",
        "form": "FTOS_BARET_AccountApplication_UserJourney",
        "section": "Current Account"
    },
   "maskNextStepURLFailSessionExpired":{  
      "entity":"TestEntity",
      "form":"FTOS_BARET_AccountApplication_UJ_FlowControl",
      "section":"SessionExpired1"
   }, 
    "businessStatusSuccess": "OCR Validation",
    "businessStatusFail": "OCR Failed",
    "DocumentType": "IdRom"
}

Computer Vision settings for an insert form

Copy

{
    "Entities": [
        {
            "DestinationEntityName": "FTOS_ACC_Account",
            "SourceEntityName": "FTOS_ACC_Account",
            "SourceLookupDestinationName": "FTOS_ACC_Accountid"
        },
        {
            "DestinationEntityName": "FTOS_ACC_Address",
            "SourceEntityName": "FTOS_ACC_Account",
            "SourceLookupDestinationName": "DefaultAddressId"
        }
    ],
    "WaitUserConfirmation" : true,
    "ShowUploadPhotoButton" : true,
    "ShowTakePictureButton" : true,
    "RegisterFaceFromOCR" : false,
    "SessionExpiredMins" : 15,
    "RotateImage" : false,
    "CropImage" : false,
    "MaxRetry":5,
    "OptionSets":[
        {
            "OptionSetName": "FTOS_ACC_GenderType",
            "MappingName": "Sex",
            "OptionSetItems": {
                "M": "Male",
                "F": "Female"
            }
        }
    ],
    "LookupEntities": [
         {  
         "MappingName":"DistrictCode",
         "EntityName":"District",
         "AttributeKey":"Code"
      },
      {  
         "MappingName":"BirthDistrictBody",
         "EntityName":"District",
         "AttributeKey":"Code"
      },
      {  
         "MappingName":"IssuingCountry",
         "EntityName":"FTOS_CMB_Country",
         "AttributeKey":"code"
      },
      {  
         "MappingName":"City",
         "EntityName":"City",
         "AttributeKey":"Name",
         "Parent":{  
            "AttributeParentKey":"DistrictId",
            "MappingParentName":"DistrictCode"
         }
      }
    ],
     "Validations":[  
      {  
         "type":"IdRom",
         "Validations":"V01,V05,V06,V07,V08",
         "CheckScriptName":"ValidateIdROM"
      },
      {  
         "type":"Passport",
         "Validations":"V05",
         "CheckScriptName":"ValidateIdPass"
      }
   ],
    "AvailableDocumentTypes":[  
      {  
         "type":"IdRom",
         "DocumentType":"IdentityCard",
         "Country":"RO",
         "Provider":"Azure"
      },
      {  
         "type":"IdBG",
         "DocumentType":"IdentityCard",
         "Country":"BG",
         "Provider":"Abbyy"
      },
      {  
         "type":"Passport",
         "DocumentType":"MRZ",
         "Provider":"Azure"
      },
      {  
         "type":"DrivingLicence",
         "DocumentType":"DrivingLicence",
         "Provider":"Azure"
      }
   ],
   "maskNextStepURLSuccess":{  
      "entity":"TestEntity",
      "form":"FTOS_BARET_AccountApplication_UJ_FlowControl",
      "section":"Personal Data"
   },
   "maskNextStepURLFail":{  
      "entity":"TestEntity",
      "form":"FTOS_BARET_AccountApplication_UJ_FlowControl",
      "section":"Current Account"
   },
   "maskNextStepURLFailSessionExpired":{  
      "entity":"TestEntity",
      "form":"FTOS_BARET_AccountApplication_UJ_FlowControl",
      "section":"SessionExpired1"
    },
    "DocumentType": "IdRom"
}