Planon Extension - Visitor Check-In

Introduction

This document outlines the functionality of the ‘Extension for Visitor check in’ app.

The Visitor check in app contains a web page that allows both internal and external visitors to check in and check out at the office themselves. It also supports self-registration of new visitor records when enabled. The page can be accessed using a link and passing an access key in the URL.

Check in and check out can be done both by using a QR code or by manually searching for the visitor name. The app also supports self registration, where you can register yourself as a visitor

Prerequisites

Environment

This app is designed to work with Planon L96 and above.

Constraints

  • The webpage is intended to show the visitors for the current day only

  • The webpage is designed to be shown on tablets / kiosk devices

  • The webpage only supports browsers as supported by the Planon core product (see supported configurations)

  • The webpage shows a fixed set of fields. Below is the set of Business Objects and respective fields which are visible on the screen:

  • Visitor

    • Name

    • Host

    • Start / end time

Required (free)fields

  • When the NDA signing feature is used a FreeField of type ‘image’ is required to store the visitors autograph.

Assumptions

N/A

Features

This chapter describes the features of the visitor check-in app.

QR code check in

The app allows visitors to check in using a QR code. This QR code should contain the unique value of the configured visitorLookupField (default: Syscode). Generating a QR code can be done using the Planon app ‘Extension for QR code generator’.

Manual check in

The app also allows for visitors to manually search for a visitor record and check in. Search can be done based on name or email address.

Require visitor to sign NDA

It is possible to require external visitors to sign an NDA / visitor agreement before being able to check in. The autograph will be stored on the visitor record. External visitors are visitors that have a ‘visiting’ reference (PersonRef) filled out.

QR code check out

The app allows visitors to check out using a QR code. The scanned value is resolved using the configured visitorLookupField. The visitor must be in Arrived status and will then be transitioned to Departed.

Manual check out

Visitors can also check out by searching manually on name or email address. The app searches only visitors for the current day that are in Arrived status.

Self registration

When self-registration is enabled, visitors can create their own visitor record directly from the kiosk page. The flow requires:

  • Full name
  • Visiting date
  • Property
  • Person

After successful registration, the new visitor is transitioned to Registered and a confirmation page is shown.

When multiple properties are configured, the visitor first selects a property. The person list is then filtered for that property when the Person business object contains a property reference.

Configurable home screen flow

The startup screen is configurable:

  • showWelcomeScreen=true: starts with Welcome.
  • showWelcomeScreen=false and enableRegistrationPage=true: starts with Self Registration.
  • showWelcomeScreen=false and enableRegistrationPage=false: starts with Check-In or Check-Out based on enableCheckInCheckOut, and uses QR or Manual based on enableQRCodeCheckIn.

How does it work?

This chapter contains the functional and technical description of the features.

Functional behavior

  • Property scope is taken from URL parameter propertyCode when provided; otherwise the configured propertyCodes setting is used.
  • Manual check-in searches visitors in Registered status for today and transitions to Arrived.
  • Manual check-out searches visitors in Arrived status for today and transitions to Departed.
  • QR check-in and QR check-out use visitorLookupField to find the visitor and then perform the same status transitions.
  • If NDA signing is enabled, external visitors must sign before check-in is completed.
  • Successful check-in, check-out, and self-registration all show a confirmation page and automatically restore the default screen.

Deployment

Once the app is installed and activated, a webpage must be configured through the following Planon TSI ‘Web configuration’ to be able to create and configure a webpage that shows a list of visitors.

Most likely the URL will have to be accessed using an access key. In this case a parameter ‘accesskey=<your key here>’ has to be appended to the URL. Please refer to the Planon web help on how to create an access key.

Installation

This chapter describes the steps required to install this app on your Planon environment.

Installation Process

There are two ways to install the app:

  1. Using the Marketplace
  2. Manual installation

Install the app by using the marketplace

In case your environment is configured to use the Planon app store the only thing required to install the app is to add the app license in the AppCenter TSI. Planon will automatically download and install the app.

