Lucent Technologies DEFINITY Enterprise Communications Server And GuestWorks Property Management System Interface Specifications

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
59 Message Waiting 
Message Waiting
The Message Waiting feature turns on and turns off message waiting lamps in a 
room under two conditions:
nWhen the switch receives a message from the PMS
nWhen a user presses the Message Waiting Notification button on the atten-
dant console or a telephone (with notification to the PMS).
This feature controls only message status controlled by the PMS. Leave Word 
Calling or INTUITY AUDIX
® messages that activate message waiting lamps are 
not communicated to the PMS from the switch.
Feature Codes
The Message Waiting feature codes are as follows:
n13 — Normal mode
n33 — Transparent mode
n23/MSG — ASCII mode.
The message format for this feature is shown in Figure 14 on page 42
.
Process Codes
The process codes for the Message Waiting feature are shown in Ta b l e 11.
Table 11. Message Waiting Process Codes [Feature Codes 13 (N), 33 (T), 
or 23/MSG (A)]
Process 
CodeMessage 
Direction Indications
1 PMS to Switch Turn on message lamp of room telephone indicated.
2 PMS to Switch Turn off message lamp of room telephone indicated.
3 Switch to PMS Message lamp of room telephone indicated has been 
turned on via Message Waiting Notification activation 
from the attendant console or telephone.
4 Switch to PMS Message lamp of room telephone indicated has been 
turned off via Message Waiting Notification deactivation 
from the attendant console or telephone.
5
(T) (A)Switch to PMS Message lamp of room telephone indicated was already 
on or is still on due to another message type (for exam-
ple, Leave Word Calling or INTUITY AUDIX). 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
60 Message Waiting 
Operational Considerations
The Message Waiting feature message(s) will be sent and/or received and inter-
preted based on whether the Message Waiting Configuration option on the switch 
is enabled for PMS support. The possibilities are as follows:
nFeature active in switch with communication enabled on switch changes 
and active on valid PMS change requests (act-pms).
nFeature active in switch with no PMS communication (act-nopms).
Feature Active with PMS
With the Message Waiting Configuration option enabled (act-pms), the opera-
tional considerations are as follows:
nThe message waiting status for each RSN will be stored in switch memory.
nWhen a change in message waiting state for an RSN is entered via an 
attendant console or telephone (process code 3 to turn the lamp on or pro-
cess code 4 to turn the lamp off), the message will be sent to the PMS with 
the RSN indicated.
nUpon receipt in the switch of process code 1 to turn on the lamp or process 
code 2 to turn off the lamp, the appropriate lamp status change will be 
made by the switch.
If the lamp is on due to another message type and process code 1 or 2 is 
sent to the switch, the switch will return process code 5 (T) (A).
nWhen a (16,2) (N), (46,1) (T), or (29,1) (A) room check-out message is 
received from the PMS, a (16,6) (N), (46,2) (T), or (29,2) (A) check-out 
complete message will be sent to the PMS if the room telephone had the 
lamp on due to the PMS component of the message waiting lamp. A (16,5) 
(N), (46,3) (T), or (29,3) (A) message will be sent to the PMS if the mes-
sage waiting lamp is off. A (46,5) (T) or (29,5) (A) is sent if the message 
waiting lamp is on due to another message type (for example, LWC). The 
PMS component of the message waiting lamp for the RSN will always be in 
the off state after the (16,2) (N), (46,1) (T), or (29,1) (A) message has been 
processed. Subsequent status inquiries will report that the lamp is off (that 
is, the PMS component is off), even if the lamp is on due to INTUITY 
AUDIX or Leave Word Calling which are not supported through this inter-
face. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
61 Message Waiting 
Feature Active Without PMS
With the Message Waiting Configuration option disabled (act-nopms), the switch 
does not send message waiting messages to the PMS. If the PMS sends mes-
sage waiting messages to the switch, the switch will ACK the message. However, 
the switch will send a violation message to the PMS and not act on the received 
message. This information will be logged on the PMS Log printer if a printer is 
available. The message will be printed as “Feature active nopms.”
PMS Considerations
If the PMS does not store message waiting data, the Room Data Image for the 
RSN can be requested to obtain the current status as discussed in “Room Data 
Image” starting on page 72. However, if the switch reinitializes after a failure, this 
information may be incorrect.
Other Considerations
The ASCII mode has two new frames to support text and fax messages to the 
INTUITY (A). See Figure 14 on page 42
 for more information. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
