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.
Logging context ContextForm Logging context field included in the log events sent to the DCI logging. Useful for tracking the relevant digital journey when debugging.
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.
Expiration time 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 businessStatusSessionExpired.
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.
Expiration Redirect businessStatusSessionExpired Enables or disables redirection to the expiration page after SessionExpiredMins.
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.
Scanned Document DocumentSettings Defines settings specific to the scanned document:
  • DocumentType – Type of document. Supported values are: MRZ, Passport, IdentityCard, DrivingLicence, or VehicleIdentityCard.
  • Country – Optional parameter for the country code of the document.
  • Provider – OCR provider. Supported value is Azure
  • Validations - Defines advanced document validations based on predefined validation codes (see Computer Vision Validations).
  • RequiredFields - Computer Vision Mappings that are mandatory for a successful scan. Otherwise, the OCR fails.
  • BirthdayValidation - Optional parameter for Romanian identity cards that checks the date of birth (see Romanian Identity Card).
  • PINValidation - Optional parameter for Romanian identity cards that checks the personal identification number (see Romanian Identity Card).
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.
Redirect in case of session expired maskNextStepURLFailSessionExpired Location in the user interface where the user is redirected if the scan is not finalized before the expiration time (see SessionExpiredMins).
  • 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.
Retain SDK logs DisableLogSDKMessages
(Ecosystem SysPack 2.5.0 or later)		 Set this property to true if you do not wish to retain SDK logs.
Log severity level LogLevel
(Ecosystem SysPack 2.5.0 or later)		 Controls the minimum severity level for the logged messages. Set it to error to capture only SDK errors or to debug to include all SDK log messages.
Log browser details DisableSaveBrowserDetails
(Ecosystem SysPack 2.5.0 or later)		 Set this property to true to prevent storage of user platform details in the FTOS_DFP_Logging entity.
2-sided document DocumentSides
(Ecosystem SysPack 2.7.0 or later)

The number of scans per session.

  • Set this property to 2 to scan both sides of a document when using the FTOS_ECOS_OCR component.
  • When using the FTOS_DFP_OCR component, this setting is not needed.
Process both sides together CaptureBothSides
(Ecosystem SysPack 2.7.0 or later)		 Set this property to true to process and validate both sides of a document together and return a single result.
Debug mode Debug
(Ecosystem SysPack 2.7.0 or later)		 Set this property to true to log debugging information in the browser console.

 

Examples

Copy 
{  
   "SourceEntityName":"FTOS_Test_OCR",
   "Entities":[  
      {  
         "DestinationEntityName":"FTOS_Test_OCR_Applicant",
         "SourceEntityName":"FTOS_Test_OCR",
         "SourceLookupDestinationName":"applicantId"
      }
   ],
   "ContextForm" : "FTOS_Test_Processors_UserJourney",
   "WaitUserConfirmation" : false,
   "ShowUploadPhotoButton" : true,
   "ShowTakePictureButton" : true,
   "RegisterFaceFromOCR" : false,
   "SessionExpiredMins" : 15,
   "RotateImage" : true,
   "CropImage" : false,
   "MaxRetry":5,
   "businessStatusSessionExpired": true,
   "OptionSets":[  
      {  
         "OptionSetName":"Gender Type",
         "MappingName":"Sex",
         "OptionSetItems":{  
            "M":"Male",
            "F":"Female"
         }
      }
   ],
   "LookupEntities":[  
      {  
         "MappingName":"Country",
         "EntityName":"FTOS_CMB_Country",
         "AttributeKey":"code"
      }
   ],
   "DocumentSettings": {  
         "DocumentType":"Passport",
         "Provider":"Azure",
         "Validations":"V01,V05,V06,V07,V10",
         "RequiredFields": ["PersonalNumberBody", "DocumentNumberBody", "LastNameBody", "GivenNameBody", "NationalityBody", "PlaceOfBirthBody", "BirthDateBody", "SexBody"]
    },
   "maskNextStepURLSuccess":{  
      "entity":"FTOS_Test_OCR",
      "form":"FTOS_Test_OcrFDF",
      "section":"Success"
   },
   "maskNextStepURLFail":{  
      "entity":"FTOS_Test_OCR",
      "form":"FTOS_Test_OcrFDF",
      "section":"Fail"
   },
   "maskNextStepURLFailSessionExpired":{  
      "entity":"FTOS_Test_OCR",
      "form":"FTOS_Test_OcrFDF",
      "section":"Expired"
   },
   "businessStatusSuccess":"OCR Valid",
   "businessStatusFail":"OCR Failed"
}
Copy 
{  
   "SourceEntityName":"FTOS_Test_OCR",
   "Entities":[  
      {  
         "DestinationEntityName":"FTOS_Test_OCR_Applicant",
         "SourceEntityName":"FTOS_Test_OCR",
         "SourceLookupDestinationName":"applicantId"
      }
   ],
   "ContextForm" : "FTOS_Test_Processors_UserJourney",
   "WaitUserConfirmation" : false,
   "ShowUploadPhotoButton" : true,
   "ShowTakePictureButton" : true,
   "RegisterFaceFromOCR" : false,
   "SessionExpiredMins" : 15,
   "RotateImage" : true,
   "CropImage" : false,
   "MaxRetry":5,
   "businessStatusSessionExpired": true,
   "OptionSets":[],
   "LookupEntities":[],
   "DocumentSettings": {  
         "DocumentType":"DrivingLicence",
         "Country":"RO",
         "Provider":"Azure",
         "Validations":"",
         "RequiredFields": ["IssuedAt", "IssuedUntil", "IssuedBy", "PIN", "DrivingLicenceNo", "DrivingCategory"]
    },
   "maskNextStepURLSuccess":{  
      "entity":"FTOS_Test_OCR",
      "form":"FTOS_Test_OcrFDF",
      "section":"Success"
   },
   "maskNextStepURLFail":{  
      "entity":"FTOS_Test_OCR",
      "form":"FTOS_Test_OcrFDF",
      "section":"Fail"
   },
   "maskNextStepURLFailSessionExpired":{  
      "entity":"FTOS_Test_OCR",
      "form":"FTOS_Test_OcrFDF",
      "section":"Expired"
   },
   "businessStatusSuccess":"OCR Valid",
   "businessStatusFail":"OCR Failed"
}