Hello, how can we help you?

Search

ONARKEN® Documentation

Locker Management Software

Locker Management

See all articles
How to disable asset AI detection in my locker bays?

Asset AI detection for Sovran™ Smart Lockers in the ONARKEN® management system can now be turned off. This can be used in cases when you would prefer to have a more trust based system with photos taken for evidence.
 

Required Permissions

To configure AI detection for your Sovran™ locker bays, you must have the installations.toggle_ai_detection permission.  

Steps to configure asset AI detection:

  1. Log into your ONARKEN account. 

    Ensure you are using an account with the necessary permissions.
     

  2. Navigate to your smart locker installation you wish to configure. 
     
  3. Click on a bay on the locker map, which will take you to the bay management screen. Then click the options drop down.

    1. Alternatively, go to the Manage Bays panel, and click the 'Options' drop down. 


  4. Click the 'Disable AI detection' option. You will see the icon get removed from the bay on the locker map, and the feature removed from the Manage Bays panel. An alert will be displayed at the bottom right of the page. 


     

  5. To enable AI detection, simply reverse this process. The options drop-down will have an 'Enable AI detection' option. 

When AI detection is disabled for a bay, the locker camera is still enabled to take pictures. This will still allow you to review deposited and returned items on the ONARKEN­­­­® Management Platform. Pictures will still be taken after transactions, and by request by pressing the 'Take photo' button on the 'Manage bay' screen. 

See more
How can I configure a screen saver video?

The ONARKEN® Smart Locker software now plays a screen saver video while the Smart Locker is left idle. There is a video that will play as default but you can customise this and add your own video to play instead. 

Using a screen saver help to prevent screen burn-in and allows you to advertise events, display help videos, advertisements or showcase other information to your users. 

Screen savers are available on the following products:

  • Diplomat™ Pro
  • Sovran™
  • Envoy™
  • Consul™

Here are the screensaver videos we provide as default with the ONARKEN® client software.
 

Diplomat™ Pro and Consul™:

Preview:

Adobe Express - Diplomat Screen Saver.gif

Download link: Diplomat Pro™ screen saver
 

Sovran™:

Preview:

Adobe Express - Sovran Screen Saver.gif

Download link: Sovran™ screen saver
 

Envoy™: 

Preview:

Adobe Express - Envoy Screen Saver.gif

Download link: Envoy™ screen saver
 

For guidance on sizing and formatting your video file to use as a screensaver, please read this article: What size background image/video should I use?

To customise the screen saver video, please follow the instructions in the slide show below:

 

 

See more
How can I update the expiry date of a user's card number in ONARKEN®?

Users can have several card numbers created and assigned to them to login at the Smart Locker. User cards are not required to have an expiry date at the time of creation, but an expiry date can be applied regardless of if one was set at the time the card number was created. 

 

Required Permission

To perform this action, the user will require the permission users.delete_codes
 

Prerequisites

The User must have at least one user code associated with their account on ONARKEN®.


Steps to update the user code expiry date

From the sidebar, navigate to the Manage section and click 'Users'. On the 'All Users' tab, select the 'View user' button. 

view_user_censored.webp

After clicking the 'View user' page, a new 'Manage expiry' button will be displayed to the right of the users credentials, for all ID codes they have associated with their account. 

Once you have clicked 'Manage expiry', this pop-up will show. 

Click the date field and select an expiry date from the drop-down calendar. 

Then click 'Update expiry' and the new end date will be saved to the users account. 

See more
What size background image/video should I use?

With ONARKEN® Smart Lockers, you can create bespoke screen designs to personalise the locker interface and align it with your organisation’s branding.

As part of the screen design, the home screen background can be either a static image or a video.

The required dimensions for your background image or video depend on the specific Smart Locker model you have.

 

Background Image and Video Dimensions

Product  Screen Size Resolution (in px) Background size (in px) Screen saver size (in px) Orientation
Diplomat™ Pro Screen size: 19" 1280 x 1024 1280 x 785* 1280 x 1024 Landscape
Consul™ Screen size: 19" 1280 x 1024 1280 x 785* 1280 x 1024 Landscape
Diplomat™ LITE Screen size: 15" 1024 x 768 1024 x 616* 1024 x 768 Landscape
Sovran™ Screen size: 12" 1080 x 1920 1080 x 1820* 1080 x 1920 Portrait
Envoy™ Screen size: 7" 1024 x 600 1024 x 600 Landscape

 

*  The reduced image size is to accomodate the status bar at the top or bottom. 

†  Custom background images are not supported on this product

See more
How do I configure a Smart Locker IP Connection Whitelist

The IP Whitelisting feature enhances the security of your ONARKEN® Smart Locker, by restricting API access to specified IP addresses. Only connection attempts from these approved addresses will be allowed, safeguarding the system from unauthorised access.

 

Required Permissions

To perform this action, your account must have the installations.update_ip_whitelist permission.

 

Steps to configure IP Connection whitelist.

  1. Log in to your ONARKEN account.
    Ensure you are using an account with the necessary permissions.

  2. Access the Smart Lockers page.
    From the main menu, navigate to the Smart Lockers page.

  3. Access the required Smart Locker
    From the Smart Lockers page, navigate to the required Smart Locker.

  4. Navigate to the Settings Panel
    Navigate down to the Connection IP address whitelist section.

  5. Configure IP address
    Input the selected IP Address that is required to be added to a whitelist for API connections. Once the IP has been imputed click the + icon to save.

  6. Delete IP address
    To remove an IP address from the whitelist, navigate to the required IP and click on the Trash Can icon.

Once you have followed these steps, an IP address will be configured to connect to the current Smart Locker.

See more
How do I set custom loaning hours on my smart locker?

The Custom Loaning Hours allows you to define specific days and times during which users are permitted to borrow items from the Smart Lockers. This ensures that borrowing activities are restricted to predetermined hours while maintaining flexibility for item returns.

 

Required Permissions

To perform this action, your account must have the installations.configure_loaning_hours permission.

 

Steps to configure Smart Locker Loaning Hours.

  1. Log in to your ONARKEN account.
    Ensure you are using an account with the necessary permissions.

  2. Access the Smart Lockers page.
    From the main menu, navigate to the Smart Lockers page.

  3. Access the required Smart Locker
    From the Smart Lockers page, navigate to the required Smart Locker.

  4. Navigate to Settings Panel
    Once on the settings panel,
    navigate down to the Loaning Hours Section.

  5. Configure Loaning Hours
    Days of the week are listed here with the default loaning hours (24 hours). To remove the option to loan on a certain day, click on the X next to where the times are displayed.

    To set custom hours on for certain days, click on Add button, and navigate to Add Opening Hours. Here you can select the required day of the week and the required times that the locker is available for loans.

  6. Add Exception Dates
    To configure exception dates that ignore the configured rules. Click on the X button, and navigate to Add Exception. Here you can enter a Start and End date for the exception as well as an option for this to be an annual exception.

Once you have followed these steps, the Loaning Hours and Exceptions will be configured for the current Smart Locker.

See more
How can I allow users to report issues with their asset when returning?

When assets are on loan, issues such as damage or functional problems can arise. Allowing users to report these issues when returning items to the lockers is vital for maintaining a satisfied user base and ensuring that faulty assets are not passed on to the next user.

ONARKEN provides a customisable Fault Reporting feature, which can be enabled through Loan Rules. This feature allows you to tailor fault reporting for specific asset types or loan durations, ensuring a streamlined and effective issue management process.

 

Fault Reporting Types in ONARKEN

ONARKEN offers three types of fault reporting, giving organisations flexibility in how issues are logged:

  1. Yes/No Question:

    • Users are simply asked whether there were any issues with the asset.
    • This is quick and user-friendly but leaves issue diagnosis to administrators.

  2. List of Options:

    • If users report an issue, they are presented with a predefined list of issue categories (configured within the Loan Rule).
    • This allows for faster categorisation of problems.

  3. List of Options with a Custom Field:

    • Functions like the List of Options but includes a free-text field for users to describe the issue in their own words.
    • Ideal for detailed feedback but may extend the return process time.

Permissions Required

To enable and manage fault reporting, you must have the loan_rules.edit permission.

Steps to Enable Fault Reporting

  1. Log in to the ONARKEN Management Platform.
    Use your credentials to access the system.

  2. Access the Loan Rules Tab.
    Navigate to Loaning -> Loan Rules.

  3. Select the Rule to Edit.
    Click the arrow icon next to the Loan Rule you wish to modify.

  4. Locate the Fault Reporting Section.
    Scroll down to the Fault Reporting section within the rule.

  5. Enable Fault Reporting.

    • Check the Enabled checkbox.

  6. Configure the Fault Reporting Type.

    • Select the desired fault reporting type:
      • Yes/No Question
      • List of Options (configure the predefined options as required)
      • List of Options with Custom Field

  7. Save Changes.
    Click Save to apply the updated settings.


Benefits of Enabling Fault Reporting

  • Improved User Experience: Ensures that users feel heard and supported when issues arise.
  • Preventive Maintenance: Allows administrators to identify and address problems before they impact subsequent users.
  • Customisation: Tailor fault reporting settings to suit specific assets and loan scenarios.
  • Operational Efficiency: Streamlines the reporting and categorisation of asset issues.
See more
How to assign a user to booking allocations

In ONARKEN, users can be assigned to individual Booking Allocations, ensuring that only the assigned user can collect the designated asset from a specific locker bay. This feature provides precise control over who can access assets reserved for bookings.

 

Default Booking Allocation Behaviour

  1. Unassigned Allocations:
    By default, booking allocations remain unassigned. In this state, they can be collected by any user once they are automatically released after the booking date and time.

  2. Automatically Assigned Allocations:

    • If the booking quantity is one, the booking owner is automatically assigned to the allocation.
    • If an Access Group is selected during the booking process, users in that group are automatically assigned to allocations, ensuring they can access their reserved assets.

 

Steps to Manually Assign Users to Booking Allocations

Follow these steps to assign users to specific booking allocations:

  1. Log in to the ONARKEN Management Platform.
    Use your credentials to access the system.

  2. Locate the Booking.
    Navigate to Loaning -> Bookings and find the booking you wish to update.

  3. Open the Assign Users Tool.
    Click the Assign Users button.

  4. Search for a User.
    Use the search bar to find the user you want to assign to a specific booking allocation.

  5. Assign the User.
    Once you locate the correct user, click Assign.

    • The assigner tool will remain open, allowing you to continue assigning additional users.

  6. Complete the Assignment Process.
    When you’ve finished assigning users, close the assigner by clicking the cross icon in the top-right corner.


Why Assign Users to Booking Allocations?

Assigning users to booking allocations provides several advantages:

  • Ensures accountability by restricting access to specific individuals.
  • Prevents misuse of reserved assets.
  • Streamlines group bookings by pre-assigning users to allocations.
See more
How can a staff member make a bulk booking?

The bookings feature allows staff members to make bulk bookings, ideal for scenarios where multiple assets are needed for a specific date and time. For example, a lecturer can ensure sufficient assets are available for all students attending a lecture.

 

Prerequisites

  1. Bookings Enabled: Ensure the bookings feature is enabled. Refer to the How to enable bookings? documentation for guidance.
  2. Permissions Required: You must have the bookings.make_bulk permission to create bulk bookings.

 

Steps to Make a Bulk Booking

  1. Log in to the ONARKEN management platform.
    Use your administrator credentials to access the system.

  2. Access the Bookings Tool.

    • Click the Quick Action button from the main navigation menu.
    • Alternatively, use the keyboard shortcut /.

  3. Initiate a Booking.
    Click Make Booking.

  4. Select a Location.
    Choose the location where you would like to book the assets.

  5. Choose an Asset Type.
    Select the type of asset required for the booking.

  6. Set the Booking Date and Time.
    Specify when the assets are needed.

  7. Determine the Booking Quantity.

    • If booking for a group of users, select an Access Group. The system will automatically set the booking quantity to match the number of users in the group, and each user will be assigned a booking allocation.
    • Alternatively, manually set the quantity to the number of assets required.

  8. Adjust Installation Settings (Optional).

    • By default, the Book Across Installations checkbox is enabled, allowing your booking to utilise multiple Smart Lockers at the same location for greater capacity.
    • To ensure all assets are booked from the same Smart Locker, uncheck this option. Note that this may reduce the booking capacity.

  9. Complete the Booking.
    Click Make Booking to finalise the reservation.

 

