Vostio key cutter integration for Mews Operations

 

 

This help article guides you through the process of setting up your Mews system to integrate to the Assa Abloy Vostio door lock system. It is meant for systems administrators who are able to add and edit integrations. It also includes help with troubleshooting, in case of unexpected events related to the integration. You need to perform the set-up process only once at the start. Once set up, staff at your property can create keys from within Mews Operations without needing to log in to the Vostio system.

In this article you can learn the following process of setting up your Mews system to integrate to the Assa Abloy Vostio door lock system:

 

Introduction

Overview 

Before you begin the step-by-step process, here's an overview of how the system works.


System Overview
 

Prerequisites

You need the following to set up the integration:
  • Assa Abloy Vostio integration: Contact your Assa Abloy local tech support and request them to set up and activate an integration to Mews. As part of this process, you need to generate a set of Vostio API credentials for Mews to use. Refer to Step 1: Get Vostio Credentials below
  • Access privileges: Access privileges to add and edit integrations within the Mews system.
  • Key cutters/ Key encoders: At least one physical key cutter/ key encoder.
 

Setup process

The setup process consists of the following steps: 


Step 1: Get Vostio credentials

Get the Vostio credentials that Mews needs to access the Vostio API. In this step, follow the Vostio setup process to set up the integration and generate a set of credentials for Mews to be able to connect to Vostio. The credentials are within a file that you download to your computer. You need to store the file securely, as it contains confidential information to access the Vostio system. Note: All the examples in this article use dummy data. In Step 2, you enter the data into the Mews system.

 

Process

  1. Log in to the Vostio system at https://vostio.assaabloy.com/.
  2. Follow the instructions in the Vostio manual or setup guide to set up the integration to Mews and navigate to the part of the system from where you generate a new set of Vostio API credentials.
  3. Enter a meaningful name for the credentials, for example, "Mews - <property name>".
  4. Download the credentials file and save it securely so that you can open the file to extract the contents.
  5. Open the credentials file in your preferred text editor, for example, Notepad on Windows or TextEdit on Mac. You need the username and password in Step 2 "Create the Vostio integration in Mews". Use cut-and-paste to extract the relevant data.

Note:

  • Do not include the quotation marks, just the text within them. 
  • The example here uses dummy data.

For example:

  • Username: S3I4l4VOhvfC308uk877
  • Password: QPxC6PxU;*DSH%H9D.i#

 

Step 2: Create the Vostio integration in Mews

You need to have the necessary access privileges to add and configure integrations.

  1. Log in to Mews Operations. 
  2. Go to the main menu Screenshot_2.png > Marketplace and under the "Facility management" category which lists all key cutter integrations, type in "vostio" in the search bar. The integration name is "Vostio key cutter integration".

 

Mews Vostio key cutter integration

 

  1. Click Explore to open the integration and access the settings.
  2. Enter Name, Username and Password. You can keep the default name, which is "Vostio-integration" as Name. For Username and Password, enter the username and password that you obtain from the Vostio API credentials in Step 1.
  3. Click Save.

 

Mews Key cutter settings

 

 Step 3: Set up Key cutters

Set up the individual key cutters that physically encode keycards. In this step, you set up all your individual key cutters or key encoders in Mews, one for each physical device. Follow the detailed process below.
 

ℹ️ Terminology

Note the terms Key cutter and Key encoder refer to the same thing. Modern keys are normally in the form of cards the size of credit cards, and are digitally encoded with secure information about what rooms they can access and when, whereas traditional keys were physically cut to shape out of metal.

 

Process

  1. In the Vostio system, follow the Vostio manual or setup guide to navigate to the list of encoders. Make a note of the names of the encoders. You need to use these names when setting up the encoders in Mews.
  2. In Mews Operations, open the Vostio integration you created in Step 2 and click Key cutters. Click on + on the top-right to add a new key cutter.

 

Mews Key cutters

 