AppCenter Marketplace Installation

Manual installation

In case you want to perform a manual installation follow the steps below.

  1. Open AppCenter TSI from Planon webclient and click on install from action menu

AppCenter Installation

  1. Browse to the .ppk file

Browse ppk file

  1. Click OK to install the app and follow the installation process
  2. When the app is successfully installed, the app will appear in the AppCenter

Installed App

  1. Add the app license in Apps TSI

Add App License

Translations

It is possible to provide a translation for any visible text in the app. Translations can be provided in the AppCenter TSI.

  • Select the app
  • Drilldown to Details selection step
  • Select the Translations selection level.

Activation

Once the app has been configured, you can activate the app by pressing the Active status transition from the action panel. Always make sure that the required User groups are linked correctly and the Configure action is executed before activating the App.

AppCenter App Activation

Configuration

PSS Module

In order to add/configure the PSS - Visitor Check in module to Planon, follow the below steps described.

  1. Navigate to the TSI with name TSIs.

  2. Find the TSI ProCenter modules – Web configuration.

  3. Select the TSI and set it to under construction.

  4. Click on the Add action as shown below

  5. Add the step ‘VisitorCheckIn’ to the selected list

  6. Set the TSI back to completed.

  7. Logout and Login to Planon

  8. Navigate to the Web configuration TSI and selection step VisitorCheckin.

  9. Now you can add a new definition of your PSS Module in the Web configuration TSI and fill the setting as needed in General tab. More information about settings can be found in the further chapters.

  10. Visit the webpage by pasting the URL or clicking on the link icon

  11. The url can be extended with param propertyCode which is used to pass codes of property. When this param is passed, the setting propertyCodes is ignored. This feature is available from version 1.4.0

System images configuration

This apps make use of system images that is shown within the welcome screen. This can be configured as follows:

  1. Navigate to the ‘System images’ TSI
  2. Add a new System images record with the following name ‘VisitorCheckInLogo’.

Note : Logos can be downloaded here Planon Dark Theme Logo

Planon Default Logo

PSS Module settings

This chapter describes and explains the settings that are available for this app.

Description of settings

SettingExplanation
cameraThe camera to use on the QR check in page. Use ’environment’ (without the quotes) for the back facing camera and ‘user’ (without the quotes) for the front facing camera.
defaultExpectedTimeOfDepartureDefault value to show when the ‘Expected time of departure’ is empty on the Visitor record. Default value is: ?
enableCheckInCheckOutSet to yes to use check-in as default home flow when welcome screen is disabled. Set to no to use check-out as default home flow.
enableNDASigningSet to yes to ask external visitors to sign an NDA before checking in
enableQRCodeCheckInSet to yes to enable QR code based check-in and check-out functionality
enableRegistrationPageSet to yes to show self-registration as home screen when welcome screen is disabled
ndaTextThe NDA text to be displayed. Only needed when NDA signing is enabled.
propertyCodesProvide the property codes (comma separated) for which this visitor check-in definition should work. This is a security measure to prevent visitors registered for Property A checking in at Property B. This can be overridden with url param ‘propertyCode’
showWelcomeScreenSet to yes to display a welcome screen.
visitorSignatureFieldThe system name of the FreeField (type image) in which the signature should be stored. Only applicable when NDA is enabled.
visitorLookupFieldThe system name of the field that is used to retrieve the visitor when checking in with a QR code. So for example, if the QR code contains the visitors syscode, this should be set to the field ‘Syscode’. The value in this field should be unique for the Visitor BO.

Troubleshooting

Error handling

  • Errors are recorded in the server logs:
    • Tomcat log for web components
      • Webpages
      • PSS modules
      • Stepview
      • TSI Action
      • JAX-RS webservices
    • Wildfly log for server-side components
      • Business rules
      • Scheduled tasks
      • Workers
      • Event Connector
  • UI components (TSI Actions) also display errors in the interface