62 Controlled Restriction 
Controlled Restriction
The Controlled Restriction feature enables an RSN to be restricted using selected 
origination and/or termination capabilities either from switch terminals (with com-
munication to the PMS), or on receipt of feature messages from the PMS.
NOTE:
The switch also has the capability to apply controlled restrictions to a group 
of rooms at one time. This capability is not supported on the PMS interface. 
Modification of user-controlled restrictions do not affect the values of group-
controlled restrictions.
Feature Codes
The Controlled Restriction feature codes are as follows:
n15 — Normal mode
n35 — Transparent mode
n25/CR — ASCII mode.
This feature message format is shown in Figure 15 on page 43
.
Process Codes
The process codes for the Controlled Restriction message are shown in Ta b l e 1 2.
Table 12. Controlled Restriction Process Codes [Feature Codes 15 (N), 35 (T), 
or 25/CR (A)]
Process 
CodeMessage 
Direction Indications
1 PMS to Switch Set restriction for indicated RSN.
2 Switch to PMS Restriction has been set for indicated RSN via the atten-
dant console or a telephone. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
63 Controlled Restriction 
Operational Considerations
The controlled restriction message communication with the PMS is based on the 
switch installation parameters. The possibilities are as follows:
nThe feature is active in the switch with no communication with the PMS 
(act-nopms).
nThe feature is active in the switch and communication with the PMS is 
active. In this configuration, the change can be initiated from either an 
attendant console or a telephone with console permissions on the switch 
(with notification of the change to the PMS), or from the PMS (with a 
request sent to the switch to impose the specified restriction level) 
(act-pms).
Switch Operations (act-pms)
The RSN and new restriction level will be sent to the PMS for changes to single 
user-controlled restriction levels.
When a (15,1) (N), (35,1) (T), or (25,1) (A) message is received from the PMS, the 
restriction change indicated will be implemented on the indicated RSN, overriding 
any previous single user-controlled restriction.
The controlled restriction level codes and the action indicated are shown in 
Ta b l e 1 3
.
Table 13. Controlled Restriction Level Codes and Actions
Level Action
00 No restrictions placed on RSN.
01 Outward restriction, which denies all local and toll calling from the room tele-
phone, or toll* restriction, which denies all toll calls.
02 Station-to-station restriction, which denies all calls to or from other tele-
phones (both administrative and guest rooms), or toll* restriction, which 
denies all toll calls.
03 Outward* and station-to-station* restriction (both levels 01 and 02 above in 
effect).
04 Total restriction, which denies all calls to and from the room telephone 
(effectively cuts off the room telephone service).
05 Termination restriction, which denies all calls to the room telephone.
06 Outward* and termination restriction (both levels 01 and 05 in effect).
07 Station-to-station* and termination restriction (both levels 02 and 05 in 
effect).
* Toll restriction can be substituted for either outward restriction or station-to-station
restriction. Toll restriction allows guests to place free outgoing calls. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
64 Controlled Restriction 
When a controlled restriction is set on an RSN, the denied outward/toll, 
termination, station-to-station/toll, and origination calls are routed to the translated 
intercept treatment.
The switch automatically removes previous single user-controlled restrictions, 
imposes controlled outward restriction on room check-out, and removes 
controlled outward restriction on room check-in. No (15,2) (N), (35,2) (T), or (25,2) 
(A) message is sent from the switch to the PMS for the automatic change.
NOTE:
If the Controlled Restriction Communication feature is active for the PMS, 
only manual changes made from a telephone for a single room will be sent 
to the PMS. Group-controlled restrictions will not be communicated to the 
PMS. Modification of user-controlled restrictions do not affect the values of 
group-controlled restrictions.
PMS Considerations
If the PMS stores controlled restrictions and sends a restriction message altering 
the level of restriction on an RSN, the PMS must also change its stored restriction 
level.
Switch Operations (act-nopms)
With the feature translated as act-nopms, the switch will not send controlled 
restriction messages to the PMS. If the PMS sends control restriction messages 
to the switch, the switch will acknowledge the messages. However, the switch will 
send a violation message to the PMS and not act on the received message. This 
information will be logged on the PMS Log printer if a printer is available. The 
message will be printed as “Feature active nopms.”
Other Considerations
In ASCII Mode, the restriction level value is a 2-digit field. When the restriction 
level is sent to the PMS, it is sent as “digit-blank.” The switch can receive the 
restriction level in several different ways: 0-digit, digit-blank, or blank-digit. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
65 Check-In/Check-Out 
Check-In/Check-Out
The Check-in/Check-out messages do not represent a unique feature, but rather 
are a convenient device for invoking a sequence of functions commonly per-
formed when a guest checks in or checks out of a room. It is expected that each 
check-in or check-out performed in the PMS will immediately be transmitted to the 
switch
*. Upon reception of the check-in/check-out message, the switch performs a 
sequence of operations based on its feature definitions.
The transmission of the check-in/check-out feature messages from the PMS is not 
an optional switch installation parameter, but is assumed a standard feature for 
switch operational integrity if the PMS is controlling room status.
The switch requires the check-in/check-out notification from the PMS to perform 
the appropriate internal status changes for that guest room for message waiting 
lamp status, wakeup request, and controlled restriction level. The switch also 
performs changes to the guest name and coverage path numbers (T) (A). Failure 
to communicate check-in or check-out information could result in invalid message 
waiting lamp status, the guest being unable to originate room telephone calls, the 
guest receiving an unrequested wakeup call (or no wakeup call at all), and 
erroneous guest names and coverage paths (T) (A). Immediate notification to the 
switch from the PMS is necessary to prevent these sources of guest 
dissatisfaction.
Feature Codes
The Check-In/Check-Out feature codes are as follows:
n16 — Normal mode (combined check-in/check-out message)
n36 — Transparent mode (check-in message)
n46 — Transparent mode (check-out message)
n26/CKI — ASCII mode (check-in message)
n29/CKO — ASCII mode (check-out message).
These feature message formats are shown in Figure 16 on page 44
, Figure 17 on 
page 45, and Figure 18 on page 46.
* The check-in message should also be sent if a guest is reinstated after having checked out initially. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
66 Check-In/Check-Out 
Process Codes
The process codes for the Check-In/Check-Out features are shown in Table 14.
The process codes for the Check-In feature are shown in Table 15
 and Table 16. Table 14. Check-In/Check-Out Process Codes [Feature Code 16 (N)]
