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 Connector 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
ID | Default | Values | Description |
---|---|---|---|
clienttoken | <key> | mews client token | |
accesstoken | <key> | mews access token | |
startupevents | false | true | generate IO events also during the driver’s start-up phase |
false | start generating events only after HSYCO is aligned with the current status of the system | ||
useidasdatapoints | false | true | use the ID as the resources datapoint name |
false | use the name as the resources datapoint name | ||
pollingtime | 10000 | >= 0 | time in milliseconds that HSYCO will wait before the next API check. If 0 or less than 10000 defaults to 10000 |
demoenv | false | true | the driver will connect to the Mews demo sandbox. It should be used for testing purposes |
false | if true, the driver will connect to the client’s instance specified by the access and client tokens | ||
booleanvalueformatlegacymode | false | true | all boolean datapoint values will be written as 1 or 0 as "true" or "false" |
false | all boolean datapoint values will be written as 1 or 0 | ||
enableverbosedump | false | true | when verbose logging is enabled, all requests and responses sent to the Connector API are logged in detail |
false | when verbose logging is disabled, requests and responses are not logged to the log files. No request details are written |
Polling
The MEWS I/O Server operates by periodically polling key data sources: Configuration, Services, and Departments are updated every 12 hours, with an option for manual refresh (see Request Refresh below). Customers, Companies, Resources, and Reservations (check-ins) are refreshed every 10 seconds, ensuring real-time updates and responsiveness.
Datapoints
Request Refresh
ID | Value | R/W | Description |
---|---|---|---|
request.configuration.refresh | online | W | Request an immediate Configuration's datapoints request |
request.services.refresh | String | W | Request an immediate Services' datapoints request |
request.departments.refresh | String | W | Request an immediate Departments' datapoints request |
Basic Info
ID | Value | R/W | Description |
---|---|---|---|
connection | online | R | HSYCO requested and obtained required resources within 30 seconds |
offline | R | HSYCO didn't obtain required resources within 30 seconds |
Configuration
ID | Value | R/W | Description |
---|---|---|---|
info.id | String | R | The hotel ID |
info.name | String | R | The hotel name |
info.defaultlanguagecode | String | R | The hotel default language code |
info.legalenviromentcode | String | R | The hotel legal environment code |
info.taxenvironmentcode | String | R | The hotel tax environment code |
info.pricing | String | R | The hotel pricing (Net or Gross) |
info.location.id | String | R | The hotel address ID |
info.location.address | String | R | The hotel full address |
info.currencies | String | R | The hotel allowed currencies |
Services
ID | Value | R/W | Description |
---|---|---|---|
service.<serviceId>.id | String | R | The service ID |
service.<serviceId>.name | String | R | The service name |
service.<serviceId>.isactive | true | R | The service is active |
false | R | The service is not active |
Departments
ID | Value | R/W | Description |
---|---|---|---|
department.<departmentId>.id | String | R | The department ID |
department.<departmentId>.name | String | R | The department name |
department.<departmentId>.isactive | true | R | The department is active |
false | R | The department is not active |
Customers
ID | Value | R/W | Description |
---|---|---|---|
customer.<customerId>.name | String | R | The first name of the customer |
customer.<customerId>.lastname | String | R | The last name of the customer |
customer.<customerId>.info | String | R | The full customer info, including Title and Sex, if applicable |
Companies
ID | Value | R/W | Description |
---|---|---|---|
company.<companyId>.name | String | R | The name of the company |
Resources (Spaces)
ID | Value | R/W | Description |
---|---|---|---|
resource.<resourceId>.id | String | R | The resource ID |
resource.<resourceId>.name | String | R | The resource name |
resource.<resourceId>.isactive | true | R | the resource is active |
false | R | the resource is not active | |
resource.<resourceId>.state | Dirty | R | The resource is dirty |
Clean | R | The resource is clean | |
Inspected | R | The resource is inspected | |
OutOfService | R | The resource is out of service | |
OutOfOrder | R | The resource is out of order | |
resource.<resourceId>.checkedin | true | R | The resource owner has checked-in |
false | R | The resource owner has not checked-in yet | |
resource.<resourceId>.checkedinby | String | R | The resource owner's name and lastname |
resource.<resourceId>.checkedinbyid | String | R | The resource owner's ID |
resource.<resourceId>.reserved.today | true | R | The resource is reserved for the current day |
false | R | The resource is not reserved for the current day | |
resource.<resourceId>.reserved.tomorrow | true | R | The resource is reserved for the next day |
false | R | The resource is not reserved for the next day |
Tasks
ID | Value | R/W | Description |
---|---|---|---|
task.new | Json | W | Json 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
- removed
retryafterinterrupt
option - added
enableverbosedump
option - added
Companies
datapoints - added
booleanvalueformatlegacymode
option
3.9.0
- added
retryafterinterrupt
configuration setting (defaults to 10) - bug fix: StartupEvent setting was not read correctly
- bug fix: when the driver gets a 429 error the connection datapoint is now set to "offline" until the rate-limit timeout expires
3.8.0
- initial release
Mews is a registered trademark of Mews Systems