Aspenware Scanning

Owned by Kevin Vogle, created
Last updated: Jun 15, 2023 by Sarah Holst
10 min read

The Aspenware Scanning application integrates into RTP’s access control system and can be used to process online and offline scans.  The application runs on handheld devices running Android kitkat up to version 11 of Android (version 4.4 to version 11) which also have the DataWedge application (typically Zebra devices).  The devices connect via http or https to a server within the resorts internal local area network (LAN) running Aspenware’s Unity API. Unity then communicates to the RTP database on the resorts LAN to verify scanning data and retrieve customer information.  The Unity API can be installed on the existing RTP application server or on another server located within the resort’s LAN.

The devices should be configured on the resorts local area network (LAN) and not a through a public wireless access point.  The devices should not have access to the internet, and it is the resorts responsibility to secure access to the scanner data and network traffic. It is also recommended to disable Bluetooth and any cellular networks on the device.

There are 3 main aspects of this solution, 1) Android Device (AWScanning.apk), 2) Unity, and 3) RTP

Settings Overview

The Aspenware Scanning application settings allow configuring the device behavior on the Login page and when scanning barcodes and reading RFID media cards.  The Login page can be configured to require scanning barcodes/RFID cards in order to sign-in as well as to require the user of a valid RTP UserID.  To gain access to the device settings, manually enter or scan a barcode of the word, ‘SETTINGS’.  This will automatically display the settings page on the device.

 

  1. Web Service – defines connectivity information for the device to connect to Unity.

  2. Device – defines DeviceID as well as behavior of the Login page.  See below for more info on each setting.

  3. Sound Settings – defines sound and vibration settings for offline, validate only and live  scans.  See below for more info on sound settings.

  4. UHF Scan Settings – only displays on a device that is configured to use UHF.  These settings control the default trigger mode, range of the UHF reader and RFID conversion type.  See below for more info on each setting.

 Settings - Web Service

  1. The web service URL must be entered in the following format including the trailing slash:  https://<servername>/Unity/ (i.e. https://aspenwarecommerce.net/UnityProd/)

  2. Client Id – defined during implementation. Do not change.

  3. Client Secret – defined during implementation. Do not change.

Settings - Device Settings