Process 
CodeMessage 
Direction Indications
1 PMS to Switch Switch is to perform the functions associated with check-in 
for the indicated RSN.
2 PMS to Switch Switch is to perform the functions associated with check-out 
for the indicated RSN.
5 Switch to PMS Check-out functions were completed for the indicated RSN 
and the message waiting lamp was not on.
6 Switch to PMS Check-out functions were completed for the indicated RSN 
and the message waiting lamp was on.
7 Switch to PMS Confirmation of receipt of check-out message: no action 
was taken because the indicated RSN was already vacant.
8 Switch to PMS Confirmation of receipt of check-in message: no action was 
taken because the indicated RSN was already occupied.
Table 15. Check-In Process Codes [Feature Code 36 (T)]
Process 
CodeMessage 
Direction Indications
1 PMS to Switch Switch is to perform the functions associated with check-in 
for the indicated RSN.
2 Switch to PMS Confirmation of receipt of check-in message: no action was 
taken because the indicated RSN was already occupied. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
67 Check-In/Check-Out 
The process codes for the Check-Out feature are shown in Ta b l e 1 7
Operational Considerations
The switch will maintain a vacant/occupied status for each RSN. The two possible 
states for a room are vacant or occupied. These two switch states will be updated 
by the receipt of the check-in and check-out messages from the PMS. Under nor-
mal circumstances when the PMS link to the switch is operational, check-in and 
check-out cannot be performed at the switch attendant console or telephones. 
These functions can only be done at the PMS terminals. The PMS is required to 
send each check-in/check-out immediately to the switch to support the PMS data 
link and associated switch operations. Table 16. Check-In Process Codes [Feature
Code 26/CKI (A)]
Process 
CodeMessage 
Direction Indications
1 PMS to Switch Switch is to perform the functions associated with check-in 
for the indicated RSN. If Frame 37 contains a “y” instead of 
NULL, the PMS requests the switch to select a DID number 
(R8). 
2 Switch to PMS Confirmation of receipt of check-in message: no action was 
taken because the indicated RSN was already occupied.
3 Switch to PMS Confirmation of receipt of check-in message. The DID 
assignment is in the name fields (R8). 
Table 17. Check-Out Process Codes [Feature
Codes 46 (T) or 29/CKO (A)]
Process 
CodeMessage 
Direction Indications
1 PMS to Switch Switch is to perform the functions associated with check-out 
for the indicated RSN.
2 Switch to PMS Check-out functions were completed for the indicated RSN 
and the message waiting lamp was not on.
3 Switch to PMS Check-out functions were completed for the indicated RSN 
and the message waiting lamp was on.
4 Switch to PMS Confirmation of receipt of check-out message: no action 
was taken because the indicated RSN was already vacant.
5 Switch to PMS Check-out functions were completed for the indicated RSN 
and message waiting lamp is still on due to another mes-
sage type (for example, Leave Word Calling or INTUITY 
AUDIX). 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
68 Check-In/Check-Out 
If the PMS link is down, check-in and check-out must be done at both the PMS 
terminal and at the attendant console or telephones. This procedure must 
continue until the PMS link is up again. For the DEFINITY G3V2 through G3V4, 
DEFINITY ECS, and GuestWorks, you can use the   button at the 
attendant console to determine the room status when the link to the PMS is down.
Switch Actions
When a room check-in message (process code 1) is received from the PMS, the 
status of that room will be set to Occupied. This change does the following (if the 
associated function is active in the switch):
nDeactivates Controlled Restriction
nStores guest name (T) (A)
nStores coverage path (T) (A)
nRemoves Leave Word Calling (LWC) messages (T) (A).
If Frame 37 contains a “y” instead of NULL, the PMS is requesting that the switch 
select a DID number for the guest room. The switch returns the selected DID 
number to the PMS with Process Code 3. The DID selection only applies to 
Feature Code 26. If Frame 37 contains a NULL, and Automatic Selection of DID 
Numbers is enabled on the switch, a DID number is sent anyway. This will use up 
the DID numbers faster, so send a “n” if a DID number is not required. This is true 
only for DEFINITY R8 and later, and GuestWorks Issue 6 and later.
When a room check-out message (16,2) (N), (46,1) (T), or (29,1) (A) is received 
from the PMS, the status of that room will be set to Vacant. This change also does 
the following (if the associated function is active in the switch):
nTurns off the message waiting lamp PMS component for the indicated RSN
nClears any existing wakeup entry for the room
nCancels any current controlled restriction and activates Controlled Out-
ward/Toll Restriction
nRemoves guest name (T) (A)
nSets coverage path to “Default Coverage Path for Client Rooms” field value 
(T) (A)
nChecks for other message types and return (46,5) or (29,5) if found (T) (A).
Occupd Rooms