Skip to content

Migration Guide: From 7.7 to 8.1

Web Service

Logging Configuration

Changed the configuration logic for processing results logs. Previously, the logs have been collected if the processing section existed in the config.yaml with any number of subsidiary fields. Now, to log the Web Service processing results, you need to explicitly set the enabled = true field. See the example.

config.yaml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
service:
  processing:
    enabled: true
    results:
      audit: true
      saveResult: true
      location:
        bucket: "docreader-processing"
        container: "docreader-processing"
        folder: "docreader-logs"
        prefix: "processing"
config.yaml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
service:
  processing:
    results:
      audit: true
      saveResult: true
      location:
        bucket: "docreader-processing"
        container: "docreader-processing"
        folder: "docreader-logs"
        prefix: "processing"

For more details, see the Web Service Logging Configuration page.

Database Configuration

Changed the Oracle Database driver used for the setup of the Complete Server-Side Verification from cx_Oracle to oracledb. See the example connection string:

config.yaml
service:
  database:
    connectionString: "oracle+oracledb://system:admin@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=127.0.0.1)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=FREE)))
config.yaml
service:
  database:
    connectionString: "oracle+cx_oracle://system:admin@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=127.0.0.1)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=FREE)))

For more details, see the Connect Database instructions.

Mobile

General Changes

RFID Processing

The RFIDScenario.readingBuffer property has taken an integer value, that defined the buffer size (see the details in the Document Reader SDK Programmers Guide). Now, it takes one of the values of the RFIDReadingBufferSize enumeration. See the examples on the RFID Configuration page.

If you use only the RFID chip reading (without optical processing beforehand), now you need to set the new dedicated scenario—RFID. See the example.

DocReader.shared.processParams.scenario = RGL_SCENARIO_RFID;

RGLDocReader.shared.processParams.scenario = RGL_SCENARIO_RFID;

DocumentReader.Instance().processParams().scenario = Scenario.SCENARIO_RFID

DocumentReader.Instance().processParams().scenario = Scenario.SCENARIO_RFID;

DocumentReader.instance.processParams.scenario = Scenario.RFID;

DocumentReader.setProcessParams({
    scenario: ScenarioIdentifier.SCENARIO_RFID
}, (str) => { console.log(str) }, (error) => { console.log(error) });

DocumentReader.setProcessParams({
    scenario: ScenarioIdentifier.SCENARIO_RFID
});

DocumentReader.setProcessParams({
    scenario: ScenarioIdentifier.SCENARIO_RFID
}, function (m) { }, function (e) { console.log(e); });

// Android
DocumentReader.Instance().ProcessParams().Scenario = Scenario.ScenarioRFID;

// iOS
RGLDocReader.Shared.ProcessParams.Scenario = Constants.RGL_SCENARIO_RFID;

Also, you need to manually set the access key.

Info

If the RFID chip processing follows the optical processing, there is no need to set the scenario before starting the RFID chip processing.

New UI

Mobile SDK introduces the new UI for the document scanning process. For now, you will be able to select either the old UI or the new one, and it's recommended to migrate to the new UI. To compare the appearance, explore the Customize User Interface pages.

To switch between the UIs, when launching the document scanning, run the Document Reader methods starting from showScanner (for the old UI) or from startScanner (for the new UI).

For more details, see the Document Processing instructions and explore the sections below.

iOS

  • Deprecated method showScannerFromPresenter() in RGLDocReader. You can still use it to launch the document scanning process in the old UI. Use startScannerFromPresenter() instead to run document scanning in new UI.
  • Deprecated method prepareCameraViewController() in RGLDocReader. You can still use it to get the view controller with old UI. Use prepareCameraViewControllerForStart() instead to get the view controller with new UI.
  • Deprecated the following old UI properties in RGLCustomization:
    • resultStatus
    • resultStatusPositionMultiplier
    • resultStatusTextColor
    • resultStatusTextFont
    • resultStatusBackgroundColor
  • Deprecated the property showChangeFrameButton in RGLFunctionality.
  • Changed the default value for the backgroundMaskAlpha in RGLCustomization to 1.0.
  • Changed the type of the cameraViewController property in RGLFunctionality from RGLDocumentReaderCameraViewController to RGLDocumentReaderBaseCameraViewController.
  • Changed the type of the readingBuffer property in RFIDScenario from integer to RGLRFIDReadingBufferSize enumeration.

For the information about the most current functionality, see iOS API Reference Documentation.

