Versions Compared

Old Version 1

changes.mady.by.user Tan Rong Wei

Saved on

compared with

New Version Current

changes.mady.by.user Tan Rong Wei

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Problem (Issue) Statement:How to modify the secret key for static QR code in xPortalNet software
Description:

This article will guide a technical user to modify the secret key for static QR code in xPortalNet software.

The site admin usually would change the secret key when the key is tampered with or when they want to change the default secret key of QR code. It is, however, recommended to change the default secret key of QR code for security purposes.

After modifying the QR secret key, the door parameters need to be downloaded to Q series controller so the key stored in controller match with the key that is set in software. This secret key is encrypted to ensure secure communication between the controller and the software.

Related Software:xPortalNet
Related Hardware:Q series controller, MicroEngine QR Code reader (Q80MS, Q81MS)
System Application:NIL
Symptom and Finding:NIL
Cause:For first time guide to modify the secret key for static QR code in xPortalNet sofware.
Solution:


Warning
titlePre-requisites / requirements

  1. MicroEngine software that support QR Code feature.

  2. Email notification settings MUST be configured in xPortalNet Server software to allow any notification to be sent to staff with Static QR code via email. Refer to How to Configure the Email Notification in xPortalNet Software article to configure email notification setting.

  3. Staff record or visitor record with Static QR code type in xPortalNet.

.

.

Summary:

.

Step-by-step Guide:

  • Anchor
    Section1
    Section1
    Modify secret key for Static QR code in System Properties:

Step 1: Login to xPortalNet Server software. Then, go to Server Admin > System Properties.

.

Step 2: In System Properties window, click Modify.
System Properties Window
Figure 1: System Properties window.

.

Step 3: In Edit System Properties window, go to Miscellaneous > QR Code. Then, edit the Secret Key for Static QR Code. Click OK to save the settings.
Modify Static QR Code Secret Key in System Properties - QR Code Settings
Figure 2: Modify Static QR Code Secret Key in System Properties - QR Code Settings

.

Step 4: The software will prompt users to go to xPortalNet Client to download the door parameters to the controller(s).
Please go to xPortalNet HS Client Software to Download the Settings Message
Figure 3: Please go to xPortalNet HS Client Software to Download the Settings Message

.

Step 5: In the mean time, the software will send a “Access Badge Updated“ email to all staffs and visitors with Static QR Code type. This email contains a new QR code image that can be used to obtain a valid door access after the door settings (door parameters) are downloaded to controller.
Access Badge Updated Email Sent to Staff with Static QR Code
Figure 4: Access Badge Updated Email Sent to Staff with Static QR Code

.

.

  • Anchor
    Section2
    Section2
    Download secret key to Q series controller:

After modified the QR secret key in xPortalNet Server, the key needs to be downloaded to controller(s) by sending door parameters through xPortalNet Client to apply the changes.

Step 1: Login to xPortalNet Client software. Then, go to Device Comm > Send Door Setting.

.

Step 2: Select controller(s) and click Door Parametersbutton to download door parameters.
Send Door Parameters in Send Door Controller Settings Window
Figure 5: Send Door Parameters in Send Door Controller Settings Window

.

Step 3: Make sure that QR code settings are sent to controller(s) successfully.
Delivery Report Window Showing All Send Data OK
Figure 6: Delivery Report Window Showing All Send Data OK

.

Step 4: Click button Close to close the Delivery Report window.

.

Info
titleTips

Users can retrieve door parameters to ensure that the secret key has been downloaded successfully to controller. (xPortalNet Client > Device Comm > Retrieve Device Setting > Door Parameters)
QR Code Settings in Retrieved Door Parameters Communication Result Window
Figure 7: QR Code Settings in Retrieved Door Parameters Communication Result Window

.

.

Step 5: Staffs or visitors should be able to gain a valid access transaction when scan the new QR code at MicroEngine QR door reader.
Valid Entry Access Transaction in Latest Event List
Figure 8: Valid Entry Access Transaction in Latest Event List

.

Note
titleNote

Staff or visitor must use the latest static QR code to get a valid door access. Otherwise, they will get an “Invalid QR Code” transaction which prevent them from entering the premise.


Common Issues:NIL
Documentation Date:04/05/2020 (Rev 1.0)

Status
subtletrue
colourYellow
titleproof-read

...

Section
bordertrue


Column
width100%

Related Articles.

Containing the label "static-qr-code"

Filter by label (Content by label)
showLabelsfalse
max6
showSpacefalse
sortcreation
reversetrue
cqllabel = "static-qr-code" and space = "MKB" and title ~ "!\"How to Modify the Secret Key for Static QR Code in xPortalNet Software\""


.

...

.

Choices for confluence
_id5ed8bcda4f0af40020ec742c