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 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

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 0 or less than 10000 defaults to 10000
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
enableverbosedumpfalsetruewhen verbose logging is enabled, all requests and responses sent to the Connector API are logged in detail
falsewhen 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

IDValueR/WDescription
request.configuration.refreshonlineWRequest an immediate Configuration's datapoints request
request.services.refreshStringWRequest an immediate Services' datapoints request
request.departments.refreshStringWRequest an immediate Departments' datapoints request

Basic Info

IDValueR/WDescription
connectiononlineRHSYCO requested and obtained required resources within 30 seconds
offlineRHSYCO didn't obtain required resources within 30 seconds

Configuration

IDValueR/WDescription
info.idStringRThe hotel ID
info.nameStringRThe hotel name
info.defaultlanguagecodeStringRThe hotel default language code
info.legalenviromentcodeStringRThe hotel legal environment code
info.taxenvironmentcodeStringRThe hotel tax environment code
info.pricingStringRThe hotel pricing (Net or Gross)
info.location.idStringRThe hotel address ID
info.location.addressStringRThe hotel full address
info.currenciesStringRThe hotel allowed currencies

Services

IDValueR/WDescription
service.<serviceId>.idStringRThe service ID
service.<serviceId>.nameStringRThe service name
service.<serviceId>.isactivetrueRThe service is active
falseRThe 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

Customers

IDValueR/WDescription
customer.<customerId>.nameStringRThe first name of the customer
customer.<customerId>.lastnameStringRThe last name of the customer
customer.<customerId>.infoStringRThe full customer info, including Title and Sex, if applicable

Companies

IDValueR/WDescription
company.<companyId>.nameStringRThe name of the company

Resources (Spaces)

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>.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 has checked-in
falseRThe resource owner has not checked-in yet
resource.<resourceId>.checkedinbyStringRThe resource owner's name and lastname
resource.<resourceId>.checkedinbyidStringRThe resource owner's ID
resource.<resourceId>.reserved.todaytrueRThe resource is reserved for the current day
falseRThe 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

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

  • 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