Android

  • Deprecated method showScanner() in DocumentReader. You can still use it to launch the document scanning process in the old UI. Use startScanner() instead to run document scanning in new UI.
  • Deprecated the method setShowChangeFrameButton() in Functionality.
  • Deprecated the following old UI methods in ParamsCustomization:
    • setResultStatusPositionMultiplier(Float resultStatusPositionMultiplier)
    • setResultStatusBackgroundColor(String resultStatusBackgroundColor)
    • setResultStatusTextColor(String resultStatusTextColor)
    • setResultStatusTextSize(Integer resultStatusTextSize)
    • setResultStatusTextFont(Typeface resultStatusTextFont)
    • setShowResultStatusMessages(boolean showResultStatusMessages)
    • setResultStatus(String status)
    • setChangeFrameCollapseButtonImage(Drawable changeFrameButtonCollapseImage)
    • setChangeFrameExpandButtonImage(Drawable changeFrameButtonExpandImage)
  • Changed the type of the readingBuffer property in RFIDScenario from integer to RFIDReadingBufferSize enumeration.

For the information about the most current functionality, see Android API Reference Documentation.

Web Component

Warning

All items that were marked as deprecated by the time of release 8.1 are now removed. This applies to CSS variables, components' settings, parameters, attributes, methods, etc. If you're still using any of them, consider the current alternatives. See details below.

Obsolete Settings and Methods

The following parameters and methods are now obsolete, they are deleted from source code and should not be used anymore:

  • Deleted --font-family and --font-size CSS variables. Use the properties of the corresponding part CSS elements instead.
  • Deleted flipFrontIcon and flipBackIcon settings. Use the part CSS elements with the prefixes hint-next-page-front- and hint-next-page-back- instead.
  • Deleted the prepare() method and prepareListener field from DocumentReaderService.
  • Deleted the license attribute and the devLicense setting. Use the RegulaDocumentSDK.initialize() method instead.
  • Deleted the regulaLogo setting. Use the copyright setting instead.
  • Deleted the respectImageQuality parameter. Use strictImageQuality instead.
  • Deleted settings: statusBackgroundColor, statusTextColor, backgroundMaskAlpha. Use the properties of the corresponding part CSS elements instead.

For the information about the most current functionality, see Web Component documentation.

UI and UX Changes

In the release 8.1 the component's UI has changed.

Starting from release 8.1, the ::part() elements' icons are now set with the ::before pseudo-element.

The list of part CSS pseudo-elements has been updated to support the effective icons' customization.

Deleted part elements:

  • hint-next-page-front-img
  • hint-next-page-back-img

Added part elements:

  • hint-status-processing-error-icon
  • hint-status-search-icon
  • hint-status-square-icon
  • hint-holo-id-front-icon
  • hint-holo-passport-single-icon
  • hint-holo-passport-both-pages-icon
  • hint-holo-id-front-icon
  • hint-holo-id-mrz-front-icon
  • hint-holo-id-back-icon
  • hint-holo-id-mrz-back-icon
  • hint-holo-id-barcode-back-icon
  • hint-holo-id-mrz-barcode-back-icon
  • hint-holo-bank-card-front-icon
  • hint-holo-bank-card-back-icon
  • hint-holo-document-front-icon
  • hint-holo-document-back-icon
  • hint-next-page-front-id-front-icon
  • hint-next-page-front-passport-single-icon
  • hint-next-page-front-passport-both-pages-icon
  • hint-next-page-front-id-front-icon
  • hint-next-page-front-id-mrz-front-icon
  • hint-next-page-front-id-back-icon
  • hint-next-page-front-id-mrz-back-icon
  • hint-next-page-front-id-barcode-back-icon
  • hint-next-page-front-id-mrz-barcode-back-icon
  • hint-next-page-front-bank-card-front-icon
  • hint-next-page-front-bank-card-back-icon
  • hint-next-page-front-document-front-icon
  • hint-next-page-front-document-back-icon
  • hint-next-page-back-id-front-icon
  • hint-next-page-back-passport-single-icon
  • hint-next-page-back-passport-both-pages-icon
  • hint-next-page-back-id-front-icon
  • hint-next-page-back-id-mrz-front-icon
  • hint-next-page-back-id-back-icon
  • hint-next-page-back-id-mrz-back-icon
  • hint-next-page-back-id-barcode-back-icon
  • hint-next-page-back-id-mrz-barcode-back-icon
  • hint-next-page-back-bank-card-front-icon
  • hint-next-page-back-bank-card-back-icon
  • hint-next-page-back-document-front-icon
  • hint-next-page-back-document-back-icon

To change the default element's icon, use the named part attribute with the before pseudo-element and change the background-image property appropriately. See CSS examples further.

Icon replacement

Using image in Base64 format:

document-reader::part(hint-next-page-back-passport-single-icon)::before {
    background-image: url("data:image/svg+xml;base64,<BASE64_IMAGE_STRING>");
}

Define the absolute or relative path to image:

document-reader::part(hint-next-page-back-passport-single-icon)::before {
    background-image: url("https://pictures.com/some_image.png");
}

Icon resizing

document-reader::part(hint-status-search-icon)::before {
    width: 30px;
    height: 30px;
}

For more details, see the Customize Icons instructions.