At each stage of the communication between the Mews server and the key encoder, 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.

Information flow from Mews Server to Mews Connector application

 

1. A user creates a key from the reservation module in Mews by selecting an encoder.
2. Mews server registers this event and sends the key creation message to the Mews Connector application. It identifies the right Mews Connector by the access token used when setting up Mews Connector.
3. The arrival and departure time of the message is sent in UTC time.
4. The key creation message contains information such as the API URL (IP Address and Port Number), username, password, and the Data JSON. All of these were previously configured in Mews Marketplace > My subscriptions > key cutter integration

 

Information flow from Mews Connector application to your door lock software Server application

 

1. The Mews Connector application receives the key creation message from the Mews server.
2. Mews Connector takes the time zone of the computer and converts UTC time in the original message to the property's local time.
3. Mews Connector translates and formats the key creation message into the door lock software's accepted protocol based on the "Type" specified in the Data JSON field.
4. Mews Connector 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.

 

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

Note: "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.

 

 

Information flow between the door lock software server application, the client application, and the encoder device

 

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

 

If the processing is successful:

 

1. The message gets passed on in the lock software system and reaches the targeted encoder (user selected it in the reservation module in Mews).
2. If the message is processed, the user is able to place a key card on the encoder.
3. The key creation process is successful.
4. The encoder responds with a success message to the lock software.
5. Lock software then passes on the corresponding status/response code to Mews Connector.
6. Mews Connector returns the response to Mews Server.
7. The status message is 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:

 

1. If there were some issues with either key card or the encoder, the encoder throws an error, which is returned to the lock software.
2. If the key creation message could not reach the encoder, the lock software registers an unsuccessful key creation attempt.
3. The lock software informs the Mews Connector application of key creation failure with the relevant response code.
4. Mews Connector returns the response to Mews server.
5. The status message is displayed in the Device Commands Queue (Main menu > Queues > Device Commands)

If processing was unsuccessful:

 

1. The lock software returns an error code to the Mews connector application.
2. Mews Connector returns the response to Mews server.
3. The status message is displayed in the Device Commands Queue (Main menu > Queues > Device Commands)

 

How is unsuccessful key creation related to key cutter troubleshooting?

 

When a key creation attempt was not successful, Mews recommends double-checking that the key creation message is passing through each checkpoint, in order to pinpoint the issue. Usually, 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.
• When there are network issues slowing down/blocking the communication between two systems.

 

 

Read more about Mews Connector and Key cutters

Mews Connector application for Windows

How to find logs in the Mews Connector app

Door lock protocols and key creation messages