The login page is configurable through Device Settings to allow the following options.

  1. Device ID – defines the ID used to record scans in RTP.  Recommend defining a unique Device ID per device.

  2. Require Location Scan – determines whether user can manually select Access Location or if scanning a barcode is required to sign-in.  If set to Y, user must scan a valid AccessLocationCode from RTP (i.e barcode of 100, 110, 120, etc.)

  3. Validate UserID – determines whether username is a validated against RTP.  If enabled, a valid RTP UserID must be used to sign-in.

  4. Force Login Scan – determines whether a user must scan a pass media barcode or read an RFID card to sign-in.  If enabled, the RTP IPCode the pass belongs to must be added to a UserID in Admin/Security Administration/User in RTP:

  5. Enable Add Customer ID –enables functionality to allow operator to enter an RTP Customer ID (IPCode) when a certain RTP Access Error is returned as a scan result.  After entering customer ID, a new scan will be triggered that appends the {CustomerID} to the end of the previously scanned code.

  6. Customer ID Scan Code – click to enter a specific RTP Access Error ‘Error Message’ for the Enable Add Customer ID functionality.  This will be the only RTP Access Error that will trigger this functionality to allow an operator to enter a Customer ID (IPCode).  For example, ‘Bad Type’ is entered below so when this scan result is returned to the scanner, the ‘Add Customer ID’ option will display allowing the operator to enter an RTP IPCode.

    After scan occurs that returns this type, the Add Customer ID button appears:

     

    Which allows the operator to enter data which then gets appended to the previously scanned code and triggers a new scan:

    Date entered gets appended (444 was entered to trigger the scan below:

     

Settings - Device Settings

Adjust Date Format settings to allow the device to display different date formats.

Settings - Sound Settings

Sound settings define the sound generated for an Offline, Validate Only and Live Scan on the device.  Several sounds are delivered in each category and custom sounds can also be uploaded as of v1.14 of the app. You can also define whether the device vibrates with each type of sound by checking the Vibrate checkbox.

 For Live Scans, ‘Beep’ settings are used to map to valid and invalid scans from RTP Access Rule Product Type administration.  Settings for 1 and 3 Beeps are delivered with the device and map to a valid and invalid scan from RTP (3 is always an invalid scan in RTP).  Additional Beeps can be added which map to RTP’s Access Rule Product Type administration entries.  To add new Beeps, click the ‘New Setting’ button below and define an un-used Beep Count, Sound and Vibrate setting.  ‘4 Beeps’ has been added in the screen shot below.  After adding a new setting, you must click the ‘Save Settings’ button.

 

To upload custom sounds, place a .wav file in the devices Notification directory and select the custom sound file when defining new beeps or when editing the Offline and/or Validate Only settings. For example, in the screen shots below, the ‘LightningSound.wav’ was uploaded to the device making it available to select through the app.

 

Settings - UHF Scan Settings

The UHF Scan Settings are configurable to allow adjusting the default behavior of the trigger, the transmit power of the device as well as the type of RFID’s populated into the device.

  1. Trigger Mode

    1. Barcode and RFID – allows the scanner to scan barcodes and read RFID tags.  When this is enabled, a barcode will be read first even if an RFID tag is in range.

    2. RFID Only – only allows the scanner to scan RFID tags.

  2. Use Max Transmit Power – impacts the range of the scanner.  When enabled, the max range of the device will be used to scan RFID tags.  The max range for the Zebra MC3300 is 270 but this can differ per device.  This value is a numeric value that relates to a dBm value (decibels with reference to one milliwatt.)  The Zebra MC3300 has a range of 0-30 dBm so a value of 270 is equivalent to 30 dBM.

    1. Transmit Power – used when Use Max Transmit Power is disabled and defines transmit power other than the max value.  It is likely that this setting will need to be adjusted for each customer to find the optimal setting.  A lower value (i.e. 30 or 50) makes it easier to scan a specific tag while a higher value allows reading tags from greater distances.

  3. Set Tag Population – enabled or disabled.

    1. Tag Population – if Set Tag Population is enabled, this value defines the estimated number of tags that will be in range of the scanner.

  4. Convert IDs to Base 32 – enabled or disabled

    1. If enabled, Id is converted to Base 32 (i.e. 1OG000B706016C1N1R02)

    2. If disabled, Id is Base 16 (i.e. E28068900000000163F009B9)

  5. Use TID Memory Bank – enables the application to use the value stored in the TID memory bank instead of the default tagId. Typically ‘Convert IDs to Base 32’ is also selected when this is enabled.

  6. Use EPC Memory Bank – enables the application to use the value stored in the EPC memory bank instead of the default tagId. Typically ‘Convert IDs to Base 32’ is also selected when this is enabled.

Login Page

Based on how Login Settings are defined, the login page will appear with various options.

  1. Login page requiring Login Scan but not a Location Scan. User must manually define the Access Location Group and Access Location:

  2. Login page requiring a Location Scan.  Click the Scan Location Barcode button to then scan an AccessLocation code.

     

  3. Login page after scanning a location barcode.  Tap ‘Log In’ to then sign-in.

     

Scanning Functions

After successfully signing in, the device is ready to scan tickets and passes using the barcode or RFID reader.  Barcodes can also be manually entered using the device keyboard if the barcode is unreadable by the device. 

  1. Scanning Tickets

    1. Valid Scan - Reading RFID:

    2. Invalid Scan – Scanning barcode:

    3. Access Info button – displays summary information and previous scans

    4. Hotlist button – allows hotlisting a ticket.  Click the ‘Active Pass’ dropdown to then select a hotlist reason.

       

    5. To Un-Hotlist – access the same page and select the ‘Active Pass’ hotlist reason.

  2. Scanning Passes

    1. Valid scan using RFID

    2. Invalid scan using RFID:

    3. Valid Pass Media Barcode scan:

    4. Media Info button – displays media information and allows Activating/Inactivating and Hotlisting Pass Media Code.  Highlight an Inactive row to then Activate the media or select Hotlist to hotlist the Pass Media Code.

    5. Access Info button – displays a summary of the Access Code used for validation along with current Hotlist Status.

      1.  All Scans – displays scan history of Access Code.  Click Hotlist to hotlist the Access Code.

      2. Access Profiles – displays list of customers Access Profiles.  Highlight any row in the list and then click All Scans to see a summary and scan history of that Access Code.

Validate Only Mode

Select Validate Only to check if a pass or ticket is valid for a date and time.  Scanning in Validate Only mode will not count as an actual scan on the ticket or pass.

Offline Mode

The application will automatically go into Offline mode when connectivity to the Unity server is not available.  A unique offline sound will occur for each scan.  Offline scans will accumulate until the device is back online and scans will automatically be uploaded in the back-ground while not interfering with new online scans.

 It is possible to login to the device when in offline mode.  The list of Access Locations on the login page is cached on the device allowing users to select locations before logging in.  It is not possible to login while in offline mode if the Device Setting, ‘Validate UserID’ is enabled.

  1. Scan occurring in Offline Mode:

  2. Logging off when offline scans exist – the user will see the following messages when logging-off of the application when offline scans exist:

  3. Logging back in when offline scans exist – offline scans will automatically begin uploading when logging in to the device but will not interfere with new online scans.

  4. Message displays indicating offline scans have been processed successfully

  5. RTP Access Profile summary showing ‘Batch Scan’

 

Other Features

  1. Review previous 10 scans – swipe left and right on the scan results page to see previous 10 scans.  The screen shot below shows the user swiped back to the 5/10 scan.

  2. Click customer photo to enlarge image