Specyfikacja protokołu PMS 3CX

Wprowadzenie

Ten rozdział opisuje protokół PMS 3CX, który integruje się z oprogramowaniem hotelowym PMS. Protokół PMS 3CX jest bardzo zbliżony do protokołu PMS Mitel lub Oracle Micros-Fidelio, dlatego w systemie PMS możliwe jest wskazanie protokołu Mitel PMS (SX2000) lub FIAS. Protokół Mitel został szczegółowo opisany w tym rozdziale, natomiast protokół Micros-Fidelio jest standaryzowany przez Oracle Micros.

Formularz specyfikacji rekordu dostawcy Micros FIAS

3CX posiada certyfikację od Micros-Fidelio po zakończeniu programu interoperacyjności.

Ogólne informacje o protokole Mitel

Dwukierunkowe połączenie PMS/system (w trybie half-duplex) wykorzystuje protokół ENQ/ACK/STX-tekst-ETX/ACK. Sekwencja transmisji PMS do systemu jest następująca:

Transmisja wiadomości jest zakończona.

Na sekwencje transmisji nakładane są ograniczenia czasowe:

Maksymalny czas oczekiwania na ACK po transmisji STX + msg + ETX wynosi 3 sekundy.

Transmisja z PMS do systemu

Po otrzymaniu znaku ENQ z PMS, system odpowiada w ciągu trzech sekund, wysyłając ACK lub NAK. ACK oznacza, że transmisja zakończyła się powodzeniem. NAK oznacza, że wystąpił błąd transmisji lub że system jest zajęty. System generuje wpis w dzienniku hotelowym wskazujący, że wystąpił taki błąd. Po wysłaniu ACK system natychmiast jest gotowy do odbioru STX, tekstu wiadomości i ETX. W ciągu trzech sekund od otrzymania ETX, system odpowiada:

• ACK, co oznacza, że transmisja zakończyła się powodzeniem i wszystkie pola wiadomości są poprawne.
• NAK, co oznacza, że wystąpił błąd w samej transmisji, w jednym z pól wiadomości lub w składni wiadomości (w szczególności STX, ETX, kod funkcji i kod statusu, np. gdy zostanie wysłane CHK3 zamiast CHK1). System generuje wpis w dzienniku hotelowym wskazujący na ten błąd. PMS może ponowić wysłanie jedynie samej wiadomości txn (STX, tekst wiadomości i ETX) do trzech razy, bez ponownego przesyłania wiadomości ENQ.

Poniższy przykład ilustruje ponowienie transakcji PMS:

Następnie PMS odrzuca transakcję.

Specyfikacja formatu PMS

Wiadomości mają następujący ogólny format:

Wiadomości Check In/Out

Wiadomość ma następujący format:

X: Kod statusu Check In/Out

• Znak ASCII 1 dla Check In
• Znak ASCII 0 dla Check Out

SP: Znak spacji ASCII
n: Cyfra numeru wewnętrznego

Uwaga: Numery wewnętrzne krótsze niż pięć cyfr są wypełniane znakami spacji (ASCII 32, HEX 20), a nie zerami (ASCII 48, HEX 30).

Jeśli otrzymana wiadomość z PMS jest nieprawidłowa, system odpowiada NAK (znakiem ASCII oznaczającym negatywne potwierdzenie).

Przykład:

Check In (zameldowanie dla numeru wewnętrznego 100):

STXCHK1   100ETX (gdzie STX = 2, ETX = 3), co skutkuje wiadomością: 2CHK1   1003

Wiadomość Name

Ta wiadomość jest wysyłana z PMS i służy do wyświetlania nazwiska gościa na telefonie. Wiadomość Name ma następujący format wejściowy:

NAM: Kod funkcji Name.

NAME: Znak nazwy (maksymalnie 21 znaków).

n: Cyfra numeru wewnętrznego.

Długość nazwy (do 21 znaków) jest wyrównana do lewej, a pozostałe znaki są uzupełnione spacjami. Znaki mogą być małe lub wielkie oraz mogą zawierać cyfry. Można podać imię i nazwisko (oddzielone przecinkiem, który nie może się znajdować na 1. ani 21. pozycji), jednak jeśli podana jest tylko jedna nazwa, zostanie ona domyślnie zarejestrowana jako nazwisko. Pierwsza nazwa w ciągu musi być nazwiskiem, a następnie podaje się imię. Jeśli podana jest tylko jedna nazwa, 21. znak to spacja (maksymalna długość nazwy to 20 znaków).

Kod operacji na ciągu znaków umożliwia dodawanie lub usuwanie określonej nazwy przypisanej do numeru wewnętrznego.

System umożliwia przypisanie więcej niż jednej nazwy do jednej stacji, choć zazwyczaj przypisana jest tylko jedna.

Pierwszy bajt kodu statusu to kod operacji na ciągu znaków i może przyjąć jedną z następujących wartości:

