Guide to migrate configuration¶
Description¶
The following table compares the configuration variables from previous major versions of the SDK with the current one:
Note that the following configuration variables are only those that fit the new ones. To check all configuration variables for the current SDK, see the configuration documentation.
Reference map¶
does not apply means that the previous major version's SDK config variable does not match any config variable in the current SDK version.
name + PART means that the configuration variable from previous versions, can be set by the new PART configuration system. For more information see the CSS Parts customization section of the documentation.
The path pattern means that the configuration variable from previous versions, can be set by the following variable that represents the path in the configuration schema, if you are using a
config.jsonfile just follow the intellisense provided by theschema.jsonfile in the assets. If you are using an object, please ensure that this object match configuration's interface.
For more information see the configuration section of the documentation, you could also find an example in the setup section at the configuration input
Migration guide for REACT versions¶
| Old configuration parameters | Old default values parameters | New configuration | New default values |
|---|---|---|---|
| borderColorCenteringAidDetecting | - | does not apply (*) | - |
| borderColorCenteringAidInactive | #717171 | vd-video::part(capture_glowing_outline_container) {border: 30px solid #a830cc;} |
#FFFFFF |
| borderThickness | 6 | vd-video::part(capture_glowing_outline_container_success) {border: 30px solid #a830cc;} vd-video::part(capture_glowing_outline_container_detection) {border: 30px solid #a830cc;} vd-video::part(capture_glowing_outline_container) {border: 30px solid #a830cc;} |
border-width: 4px; |
| closeButton | false | generic.common.ui.buttons.close.show | false |
| infoFaceRecording | Please say your first and last name Diga su NOMBRE y APELLIDOS |
sdkVideo.views.capture.guidance.nameAndSurname.card.title | ES: Diga su nombre y apellidos en voz alta EN: Say your first and last name out loud |
| infoFaceRecordingRandomNumber | - | does not apply (*) | - |
| infoReverseRecording | And now the BACK Y ahora la parte TRASERA |
sdkVideo.views.capture.guidance.preCapture.reverse.card.title | ES: Muestre la parte TRASERA del documento en la CÁMARA FRONTAL EN: Show the BACK of the document to the FRONT CAMERA |
| infoObverseRecording | Please show the FRONT of the document Muestre la parte DELANTERA del documento |
sdkVideo.views.capture.guidance.preCapture.obverse.card.title | ES: Muestre la parte DELANTERA del documento dentro del recuadro en la CÁMARA FRONTAL EN: Show the FRONT of the document to the FRONT CAMERA |
| confirmationColorTick | #737373 | vd-video::part(capture_success_tick_circle) {stroke: #a8329d; fill: none;} |
stroke: #53A335; fill: none; |
| customConfirmationImageTick | - | does not apply (*) | - |
| detectionTimeout | 300000 | sdkVideo.views.capture.detectionTimeout | 120000 |
| continueText | - | does not apply (*) | - |
| displayErrors | - | does not apply (*) | - |
| errorActionButtonBackgroundColor | - | does not apply (*) | - |
| errorActionButtonTextColor | - | does not apply (*) | - |
| errorDisplayBackgroundColor | - | does not apply (*) | - |
| errorDisplayTextColor | - | does not apply (*) | - |
| errorDisplayUserActionShow | - | does not apply (*) | - |
| errorDisplayIconColor | - | does not apply (*) | - |
| fontSize | - | does not apply (*) | - |
| infoAlertShow | - | does not apply (*) | - |
| infoAlertShowVideo | - | does not apply (*) | - |
| infoModalShow | true | sdkVideo.views.instructions.active | false |
| isInfoModalShow | - | does not apply (*) | - |
| infoAlertVideoSelfie | - | does not apply (*) | - |
| logEventsToConsole | false | generic.common.behavior.web.logEvents | false |
| sdkBackgroundColorInactive | #2E2E2E | vd-video::part(instructions_slide) | #FFFFFF |
| dataSaveMode | - | does not apply (*) | - |
| setLandscapeDeviceMessage | - | does not apply (*) | - |
| setPortraitDeviceMessage | Please, hold the device in portrait mode Por favor, ponga el dispositivo vertical |
sdkVideo.views.deviceRotated.card.title | To continue, put the phone in VERTICAL orientation Para continuar, coloque el teléfono en orientación VERTICAL |
| showLogo | false | generic.common.ui.logo.show | true |
| customLogo | "" | generic.common.ui.logo.media | /images/veridasLogo.png |
| targetSelector | - | does not apply (*) | - |
| videoErrorConstraint | - | does not apply (*) | - |
| videoErrorConstraintActionLabel | - | does not apply (*) | - |
| videoErrorDefault | Sorry, there was an error starting the camera Lo sentimos, se ha producido un error iniciando la cámara |
does not apply (*) | - |
| videoErrorExternalInput | - | does not apply (*) | - |
| videoErrorNotFound | Please check that you do not have any software simulating the camera Por favor, compruebe que no tiene ningún software simulando la cámara |
does not apply (*) | - |
| videoErrorPermission | Please allow the page to access the camera Por favor, permita a la página acceso a la cámara |
sdkVideo.views.feedback.errors.videoErrorPermission.card.title | Please, make sure to allow the page access to the camera and microphone Por favor, asegúrese de permitir a la página acceso a la cámara y micrófono |
| videoErrorPermissionActionLabel | - | does not apply (*) | - |
| videoErrorUnavailable | - | does not apply (*) | - |
| videoErrorUnavailableActionLabel | - | does not apply (*) | - |
| webrtcUnsupportedText | - | does not apply (*) | - |
| detectionMessageBackgroundColor | #737373 | vd-video::part(capture_display_message) { background-color: #b300ff } |
#FFFFFF |
| detectionMessageTextColor | #FFFFFF | vd-video::part(capture_display_message_text) { color: #8f7c00 } |
#000D44 |
| detectionMessageBackgroundColorVideo | #737373 | vd-video::part(capture_display_message) { background-color: #b300ff } |
#FFFFFF |
| detectionMessageTextColorVideo | #FFFFFF | vd-video::part(capture_display_message_text) { color: #8f7c00 } |
#000D44 |
| infoUserSliderButtonText | START COMENZAR |
sdkVideo.views.instructions.buttons.startProcess.text | Start Comenzar |
| forceAlternativeVideoRecorder | does not apply (*) | - | false |
| infoUserVideoMedia | helpIconDocumentCenter | sdkVideo.views.instructions.card.media.video | [ "/images/document1.svg", "/images/document2.svg" ] |
| infoUserVideoBackgroundColor | #E4F6F6 | vd-video::part(instructions_slide_box) { background: #7b98ff } |
#FFFFFF |
| infoUserVideoBackgroundColorTop | #26BAB8 | vd-video::part(instructions_slide_box) { background: #7b98ff } |
#FFFFFF |
| infoUserVideoBackgroundColorButton | #26BAB8 | vd-video::part(instructions_slide_button) { background: #ff39ee } |
#000D44 |
| infoUserVideoTextColor | #0E4645 | vd-video::part(instructions_slide_box_subtitle) { color: #89ff4a } |
#424242 |
| infoUserVideoFontSize | - | does not apply (*) | - |
| infoUserVideoTextColorButton | #051717 | vd-video::part(instructions_slide_button) { color: #40ff00 } |
#FFFFFF |
| infoUserVideoPaddingButton | 2% 10% | vd-video::part(instructions_slide_button) { padding: 20px } |
auto |
| infoUserButtonTextColor | - | does not apply (*) | - |
| infoUserButtonBackgroundColor | - | does not apply (*) | - |
| infoUserVideoTitle | 1. Please say your NAME and SURNAME when prompted 2. Show the FRONT part of your document 3. Show the BACK of your document 1. Diga su NOMBRE y APELLIDOS cuando se le solicite 2. Muestra la parte DELANTERA de su documento 3. Muestra la parte TRASERA de su documento |
sdkVideo.views.instructions.card.subtitle.video | ES: [1. Centre su cara en el marco, mire hacia la cámara y no sonría. 2. Diga su nombre y apellidos en voz alta cuando se indique en pantalla, Muestre el documento a cámara, primero la parte delantera y luego la parte trasera, como se indica en pantalla,] EN: [1. Center your face within the frame and do not smile. 2. Say your first and last name out loud when prompted on screen, Show the document to the camera, first the front and then the back, as indicated on the screen,] |
| videoErrorExternalInputLabel | Retry Reintenta |
does not apply (*) | - |
| customOval | - | does not apply (*) | - |
| customOvalBorderRadius | 51% 49% 49% 51% / 33% 32% 68% 67% | vd-video::part(capture_glowing_outline_container_detection) {border-radius: 2px} vd-video::part(capture_glowing_outline_container) {border-radius: 2px} vd-video::part(capture_glowing_outline_container_faceNotCentered) {border-radius: 2px} |
20% |
| errorBoxBackgroundColor | - | does not apply (*) | - |
| errorBoxTextColor | - | does not apply (*) | - |
| errorBoxTitle | - | does not apply (*) | - |
| errorBoxButtonColor | - | does not apply (*) | - |
| errorBoxButtonText | - | does not apply (*) | - |
| errorBoxButtonTextColor | - | does not apply (*) | - |
| obverseDocumentErrorBoxSubTitle | - | does not apply (*) | - |
| reverseDocumentErrorBoxSubTitle | - | does not apply (*) | - |
| resetVideoBoxSubTitle | - | does not apply (*) | - |
| recordingTimeStates | - | does not apply (*) | - |
| smartRecordingTimeStates | - | does not apply (*) | - |
| faceDetectionTime | - | does not apply (*) | - |
| faceWarningDelayTime | - | does not apply (*) | - |
| videoRecordingMaxTime | - | does not apply (*) | - |
| faceErrorBoxSubTitle | - | does not apply (*) | - |
| obverseDocumentWarningDelayTime | - | does not apply (*) | - |
| reverseDocumentWarningDelayTime | - | does not apply (*) | - |
| videoToken | - | does not apply (*) | - |
| enableVideoToken | - | does not apply (*) | - |
| ovalFaceDetectionColor | #00FF00 | vd-video::part(capture_glowing_outline_container_detection) {border-color: #f2f2f2} vd-video::part(capture_glowing_outline_container) {border-color: #f2f2f2} vd-video::part(capture_glowing_outline_container_faceNotCentered) {border-color: #f2f2f2} |
#257CD0 #ffffff #f2f2f2 |
| confirmationDialogBackgroundColor | - | does not apply (*) | - |
| confirmationDialogTextColor | - | does not apply (*) | - |
| confirmationDialogButtonPadding | - | does not apply (*) | - |
| confirmationDialogLinkTextColor | - | does not apply (*) | - |
| confirmationDialogButtonBackgroundColor | - | does not apply (*) | - |
| detectionStageCustomLogo | - | does not apply (*) | - |
| backgroundColorEffectMessage | - | does not apply (*) | - |
Migration guide for new configuration schema v5.1.Z and above¶
The version family v5.1.Z and above has schema changes, this changes are reflected in the following table, use the reference to make the changes in your configuration input object or file.
Generic important changes:
- The legacy and deprecated nodes have been removed. Therefore, when utilizing the schema.json file as the schema for your config.json file, ensure that there are no warning messages in the editor to prevent configuration initialization errors.
- The
generic.feedbacknode has been moved to each SDK node in order to have more specific feedback per SDK. - The
generic.common.ui.successTicknode has been moved to each SDK node. - Some
generic.common.behavior.webnodes has been moved to each SDK node(pathAssets, detectionTimeout). - The
selectCameraparemeter has been deleted.
Specific Video important changes:
generic.common.ui.successTickmoves tosdkVideo.views.capture(document obverse and reverse success tick will be configured as the same element, selfie and nameSurname stages do not show successTick element).sdkVideo.views.deviceRotated.onOrientationshould use alandscapedefault value.sdkVideo.views.deviceRotated.card.mediashould use a portrait.gif(this gif should recommend to rotate the device to the portrait position).sdkVideo.views.capture.feedbackmoves tosdkVideo.views.feedback, this node will include the generic and specific errors and feedbacks but should maintain the guidance for the capture stages.generic.feedbackmoves tosdkVideo.views.feedback, the errors also has been reorganized to be more specific to each sdk with the generic errors included(this will be more clear on the task execution check other tasks with feedback references).- Removed
sdkVideo.blurDetectorActive. generic.commom.behavior.web.(pathAssets, detectionTimeout)moves to sdkVideo, in order to place each property with a better orderpathAssetswill move tosdkVideo.pathAssets,detectionTimeoutwill move to thesdkVideo.views.capture.