Skip to main content

Mews

Mews is an Hotel management software that can be integrated in HSYCO with an API connection. The current release of the I/O Server has been tested with the Mews Web API.

HSYCO Configuration

Add a MEWS I/O Server in the I/O Servers section of the Settings and set its parameters:

High Availability

  • Shutdown when inactive: defaults to true.

Options

IDDefaultValuesDescription
clienttoken<key>mews client token
accesstoken<key>mews access token
startupeventsfalsetruegenerate IO events also during the driver’s start-up phase
falsestart generating events only after HSYCO is aligned with the current status of the system
useidasdatapointsfalsetrueuse the ID as the resources datapoint name
falseuse the name as the resources datapoint name
pollingtime10000>= 0time in milliseconds that Hsyco will wait before the next API check. If not set or set to 0 default is used
retryafterinterrupt10>= 0if the number of 429 error codes is equal to the value set the driver will restart
demoenvfalsetruethe driver will connect to the Mews demo sandbox. It should be used for testing purposes
falseif true, the driver will connect to the client’s instance specified by the access and client tokens
booleanvalueformatlegacymodefalsetrueall boolean datapoint values will be written as 1 or 0 as "true" or "false"
falseall boolean datapoint values will be written as 1 or 0

Datapoints

Basic infos

IDValueR/WDescription
connectiononlineRHSYCO connection socket is open
offlineRHSYCO cannot create the connection socket
info.nameStringRThe hotel name
info.legalenviromentcodeStringRThe hotel legal env code
info.location.cityStringRThe hotel city
info.location.postalcodeStringRThe hotel city postal code
info.location.countrycodeStringRThe hotel country code

Customers

IDValueR/WDescription
customer.<customerId>.nameStringRThe name of the user
customer.<customerId>.lastnameStringRThe lastname of the user
customer.<customerId>.reservationJsonRThis datapoint contains all the reservation for given customerId, if no reservation is present an empty Json array will be given.

Services

IDValueR/WDescription
service.<serviceId>.idStringRThe service id
service.<serviceId>.nameStringRThe service name
service.<serviceId>.isactivetrueRThe service is active
falseRThe service is NOT active
service.<serviceId>.isactive.alt1RThe service is active
0RThe service is NOT active

Departments

IDValueR/WDescription
department.<departmentId>.idStringRThe department id
department.<departmentId>.nameStringRThe department name
department.<departmentId>.isactivetrueRThe department is active
falseRThe department is NOT active
department.<departmentId>.isactive.alt1RThe department is active
0RThe department is NOT active

Resources

IDValueR/WDescription
resource.<resourceId>.idStringRThe resource id
resource.<resourceId>.nameStringRThe resource name
resource.<resourceId>.isactivetrueRthe resource is active
falseRthe resource is NOT active
resource.<resourceId>.isactive.alt1Rthe resource is active
0Rthe resource is NOT active
resource.<resourceId>.stateDirtyRThe resource is dirty
CleanRThe resource is clean
InspectedRThe resource is inspected
OutOfServiceRThe resource is Out Of Service
OutOfOrderRThe resource is Out Of Order
resource.<resourceId>.checkedintrueRThe resource owner is currently checked-in in that specific resource
falseRThe resource owner is NOT currently checked-in in that specific resource
resource.<resourceId>.checkedin.alt1RThe resource owner is currently checked-in in that specific resource
0RThe resource owner is NOT currently checked-in in that specific resource
resource.<resourceId>.checkedinbyStringRIf the checkedin is true, this datapoints shows the owner name and lastname
resource.<resourceId>.checkedinbyidStringRIf the checkedin is true, this datapoints shows the owner id
resource.<resourceId>.reserved.todaytrueRThe resource is reserved for the current day
falseRThe resource is NOT reserved for the current day
resource.<resourceId>.reserved.today.alt1RThe resource is reserved for the current day
0RThe resource is NOT reserved for the current day
resource.<resourceId>.reserved.tomorrowtrueRThe resource is reserved for the next day
falseRThe resource is NOT reserved for the next day
resource.<resourceId>.reserved.tomorrow.alt1RThe resource is reserved for the next day
0RThe resource is NOT reserved for the next day

Tasks

IDValueR/WDescription
task.newJsonWJson that contains data for creating a new task (Read example below)

New Task Example

In this example HSYCO is using the following format to create a new task:

INIT : {
var obj = new Object();
obj.Name = "Clean room 101";
obj.Description = "Start cleaning the room 101 asap";
obj.DeadlineUtc = "2023-02-06T18:00:00Z";
obj.DepartmentId = "915fbb82-de35-48a0-9e9b-f4a7eac711bb";
var jsonString = JSON.stringify(obj);
ioSet("mews.task.new", jsonString);
}

Where "DepartmentId" is the id of the department with the task is assignd to, you can get this id reading the "mews.department" datapoints in HSYCO and "mews." is the name of the mews I/O Server in HSYCO

Release Notes

3.10.0

  • added booleanvalueformatlegacymode option

3.8.0

  • initial release

Mews is a registered trademark of Mews Systems