Post-Booking Details

  • If an Access Group was selected in step 7, users in the group will be automatically assigned to individual booking allocations and can collect their assets at the booking time.
  • If you manually set the booking quantity, assets will be released at the booking time for all users unless you manually assign a user to each booking allocation.

 

Relevant articles

How can a user book an asset?

 

 

See more

Drop Off & Collection

See all articles
Custom Asset Reasons in ONARKEN®

ONARKEN® allows you to create custom reasons to specify why assets are stored in your Smart Lockers. It’s common to have a variety of assets in your lockers for multiple purposes — for example:


• Service or repair
• End of life
• New stock
• Employee offboarding


Clearly identifying the reason an asset is in a locker helps ensure it is assigned to the correct user. For instance, you wouldn’t want a faulty laptop to be given to a new starter. It’s essential that your IT teams or locker administrators can easily view each asset and understand its purpose in the locker.


Your ONARKEN® instance comes pre-configured with three default reasons:


• Service / Repair
• End of Life
• Deployment


You can update, remove, or add to these with your own custom reasons, and assign unique locker map colours for easy identification.

 

 

How do I create custom reasons and use them during drop-offs?

 

See more
How do I arrange a Drop Off?

ONARKEN’s Drop-Off & Collection lockers enable assets to be securely dropped off and collected using one-time codes or a user’s ID badge. This feature is designed to facilitate smooth and secure transactions for asset transfers.

 

Permissions Required

To arrange a drop-off, you must have the drop_offs.create permission.

 

 

See more
How to cancel a vend allocation

Sometimes you may need to cancel a vend allocation — for example, if the user has taken too long to collect the item or the stock is needed more urgently elsewhere. To do this, simply follow the steps below.

 

 

See more
Vend Request Allocation Approvals

If a user selects Asset Types that they do not have permissions to access via Access Groups, then a request will be sent to Location Administrators to either approve or reject the request for the Asset Type(s).

 

This process is helpful when you would like users to be able to see items that are available for vending, but you would like an administrator to approve the request before they can have access to it, this approval is for a one off request.

 

See more
How to Arrange a Vend

With the ONARKEN® Management Platform, arranging a vend for users to collect takes just a few clicks. Simply select a location, choose the Asset Types you want the user to collect, and then either share a link to their Vending Ticket or send them a one-time code.
 

See more

User Management

See all articles
How do I change a users role?

Changing a User's Role in ONARKEN® allows you to update a user's permissions and responsibilities within the system. This functionality ensures that users have the appropriate level of access for their role whilst maintaining system security. By changing user roles, you can adapt to evolving organisational needs with ease.

 

Required Permission

To perform this action the user will require the permission users.view and users.set_role to perform this action.

 

Steps to change a users role

  1. Log in to your ONARKEN account.
    Ensure you are using an account with the necessary permissions.

  2. Access the Users page.
    From the main menu, navigate to the Users page.

  3. Find the User
    Find the required user by searching for their name, or using the different available filters.

  4. Change User Role
    Locate the Options drop-down menu and select Role option. Change the users role by selecting the required role from the list of available roles.

    If the required role is not on the list, follow this guide on How do I create user roles?

Related Articles

See more
How do I remove locker admins?

Locker Admins in ONARKEN® management system allows you to assign users as admins to certain Smart Lockers. These Admins have the authority and ability to manually open locker doors using their ID cards. Allowing the admin to manage the Smart locker, and its assets.

 

Required Permissions

To remove locker admins, your account must have the installations.remove_admins permission.

 

Steps to remove locker admins

  1. Log in to your ONARKEN account.
    Ensure you are using an account with the necessary permissions.

  2. Access the Users page.
    From the main menu, navigate to the Users page.

  3. Access the Locker Admins panel.
    From the users page, navigate to the Locker Admins panel.
  4. Update a Locker Admin
    Locate the Admin to remove, and select the Update Lockers button.

    1. Unselect any lockers that they are an admin for.

Related Articles

See more
How do I create locker admins?

Locker Admins in ONARKEN® management system allows you to assign users as admins to certain Smart Lockers. These Admins have the authority and ability to manually open locker doors using their ID cards. Allowing the admin to manage the Smart locker, and its assets.

 

Required Permissions

To perform this action, your account must have the installations.add_admins permission.

 

Steps to add locker admins

  1. Log in to your ONARKEN account.
    Ensure you are using an account with the necessary permissions.

  2. Access the Users page.
    From the main menu, navigate to the Users page.

  3. Access the Locker Admins panel.
    From the users page, navigate to the Locker Admins panel.

  4. Add Locker Admin
    Locate the New Locker Admin button. 

    1. Search for the user to become a Locker Admin.
    2. Select the Smart Lockers for that user to become an admin of.

Related Articles

See more
How do I create a new access group?

Access Groups in ONARKEN® management platform enables you to define, and maintain access groups for specific Asset Types and Smart Lockers. This feature allows you to create new access groups.

 

Required Permissions

To perform this action, your account must have the access_groups.create permission. 

 

Steps to Manage User Access Groups

  1. Log in to your ONARKEN account.
    Ensure you are using an account with the necessary permissions.

  2. Access the Users page.
    From the main menu, navigate to the Users page.

  3. Access the Roles panel.
    From the users page, navigate to the Access Groups panel.

  4. Create an Access Group
    Locate the Create Access Group button.

    1. Enter the access group name.
    2. Select an access group colour.
    3. Select any smart lockers required for the access group.

    4. Select any asset types required for the access group.

    Noting a single access group can have access to everything, or just to one smart locker and asset type.

Related Articles

See more
How do I create a new user role?

User Roles in ONARKEN® management system enables you to define, customise, and maintain roles with specific permissions tailored to users responsibilities. This feature allows you to create new roles.

Role Types

  1. Locker Usage
    Users that have the locker usage role type will only be able complete actions at the lockers and will not be able to login to the ONARKEN Management Platform.
  2. Maintainer
    Users that have the maintainer role type will be able to login to the ONARKEN Management Platform and perform actions that they have been given permission for.
  3. Administrator
    Users that have the Administrator role type will be able to login to the ONARKEN Management Platform and perform all actions with the exception of updating roles and changing a users role.

Required Permissions

To perform this action, your account must have the roles.create permission. To edit roles, your account must have the roles.edit permission. To delete roles, your account must have the roles.delete permission.

 

Steps to create a role

  1. Log in to your ONARKEN account.
    Ensure you are using an account with the necessary permissions.

  2. Access the Users page.
    From the main menu, navigate to the Users page.

  3. Access the Roles panel.
    From the users page, navigate to the Roles panel.

  4. Create a role
    To create a role first click on the Create Role button.

    1. Enter the role name.
    2. Enter the concurrent loan limit
    3. Select the role type
    4. Select the required permissions from the list below.

    Noting certain role types can only have certain permissions.

Related Articles

See more
How do I delete an asset from ONARKEN?

Deleting Assets in ONARKEN® allows you to remove assets that are no longer in use or relevant to your operations. This helps you and your team maintain an organised and efficient system by ensuring that outdated or unnecessary assets are securely and effectively removed from your inventory.

 

Required Permissions

To perform this action, your account must have the assets.delete permission.

 

Steps to delete an asset

  1. Log in to your ONARKEN account.
    Ensure you are using an account with the necessary permissions.

  2. Access the Assets page.
    From the main menu, navigate to the Assets page.

  3. Locate the Asset
    Locate the asset by using the search feature, searching for the asset reference. Or by using the filters to search by asset type or smart locker.


    Once the required asset has is located, located the Trash Can icon and follow the steps on screen.

  4. Not Deletable?
    If there is no Trash Can icon displayed, this means the asset is not able to be deleted. This is because the asset is either in a Smart Locker or on Loan.

Once you have followed these steps, the Asset has been deleted and is not available to be loaned, or in ONARKEN.

See more
How do I create new asset type in ONARKEN?

Asset Types allow you to define and categorise different types of assets within ONARKEN®. This enables you to tailor the system to handle different categories of items, that are stored and used in the Smart Lockers. 

 

Required Permissions

To perform this action, your account must have the asset_types.create permission.

 

Steps to create a new asset type

  1. Log in to your ONARKEN account.
    Ensure you are using an account with the necessary permissions.

  2. Access the Assets page.
    From the main menu inside of the Manage sub-menu, navigate to the Assets page.

  3. Navigate to Asset Types Panel

  4. Add new Asset Type
    To create a new asset locate the New asset type button. Enter in the required Asset Type name and save.

Related Articles

See more
How do I configure smart charging for an asset type?

Managing an Asset Type allows you to customise the settings and properties for a specific asset type within ONARKEN®. This ensures that each asset type is properly defined and managed, enhancing overall tracking and reporting capabilities.

 

Required Permissions

To perform this action, your account must have the asset_types.edit permission.

 

Steps to configure an asset type

  1. Log in to your ONARKEN account.
    Ensure you are using an account with the necessary permissions.

  2. Access the Assets page.
    From the main menu, navigate to the Assets page.

  3. Navigate to Asset Types Panel
    Find the required Asset Type and select it to view.
  4. Navigate to Smart Charging Panel
    To configure Smart Charging click on the Configure button.

    First, you will need to select a Manufacturer from the list of supported manufacturers available. Next, you will need to select the supported model from the list.


    Once both have been selected, it will automatically update and display the list of supported lockers for that asset type.

Related Articles

 

See more
How do I create a new asset in ONARKEN?

Creating Assets allows you to add and define new items or resources within ONARKEN®. These assets represent physical items, such as laptops or tablets, that are stored in the lockers, that are tracked and managed.

 

Required Permissions

To perform this action, your account must have the assets.create permission.

 

Steps to create a new asset

  1. Log in to your ONARKEN account.
    Ensure you are using an account with the necessary permissions.

  2. Access the Assets page.
    From the main menu inside of the Manage sub-menu, navigate to the Assets page.

  3. Add new Asset
    To create a new asset locate the Add asset button. 

    To create a new asset an Asset type will need to be selected from the drop-down list. If the Asset Type is not available, you can follow this guide to Create New Asset Types.

    Next, an asset
    reference is required to help you identify the asset once it is in use.

    Optionally an asset tag can be entered for additional tracking.

By following these steps, a new single asset will have been created and available to be loaned to users.

 

Related Articles

See more

Notifications

See all articles
How to Keep up to date with the ONARKEN® Maintenance, Status & New Features

To receive ONARKEN® update notifications, simply go to the sidebar, go to the bottom section, and click the 'Keep up to date' button with the bell icon. 

You will then see this pop-up. 

Read and confirm you agree with the terms and conditions, and then press 'Subscribe me'. 

You will then receive regular email communications, with news about the ONARKEN® platform. 

You are free to update your notification preferences or unsubscribe you will see a link to do this at the bottom of each email that you receive from ONARKEN® Updates.

See more
How can I configure Admin Email notifications in ONARKEN®?

This article goes through the process of setting up channels for automated email notifications for ONARKEN administrators and staff. 

To see a full overview of notification features in ONARKEN®, please read the ONARKEN® Notifications Overview

If you wish to configure email notifications for end users, go to this article: How do I Enable & Customise Email Notifications for End Users? 

When an issue occurs with a transaction or at a smart locker that requires manual intervention, it is important that your IT staff in your organisation are made aware as soon as possible.  You can receive automated admin notifications about your LapSafe® smart locker and vending machine installations directly from automated emails. 