1. (addition) – nazwa zostaje DODANA do bieżącej listy nazw przypisanych do tej stacji. Jeśli wcześniej żadna nazwa nie była przypisana, tworzony jest nowy wpis w książce telefonicznej.
2. (replacement) – nazwa ZASTĘPUJE pierwszą alfabetyczną nazwę przypisaną do tego numeru. Pozostałe nazwy nie są modyfikowane.

Jeśli otrzymana wiadomość z PMS jest nieprawidłowa, system odpowiada NAK.

Wiadomości Wake Up (budzenie)

System PMS może poinformować system, kiedy ustawić połączenie budzące dla określonego numeru wewnętrznego gościa. Wiadomość Wake Up ma następujący format wyjściowy:

t: Czas budzenia. 

n: Cyfra numeru wewnętrznego.

Czas budzenia podaje się w formacie 24-godzinnym. Cztery znaki, wypełnione spacjami ASCII, oznaczają usunięcie ustawionego czasu budzenia (format czasu: HHmm).

Przykład: połączenie budzące o godzinie 23:30 dla numeru wewnętrznego 100:

2MW 2330 1003

Wiadomość DND (Nie przeszkadzać)

System PMS może poinformować centralę PBX, kiedy ustawić status DND dla konkretnego numeru wewnętrznego gościa, wysyłając następującą wiadomość.

Format wiadomości DND:

KOD STATUSU:

• 1 – DND WŁĄCZONE
• 0 – DND WYŁĄCZONE
• SP: Znak spacji ASCII.

Przykład: ustawienie DND WŁĄCZONE dla numeru wewnętrznego 302:

• 2DND1   3023  STXDND1SPSPSP302ETX
• StxValue = 2
• EtxValue = 3
• ENQ = 5;
• ACK = 6;
• NACK = 21

Wiadomość Message Registration (rejestracja wiadomości)

Za każdym razem, gdy numer hotelowy wykonuje połączenie zewnętrzne, system wysyła wiadomość do PMS w celu aktualizacji całkowitej liczby połączeń zewnętrznych przypisanych do pokoju gościa. Nie rozróżnia się połączeń lokalnych od międzymiastowych. Rejestracja wiadomości działa poprzez zliczanie impulsów taryfikacyjnych naliczanych w czasie trwania połączenia.

Wiadomość Message Registration ma następujący format wyjściowy:

SP: Znak spacji ASCII.

n: Cyfra numeru wewnętrznego.

W tym przypadku kod statusu to opłata. To jedyny przypadek, w którym długość kodu statusu wynosi 4 bajty zamiast 2.

Komunikat o Ograniczeniu Stacji

Komunikat o ograniczeniu stacji może być użyty do wprowadzenia ograniczeń połączeń. Gdy ten komunikat zostanie wysłany z systemu PMS do systemu, wprowadza wcześniej zaprogramowane ograniczenia połączeń w życie.

Uwaga: Połączenia alarmowe (911/999) oraz połączenia wewnętrzne nigdy nie są ograniczane.

Komunikat o ograniczeniu stacji ma następujący format:

RST: Kod funkcji ograniczenia stacji.

X: Cyfra numeru wewnętrznego lub apartamentu.

S: eden z poniższych kodów statusu:

• 0 - Wewnętrzne
• 1 - Lokalne
• 2 - Międzymiastowe

StxValue = 2

EtxValue = 3

ENQ = 5;

ACK = 6;

NACK = 21

Komunikat o Statusie Pokojówki

Komunikat o statusie pokojówki służy do umożliwienia personelowi sprzątającemu ustawienia statusu pokoju za pomocą telefonu. Komunikat ten jest wyzwalany poprzez wykonanie połączenia z danego pokoju oraz wpisanie specjalnego kodu funkcji, a następnie odpowiedniego kodu określającego status pokoju.

Na przykład, wybranie „*682” z pokoju spowoduje wysłanie do systemu PMS komunikatu o statusie pokojówki, który ustawi status pokoju jako posprzątany.

Komunikat o statusie pokojówki ma następujący format:

X: Kod statusu pokojówki.

SP: Znak spacji w kodzie ASCII.

n: Cyfra numeru stacji (do 5 cyfr).

Gdy zostanie wybrany kod funkcji, system wysyła zarówno kod funkcji, jak i kod statusu do systemu PMS, który interpretuje je w następujący sposób:

Komunikat – Warunek zajętości pokoju

• STS1 - Pokojówka obecna
• STS2 - Pokój czysty
• STS3 - Pokój brudny
• STS4 - Pokój wyłączony z użytku
• STS5 - Do inspekcji
• STS6 - Zajęty / Czysty
• STS7 - Zajęty / Brudny
• STS8 - Wolny / Czysty
• STS9 - Wolny / Brudny

Ostatnia aktualizacja
Ten dokument został ostatnio zaktualizowany 18 lipca 2022
https://www.3cx.pl/docs/protokol-3cx-pms/