Mews Key cutter Add

 

  1. For each key cutter you add, you need to enter the Name and Identifier. Select a suitable name that is clearly identifiable to your staff. For example, "Reception LEFT" or "Reception RIGHT" 
  2. In the Identifier field insert the name of the Key cutter as it appears in the Vostio system. This enables Mews to identify the correct Key cutter when interacting with the Vostio integration.
  3. Keep the Data JSON field blank.
  4. Click Save to create the Key cutter.

 

Mews Key cutter Identifier

 

  1. On successful completion of all integration details, select Enabled to make the integration live. 
  2. Then click Save.

 

Mews integration Enabled

 

Step 4: Set up space mappings

If necessary, set up space mappings to map Mews spaces to Vostio spaces. This is an optional step, You only need it if your rooms and other spaces have different names or identifiers in Vostio and in Mews. Follow the detailed process below to set up the mappings. 

 

ℹ️ What are space mappings?

If Mews refers to its rooms and other spaces using different names or numbers than in Vostio, you need to 'map' them. For example, if Mews issues a Create key command for space "402" but Vostio refers to that space as "0402X", then the system needs to know to send the command for "0402X" and not "402". If the notation is the same in both systems, then you can skip this step.

 

Process

Firstly, check the space naming/ room numbering system in Vostio to check if it differs from Mews. Follow the Vostio manual or setup guide to navigate to the appropriate screen.

  1. To set up space mappings in Mews Operations, open the Vostio integration created in Step 2.
  2. Click Key cutter mappings. Click on + at the top-right to add each new key cutter mapping entry in the mapping table.

 

Mews Key cutter mappings
  1. For each key cutter mapping that you add, you need to enter Room and Lock identifier.

    • Room is the name or number of the room or space in Mews,
    • Lock identifier is the name or number of the corresponding room or space in the Vostio system.

 

Mews Key cutter mappings Lock Identifier
 

Step 5: Test the integration

Check that the integration works as expected. This final step is to try out the integration to make sure it works. If it doesn't, go back and check all the previous steps. Refer to the overview diagram at the beginning of this help article. If this doesn't resolve the issue, then refer to the Troubleshooting section below. 

To test the integration, follow your normal process for creating keys, whether that's from the Reservations management screen in Mews Operations or via the Mews Kiosk.

If creating keys from a reservation and you have multiple Key cutters set up, you need to select the one you want to use.

 

Mews Create keys
 

Troubleshooting

If the integration doesn't work as expected, go back and check all the previous steps. You can refer to the overview diagram at the beginning of this help article.

The best way to identify a problem is to check the progress of the Create key command through the system, from when you first request a key through to the Vostio system and on to the encoder that physically encodes the key. Within Mews, the create key instruction is a type of device command and you can follow its progress by consulting the Device commands queue.

You can find this in Mews Operations, at: main menu Screenshot_2.png > Queues > Device commands

The Device commands queue allows you to track commands through the system to see if any errors or blockages occur. In particular, you can see the status of an individual command. The expected progress is from PENDING to either PROCESSED or ERROR, according to the result that the Vostio system returns.

  • PENDING: The command is still on the queue awaiting execution.
  • PROCESSED: The command execution was successful.
  • ERROR: An error occurred in executing the command.

 

⚠️ UTC time format

Note that the times recorded for Device command events are in UTC format, i.e. Universal Time, so you need to adjust this as per your local time zone.

For more information, see The Device commands queue. If you still have unresolved issues, you can access the Mews Digital Assistant in Mews Operations.

 

Additional resources

You can find more information about key cutter integrations in the following help articles:

 

⚠️ IMPORTANT: Mews Connector integrations

Please ignore any references to Mews Connector for Vostio integrations!

The Assa Abloy Vostio integration is a new cloud-to-cloud integration. Prior to this, door lock integrations were "cloud-to-premise".

This means that you connect Mews with the door lock system on-premise at the property via a system component called Mews Connector. This includes Assa Abloy Visionline as well as integrations with Salto, Haflok and other Mews partners. As a result of this, any reference to Mews Connector in the help articles does not apply to the Vostio integration. Mews is working to gradually update all the existing help articles to make sure they include Vostio. 







Was this article helpful?
00



Feedback