Configuration

The following events can be reported by email notification to ONARKEN administrators and staff users when:

  • Locker doors are left open for longer than 30 seconds 
  • Installations lose connection to ONARKEN
  • Faulty bays are reported by the ONARKEN client
  • When loaned assets are not returned correctly
  • When locker bays enter quarantine
  • When fault reports are logged on returned assets
  • When returned assets require a manual review, if the AI camera cannot determine the returned asset
  • When asset drop-offs fail
  • When asset collections fail
  • When asset swaps fail

Setup

To set up admin notifications in an email channel, follow the guide below:

 

Example Notifications

Admin email notifications can be read easily on PC and mobile. 

Example 'Doors left open' admin email notification
Example 'Collection failed' admin notification

 

 

 

See more
How do I Enable & Customise Email Notifications for End Users?

Configuring an End User Notification

Every end-user notification has a configurable 'subject' and 'body' field, along with several custom variables. Each end-user notification has a pre-configured template already saved, so you can use this feature as-is if you prefer.

If you wish to configure ONARKEN® notifications for administrators, please see our guide - How can I configure Admin Email notifications in ONARKEN®?

When you click the 'Notifications' button on the sidebar, you will be taken to the end-user notifications page. 

End User Notifications page

For this example, we will be configuring the "Your loan returned confirmation" notification. You can see this template below.

To select this template, click the 'Your loan return confirmation' from the 'Loaning' section of the drop-down menu.

 

'Your loan return confirmation' notification template

The default text for this template reads as follows:

Subject Hello {{ user.name }}
Content

Thank you for using the Smart Locker and for returning the {{ asset_type.name }} you borrowed.

Your item was returned to {{ installation.name }} bay {{ bay.number }} at {{ returned_at }}.

 

Select the subject and content textboxes, and then type to change the content that will be sent in the email. The selected textbox will have a blue outline. 

To copy a variable, go to the variables section and click the 'copy' button to the right of the variable name. 

Go back to the body or subject fields, and press ctrl+V, or right click, and select paste.

For this example, I have changed the template text to the following. You can change the notification text to whatever you wish. 

Subject Hi {{ user.name }}, Thank You For Returning Your Loan
Content

Hello {{ user.name }}

Thank you for using the Smart Locker and for returning the {{ asset_type_name }} you borrowed. 

Your item was returned to {{ installation.name }} bay {{ bay.number }} at {{ returned_at }}.

To enable the notification to be sent to your users. Toggle the 'Enabled' switch.

Once you are satisfied with the changes you have made to the email template, press 'Save template'. 

 

Example Emails

The end user notifications will look like this to the end user. All end user notifications are mobile friendly. 

Example 'New Loan' email (as displayed on PC)
Example 'Your Reservation' email (as displayed on PC). This message contains the one-time collection barcode that can be scanned at the smart locker. 

 

Example 'Your Reservation' email (as displayed on PC). This also contains a one-time reservation barcode that can be scanned at the smart locker. 

 

Example 'Loan Due Soon' email (as displayed on mobile). 
Example 'Reservation Cancelled' email (as displayed on mobile)

 

See more
ONARKEN® Webhook Documentation

Webhook Payload Formats

Example request payloads for each webhook event can be seen below. All fields in each webhook event will be described as below. 

To learn how to set up webhooks in ONARKEN®, read this article: Configuring Webhooks for Custom Integrations

For more information on verifying received webhooks, go to  https://api.onarken.com/#webhooks

Note: drop_off.failed, collection.failed and swap.failed webhooks are only sent on Sovran smart lockers with AI asset detection features installed. 
 

Drop off completed  (drop_off.completed): 

