What is this article about?

This article gives a high-level overview of how the information flows from Mews Server all the way to the key encoder and back to Mews Server (to confirm success or failure of key creation attempt).

At each stage of the communication, the recipient of the key creation message responds to the sender of the message to indicate whether the message was received and processed successfully.

Your key creation attempts could result in error if any issues occurred at any stage of the information flow.

Mews Server to Mews Connector application

  • A user creates a key from the reservation module in Mews by selecting an Encoder
  • Mew Server (in the cloud) registers this event and sends the key creation message to the Mews Connector application. It identifies the right Connector by the Access Token used when setting up Connector
  • The arrival and departure time of the message is sent in UTC time
  • The key creation message contains information such as the API URL (IP Address and Port Number), user name, password, and the Data JSON. All of these were configured in your Key cutter integration under Mews Marketplace > My subscriptions

Mews Connector application to your door lock software Server application

  • The Mews Connector application receives the key creation message from the Mews Server
  • Connector takes the time zone of the computer and converts UTC time in the original message to the property's local time
  • Connector also translates and formatted the key creation message into the door lock software's accepted protocol based on the "Type" specified in the Data JSON field
  • Connector then sends the translated key creation message to the door lock software's Server application at the IP Address & Port Number specified in the original message and awaits a response from the door lock software

(!) If you have a door lock software that uses the FIAS protocol, then the Mews Connector application typically expects the door lock protocol to initiate contact to establish a connection. However, if you are using a Dormakaba software, then you will need to set the Mews Connector application in "Client mode" so that it initiates the contact.

Door lock software Server application - Client Application - Encoder device

  • The door lock application receives the key creation command/message from the Connector application and registers it in the database and processes it.

If processing successful:

  • If successful, the message gets passed on in the lock software system and reaches the targeted Encoder (user selected it in the reservation module in Mews)
  • If the message reached the encoder, and gets processed, the user will be able to place a key card on the encoder
  • If there were no issues with the key card or the encoder, then the key creation process will most likely be successful
  • The encoder will respond with a success message to the lock software
  • Lock software then then passes on the corresponding status/response code to Mews Connector
  • Mews Connector then returns the response to Mews Server
  • The status message is then displayed in the Device Commands Queue (main menu > Queues > Device Commands)

If lock software was able to register message, but encoder was not able to complete the key creation process:

  • If there were some issues with either key card or the encoder, the encoder will throw an error, which is then returned to the lock software
  • IF the key creation message could not reach the encoder, then the lock software will register an unsuccessful key creation attempt
  • The lock software then informs the Connector application of key creation failure with the relevant response code
  • Mews Connector then returns the response to Mews Server
  • The status message is then displayed in the Device Commands Queue (main menu > Queues > Device Commands)

If processing was unsuccessful:

  • If processing was unsuccessful, the lock software returns an error code to the Mews Connector application
  • Mews Connector then returns the response to Mews Server
  • The status message is then displayed in the Device Commands Queue (main menu > Queues > Device Commands)

*”Type” in Data JSON corresponds to the door lock protocol with which the Mews Connector application communicates with your door lock software. See individual key cutter set up guides for more detail on the one to use for your key cutter.

How is this related to key cutter troubleshooting?

When a key creation attempt has not been successful, Mews recommends double-checking that the key creation message is passing through each checkpoint, in order to pinpoint the issue. Most often, the issue occurs

  • When the key cutter integration has not been configured correctly in all relevant places
  • When the key cutter is not able to receive or successfully process key creation commands sent from Mews Connector
  • Or there are network issues slowing down/blocking the communication between two systems.

Check out the Key cutter response messages collection to dive into specific error messages.

Read more about Mews Connector and Key cutters:

Did this answer your question?