{ 
  "event_id": "<uuid>", 
  "event_type": "drop_off.completed", 
  "event_data": { 
    "id": "<uuid>", 
    "dropped_off_at": "<dateTime>"
    } 
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the drop off transaction
event_data.dropped_off_at dateTime Timestamp asset was dropped off at


Drop off expired  (drop_off.expired):

 {
    "event_id": "<uuid>",
    "event_type": "drop_off.expired",
    "event_data": {
        "id": "<uuid>",
        "cancelled_at": "<dateTime>"
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the drop off transaction
event_data.cancelled_at dateTime Timestamp drop off transaction expired


Drop off cancelled  (drop_off.cancelled):

{
    "event_id": "<uuid>",
    "event_type": "drop_off.cancelled",
    "event_data": {
        "id": "<uuid>",
        "cancelled_at": "<dateTime>"
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the drop off transaction
event_data.cancelled_at dateTime Timestamp drop off transaction was cancelled


Drop off failed  (drop_off.failed):

{
    "event_id": "<uuid>",
    "event_type": "drop_off.failed",
    "event_data": {
        "id": "<uuid>",
        "ai_detection": {
            "likeliness_percentage": <int>,
            "justification": "AI desciption why drop off failed",
            "detected_object": "description of unauthorised asset, or locker state"
        }
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the drop off transaction
event_data.ai_detection object Object containing information from the AI detection used to determine the status of the transaction. 
event_data.ai_detection.likeliness_percentage string Percentage of certainty that the asset in the locker bay is correct. 
event_data.ai_detection.justification string AI reasoning on why drop off was rejected
event_data.ai_detection.detected_object string Description of unexpected asset placed in the locker bay. Will report "none" or something similar if the locker bay is empty. 


Collection completed  (collection.completed):

{
    "event_id": "<uuid>",
    "event_type": "collection.completed",
    "event_data": {
        "id": "<uuid>",
        "dropped_off_at": "<dateTime>"
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the collection transaction
event_data.dropped_off_at dateTime Timestamp asset was collected at


Collection cancelled  (collection.cancelled):

{
    "event_id": "<uuid>",
    "event_type": "collection.cancelled",
    "event_data": {
        "id": "<uuid>",
        "cancelled_at": "<dateTime>"
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the collection transaction
event_data.cancelled_at dateTime Timestamp collection transaction was cancelled


Collection expired  (collection.expired):

 {
    "event_id": "<uuid>",
    "event_type": "collection.expired",
    "event_data": {
        "id": "<uuid>",
        "cancelled_at": "<dateTime>"
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the collection transaction
event_data.cancelled_at dateTime Timestamp collection transaction expired


Collection failed  (collection.failed): 

{
    "event_id": "<uuid>",
    "event_type": "collection.failed",
    "event_data": {
        "id": "<uuid>",
        "ai_detection": {
            "likeliness_percentage": <int>,
            "justification": "Detailed AI desciption why collection failed.",
            "detected_object": "Brief description of unauthorised asset, or locker state"
        }
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the drop off transaction
event_data.ai_detection object Object containing information from the AI detection used to determine the status of the transaction. 
event_data.ai_detection.likeliness_percentage string Percentage of certainty that the asset in the locker bay is correct. 
event_data.ai_detection.justification string AI reasoning on why collection was rejected
event_data.ai_detection.detected_object string Description of unexpected asset placed in the locker bay. 

Collection failed events will only trigger if the AI detects the expected asset assigned for collection still in the locker. 


Loan returned  (loan.returned):

{
    "event_id": "<uuid>",
    "event_type": "loan.returned",
    "event_data": {
        "id": "<uuid>",
        "bay_id": "<guid>",
        "asset_id": "Asset-name",
        "user_id": "<guid>",
        "requested_at": "<dateTime>",
        "loaned_at": "<dateTime>",
        "due_at": "<dateTime>",
        "returned_at": "<dateTime>,
        "cancelled_at": null
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the loan transaction
event_data.bay_id string The unique UUID of the locker bay
event_data.asset_id string The unique UUID of the asset
event_data.requested_at string Timestamp return transaction request was approved at the smart locker
event_data.loaned_at string Timestamp asset being returned was originally loaned at
event_data.due_at dateTime Timestamp loaned asset was due to be returned
event_data.returned_at dateTime Timestamp asset was returned at. 
event_data.cancelled_at dateTime Timestamp collection transaction expired


Loan failed to return  (loan.failed_return):

{
    "event_id": "<uuid>",
    "event_type": "loan.failed_return",
    "event_data": {
        "failure_reason": "Failure reason",
        "failed_at": "<dateTime>",
        "loan": {
            "id": "<uuid>",
            "bay_id": "<guid>",
            "asset_id": "Asset-name",
            "user_id": "<guid>",
            "reason": "ai_empty",
            "loaned_at": "<dateTime>",
            "due_at": "<dateTime>",
            "cancelled_at": null
        }
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.failure_reason string Text description on why loan failed
event_data.failed_at string Timestamp return was detected as failed
event_data.loan object Collection of properties specific to the loan transaction
event_data.loan.id string The unique UUID of the loan transaction
event_data.loan.bay_id string The unique UUID of the locker bay
event_data.loan.asset_id string The unique UUID of the asset
event_data.loan.requested_at string Timestamp return transaction request was approved at the smart locker
event_data.loan.loaned_at string Timestamp asset being returned was originally loaned at
event_data.loan.due_at dateTime Timestamp loaned asset was due to be returned
event_data.loan.returned_at   Timestamp asset was returned at. 
event_data.loan.cancelled_at dateTime Timestamp collection transaction expired


Swap completed  (swap.completed):

{
    "event_id": "<uuid>",
    "event_type": "swap.completed",
    "event_data": {
        "id": "<uuid>",
        "swapped_at": "<dateTime>"
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the swap transaction
event_data.swapped_at dateTime Timestamp swap transaction occurred


Swap cancelled  (swap.cancelled):

{
    "event_id": "<uuid>",
    "event_type": "swap.cancelled",
    "event_data": {
        "id": "<uuid>",
        "cancelled_at": "<dateTime>"
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the collection transaction
event_data.cancelled_at dateTime Timestamp swap transaction was cancelled


Swap expired  (swap.expired):

{
    "event_id": "<uuid>",
    "event_type": "drop_off.expired",
    "event_data": {
        "id": "<uuid>",
        "cancelled_at": "<dateTime>"
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the collection transaction
event_data.cancelled_at dateTime Timestamp swap transaction expired


Swap failed (swap.failed)

{
    "event_id": "<uuid>",
    "event_type": "swap.failed",
    "event_data": {
        "id": "<uuid>",
        "ai_detection": {
            "likeliness_percentage": <int>,
            "justification": "Detailed AI desciption why swap failed.",
            "detected_object": "Brief description of unauthorised asset, or locker stat"
        }
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the drop off transaction
event_data.ai_detection object Object containing information from the AI detection used to determine the status of the transaction. 
event_data.ai_detection.likeliness_percentage string Percentage of certainty that the asset in the locker bay is correct. 
event_data.ai_detection.justification string AI reasoning on why swap was rejected
event_data.ai_detection.detected_object string Description of unexpected asset placed in the locker bay. Will report "none" or something similar if the locker bay is empty. 


Door left open  (bay.door_left_open):

{
    "event_id": "<uuid>",
    "event_type": "bay.door_left_open",
    "event_data": {
        "id": "<uuid>",
        "opened_at": "<dateTime>"
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the door left open incident
event_data.opened_at dateTime Timestamp locker bay door was left open at


Bay quarantined  (bay.quarantined):

{
    "event_id": "<uuid>",
    "event_type": "bay.quarantined",
    "event_data": {
        "id": "<uuid>",
        "quarantined_at": "<dateTime>",
        "quarantined_until": "<dateTime>"
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the quarantined bay incident
event_data.quarantined_at dateTime Timestamp bay quarantining started
event_data.quarantined_until dateTime Timestamp bay quarantining will expire


Installation connected  (installation.connected):

{
    "event_id": "<uuid>",
    "event_type": "installation.connected",    
    "event_data": {
        "id": "<uuid>",
        "connected_at": "<dateTime>"
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the installation connected incident
event_data.connected_at dateTime Timestamp smart locker client connected to ONARKEN


Installation disconnected  (installation.disconnected):

{
    "event_id": "<uuid>",
    "event_type": "installation.disconnected",
    "event_data": {
        "id": "<uuid>",
        "disconnected_at": "<dateTime>"
    }
}
Field Type Description
event_id string The unique UUID of the event
event_type string The type (name) of the event
event_data object Contains a collection of properties specific to the event type. 
event_data.id string The unique UUID of the installation disconnected incident
event_data.disconnected_at dateTime Timestamp smart locker client disconnected from ONARKEN

If you require any more information about processing webhooks, visit https://api.onarken.com and go to the "Webhooks" section. 

See more
Configuring Webhooks for Custom Integrations

Webhooks allow us to send real time notifications of events happening on our ONARKEN® platform, straight for processing on your application or system. Webhooks allow us to send HTTP requests when events occur on ONARKEN® powered smart lockers, to your app or service. 
 

Available Webhook Endpoints

The following webhook endpoints are supported by ONARKEN®:

  • Drop off completed
  • Drop off expired
  • Drop off cancelled
  • Drop off failed*
  • Collection completed 
  • Collection cancelled
  • Collection expired
  • Collection failed
  • Loan returned
  • Swap completed
  • Swap cancelled
  • Swap expired
  • Swap failed
  • Installation connected
  • Installation disconnected
  • Door left open
  • Bay quarantined
  • Loan failed to return

Any combination of these notification subscriptions can be enabled. All that is required for webhooks to be enabled, is to set up a valid endpoint URL in your application to provide ONARKEN® with, and then select the subscription options you wish to receive webhook notification for. 
 

How can I Enable Webhooks?

To Enable Webhooks, follow the steps below.

Once you have set this up, ONARKEN will start sending POST requests to the provided endpoint when events occur. 
 

Request Payloads

Sample request payloads for each webhook event are viewable in ONARKEN®. You can see example webhook payloads by clicking the 'Payload Example' button for each webhook entry. A pop-up is then displayed showing a complete example payload. 

Details and full documentation for each webhook event can be found here: (Link to be provided when article published). 

If you require any more information about processing webhooks, visit https://api.onarken.com and go to the "Webhooks" section. 

See more
Slack Admin Notifications integration guide

Slack webhook notifications are now supported by ONARKEN®. This means that you can receive automated admin notifications about your LapSafe® smart locker and vending machine installations directly in a Slack channel or direct message chat.
 

Setting up the Application Workflow

There are two different types of workflows you can create in Slack, standard workflows and application workflows. We need to create application workflows to support incoming webhook endpoints, which are required for us to send the notifications to the channel/application. Please follow the steps below. 

 

Message Examples:

 

The ONARKEN® notifications will appear like this in Slack:

Example loan return manual review notification

 

Example loan return failed and collection failed notifications
Example locker quarantined and doors left open notifications
Example installation disconnected notification

Notifications will have buttons, that will take you to the link of the loan, locker bay or installation that has sent the alert notification. 

Slack notification channels can be modified at any time on ONARKEN® once set up. 

See more

Reporting

See all articles
How can I configure a scheduled report for Overdue Loans?

This guide is to give you a quick overview of how to recieve regular notifications in ONARKEN®  

The best way to recieve regular notifications of loans going overdue, is to set up a scheduled report to email at a fixed interval to send a list of all overdue loans in .csv format. The email also contains a link, so that registered ONARKEN users can view the overdue loans on the dashboard. 

Prerequisites

To create reports with data on overdue loans, you must have the loans.view permission enabled. 

Setting up the Report

To set up the Automated report, please follow the interactive guide below.

 

 

 

 

 

See more

ONARKEN® Settings

See all articles
Manage ONARKEN Ticket Settings

Ticket Settings

Users have the ability to create templates for fault report tickets and enable automatic ticket generation when asset loans are overdue

To edit the full ticket settings configuration, you must have super admin permissions. 

Subcategories

There are two subcategories for editing tickets on this page. 
 

Fault Reporting Settings

These settings enable automated configuration of a template when fault report tickets are generated from end users reporting issues with their devices at the smart lockers. Or alternatively, by administrators logging tickets directly on the ONARKEN portal. 

A pre-configured ticket title and description format used for ONARKEN tickets generated when devices are returned with faults can be configured here. A default title and description will be set, but these are completely configurable to suit your needs. The user has several variables which can be used to adjust what data is displayed on ONARKEN and sent to administrators via email. 

Simply press the copy button of the variable you wish to copy, and paste it into the title or description field. 

Press 'Save' when done. 
 

Overdue Loan Ticket Settings

These settings enable automated ticket generation when loaned assets go overdue. The 'Raise tickets for overdue loans' configures the ability for ONARKEN to automatically create tickets for overdue assets. If disabled, this section will be hidden. 

A template ticket title and ticket description are editable in the same way as the fault reporting ticket settings. A series of variables are available here too. 
 

Auto Close

This setting allows you to enable auto closure of tickets when overdue assets are returned. Disable this setting if you wish to manually review assets before enabling them for loan. 
 

Delay before raising ticket

By default, an overdue loan ticket will be automatically raised as soon as an asset is detected as overdue by ONARKEN. A delay period of up to 24 hours can be added before the ticket is raised to give users a grace period, by using the slider control.  

Press 'Save' when done. 
 

Automated FreshService Ticketing Integration

The following features require a FreshService integration licence to be purchased at an additional cost. Please speak to LapSafe support if you wish to enable this feature. 

The ONARKEN® integration with Freshservice has has some updated features to improve ticket automation, and to work with the new settings described above. ONARKEN® users can now automatically create FreshService tickets when asset loans go overdue, or when smart locker users submit fault reports. 

When viewing tickets in ONARKEN®, if you have FreshService integration enabled, the table will display some additional columns. You will be able to see:

  • An 'ITSM' column with the FreshService ticket number
    • The FreshService ticket numbers in the table are links that will take the user to the ticket in FreshService
    • The user can also press the options '· · ·' button to view the link to the FreshService ticket, or to go to the ONARKEN ticket page. 
  • A new ticket 'Type' to differentiate tickets created for overdue assets, and tickets created for faulty assets.

Tickets created directly on the management portal will also be copied into FreshService when connected.
 

How to enable the ONARKEN® FreshService ticket integration?

Read the following guides: How to enable FreshService integration with ONARKEN®? and How to automate ONARKEN ticket resolutions in FreshService

 

 

 

 

See more
Location Administrators

Location Administrators can be assigned to individual locations. They are currently used to receive notifications for approving vend request allocations, with further functionality planned for the future.


You can assign multiple users to administer a single location, and a user can administer multiple locations. To manage your Location Administrators, follow the steps below.

 

 

See more
How do I add a map to my location

You can associate a Google place with your Location in ONARKEN® this allows you to display a map for that location, making it easier to share location details with your users and generate directions.

 

 

See more
How do I change the Drop off auto expire settings

The Drop-Off and Collection Settings in ONARKEN® allow you to customise key operational policies for your Smart Lockers. Configure settings for drop off auto expiry, to ensure that lockers aren't left vacant and waiting for a drop off that may never happen.

 

Required Permissions

To perform this action, your account must have the general.miscellaneous permission. 

 

Steps to configure Drop Off Auto Expire Settings

  1. Log in to your ONARKEN account.
    Ensure you are using an account with the necessary permissions.

  2. Access the Settings page.
    From the main menu, navigate to the Settings page.

     

  3. Navigate to Drop off & collection settings
    Once here you are able to configure how the drop off & collection system works with your smart lockers.
  4. Drop Off Auto Expire
    This allows you to set an automatic expire date to remove the drop off from the locker and allow other users to use that bay again. You can disable this by setting it to 0, meaning drop offs will not auto expire.

Once you have followed these steps, your Drop off auto expiry settings will have been configured.

 

Related Articles

See more
How do I delete a screen design?

Deleting a Screen Design allows you to remove a previously customised interface from your Smart Lockers. This action cannot be reversed and if the screen design is required again after it has been deleted, it will have to be re-created by following the guide below.

 

Create/Edit Screen Designs

If you need to create/edit a Screen Design. You can follow these guides,

How do I create a screen design?

How do I delete a screen design?

 

Required Permissions

To perform this action, your account must have the screen_designs.delete permission.

 

Steps to delete a Screen Design.

  1. Log in to your ONARKEN account.
    Ensure you are using an account with the necessary permissions.

  2. Navigate to the Settings Page
    Once on the settings page, Navigate to the Smart Lockers panel and the
    Screen Designs section.

  3. Locate Screen Design
    To delete a screen design, locate the required screen design, click the delete button and follow the on-screen steps.

Once you have followed these steps, the screen design will have been deleted. Any Smart Lockers using this screen design will have been reset to default. 

 

See more
How do I edit a screen design?

Updating a Screen Design allows you to modify the interface of your Smart Lockers, ensuring it stays aligned with your organisation’s branding and visual identity.

 

Create/Delete Screen Designs

If you need to create/delete a Screen Design. You can follow these guides,

How do I create a screen design?

How do I delete a screen design?

 

Required Permissions

To perform this action, your account must have the screen_designs.edit permission.

 

Steps to edit a Screen Design.

  1. Log in to your ONARKEN account.
    Ensure you are using an account with the necessary permissions.

  2. Navigate to the Settings Page
    Once on the setting page, Navigate to the Smart Lockers panel and to the
    Screen Designs section.

  3. Locate Screen Design
    To edit the screen design background. Select the background button and upload a new background image/video.

    To edit the name and colours. Select the edit button and update the
    relevant information.

Once you have followed these steps, the screen design will have been updated and any Smart Locker using the screen design will have been updated.

See more

Microsoft Entra ID

See all articles
How do I map permissions from Microsoft Entra to ONARKEN?

ONARKEN synchronises users from Microsoft Entra ID based on configured Role and Access Group mappings. These mappings determine which users are imported into ONARKEN, their permissions, and the Smart Lockers or Asset Types they can access.

 

Key Concepts

  1. Roles:
    Every user in ONARKEN must be assigned a single Role. Roles define a user’s permissions within the platform.

    • Users without a valid Role mapping in ONARKEN will be considered invalid and not imported.

  2. Access Groups:
    Access Groups define which Smart Lockers and Asset Types a user can access.

    • Users with a valid Role but no Access Group will be imported into ONARKEN but will likely have no functional access to lockers or assets.

Prerequisites

Before mapping roles and access groups, ensure your ONARKEN instance is already connected to Microsoft Entra. If not, refer to the How to connect Microsoft Entra ID to ONARKEN? for instructions.


How to Configure Role and Access Group Mappings

  1. Log in to the ONARKEN Management Platform.
    Use your administrator credentials to access the system.

  2. Access the Integrations Section.

    • Click Integrations from the main navigation menu.

  3. Open Microsoft Entra ID Configuration.

    • Under Microsoft Entra ID, click Configure Integration.

  4. Map Roles and Access Groups:

    • For each Role or Access Group you want to map, click Map.

  5. Search for the Group in Microsoft Entra ID:

    • Use the search box to locate the desired Group Name in Microsoft Entra.

  6. Add the Mapping:

    • Once you find the required group, click Add Mapping.

  7. Repeat as Needed:

    • Continue mapping until all necessary Roles and Access Groups are configured.

 

Best Practices

  • Ensure every user in Microsoft Entra ID has a valid mapping to a Role in ONARKEN.
  • Configure Access Groups thoughtfully to align with your organisational structure and access requirements.
  • Regularly review mappings to ensure they reflect current operational needs.

 

What Happens During Synchronisation?

  • Valid Mappings:
    Users with valid Role and Access Group mappings are imported into ONARKEN with the appropriate permissions and access.

  • Missing Role Mapping:
    Users without a valid Role mapping are marked as invalid and will not be imported.

  • Missing Access Group Mapping:
    Users with a Role but no Access Group will be imported but will not have access to lockers or asset types.

 

By correctly mapping Roles and Access Groups, you ensure that user synchronisation between ONARKEN and Microsoft Entra ID is accurate and effective, supporting secure and efficient locker and asset management.

See more
How does the Microsoft Entra ID sync work?

ONARKEN provides the ability to synchronise users directly from Microsoft Entra ID, streamlining user management by leveraging group mappings and ensuring that permissions are consistently applied.


How Synchronisation Works

  1. Role-to-Group Mapping:

    • Within ONARKEN, you can map ONARKEN Roles to corresponding Microsoft Entra ID Groups.
    • This mapping determines which ONARKEN permissions are assigned to users based on their group memberships in Entra ID.

  2. User Import and Synchronisation:

    • All Microsoft Entra ID users with a valid group mapping in ONARKEN will be imported into the system.
    • These users will inherit the permissions configured in the mapped ONARKEN Roles.

  3. Ongoing Updates with Microsoft Graph Delta API:

    • After the initial synchronisation, ONARKEN uses the Microsoft Graph Delta API to monitor changes in Entra ID.
    • Any changes (additions, updates, or deletions) to users in mapped groups will be reflected in ONARKEN during subsequent synchronisations.
See more
What permissions does ONARKEN need to my Microsoft Entra ID account?

To integrate ONARKEN with Microsoft Entra ID, specific permissions must be granted. These permissions allow ONARKEN to access and synchronise user and group information, ensuring seamless functionality within the system.


Permissions Required

  1. User.Read

    • Purpose: Allows ONARKEN to read the basic information of the user who is authenticating.
    • Usage: Ensures that ONARKEN can verify and authenticate individual users during login.

  2. User.Read.All

    • Purpose: Allows ONARKEN to read information about all users within the Microsoft Entra ID directory.
    • Usage: Enables ONARKEN to manage and synchronise user accounts for locker management and other functionalities.

  3. Group.Read.All

    • Purpose: Allows ONARKEN to read all group information within the Microsoft Entra ID directory.
    • Usage: Facilitates the integration of group-based permissions, access control, and management within ONARKEN.


Granting Permissions

When configuring the integration, these permissions will be requested during the admin consent process in Microsoft Entra ID. As an administrator, you must approve these permissions to enable the integration.

See more
How to connect Microsoft Entra ID to ONARKEN?

Integrating Microsoft Entra ID with ONARKEN allows for streamlined user authentication and data synchronisation. Before starting the process, ensure you have all the necessary prerequisites in place.

 

Prerequisites

Before attempting the connection, confirm the following:

  • You have administrative access to your Microsoft Entra account.
  • You have your Microsoft Entra Tenant ID.

For more details, refer to What is required to setup Microsoft Entra ID integration?

 

Steps to Connect Microsoft Entra ID to ONARKEN

  1. Log in to the ONARKEN Management Platform.
    Use your administrator credentials to access the platform.

  2. Access the Integrations Menu.

    • Navigate to Integrations in the main menu.
    • Locate the Microsoft Entra ID section.

  3. Configure the Integration.

    • Click Configure Integration under the Microsoft Entra ID option.

  4. Initiate the Connection.

    • Click Connect to start the integration process.

  5. Enter Your Tenant ID.

    • Provide your Microsoft Entra Tenant ID in the designated field.
    • Click Connect to proceed.

  6. Authenticate with Microsoft Entra ID.

    • You will be redirected to Microsoft’s login page.
    • Log in using your Microsoft Entra administrator credentials.

  7. Grant Admin Consent.

    • After logging in, grant the ONARKEN application admin consent to access your Microsoft Entra directory.
See more
What is required to setup Microsoft Entra ID integration?

Integrating ONARKEN with Microsoft Entra ID enables seamless user authentication and management. To complete the setup, you’ll need administrative access to your Microsoft Entra account and specific information about your Microsoft Entra configuration.

 

Prerequisites

  1. Administrative Access:
    You must be an administrator in your Microsoft Entra account. This is required to grant admin consent to the ONARKEN application.

  2. Microsoft Entra Tenant ID:
    The Tenant ID is a unique identifier for your Microsoft Entra directory. This ID is essential for configuring the integration.

 

Steps to Configure Microsoft Entra ID Integration

  1. Log in to the Microsoft Entra Admin Centre:
    Use your administrator credentials to access the Microsoft Entra portal.

  2. Locate Your Tenant ID:

    • In the Microsoft Entra portal, navigate to the Overview section.
    • Copy the Tenant ID, which you will need to provide to ONARKEN.

  3. Grant Admin Consent to ONARKEN:

    • Follow the ONARKEN setup instructions to connect your Microsoft Entra ID.
    • When prompted, grant admin consent for the ONARKEN application to access your Microsoft Entra directory.

  4. Complete the ONARKEN Configuration:

    • In the ONARKEN Management Platform, navigate to the Microsoft Entra ID integration settings.
    • Enter your Microsoft Entra Tenant ID and confirm the configuration.


Why is Admin Consent Required?

Granting admin consent allows the ONARKEN application to integrate with your Microsoft Entra directory securely. This enables features such as:

  • User authentication through Microsoft Entra ID.
  • Synchronisation of user data for seamless usage of lockers.
See more
Using Entra ID vs LDAP

ONARKEN® supports integration for Active Directory, using either your on-premises LDAP connection or Entra ID. This guide is designed to help you choose which option suits your organisation best.


Entra ID

The ONARKEN® Entra ID integration works by configuring the Entra groups you would like synced into ONARKEN®, enabling usage at your Smart Lockers and/or logging into the ONARKEN® Management Platform.

 

Why pick Entra ID?

  • The Entra ID integration supports Single Sign-On for users on the ONARKEN® management platform and Smart Locker users on the My ONARKEN® application.
  • Users are kept up-to-date through automatic daily synchronisation and optional live check on user scan.
  • Self-registration option if card numbers are not stored in Entra ID.

 

LDAP Lookup

The ONARKEN® LDAP Lookup integration works by searching your on-premises Active Directory. When a user scans their card at the Smart Lockers, if a user is found, they are registered to the ONARKEN® system and can proceed with using the Lockers.

 

Why pick LDAP Lookup

  • Users are authenticated live against your Active Directory when scanning.
  • No time-consuming registration process for the locker user.

 

Drawbacks of LDAP Lookup

  • Users are only updated during the locker scan process, therefore users that no longer exist will not be removed from ONARKEN® until an automatic purge date.
  • Users will not exist in ONARKEN® until their first locker scan, therefore, cannot use My ONARKEN® or have Drop Off / Collections arranged for them until they use the lockers.
  • Amendments to users' details will not be updated, such as change of email address, card number or name, until they re-scan at the lockers.
  • Card numbers must exist within your Active Directory.

 

LDAP Self-Registration

The ONARKEN® LDAP Registration integration works when a card number is scanned for the first time, the user will be asked to enter their Active Directory login credentials, if they are successfully authenticated, and are granted permission to use the Smart Lockers, ONARKEN® will then match the card number with the user. All subsequent reads will check the user against Active Directory via their email address.

 

Why pick LDAP Self-Registration

  • Users are authenticated live against your Active Directory when scanning.
  • Card numbers are not needed to be stored within your Active Directory
 

Drawbacks of LDAP Self-Registration

  • Users are only updated during the locker scan process, therefore users that no longer exist will not be removed from ONARKEN® until an automatic purge date.
  • Users will not exist in ONARKEN® until their first locker scan therefore cannot use My ONARKEN® or have Drop Off / Collections arranged for them until they use the lockers.
  • Self-registration for a fresh intake of users can be a time-consuming process.
  • Users can register to use the service with any compatible ID card therefore this may not match your internal card management system.
See more

Microsoft Active Directory (LDAP)

See all articles
How do I manage permissions when connected to LDAP Active Directory?

ONARKEN’s LDAP integration enables real-time user authentication when users scan their ID badges at the lockers. Unlike a traditional import or synchronisation process, this setup directly queries your Active Directory to verify credentials at the moment of badge scan.

 

Key Concepts

  1. Real-Time Authentication:

    • When a user scans their ID badge, ONARKEN queries your LDAP Active Directory to authenticate the user.
    • This ensures that only authorised users with valid credentials can access lockers.
  2. Role and Access Group Mappings:

    • LDAP integration still relies on configured Role and Access Group mappings in ONARKEN.
    • These mappings define the permissions and access rights for authenticated users.

 

Prerequisites

Before configuring the integration, ensure:

  • Your ONARKEN instance is connected to Active Directory.
  • You have administrative access to both ONARKEN and your LDAP Active Directory.
  • The required attributes (e.g. card number) are available in your Active Directory schema.

For setup instructions, refer to the How to connect LDAP Active Directory? guide.

 

How LDAP Authentication Works

  1. ID Badge Scanning:

    • When a user scans their ID badge at the locker, ONARKEN extracts the badge ID and queries Active Directory.

  2. LDAP Query:

    • ONARKEN uses the configured Base DN and credentials to search for the user’s card number in Active Directory.

    • If the card number is found and valid, ONARKEN authenticates the user.

  3. Role and Access Check:

    • ONARKEN verifies the user’s Role and Access Group mappings to determine their permissions and access rights.

  4. Locker Access:

    • If the user is authenticated and has appropriate permissions, they are granted access to the lockers or assets.

 

Configuring Role and Access Group Mappings for LDAP Authentication

  1. Log in to the ONARKEN Management Platform:
    Use your administrator credentials.

  2. Access the Integrations Section:
    Navigate to Integrations in the main menu.

  3. Open LDAP Active Directory Configuration:
    Under LDAP Active Directory, click Configure Integration.

  4. Map Roles and Access Groups:

    • For each Role or Access Group you want to map, click the Pencil icon.
    • Use the search box to specify the Organisational Unit (OU) or security group name in Active Directory.
    • Click Add Mapping to save.

  5. Save Settings:
    Ensure all mappings are saved and reflect your organisational requirements.

See more
How to connect to LDAP Active Directory?

Integrating LDAP Active Directory with ONARKEN allows users to authenticate using their card scans, enabling seamless and secure access to lockers and assets. Follow these steps to set up the integration:

 

Steps to Connect LDAP Active Directory

  1. Log in to the ONARKEN Management Platform:
    Use your administrator credentials to access the system.

  2. Access the Integrations Section:

    • Navigate to Integrations from the main menu.

  3. Select the LDAP Active Directory Integration:

    • Under LDAP Active Directory, click Configure Integration.

  4. Complete the Setup Wizard:

Provide the required information:

      • Host Address(es) / Name(s): The address or hostname of your AD server.
      • Port Number: The port for LDAP communication (e.g., 389 for LDAP or 636 for LDAPS).
      • Service Account Credentials: The username and password for the AD account with Full Read Access.
      • Base DN: The starting point in the directory tree for user searches (e.g., OU=Users,DC=example,DC=com).
      • Card Number Attribute: The LDAP attribute stores user card numbers. If unavailable, ONARKEN can enable user self-registration.
      • Optional Cost Code Attribute: An attribute for storing cost codes, if applicable.

  1. Connect:

    • Click Connect to establish the integration.

 

Key Benefits of LDAP Integration

  • Card-Based Authentication: Simplifies user access by linking card scans directly to Active Directory accounts.
  • Centralised User Management: Leverages existing AD infrastructure for user authentication and permissions.
  • Secure Communication: Supports STARTTLS for encrypted and secure data transmission.
See more
What information is required for the LDAP Active Directory integration?

Integrating ONARKEN lockers with your Active Directory (AD) allows for seamless user authentication and efficient management of access permissions. To set up the integration, specific information is required to ensure proper configuration and functionality.

 

Required Information

  1. Host Address(es) / Name(s):

    • The address or hostname of your Active Directory server(s).

  2. Port Number:

    • The port used for communication with Active Directory (commonly 389 for LDAP or 636 for LDAPS).

  3. Active Directory Service Account:

    • An account with Full Read Access to your Active Directory. This account is used to query and retrieve user information.

  4. Base DN (Distinguished Name):

    • The root of the directory tree from which ONARKEN will search for user accounts. For example:
      OU=Users,DC=example,DC=com.

  5. Card Number Attribute:

    • The attribute in Active Directory that stores the user’s card number for authentication.
    • Note: If card numbers are not stored in AD, ONARKEN can prompt users to self-register their cards during their first use.

  6. Cost Code Attribute (Optional):

    • If applicable, this attribute can store cost codes associated with users for tracking or billing purposes.


Best Practices for Setup

  • Secure the Service Account:
    Ensure that the service account used for the integration has the minimum required permissions (Full Read Access) to reduce potential security risks.

  • Confirm Attribute Names:
    Verify the exact attribute names for card numbers and cost codes in your Active Directory schema to avoid configuration errors.

  • Test Connectivity:
    Before finalising the setup, test the connectivity to your AD server using the provided host address, port number, and service account credentials.

  • Use LDAPS for Security:
    If possible, use LDAPS (LDAP over SSL) for encrypted communication between ONARKEN and Active Directory.

Next Steps

Once the required information is gathered, follow the ONARKEN integration setup wizard to configure and establish the connection. For further assistance, refer to your ONARKEN documentation or contact support.

See more

Library Management System (LMS)

See all articles
How do I setup the Library Management System integration?

ONARKEN can seamlessly integrate with your Library Management System (LMS) to handle user authentication and manage the check-out and check-in of assets directly from lockers. This integration leverages the SIP2 protocol for efficient communication with your LMS.


Steps to Connect to the LMS

Follow these steps to configure the integration:

  1. Log in to the ONARKEN Management Platform:
    Use your administrator credentials to access the system.

  2. Access the Integrations Section:

    • Navigate to the Integrations menu from the main navigation.

  3. Select the SIP2 Library Management System Integration:

    • Under SIP2 Library Management System, click Configure Integration.

  4. Complete the Setup Wizard:

    • Provide the required details, including your LMS SIP2 connection information, such as:
      • LMS Provider & Version Number
      • SIP2 IP Address / Hostname
      • Port Number
      • Login and Password (if required)
      • Location Code or Institution ID (if required)

    • Refer to your LMS administrator or documentation for these details.

  5. Click Connect:

    • Finalise the setup by clicking Connect to establish the integration.
See more

Paxton Net2

See all articles
How to connect to Paxton Net2

ONARKEN integrates with Paxton Net2 to authenticate users at lockers, leveraging your existing access control infrastructure. To establish this integration, specific configuration details and a valid integration license are required.

 

Required Information

  1. Paxton Net2 Server Host:

    • The IP address or hostname of your Paxton Net2 server.
  2. Username:

    • The username for a Paxton Net2 account with appropriate access permissions.
  3. Password:

    • The password associated with the above username.
  4. Field Name for Email Addresses:

    • Specify the field name in Paxton Net2 where user email addresses are stored.

License Requirement

For the integration to function correctly, the LapSafe® Paxton integration license must be installed on your Paxton Net2 server. Contact LapSafe® support to obtain and install the license before proceeding.

 

Steps to Connect Paxton Net2 to ONARKEN

  1. Log in to the ONARKEN Management Platform:

    • Use your administrator credentials to access the system.

  2. Access the Integrations Section:

    • Navigate to Integrations from the main menu.

  3. Select Paxton Net2 Integration:

    • Under Paxton Net2, click Configure Integration.

  4. Enter Connection Details:

    • Provide the required information:
      • Server Host: Enter the Paxton Net2 server’s IP address or hostname.
      • Username and Password: Enter the credentials for the Paxton Net2 account.
      • Email Field Name: Specify the field name where user email addresses are stored.

  5. Save and Validate:

    • Save the settings and test the connection to validate the integration.

  6. Verify License Installation:

    • Confirm that the LapSafe® Paxton integration license is installed on the Paxton Net2 server.
See more

PaperCut

See all articles
How to connect to PaperCut

Integrating ONARKEN with your PaperCut print database allows for user authentication at lockers by scanning their ID badge. This setup leverages your existing PaperCut infrastructure to streamline access control.

 

Required Information

  1. PaperCut Server Host Address:

    • The IP address or hostname of your PaperCut server.
  2. Authorisation Token:

    • A valid authorisation token to authenticate API requests from ONARKEN to the PaperCut server.

 

Steps to Connect PaperCut to ONARKEN

  1. Log in to the ONARKEN Management Platform:

    • Use your administrator credentials to access the system.

  2. Access the Integrations Section:

    • Navigate to Integrations from the main menu.

  3. Select the PaperCut Integration:

    • Under PaperCut, click Configure Integration.

  4. Enter Connection Details:

    • Provide the following information:
      • Server Host Address: Enter the IP address or hostname of your PaperCut server.
      • Authorisation Token: Paste the token obtained from your PaperCut system administrator.

  5. Save and Test the Connection:

    • Save the settings and validate the connection to ensure proper communication between ONARKEN and the PaperCut server.
See more
How to setup Okta Single Sign-On

Integrating Okta with ONARKEN enables single sign-on (SSO), providing a secure and centralised authentication mechanism for your organisation. This integration streamlines the login process and enhances security by leveraging Okta as your identity provider.


How to Configure Okta Single Sign-On


Step 1: Create an Okta Application

  1. Access the Okta Admin Panel:
    Log in to your Okta admin panel and navigate to the Applications section.

  2. Create a New App Integration:

    • Click Create App Integration.
    • Choose OIDC - OpenID Connect as the sign-in method.
    • Select Web Application and click Next.

  3. Set Up the Application:

    • Enter ONARKEN® as the App Integration name.
    • Set the Sign-in Redirect URIs to:
      https://{domain}.onarken.com/oauth/callback
      (Replace {domain} with your ONARKEN domain.)

  4. Configure Access:

    • Choose your preferred access control options for the app.
    • Click Save.


Step 2: Enable Okta in ONARKEN

  1. Log in to the ONARKEN Management Platform:
    Use your administrator credentials.

  2. Access the Integrations Section:

    • Click Integrations from the main menu.

  3. Configure Okta Integration:

    • Under Okta Single Sign-On, click Configure Integration.
    • Enter the details from the Okta application you created, such as:
      • Client ID
      • Client Secret
      • Discovery URL (usually provided by Okta)

  4. Connect the Integration:

    • Click Connect to finalise the setup.

  5. User Login Experience:

    • Users will now see a Sign in with Okta button instead of the traditional username and password fields.


Enabling the Okta Launcher App

To allow users to log in to ONARKEN directly from their Okta account dashboard, follow these steps:

  1. Access the ONARKEN Application in Okta:

    • Navigate to the ONARKEN® application within your Okta admin panel.

  2. Edit General Settings:

    • Click Edit in the General Settings panel.

  3. Configure Login Initiation:

    • Set Login initiated by to Either Okta or App.

  4. Set Application Visibility:

    • Choose your desired visibility options for the application on the Okta dashboard.

  5. Update the Initiate Login URI:

    • Set the URI to:
      https://{domain}.onarken.com/oauth/redirect
      (Replace {domain} with your ONARKEN domain.)

  6. Save Settings:

    • Click Save to apply the changes.


Benefits of Okta Integration

  • Streamlined Authentication: Centralised access via Okta eliminates the need for separate ONARKEN credentials.
  • Enhanced Security: Reduces the risk of password-related security breaches.
  • Improved User Experience: Users can log in quickly with a single click from the ONARKEN login page or the Okta dashboard.
See more
Envoy™ Deployment Type Guide

With the release of ONARKEN® client version 1.15, the Envoy™ software now has two Deployment modes of operation. This article discusses the differences between Sequential and Last In Last Out deployment modes.

LapSafe Envoy™ smart lockers now have the option to choose between two modes of operation (known as deployment modes). This guide is to enable you to decide which deployment mode you should use, and how to get the most out of your Envoy™. 

 

Sequential Deployment

This is the default deployment type, which was the operational mode used on Envoy smart lockers prior to version 1.15. Assets will be deployed in sequential order. For example, if Locker bay 3 and locker bay 14 both have assets available to loan, the asset in locker bay 3 will always be available before locker bay 14 (and any other locker afterwards). This means that the asset loaded in locker bay 1 will always be loaned first when it is available, regardless of how long the asset has been in the locker or its charge level. 

This deployment mode is designed for environments where a large number of devices need to go on loan at once. For example, a school where a classroom requires laptops for a lesson; all the students will go to the Envoy™ at once and loan the laptops, and then they all return the laptops at once when the lesson is over. Sequential Deployment mode is the default deployment type set on Envoy™ smart lockers. 

 

Last In Last Out Deployment

This deployment type will loan assets based on how long the assets have been stored within the locker. For example, if the asset in locker bay 1 has been stored in the locker after a loan for 10 minutes, but the asset in locker bay 20 has been returned for 2 hours, the asset in locker bay 20 will be loaned first. 

This is to allow assets that have been stored for longer periods in the locker, and therefore charged for longer periods, to be loaned first. 

This deployment mode is designed for environments where the assets that go on loan must be sufficiently charged. An example use case for this deployment type is if there are a group of engineers who loan laptops for long periods, and take the device for on-site work. The devices need to be fully charged for the users to complete their tasks, so sequential deployment is not suitable in this situation. 

 

How to change deployment type

The deployment type of the Envoy™ smart lockers is configurable at any time on ONARKEN®. To change the deployment type, follow the steps below. 

 

 

 

See more

Release Notes

See all articles
16th June 2026

We have released a minor update to ONARKEN® management portal. New features and bug fixes are documented below.

New Features

Analytics Tab

We have added a new analytics tab. This shows a new loaning summary dashboard, showing you what time assets are loaned at on an easy to read line graph, statistics on total loans, total loans returned late, and average loan duration. Users can filter by locker installations, or by setting a date range from one of the preset options, or setting a custom range. 

This section is still in development. We want to hear your feedback, which you can submit here:  LapSafe® Support Requests  or by clicking on the 'Send Request' button displayed above the graph. 

Fixes

  • Create asset modal crashing in certain circumstances
  • Fixed failed return slack notification formatting not showing heading in bold

Changes

  • Changed failed return email notification formatting to improve readability
See more
5th June 2026

We have released a minor update to ONARKEN® management portal. New features and bug fixes are documented below.

Fixes

  • Fixed an issue that would prevent a custom Asset Type AI description from being auto filled when arranging a drop off or swap
     
  • Fixed an issue that would prevent AI descriptions from being auto filled when arranging collections from the quick collect shortcuts
     
  • Fixed an issue when attempting to arrange a reservation when the instance has no loaning lockers


Improvements

  • Added links to Drop Offs, Collections and Swaps at the start of the relevant tables to prevent scrolling on smaller screens
     
  • Added an arrange vend shortcut when browsing the vending section
     
  • Added a new filter to the collectables API endpoint to filter collectable assets by extension attribute
     
  • Added missing Smart Locker translations keys

 

Changes

  • Limited the bulk asset creation to 50 assets at once
See more
22nd April 2026

New Features

 

Overdue Loan Icon

We have also added a feature to display an icon on the large locker maps, when a locker bay has an overdue asset on loan. So now you can see if any of your smart lockers have any overdue loans at a quick glance. 

Overdue asset loan indicator on ONARKEN locker map UI

See more
8th April 2026

Bug Fixes

  • Fixed an issue where time based user blocks would continue to run even after being manually cleared and re-blocked

 

Client Release 1.15.26.0401

  • Fixed an issue where text on fault reporting option buttons could be clipped; text now wraps onto a new line
See more
7th April 2026

Changes

  • Increased the max limit of fault reporting list options from 6 to 20

 

Bug Fixes

  • Resolved an issue that caused the Reservation Confirmation email using the installation name variable for the location name
     
  • Resolved the Availability report CSV export not showing the time along with the date
     
  • Resolved an issue that could cause the swap completion time being stored in the incorrect timezone
     
  • Resolved error when arranging a swap for an item that someone else arranged a collection for
     
  • Resolved an issue that would prevent a user from arranging a swap for description only asset due to permissions
See more
24th March 2026

We have released a minor update to ONARKEN® management portal. New features and bug fixes are documented below.
 

New Features

 

Ticket Settings Tab

We have added a new 'Tickets' tab in the ONARKEN settings page. Users now have the ability to create templates for fault report tickets and enable automatic ticket generation when asset loans are overdue. 

For more information on these new settings, please read: Automatic Ticketing and Fault Reporting Settings
 

FreshService Ticket integration 

ONARKEN can now create tickets directly in FreshService. Tickets can also be automatically closed in ONARKEN by FreshService administrators when a workflow is created. 

We have also added a new 'ITSM' column on the tickets table when browsing all tickets in ONARKEN®. This will be visible when the FreshService (or other ITSM integration) connection is active, which will show the FreshService ticket number. 

A 'Type' column to make it easy to distinguish between fault report tickets and overdue loan tickets. 

To set up this feature, please read the following guides: 


Collectable Assets Overview

We have added a page that allows users to see an overview of all currently available collectable assets across your smart locker estate. 

You can adjust several filters here to change how the assets are grouped. 

Administrators can view the following details about each collectable asset:

  • The asset type or description of the collectable asset
  • The asset reference (if an asset type was dropped off)
  • The location of the asset
  • The smart locker the asset is stored in
  • The drop off reason
  • How long the asset has been present in the locker bay

Each asset card also has quick links to arrange a collection of the asset, and to view the previous transaction. Click the link to see a video demonstration of how to use the powerful sorting and filter options on this new screen. 

Collectable Asset Finder.mkv

 

New Locker Software Available

  • Resolved an issue retrieving SIP2 fines when a user scans with multiple card numbers
  • Added resilience to loan confirmations during power outages
  • Resolved an issue where a scenario button would appear when there were no available drop off lockers
  • Resolved an issue that could show incorrect error message format
  • Resolved an issue when attempting to return multiple loans when system is offline

 

See more

ServiceNow

See all articles
ONARKEN® ServiceNow Application Privacy Policy

Thank you for using the LapSafe® ONARKEN® ServiceNow App (the “App”). We are committed to protecting your privacy and ensuring transparency regarding how your data is handled when using our App.

1. Overview

This App functions exclusively as a set of API Spokes. It does not collect, transmit, or store any data from your ServiceNow instance unless explicitly configured by you (the customer). All data flows and integrations are initiated and managed by your own setup and preferences.

2. Data Handling

  • No Automatic Data Collection
    The App does not automatically collect or transmit any data from your ServiceNow environment.

  • User-Controlled Data Transmission
    Any data transferred using the App is solely the result of user-configured API integrations. The App does not initiate any data transfers or process data without user instruction.

  • Data Storage in ONARKEN
    If you choose to transmit data via the API integration, that data may be stored in ONARKEN, but only when you have explicitly configured and submitted such data through the App. We do not control, access, or manage this data in any way.

3. Your Responsibilities

As a user of the App, you are solely responsible for:

  • Configuring and managing API integrations.

  • Ensuring that any data transmitted complies with your organisation’s policies and applicable laws.

  • Managing the access and permissions within your ServiceNow environment.

4. Changes to This Policy

We may update this Privacy Policy to reflect changes in functionality or legal requirements. Any changes will be communicated through your account manager or the LapSafe® Support Team

5. Contact

If you have any questions about this Privacy Policy or our practices, please contact us at:

LapSafe® Self-Service Solutions
support@lapsafe.com

See more

FreshService

See all articles
How to automate ONARKEN® ticket resolution from FreshService?

Prerequisite: You must have purchased the ONARKEN® FreshService integration licence to enable the following features, and you must have activated the integration. 

This guide describes how to create a workflow in FreshService to automatically close ONARKEN tickets. 

Before reading this guide, please ensure you have set up the ONARKEN integration with FreshDesk. You can read the guide here: How to enable FreshService integration with ONARKEN®?
 

Automating Ticket Resolutions

FreshService tickets will be automatically created and linked to ONARKEN tickets as soon as the integration is active. However, a workflow must be created in FreshService to ensure that tickets closed or resolved in FreshService are updated accordingly in ONARKEN too. 

  • You must be logged in as an Administrator in FreshService for this next task. 

Go to the 'Admin' tab in the sidebar on FreshService

When loaded, browse or search for 'Workflow Automator'

You will see this page displaying all Event-Based Workflows for tickets. You will need to create an Event-Based Workflow. 

freshservive workflow list

Now follow the steps in the guide below:

To test if the connection works, simply raise a ticket on the 'All Tickets' page in ONARKEN. The ticket will be added to the table and a FreshService ticket will be created shortly after the ONARKEN ticket. 

You may have to refresh the page for the ticket information to update. 

If successful, the ITSM column of the new ticket record will be populated with an ID containing the name of the ITSM service, and the FreshService Ticket number. 

ONARKEN tickets pagem with ITSM integration

The ITSM ticket number will link to the ticket in FreshService. Click the ITSM ticket number and you will be taken to the ticket page in FreshService. 

ONARKEN ticket page in FreshService

You can then edit the ticket properties or assign the ticket to users how you wish. 

If this test has passed then tickets logged by users through fault reporting, and tickets generated from overdue loans will be created too [1].

Please note: you will be unable to close tickets in ONARKEN® when connected to FreshService, or any other ITSM platform.

[1] Providing feature is enabled.

 

See more
How to enable FreshService integration with ONARKEN®?

Prerequisite: You must have purchased the ONARKEN® FreshService integration licence to enable the following features. 

This guide describes the process to connect the ONARKEN's in built integration to FreshService ITSM. 

To get started, you must first navigate to the 'Integrations' page. 

ONARKEN integrations page

Select FreshService.

 

If you have not purchased the FreshService integration license, you will receive the following message when you attempt to connect. 

 

 

Follow the steps below to connect ONARKEN® to your FreshService instance. 

Once connected to FreshService, the tickets view will have the additional columns in the 'All Tickets' table as described above. 

To see if the integration connection has been successful, if you navigate to a ticket page in FreshService, you should see the ONARKEN Smart Lockers button, as seen below. 

ONARKEN integration button in FreshService

This button will let you create drop off and collection tasks directly in FreshService. 

Assigning an account

After creating the connection between ONARKEN and FreshService, you must add a ticket requester ID of a user account that ONARKEN will create FreshService tickets under. 

For this example, we created a bespoke requester called 'LapSafe Smart Lockers', which we recommend so users can easily tell which FreshService tickets have come from ONARKEN however, you can use any FreshService requester. 

This requester account does not need Agent or VIP user permissions. 

To find the user id simply look at the URL of the requester details page, and the ID will be displayed here. The URL will be displayed in this format:

https://{subdomain}.freshservice.com/itil/requesters/{requester-id}

Copy the requester-idfrom the URL and paste this into the Ticket requester ID field in ONARKEN®. 

Please note: tickets linked to FreshService cannot be closed directly from within ONARKEN® when connected to FreshService, or any other ITSM platform.

For more information on configuring ticketing settings, see Automatic Ticketing and Fault Reporting Settings

 

 

See more
Troubleshooting FreshService Integration

Prerequisite: You must have purchased the ONARKEN® FreshService integration licence to enable the following features. 


Drop Off & Collection Integration

Ensure you have a personal access token generated for FreshsService and bound to your account. 

A ticket requester ID must be specified in the FreshService integration settings. 

Make sure that the ticket requester ID is linked to a FreshService account. We recommend creating a new dedicated account to report tickets from ONARKEN, so that it is easier for you to filter ONARKEN tickets against tickets from other users or sources. 

onarken freshservice connection cropped.webp

Ensure your FreshService subdomain name is correct, and that your API token was entered correctly when activating your FreshService. 
 

Ticket Linking

If you are having issues when managing the workflow for closing ONARKEN tickets in FreshService, you can view the execution logs which will show any issues with the workflow. 

FreshService execution logs page

Key points to check:

  • Ensure that the endpoint for the web request is correct
  • Check that you have used the correct subdomain name for your ONARKEN® instance in the endpoint URL. 
  • Check that an inline credential is enabled for the web request, and that the 'Authentication Type' is set to 'API Key'
    • The API Key must be set to 'Authorisation'
  • The request type must be set to 'POST', and the correct headers must be set as described in the setup guide. 

In ONARKEN, check that your personal access token you created for FreshService is present and active. You will be able to see if it has been used as the 'Last used at' date will be populated. If you do not save this token, you will have to regenerate it as you cannot view the token in ONARKEN once it has been created. 

 

 

See more

Information & Statements

See all articles
ONARKEN® Smart Locker Software - Open Source Software Disclosure

(Effective as of June 2026, subject to change)

ONARKEN® includes third party open source components across its several services. These components are licensed for use and redistribution under open source libraries. Most of these components are essential for the day-to-day running of ONARKEN®. Notwithstanding any of the terms and conditions of your licence agreement with LapSafe®, the terms of certain open source licences may be applicable to your use of ONARKEN® services.  

This list of open-source code was compiled with reference to third party software integrated into the ONARKEN® smart locker client at the time the list was generated. This is in intended to be a disclosure at a particular point in time only. This list may be updated from time to time. Assuming you do not modify the open source code used within ONARKEN® services, the use of the ONARKEN® smart locker services will not require you to grant any party any of your intellectual property rights pursuant to a open source licence, or require you to make any of your source code available to third parties pursuant to an open source licence. LAPSAFE SELF SERVICE SOLUTIONS® MAKES NO REPRESENTATION OF WARRANTY, EXPRESS OR IMPLIED, WITH REGARD TO THE LIST OR ITS ACCURACY OR COMPLETENESS, OR WITH RESPECT TO ANY OBLIGATIONS ARISING AS A RESULT OF YOUR MODIFICATIONS MODIFICATION TO SUCH OPEN SOURCE CODE OR TO THE SERVICES. BY USING THE ONARKEN SERVICES, YOU AGREE THAT IN NO SUCH EVENT SHALL LAPSAFE BE LIABLE FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE ANY SUCH MODIFICATIONS MADE BY YOU, OR ANY OBLIGATIONS ARISING THEREFROM INCLUDING, WITHOUT LIMITATION, ANY SPECIAL, CONSEQUENTIAL, INCIDENTAL OR OTHER DIRECT OR INDIRECT DAMAGES. 

License summary (Locker software)

Licence Production Package Count

MIT

24

Apache-2.0

5

BSD-3-Clause

1

Other

1

 

Licence descriptions

Full Disclosure Document

The full open source disclosure document is available for download below. 

 

See more
ONARKEN Core Concepts and Terminology

To fully understand the capabilities of the ONARKEN® platform, you should become familiar with several key concepts. We will arrange the following concepts in categories. 

Assets

Asset

An individual item or device registered for use with ONARKEN® smart lockers. 

Asset Type

A particular make and model of an asset. Asset Types contain a collection of assets. When a new asset is added to ONARKEN®, the Asset Type must be specified. 

  • Asset type names should be descriptive as they are used with our AI cameras to detect if the correct asset is present within the lockers.

Asset Reference

The unique name of an asset.  

Asset Category

A collection of asset types. These are used to filter the asset selection process on the locker software. 

Asset Tag

An ID of an asset retrieved from a MIFARE tag or barcode associated with your asset

  • If you have full integration with an LMS, please import your LMS item barcodes into this field. 
  • Multiple tags can be assigned to a single asset
Example asset tag ID as scanned from a MIFARE reader.

Smart Charging Profile

Tells ONARKEN® what current draw a particular asset is expected to have as it charges up while in the locker bay. This allows the device to be used with SmartLine charging at the lockers, and ensures that a device becomes loanable at a suitable charge level. 

  • If you have a device make and model that is not listed on the smart charge profile list, please contact support@lapsafe.com and arrange to send a sample device to LapSafe® for profiling. We cannot guarantee that devices will charge as expected in SmartLine™ locker bays otherwise. 

Smart Lockers

Bay

A useable locker space for devices and assets to be stored in. 

Locker Map

An interactable UI element that is a visual representation of the smart locker installation. This allows users to select locker bays based on position and tower location instead of relying on the bay number. 

Example 'small' locker map

Terminal

The section that houses the touchscreen and smart locker PC running the ONARKEN® locker software. 

Bay features

The hardware capabilities and configuration of the locker bay. 

PowaSave™

A technology for smart charging (SmartLine™) capable lockers designed to provide power saving when devices are left in lockers for long periods. When groups of devices are detected as fully charged, the ONARKEN® smart locker will stop charging the group to avoid power wastage, and only provide minimal power. 

Example chart ONARKEN® generates when calculating PowaSave™ energy savings. 

Loan lockers

Lockers that are set up to have an assigned asset or device to them, that users can loan for a customisable set period. The asset or device must always be returned to the locker after use. 

Drop off and Collection Lockers

Locker bays that have no permanently assigned asset to them, but instead can be used for a assets to be securely placed in the locker and removed at a later time, and used for temporary storage. Once collected, the asset does not have be returned to the locker, and a new asset can be assigned to the bay. 

Hot lockers

Hot Lockers are locker bays where the bay space itself is loaned to the user, instead of the asset inside. Available Hot Lockers can be loaned by the user at the unit, or assigned to specific users on the ONARKEN® management platform. 

Loans

Loan

A transaction where a user takes an asset assigned to a specific smart locker bay for temporary use

  • Each loaned device must be returned to the same locker bay. 

Loan return

The process of the user returning an loaned asset to the locker after having used it for the assigned period. 

Loan rule

A customisable set of rules adjusting how long the devices should be on loan to the user for, how users report faults, what asset types the loan rules apply too, what smart lockers are able to use the loan rule and how assets and hot lockers are handled on return. 

An example set of loan rules created for different loan lengths and for different assets

Quarantine

A process where bays are withheld from transactions for a period of time after an asset has been returned. This can be for a set period of time after the return, or until the assigned asset to the bay has been checked by an administrator. 

Fault Report

A process where a user fills out a customised form on the ONARKEN® software to describe an issue with the asset they loaned on return. 

Tickets

Reports created on the ONARKEN® portal when assets are returned with faults, require repairs, when overdue or for other custom reasons. Can be connected and synced with tickets on various ITSM platforms. 

Drop Offs, Collections and Swaps

Drop Off

A transaction that occurs at the locker, where an asset is placed into the locker for collection later, typically for another user. 

Collection

A transaction that occurs at the locker, where an asset that was placed into the locker is then removed from the locker. The asset does not have to be returned to the locker, unless a return is specified of later. 

Swap

A transaction that takes place at Drop Off & Collection locker, where an existing asset within a drop off & collection locker bay is removed and replaced with another asset. The replacement asset is then available for collection, or to be swapped itself. 

Stack

A group of drop off, collection or swap transactions (or a mixture of the three transactions) grouped together into a single transaction 

Flexible Stack

A stack with a series of transactions that users can complete in any order. 

Static (Ordered) Stack

A stack with a series of transactions that must be completed in a particular order. 

Reason

A custom description that can be added to an asset that has been drop off. A custom colour can be picked, which will highlight the bay in the locker map to stand out against regular drop offs. 

Replenish

A quick method to restock drop off and collection lockers with new assets. 

Scenario

A custom workflow that allows users to self-serve assets from drop off and collection bays. ONARKEN® Management platform users can configure how assets are selected, if users need to submit notes, and if users need to be notified of a collectable asset being present in the locker. 

Policies

Permissions that restrict drop off’s to a customised list of asset types. Policies can be set for individual drop off and collection locker bays. 

Logins and user interaction

User Code

A unique user ID assigned to an ONARKEN® user's account. Multiple user codes can be assigned to a single account. These can be manually typed codes or usernames, barcodes or RFID tag ids. 

User PINs

A PIN or password assigned to a user code. If secondary authentication is enabled on the locker, the user will have to enter a valid PIN or password to use the lockers. 

One-Time Code

A login code that only allows a user to log in at the ONARKEN® installation to perform a specific transaction. The code expires once the transaction is complete. A user that does not have a registered ONARKEN® account can use the lockers through this method. 

  • When one time codes are generated, a numeric ID and a scannable barcode are created. 
Example one-time code 

Fault Report

A form that end user can enter details and submit to register an issue with a loaned device. When submitted, the report creates a ticket which must be resolved before the asset is made loanable again. 

Digital Pass

A virtual ID pass that users can download and save on their iOS or Android device. They can then log into any connected smart lockers or vending machines by scanning this code at the lockers. 

Reservations and Bookings

Reservation

A singular loan locker bay is removed from the general loan pool for a specified period, for a specific user to pick up the asset later. The asset is then loaned as usual. Reservations can be created by the user themselves, or by an ONARKEN® administrator for another user. Only one asset can be reserved at a time.  

Booking

Bookings are designed for all assets within a selected asset type to be 'booked out' at an appointed time. A single asset can be booked, but bookings are typically used for multiple assets. The bays are reserved to only accept loan returns, and then the assets are released for collection at the specified time. When collected, the assets go on loan to the user as normal. 

The most common use case for this workflow, is where a range of assets is booked for a class of students in advance of a lesson. 

Booking Release

Booked assets are released back to the loan pool automatically if not collected within a set amount of time after the booking date (default grace period is 20 minutes). Bookings can also be released manually. 

Vending

Stock

A list of available asset types at a vending machine. 

Vend Request

A transaction including pre-allocated assets available for the user to take at the vending machine.  Allocated assets are not available for other users to take. The user logs in using a one-time code. 

Hot Lockers

Hot lockers

Hot Lockers are locker bays where the bay space itself is loaned to the user, instead of the asset inside. 

Allocation

Hot lockers can be pre-allocated to users by ONARKEN® administrators, to prevent the hot locker from being loaned by anyone else. 

Hardware Terminology

PowaSave™

A technology for smart charging capable lockers designed to provide power saving when devices are left in lockers for long periods. When groups of devices are detected as fully charged, the ONARKEN® smart locker will stop charging the group to avoid power wastage, and only provide minimal power. 

A chart is generated to display when locker bays enter PowaSave™ mode, showing how long the bays are and are not in PowaSave mode, and how much energy and carbon was saved. 

Standard Charging

Indicated on ONARKEN® by a 3 pin socket icon. Bays fitted with ChargeLine™ or ChargeLine™ ULTRA plug sockets will have this icon. Devices are charged via an AC adapter socket installed in the locker bay. 

Smart Charging

Indicated on ONARKEN® by a electricity bolt icon. Bays fitted with SmartLine™  charging leads will have this icon. Devices are charged by the provided power cables, and monitored by the software. 

Administration

Manual Completion

A process on the ONARKEN® server dashboard, to mark a Drop off, collection or swap as completed without using the lockers. This should only be used when the transaction action fails at the locker. 

Roles

Sets of permissions that control whether ONARKEN® users can have access to the ONARKEN® management platform, and users can and cannot do on the management platform. 

Access Groups

User groups that manage ONARKEN® users access to ONARKEN® installations and asset types. 

  • e.g A user that has access to a smart locker and can borrow Chromebooks but not iPads, will not be able to select any asset belonging to the iPad asset type when they log in on the locker software. 
  • A user that attempts to log into a locker without permission via their access group(s) will be completely prevented from accessing the locker. 
  • A user can be assigned to multiple Access Groups

Locker Admins

A permission that grants users the ability to access the admin zone settings on the locker software. This enables them to manually open locker doors, load and unload assets, test locker hardware and check the status of the locker. 

Locations

You are able to set the location of your smart installations connected to ONARKEN®. This can help users when finding your smart lockers or vending machines, when using myONARKEN®.

  • Available collectable assets at smart lockers, and stock at vending machines will also be grouped by location. 
  • A map location can be configured, ONARKEN will connect to Google maps and display the location with  a pin located at the installation site in an image. 

    List of example locations

Location Administrators

A permission that grants users the ability to manage vending stock, and approve vend requests for users at vending machines within the selected location. 

 

 

See more
Accessibility Statement
We at LapSafe® Self Service Solutions are committed to accessibility, and to make our products as inclusive and compliant with regional guidelines as much as possible. 
 

Conformance status

The Web Content Accessibility Guidelines (WCAG) define requirements for designers and developers to improve accessibility for people with disabilities. It defines three levels of conformance: Level A, Level AA, and Level AAA. ONARKEN® has been assessed against all three conformance levels against the WCAG 2.0 and 2.1 standards. Partially conformant means that some parts of the content do not fully conform to the accessibility standard. All exceptions have been noted. 

All ONARKEN software products are tested regularly. Our goal is to become fully compliant with the industry standard WCAG 2.1 AA for the web management platform application and with the EN 301 549 standard for our ONARKEN locker self service software and smart locker hardware range. The ONARKEN management platform and self-service client have been assessed as a single package.  
 

European Accessibility Act

Our internal Quality Assurance department is engaged in a process of reviewing ONARKEN, our website and electronic documents, for the new regulations which came into force on 28th June 2025. This law applies to non-EU companies that sell within the EU market. 

All ONARKEN® compatible smart locker products have been evaluated against the European Accessibility Act ETSI EN 301 549 standard. We are compliant with the majority of clauses in EN 301 549 documentation, with a few exceptions noted in the ACR. 
 

Accessibility Policy

An Accessibility Conformance Report document has been produced, assessing the ONARKEN cloud management platform, ONARKEN client locker software and all compatible smart locker hardware products.  LapSafe uses the Voluntary Product Accessibility Template (VPAT) to publish the ACR, which provides an audit of our systems relative to the WCAG 2.1 standards. 

All electronic documents related to ONARKEN are created and available on LapSafe's® support documentation website, which uses Zendesk Knowledge base. Where applicable, our own documentation has been assessed internally, otherwise the results from the appropriate Zendesk ACR have been used. For more information regarding accessibility compliance with our electronic documents, see the Zendesk accessibility statement here: https://www.zendesk.co.uk/company/agreements-and-terms/accessibility/ 

Our ACR is downloadable as a PDF or Word at the bottom of this article, titled "ONARKEN ACR EAA V1". 
 

Recommended Screen Readers, Browsers and Accessibility Extensions

Please refer to the ONARKEN system requirements for more information on running ONARKEN. 

  • Windows: Use the latest version of Google Chrome or Mozilla Firefox, combined with the latest version of JAWS or NVDA. 
  • macOS: Use the latest version of Safari, combined with the inbuilt VoiceOver screen reader. 

     

StyleSheet configuration

We have made adjustments to make our web content easily readable by as many web users as possible. If additional adjustments, or custom colour themes are required for a user to use ONARKEN portal, we recommend using a Visual CSS browser extension. For configuration of the browser display for users with visual impairments, we recommend the StyleBot extension for Google Chrome, Mozilla Firefox and Microsoft Edge.  
 

Feedback

We welcome your feedback about accessibility. Please let us know if you encounter any accessibility barriers with ONARKEN®, or have any suggestions to make ONARKEN more accessible. 

If you wish to perform your own accessibility assessment on ONARKEN or our ONARKEN compatible smart locker products, please contact us. 
 

Phone: 01787 226 166

Email: info@lapsafe.com


Postal Address
Unit 2-3
Wakes Hall Business Centre
Wakes Colne
Colchester
Essex
CO6 2DY
United Kingdom

 

We try to respond to feedback within 5 business days.


 

See more