Home

User Manual

1. callinfo contains information regarding the entire call It has access to the following fields public int nHistorylD public TimeSpan tmDuration public DateTime tmCallStart imCallAnswered tmCallEnded public String sCallFrom sCallTo sGroupNum sLineNum sRecCalllD sCallerlD sDialedNumber sLastCallerlD sLastDialedNumber sBillPrefix sBillRateName Page 25 30X 3CX Phone System for Windows www 3cx com public bool blsAnswered blsFailed blsCompleted bCallFromOutside bMakeCallOrigin public Double fRate fTotalCost public cnDnKind eGroupType public int iMediaType iNumDetails iGrpAnswer details is a list of destinations for that call E g in the case of transfers it may have multiple details To iterate through all the details foreach DetailData3 dd in details Ret dd DestDN And finally the script has to return the output string return ret ToString The details object has the dollowing info available public class DetailData3 holds details for one call public int Parentldx public String DestDN DestNum public DateTime StartTime AnswerTime EndTime public TimeSpan Dur public cnStatus Status public bool IsCompl IsMediator bCallToOutside bFromExtNum public cnSpecType SpecType public int ildCallHist iNDetail ExtType For a more extensive example please look into SMDR cs allusersprofile Application Data 3C X Data CDRTemplates SMDR cs Page 26
2. The 3CX Hotel Module must be installed on the same machine as 3CX Phone System 3 Now follow the instructions of the Wizard 4 You will be prompted to enter a user name and password for the hotel module web interface This web interface will be used by the receptionists of the hotel It s a shared logon and does not provide administrative access to the system 5 The files will be copied Click Finish to complete installation Page 10 3CX 3CX Phone System for Windows www 3cx com 6 Now go to the 3CX Hotel Module web interface http lt phone system machine gt Hotel and login with the credentials you specified during setup Note that the first time you start the application it will take up to 15 seconds to load Note If you installed the Hotel Module on an existing 3CX Phone System installation you need to Check OUT and Check IN the existing extensions to reset the cost counters for each extension All Call Details will be removed for those extensions Activating 3CX Hotel module Next step is to activate your license 1 Start up the 3CX Hotel Module from the program group that has been created 2 Activate your license by going to the File gt Activate License page menu option 3 Enter your license key Company Contact Name E mail Telephone and Country and click on Activate to activate your license This information will be sent to our license key server and your license key and installation wil
3. 30X 3CX Phone System for Windows www 3cx com 3CX PMS protocol specification Introduction This chapter details the 3CX PMS protocol which integrates with PMS hotel software The 3CX PSM protocol closely resembles the Mitel PMS protocol and therefore its possible to specify the Mitel PMS protocol in the PMS system The protocol is further detailed in this chapter General Protocol information The PMS System bi directional through half duplex link uses the ENQ ACK STX text ETX ACK protocol The PMS to system transmission sequence is PMS PBX ENQ ick DMS SENDS ANENQUIRY ge THEPBX REPLIES WITH ACKNOWLEDGE 5TX msg ETX A ck PMS SENDS STX MESSAGE AND ETX TO THE _ PBX THE PBX SYSTEM ACKNOWLEDGES FFO385 The transmission of the message is complete There are timing restrictions imposed on the transmission sequences max 3 sec max 3 sec ENQ ACK STX msg ETX ACK ENQ MIN gt 0 SEC MIN gt 0 SEC FRNA The maximum time to wait for the ACK after a STX msg ETX transmission is 3 seconds PMS to System Transmission After receiving an ENQ character from the PMS the system responds within three seconds with either an ACK or a NAK The ACK indicates the transmission was successful The NAK indicates there was a transmission error or that the system is busy The system generates a hotel log indicating such an error occurred After sending the ACK the system is immediately ready to receive the STX message text an
4. DND message has the following format a ES EA FUNCTION STATUS EXTENSION NU NBER CODE CODE Where STATUS CODE 1 DND ON 0 DND OFF SP is the ASCII blank character Example set DND ON for extension 302 2DND1 3023 STXDND1SPSPSP302ETX StxValue 2 EtxValue 3 ENQ 5 ACK 6 NACK 21 Message Registration Message Each time a hotel extension makes a trunk call the system sends a message to the PMS to update the total count of outside calls made against the guest room No distinction is made between local and long distance calls Message Registration works by counting the number of meter pulses made over the duration of the call The Message Registration message has the following output format Page 30 30X 3CX Phone System for Windows www 3cx com sx w oe se ofofo 1 nfo e ex FUNCTION STATUS EXTENSI N MUNBER CODE GODE FRAN where SP is the ASCII blank character n is an extension number digit The status code in this case is a fee or peg count This is the one exception to the length of the status code being 4 bytes instead of 2 Message Waiting Message The format of this message is the same for both directions The format of the message is similar to the check in out message where the use of binary status code provides the new state of the message waiting lamp The Message Waiting message has the following format ox ow fw e xfer nfo on om e FU
5. Input failed and Input confirmed 7 Now under the Use Minibar codes section add the valid Product codes and Product names This way the system will know that the user has entered a valid product code and can give mini bar personnel the appropriate feedback To be able to replenish a minibar that contains a bottle of Sparking water type Sparking Water in the Product Name field and in the Product Code field enter a code example 10 8 Specify the Input order In this option you specify whether the user types the number of units consumed first or whether the product code is entered first a No of Items Code means the user has to type no of items first followed by the and then the product code example 2 10 means 2 bottles of Sparking water b Code No of Items means the user has to type first the product code first followed by the and then the number of items example 10 2 The character for mini bar codes will be used as multiplication character and as a delimiter character For example If two coffees code 20 and 3 cokes code 30 need to be inputted and the configured dial code name is 33 the dialled number should be 33 2 20 3 30 if No of Items Code a 33 20 2 30 3 if Code No of Items b In both cases the above syntax means Mini bar order of 2 coffees and 3 cokes Page 13 30X 3CX Phone System for Windows www 3cx com Using the Hotel Module Web interface Introductio
6. Minibar usage The minibar function allows minibar personnel to forward minibar usage to the PMS system via the phone Personnel pick up the phone from the room in question example Room 100 which will have extension 100 and dial the special dial code followed by the appropriate item code and the amount For example 33 2 10 will notify the PMS that the minibar in room 100 needs 2 units of item code 10 If the code is correct the success media file message will be played If the code is incorrect the failed media file message will be played These messages can be configured from the hotel interface File gt Configuration gt Use Dial Codes Section Page 18 30X 3CX Phone System for Windows www 3cx com Hotel software PMS integration Introduction Although all hotel related functions can be performed via the web interface it is often preferable to perform these functions automatically at check in or check out of the guest via the Property Management System software 3CX Phone System supports a wide range of hotel software systems Integration options The 3CX Phone System hotel module can integrate with PMS systems in the following ways 1 Via the 3CX PMS protocol This protocol is very similar to the Mitel protocol Most hotel software has a Mitel PBX interface so it is possible to select this integration option in the Hotel Software and it will work with the 3CX PMS protocol If multiple Mitel options are offered t
7. a minibar request from extension 100 STX MNB SP 1 20 3 50 SP SP SPSP100 ETX means posting code item 20 cocacola with a total of 1 pcs and item code 50 chocolate with a total of 3 pcs Page 33
8. other CDR features Enabling SMDR To enable it you must enter the host and port to Listen on for incoming connections In the Parameters SMDRHOSTPORT parameter SMDRHOSTPORT 0 0 0 0 1752 should work for most cases where only 1 network connection exists To disable it you must set an empty host e g SMDRHOSTPORT Advanced Settings fA Configure advanced settings such as conferencing and more Advanced Dial codes Exchange 2007 Conferencing Security Custom Parameters CDR Output This page allows editing of advanced options Only use this after having been recommended to do so by 3CX Technical Support ADVANCED USERS ONLY Filter by Parameter Name SMDR Search Name Description WA SMDRHOSTPORT SMDR will wait for incoming connections on the port specified and will output each call in SMDR format to all established connections The default format is compatible with Mitel SX 2000 and has been tested with Call Accounting Mate software The 3rd party software has the responsibility to connect and to maintain the socket connection to the SMDR service Customizing SMDR output It is also possible to customize the output by editing the C script that produces this It can be found at allusersprofile Application Data 3C X Data CDRTemplates SMDR cs Changing the script requires knowledge of C or at least programming skills The script has access to 2 objects callinfo and details
9. requireMentt cecccccecccceeceeceeeeeceeeceeeeeeceeeeeseeeeceaeecceeeeseseesecaeeesceeeesaeeessaseeseueesseneeteas 10 Installing Bee EE 10 Activating 3CX Hotel MOdule ccccececceccecceeeeeeeeeceeceeeeeceeeeeceaeeeeaeeeceeeesaeeeeeneeeseereesieeeesnaeees 11 Creating a wake up call DR 11 Configuring Mini bar feature ceccccceccceeeceeeeeeeeceeeeceeaeecaeeeseseeceaeesecaeeesaeeessaeeeeseeeeseeeetaas 12 Using the Hotel Module Web interface ooooocococccinocccioncccnoncccnnoccnoncnnonnnonnnonnnnnnnnnnn nn none nnnnn nn niancnnines 14 a NN 14 FUNCTIONS Ee cirio iia 14 Checking ln Quests ria aia 14 Checking out guests cccccecececeeeneeeeeeeeeceeeeceaeeeeaeeeceeesaeesecaeessereeesaeesecuseeseneeesiseessinees 15 Setto Do ne EE IEN 15 Scheduling a wake Up Cell 16 Block external Calls ooonnncccnnonociccnonocccccnnonnononnonnononnnnnncnn non nono n nn nennnnnonnnnnnnnnnnn nn rnancnnnrnnes 17 Viewing the calls made by aroom nana cnn nn nana cn nr naar ncnn ranma 17 Set room status by phone 17 Entering Minibar usage ENEE 18 Hotel software PMS integration ccccccceccceceeceecereeceeeeceeneeeceeeeecaeeeeeaeeeccaeeeeeeeseieeesseeeesneeetsas 19 d ee Idee 19 le ele AMO OPIO Sic E 19 Configuring 3CX PMS protocol integration ooooonocccnnncnnnncccnonccconccnnonccconnnnconncononncnnnnncconnncnino 20 Configuring Fidelio protocol integration sssessseeseeeeneseeestetsrtr
10. strings So it is possible to insert text before and after a field value and to format numbers with decimals and format dates Here are some examples Formatting the TotalCost field lt TotalCost fmt CallCost 0 000 00 gt Output CallCost 003 40 lt starttime fmt 0 ddMMyyHHmmss gt Output 311209235959 lt starttime fmt 0 dd MM yyyy HH mm ss gt Output 31 12 2009 23 59 59 Adding new line characters in XML lt NumDetails fmt Call details 0 amp xD amp xA gt Output Call details 2 lt CR gt lt LF gt CR amp xD LF amp xA CR carriage return LF line feed Each call has one main Callhistory3 entry and 1 or more CallDetails entries Each Call Detail is for one destination of the call so if a call is transferred 2 times there will be 3 call details records for it one for the initial destination and one for each transfer Complete CDR template Below are the complete contents of a CDR template It includes all the possible fields Fields that are not required can be removed by removing the corresponding xml node lt xml version 1 0 encoding utf 8 gt lt Call Template Folder 3CX Data Logs CDRSingle FileName calls txt gt lt idcallhistory3 fmt amp xD amp xA Call 0 gt lt comments get skipped gt lt callid fmt 0 gt lt duration fmt 0 gt lt starttime fmt 0 ddMMyyHHmmss gt lt use dot net string formating to format
11. the date gt lt answertime fmt 0 gt lt endtime fmt 0 gt Page 23 30X 3CX Phone System for Windows www 3cx com lt from_no fmt 0 gt io no fmt 0 gt lt group_no fmt 0 gt lt line_no fmt 0 gt lt is_answ fmt 0 gt lt is_fail fmt 0 gt lt is_ compl fmt 0 gt lt is_fromoutside fmt 0 gt lt CallerlD fmt 0 gt lt DialedNumber fmt 0 gt lt lastCallerlD fmt 0 gt lt lastDialedNumber fmt 0 gt lt mediaType fmt 0 gt lt Rate fmt 0 gt lt TotalCost fmt 0 gt lt BillPrefix fmt 0 gt lt BillRateName fmt 0 gt lt add cr new line in the string gt lt RecFile fmt 0 gt lt GrpAnswDetail fmt 0 amp xD amp xA gt lt NumDetails fmt 0 amp xD amp xA gt lt DetailsTemplate gt lt DetailNum fmt CallDetail 0 gt lt IdCallHistory2 fmt 0 gt lt ParentDetailNum fmt 0 gt lt dest_dn fmt 0 gt lt dest_num fmt 0 gt lt StartTime fmt 0 gt lt Dur fmt O gt lt AnswerTime fmt 0 gt lt Status fmt 0 gt le Comp fmt 0 gt lt SpecDstType fmt 0 gt Page 24 30X 3CX Phone System for Windows www 3cx com lt is_tooutside fmt 0 amp xD amp xA gt lt Details Template gt lt CallTemplate gt SMDR output The SMDR feature is separate from the
12. the following format X is the maid status code SP is the ASCII blank character n is the station number digit up to 5 digits When a Feature code is dialled the system sends both a Function and Status code to the PMS and the PMS interprets the codes in the following way Message Occupancy Condition STS1 maid present STS2 clean STS3 not clean STS4 out of service STS5 to be inspected STS6 Occupied Clean STS7 Occupied Not Clean STS8 Vacant Clean STS9 Vacant Not Clean Minibar message The minibar message allows minibar personnel to forward minibar usage to the PMS system via the phone The minibar message is triggered by a call from the room in question and by entering the special feature code followed by the appropriate item code and the amount For example 33 special dial code set in the management interface 10 2 Will send to the PMS that the room had 2 units of item code 10 Page 32 30X 3CX Phone System for Windows www 3cx com If the code is correct a success message will be played If its incorrect an error message will be played These messages can be configured from the interface The correct minibar item codes can be configured from the hotel management interface The minibar message has the following format STX M N B SP c c c c c 30 nnnnn the extension number cccccc data lenght 30 digit can be filled with 0 9 character has two roles delimiter and multiplication example
13. 9 11 30 15 09 15 00 00 01 0 02 OTAL COST for Guest ROOM 100 0 29 Screenshot 8 Displaying calls made by guest Click on the room number and View calls to view all the calls made by a particular room and the associated cost You can print this data by clicking print Set room status by phone This function allows cleaners to set the status of the room via the phone The maid status message is triggered by a call from the room in question and by entering the special feature code special dial code set in the hotel interface followed by the appropriate code to specify the status of the room For example Dialing 332 from the room will trigger a maid status message to the PMS that will set the status of the room to clean In this example 33 is the special feature code configurable and 2 is the status code clean The following values can be entered ch maid present clean not clean to be inspected 2 3 4 outof service 5 6 Occupied Clean 7 Occupied Not Clean Page 17 30X 3CX Phone System for Windows www 3cx com 8 Vacant Clean 9 Vacant Not Clean If the code is correct the success media file message will be played If the code is incorrect the failed media file message will be played These messages can be configured from the hotel interface File gt Configuration gt Use Dial Codes Section These are the same files that are used for the Minibar codes Entering
14. NCTION STAT US EXTENSI N NUMBER CODE CODE FRNA where SP is the ASCII blank character X is the Message Waiting Lamp status code e ASCII character 1 for Lamp On e ASCII character O for Lamp Off n is an extension number digit Station Restriction Message A Station Restriction message can be used to establish call restrictions When this message is sent from the PMS to the system it brings previously programmed Call Restrictions into effect Note Emergency Services 911 999 and internal calls are never restricted The Station Restriction message has the following format sn REI BISP PPP Leer Function Status Extension or Code Code Suite Number BB1217 where RST is the Station Restriction function code X is an extension or suite number digit S is one of the following status codes 0 Internal 1 Local 2 Long Distance StxValue 2 EtxValue 3 Page 31 3CX 3CX Phone System for Windows www 3cx com ENQ 5 ACK 6 NACK 21 Maid Status Message The maid status message is used to allow cleaners to set the status of the room via the phone The maid status message is triggered by a call from the room in question and by entering the special feature code followed by the appropriate code to specify the status of the room For example dialing 332 from the room will trigger a maid status message to the PMS that will set the status of the room to clean The Maid Status Message has
15. ODE CODE Pena Note that extension numbers less than five digits long are filled with space characters ASCII 32 HEX 20 not zeros ASCII 48 HEX 30 Page 28 30X 3CX Phone System for Windows www 3cx com If the message received from the PMS is invalid the system returns a NAK an ASCII character for Negative Acknowledge Example Check In check in for extension 100 STXCHK1 100ETX where STX 2 ETX 3 resulting the following message 2CHK1 1003 Name Message This message is sent from the PMS and is used to display the Guest name on the phone The Name message has the following input format STX Mohd 0 SP Concer cer DEET Dnnnn EXT FUNCTION STATUS EXTENSION CODE CODE NUMBER FEIT where NAM is the name function code NAME is a character of the name maximum 21 characters nis an extension number digit The length of the name up to 21 characters is left justified with blanks used for padding The characters can be upper or lower case and may also include numeric characters First and last names may be given separated by a comma placed anywhere but in the 1st and 21st location but if only one name appears it is recorded as the surname by default The first name in the string must be the last name or surname followed by the first name If only one name is given the 21st character is a blank the maximum size of a name is 20 Use of the string operation code allows for addition and dele
16. ail notification if the guest wishes to receive their voice mail in email 3 Click OK This will e Set the Extension Name to the Guest s name e Unblock the extension to allow outbound calls Checking out guests To check out a guest 1 Select the room number and click on the check out icon 6 e Cotino uerg en ec 00035796626870 2009 11 30 15 03 21 00 00 08 OTAL COST for Guest ROOM 100 0 13 Screenshot 4 Call costs dialog 2 The hotel module will bring up the cost of any calls made in a separate dialog If no calls with cost we re made a dialog confirming this will pop up 3 You can choose to print this dialog for inclusion with the hotel bill 4 Now close the cost dialog The extension will now be checked out This will e Delete the guest name and move to room to Empty rooms e Delete all voice mail messages of the room e Disable outbound calls on the extension e Clear any Do Not Disturbs set Set to Do not Disturb The Do not Disturb function will send all calls to the room to the guest voice mail The DND status will be shown in the DND On Off column e Available guest will take calls e Do Not Disturb Calls will be sent to voice mail Note Do Not Disturb overrides Wake Up calls Page 15 30X 3CX Phone System for Windows www 3cx com Scheduling a wake up call Screenshot 5 Wake up calls The wake up call feature allows you to schedule an automatic call to
17. bania 00355 K Services status American Samoa 00684 E Extensions Andorra 00376 S PSTN devices ES 00244 VOIP Providers Anguila 001264 a Inbound Rules H S Bridges Antigua and Barbuda 001268 E A OutBound Rules Argentina 0054 amp Digital Receptionist ees 00374 Aruba 00297 Ascension Island 00247 Australia 0061 Austria 0043 Azerbaijan 00994 Bahamas The 001242 Bahrain 00973 internet Screenshot 9 Billing Information in the 3CX Management Console Page 21 30X 3CX Phone System for Windows www 3cx com CDR Output The CDR feature provides three output channels 1 One file for all calls 2 One file per call 3 Socket output Advanced Settings Configure advanced settings such as conferencing and more Advanced Dialcodes Exchange 2007 Conferencing Security Custom Parameters CDR Output CDR Call Data Records Here you can configure whether 3CX should output CDRs Call Data Records and how There 3 possible formats multiple calls in 1 file one file per call or output to a socket The exact format of the CDR can be customized by modifying the XML templates located in the CORTemplates Folder Exact output locations can be specified in the templates as well Output CDR in single file 10 Output one CDR per call nO Output CDR to socket Active Initiates connection fal 2 Interval to generate CDR records in seconds 160 O Each channel can be enabled separately T
18. be placed to a room at a particular date and time To schedule a wake up call 1 Select the room number and click on Set Wake up e Set the wake Up call Webpage Dialog Set the wake Up date time for the current extension Screenshot 6 Set wake up call 2 You will be prompted for the date and time of the wake up call Click OK to set the Wake Up 3 When the time of the wake up call is reached the guest room will be called automatically by the digital receptionist created and transferred to the recorded wake up message Please note that the guest will be called only once x Room Status 102 Room 102 Available o Available Monday November 30 2009 3 15PM Clean Screenshot 7 List of wake up calls Page 16 30X 3CX Phone System for Windows www 3cx com 4 You can view a list of scheduled wake up calls at any time by clicking on the Wake up calls node Note Currently only one wake up call per extension is allowed Block external calls You can block external calls in rooms by selecting the room and selecting Block Viewing the calls made by a room e Call Info Webpage Dialog MEE E a fmt Print Copy Source Destination Start Time Duration Cost 100 00035796626870 2009 11 30 15 03 21 00 00 08 0 13 100 00035796626870 2009 11 30 15 08 37 00 00 05 0 07 100 00035799181012 2009 11 30 15 08 55 00 00 04 0 07 100 00035799181012 200
19. breaktfree with a AKI r Window User Manual 3CX Hotel module Version 1 0 Copyright 2009 3CX Itd http www 3cx com E mail info 3cx com Information in this document is subject to change without notice Companies names and data used in examples herein are fictitious unless otherwise noted No part of this document may be reproduced or transmitted in any form or by any means electronic or mechanical for any purpose without the express written permission of 3CX Ltd 3CX Phone System for Windows is copyright of 3CX Ltd 3CX is a registered trademark and 3CX Phone System for Windows and the 3CX logo are trademarks of 3CX Ltd in Europe the United States and other countries Version 1 01 Last updated 15 February 2010 Table of Contents INTO UCI AA IS eee ie oa eA i A 7 What is the 3CX Hotel module cecececececeeeeeeeeeceeeeeeeaeeeeeeecesaeeeeaeeeseeeeseaeesscueeeseneeesaeeeeeaes 7 Components it ek eee a ae eae Beal eae ee eee os 7 Operations functions performed by the Hotel Module oooooooccconccccnocccioooccconccccnncncnnnccnnonnnonnnno 8 Operations ON Check Im 8 Check out Operations criminal tir dl atte 8 Do Not Disturb DND ota oa 8 Wake Up Oe I 0 A E E E E 8 Biling e e E 8 HOW IU Soinen a heii eae a ae ete aint 9 Installing 3CX Hotel Module 10 Deployment considerations ooocconoccccnnococcccnononnnccnnnononnnnnnnnoncnnnnnnccnnnnnnncn nano nncrnnnnn cnn nnanncnnnnnnnrs 10 System
20. ction What is the 3CX Hotel module 3CX Phone System Hotel Application Windows Internet Explorer Ge yw E 10 172 0 15 sly Favorites 3Cx Phone System Hotel Application Mech ouT setono y7 Block y Di Set Wake Up XK Delete Wake Up 3 View Calls z Room Number Guest Name DND On Off Messages External Calls Wake Up Time Room Status Ki X 100 Room100 Available Available Clean GJ 101 Room 101 Available E 3CX Hotel 102 Room 102 Available El All Rooms 103 Room 103 Available I Occupied Rooms 104 Room 104 Available W Empty Rooms 105 Room 105 Available S Wake Up calls 106 Room 106 Available Available Friday December 18 2009 Clean Available Maid present Available Not specified Available To be inspected Available Occupied Clean Available Occupied Clean 107 Room 107 Available Available Not specified 108 Room 108 Available Available Not specified v lt T m a eo eo eo ofge internet oa Rio Screenshot 1 3CX Hotel Module The hotel module for 3CX Phone System adds additional functions to 3CX Phone System to allow it to be used in hotels or other hospitality environments The hotel module performs the following functions e Allows for Check in and Check out of guests e Allows setting of guest extensions to Do not Disturb e Allows blocking of external calls e Allows wake up calls to be scheduled e Allows billing of calls to rooms e Allows housekeeping to set room sta
21. d ETX Within three seconds of receiving the ETX it responds with either e ACK indicating the transmission was successful and all of the message fields are valid Page 27 30X 3CX Phone System for Windows www 3cx com e NAK indicating there was an error in either the transmission itself in one of the message fields or in the syntax of the message specifically STX ETX function code and status code for example CHK3 is sent instead of CHK1 The system generates a hotel log indicating this error occurred The PMS is able to retry sending only the message txn STX message text and ETX three more times without prefacing it with an ENQ message first The following example illustrates a PMS transaction retry PMS PBX ACK ENQ wg Cae mg NAK STX msg ETX ef E NAK STX msg ETX KE NAK STX msg ETX NAK AS TX msg ETX A FFN3AA The PMS then discards the transaction PMS Format Specification The messages have the following general format E POE A S S S A LCA FUNCTION STAT US EXTENSION NUMBER OODE CODE FFN3AAR Check In Out Messages The message has the following format sm Tel CAFES FUNCTION CODE STATLE CODE EXTENSION NUMBER COIN where X is the Check In Out status code e ASCII character 1 for Check In e ASCII character 0 for Check Out SP is the ASCII blank character n is an extension number digit Check in message CIENCIA Cate ALA FUNCTION STATUS EXTENSION NU NBER C
22. ect the Wake Up Digital Receptionist you just created from the drop down list In this example you will see 811WakeUpDR Click the OK button to save Configuring Mini bar feature 3CX Hotel Module provides a mini bar feature that allows Mini bar personnel to communicate the mini bar usage to the PMS system via the use of a phone call To configure this Page 12 30X 3CX Phone System for Windows www 3cx com 1 Inthe 3CX Management console create a Digital receptionist Call it Dial Code This dummy DR will be used for both the Maid status and the Mini bar features You do not need to upload a Prompt file 2 In the 3CX Hotel module interface go to the configuration dialog and enable the Dial codes and the Use Mini bar Codes option Select as Digital receptionist Dial code the DR you previously created 4 Specify a DR Local Port Choose a high port here for example 60000 5 Name Dial Code put for example 33 here It must not start with any of the dial codes in the Dial Codes Page Example 44 will not work because it will try and match the dial code 4 which will take you to Voicemail and not to the Mini Bar 9 will not work either because the PBX will think it is a call to Page an extension Therefore a working mini bar code that will work given you left the dial codes default will be anything starting with 3 5 7 8 6 Specify Success Media File and a Failed Media file Example content would be
23. ertrertretttrstttstttrttrrntrrerennrrerene 20 Configuring Lodging link Integration 20 Configuring the billing Interface 21 Introducir aia iia 21 NA 21 ERIC er EE 22 Changing CDR output location nn nonnnn nan n cnn rncnanncninss 22 Editing CDR output Format 22 Complete CDR template 23 SMDRioutputs sic 2 08 a Ee aia 25 Enabling SMDR amp 2 cad ie i ee i ae ea eee eee 25 Customizing SMDR OUtPUt i ia e Ged Adee laa ee eaat 25 3CX PMS protocol specification cecceeecceceeececeeeeeeceeeecneeeceeeeeaeeeeeceeeseeeeseeeeeceeessereeeiseesenaeees 27 da Wee le 27 General Protocol Information 27 PMS to System Transmission cccccccecsceceseeeceeeeeeeececeneeeseneeseeaeeceeaeeseeceesnaeeeseresseneensas 27 PMS Format Specification ixsiccisiiystictvsxsen Zeta aaa a e ara eiii 28 Check In Out Messages ccecccceeeeceeeeeeeeeeeeceaeeeecaeeceeeeecaeeeecaeecseeeeesaeeseeneeeseereeeiseeeenaeess 28 Name Message dt EE ee 29 Wake UP MeSSages iiia e ei AA ee RA A eg ey ye ee 29 DND Messages s4 oe eee eat ee ee ro es ec 30 Message Registration Message ssnsesessesrreorresrresrrtnrtttnrserrnnnttttererrrenttettrecernentseenneee 30 Message Waiting Message oooocccccncoccccnoncocncccononcncnnnnnncnnonnnncnnnonnnnnnnnannncrrnnnnnnnrnnnnnccnnnnnnrs 31 Station Restriction Message 31 Maid Status M ssag s a A dt 32 Minibar Mess ge nai Sa au hoe ei 32 30X 3CX Phone System for Windows www 3cx com Introdu
24. he Mitel SX 2000 option must be selected 2 Via the Fidelio protocol 3 Via middleware software called Lodging Link Lodging link integrates with numerous hotel software systems and provides transparent integration with the 3CX PBX hotel module Supported hotel software systems included can be found here http www comtrol com aboutus partners hospitality pms 4 Exchange of data can also be done on a custom basis In this scenario documentation must be provided by the reseller how the integration must be performed Additional charges may apply Page 19 30X 3CX Phone System for Windows www 3cx com Configuring 3CX PMS protocol integration When using the 3CX PMS protocol the 3CX Hotel module acts as a server In other words the PMS software sends messages to the 3CX Hotel Module Therefore there is nothing to configure at the 3CX side unless you want to change the default ports In the PMS software you must specify 1 The IP of 3CX Phone System 2 Specify port 15374 for the Hotel Software connection 3 Specify port 6830 for the Voice Mail connection 4 If multiple Mitel options are offered choose Mitel SX 2000 Naturally if you change the default ports you must change them in the PMS system as well The 3CX PMS protocol acts as a TCP server Configuring Fidelio protocol integration Specify the IP and the Port of the PMS server in the Web interface by going to File gt Configuration and selecting Fidelio N
25. i and will be accessed on http IP 5488 Page 9 30X 3CX Phone System for Windows www 3cx com Installing 3CX Hotel Module Deployment considerations Prior to deploying the hotel module you must install 3CX Phone System and configure it as per the documentation Keep the following points in mind e Have the extension numbers match your hotel room numbers This makes it intuitive for guests to dial other room numbers as well as for hotel staff to identify room phones 3CX Phone System can be deployed with 2 3 4 or 5 digit length extensions so it should be possible to match almost any hotel room number e f you are replacing an old phone system and want to keep certain numbers such as room service or reception using the same shortcuts keep this in mind when assigning extension numbers e t might be advisable to block access to the MyPhone User portal In that case disable port or disable the Myphone User Portal website from the IIS configuration System requirements 3CX Hotel module requires the following e Windows XP Pro Vista 2003 server or 2008 Windows 7 e NET Framework version 2 0 or higher e 1 Gigabyte Memory or higher Pentium 4 processor or up e 3CX Phone System 7 1 or higher must be installed and running Installing the software To install the 3CX Hotel module 1 Download the latest 3CX Hotel Module from http www 3cx com downloads 3CXHotelmodule1 msi 2 Execute setup on the 3CX Phone System machine itself
26. l be activated You will need to do this each time you re install 3CX Hotel Module or install an upgrade 4 Depending on your license key the product will activate with or without PMS integration 3CXH stands for the hotel module without PMS integration and 3CHPMS indicates that the license has PMS integration Creating a wake up call DR The first time you login to the Hotel Module you will be prompted that you need to configure a Digital Receptionist DR for the Wake Up call functionality This is DR is used to perform the actual wake up calls To configure a DR 1 Record a file with the text This is your wake up call Of course you can make the text anything you like For information on how to record sound files see the 3CX Phone System manual 2 In the 3CX Phone System Management Console menu select Add gt Digital Receptionist Page 11 30X 3CX Phone System for Windows www 3cx com 3CX Phone System Management Console Windows Internet Explorer DER G e E 10 172 0 15 File Edit View Favorites Tools Help Hg Favorites d free Hotmail f cx Phone System Management Console Page gt Safetyw Tools fl File Add View Settings Links Help ZA Extension status f Server Activity Log GP Add Extension gi Add PSTN Gateway gp Add VOIP Provider Wizard fyi Create Outbound Rule Zo Create DID Edit Digital Receptionist gt amp The Digital Receptionist Auto Attendant answers a
27. n This chapter explains how to use the 3CX Hotel module web interface File Guest Wake Up Calls Misc a MW check out O setono Y Q Bok y D setwakeup JE 2 View Calls z Room Number Guest Name DND On off Messages External Calls Wake Up Time Room Status 30X hotel 102 Room 102 Available o Available Clean E Al Rooms up Room 103 Available 0 Available Monday November Clean I occupied Rooms WJ Empty Rooms 23 Wake Up calls Screenshot 2 The web interface The 3CX Hotel Module web interface is located at http lt phone system machine gt Hotel After you login you will see 4 nodes e All Rooms All extensions on the phone system e Occupied Rooms These are all extensions for which a name has been set e Empty Rooms All extensions that do not have a name specified e Wake Up Calls All scheduled wake up calls Functions available Checking in guests Check in customers Webpage Dialog Room 100 vM First Name Guest First Name Last Name Guest Last Name Email address Email optional com Caller 1D 100 Screenshot 3 Checking in a guest To check in a guest 1 Select the room number from the All Rooms or Empty Rooms node and click on check in icon Page 14 30X 3CX Phone System for Windows www 3cx com 2 You will be prompted for the guest name email address and caller ID The email can be used for voice m
28. nd directs calls automatically E gt 30X Phone System General Ports Trunks Status Extension Status Q System Extensions Status Li Phones a Uo Server Activity Log es S11WakeUpDR Ki Gl Services status Redirect To MS Exchange ne Extensions ESA PSTN devices E VOIP Providers E Inbound Rules 69 53 Bridges key key 6 4 OutBound Rules i amp Digital Receptionist 28 Ring Groups Zi Call Queues ME Settings E E Links 69 Help Configure the Name Prompt and Time out for this Digital Receptionist Virtual extension number Cannot be in use as an extension B11 JO Prompt makeUpCall wav Browse Menu options Extension Number MEME H 1 3 4 5 6 7 8 9 a aaa aaa ae lt KRR R RRR Timeout 2 End Call oe JL Gesi Il ze Internet fa 100 Screenshot 14 Configuring a digital receptionist 3 Specify a name and virtual extension number for the digital receptionist 4 Now click on the browse button and specify the file that you previously recorded The file will be copied into the 3CXPhone System Data lvr prompts directory No further options are necessary click OK to save the digital receptionist 5 Take note of the Digital Receptionist virtual extension number Load up the Hotel web application by going to the File gt Configuration menu option and next to the option Wake up Digital receptionist sel
29. nt to a particular host at a particular port In this manner it is easy to integrate with a hotel software system or call accounting software Adjusting Billing costs 3CX Phone System calculates call costs based on destination number and call duration You will need to enter the cost for each country for national calls and for mobile calls The default billing rate is 1 0 To change these rates 1 In 3CX Management Console go to View gt Billing Information 2 Edit the rates as appropriate and click Apply 3 When calls are made to external numbers they are checked against this prefix table If a match is found then the cost is calculated as follows TotalCost Talking time rate where a rate of 1 0 means 100 per 60 seconds of talking time 1 minute 3CX Phone System Management Console Windows Internet Explorer 6 Se le 10 172 0 15 Pl File Edit view Favorites Tools Help E P il i Favorites S 3CX Phone System Management Console a gt E me y Page Safety Toos File Add View Settings Links Help Q Extension status uf Server Activity Log GB Add Extension y Add PSTN Gateway gp Add VOIP Provider Wizard fg Create Outbound Rull Billing Information 3CX Y Apply Ah Import 4 Export 27 Show Filter E 3CX Phone System Country Name Prefix e Ports Trunks Status default default 7 Extension Status System Extensions Status E Phones Wf Server Activity Log Algeria 00213 Afghanistan 0093 Al
30. o Enable the CDR feature from the management console go to the Settings gt advanced page and select the CDR Output tab Changing CDR output location The file output default location can be changed by editing each template file The template files are located in 1 One File allusersprofile Application Data 3CX Data Logs CDRSingle 2 Per Call allusersprofile Application Datal 3CX Data Logs CDRMulti 3 Socket All Users Application Data 3CX Data CDRTemplates CDRTemplate Socket xml In the case of socket output the host name and port must be specified in the tags Host 127 0 0 1 Port 33555 All output is text based and can be formatted by modifying the template for each channel The templates default location is here allusersprofile Application Data 3CX Data CDRTemplates Editing CDR output format If you need to alter the format with which the CDRs are outputted you can do by editing the XML template files Each template file contains XML tags that describe which database fields should be included in the CDR in which order and how each field should be formatted Page 22 30X 3CX Phone System for Windows www 3cx com Each node outputs the text quoted in the text after 0 and is replaced by the value of the actual field For example the xml node lt CallerlD fmt XX caller ID 0 XX gt Would output XX caller ID 00357999999 XX The formatting can be customised using C formatting
31. on e Clears any Do Not Disturb set Do Not Disturb DND e Sets user status to Away same as in interface e All calls will be sent to voice mail Wake up Calls The system allows for wake up calls to be scheduled This will call the guest at the scheduled time and play a predefined message so as to wake up the guest Billing The system will log calls from each room and show costs based on the cost configured in the 3CX Phone System management console The system can output a configurable CDR report for each call The CDR report can be sent to a separate text file one call per text file to a text file for all calls all calls will be listed in the same text file or to a TCP port For each case the exact format can be customized Page 8 30X 3CX Phone System for Windows www 3cx com How it works The 3CX Hotel module is an additional module that is installed on the 3CX Phone System machine The module adds an additional service to the 3CX Phone System machine as well as a web application The 3CXHotelModuleService starts only if the Hotel is licensed The webserver selection for the 3CX Hotel Module is automatic this means that if the 3CX Phone System was installed using the IIS option then the Hotel Module web interface will automatically be on IIS and will be accessed by typing in http IP hotel Alternatively if the 3CX Phone System was installed using the Cassini option the 3CX Hotel module will use Cassin
32. ow specify the IP and port of the Lodging Link server The 3CX Fidelio protocol integration acts as a TCP client Configuring Lodging link integration Lodging Link eliminates the need for property management system PMS vendors to create their own interfaces for each hardware device Such as PBX voice mail call accounting in room Internet access point of sale in room movie keyless entry mini bar and energy management systems To configure Lodging Link for use with 3CX Phone System 1 Install Lodging Link PTS or Premier according to the product documentation This product might already be installed please contact your hotel software vendor for more information 2 Specify the IP and the Port of the Lodging Link server in the Web interface by going to File gt Configuration and selecting Lodging Link Now specify the IP and port of the Lodging Link server The 3CX lodging link integration acts as a TCP client Page 20 30X 3CX Phone System for Windows www 3cx com Configuring the billing interface Introduction 3CX Phone System provides billing information so that you can charge your guests accordingly for each phone call This information is displayed per room in the web interface or alternatively you can output it to a text file or to TCP port so that you can integrate it with your PMS software Call costs are calculated and inserted into a CDR Call Data Record which is outputted to disk as a text file or se
33. tion of a specific name against an extension The system allows more than one name to be added against a station Most situations usually have just one name associated with a station number The String Operation code is the first byte of the status code and may be one of these options 1 addition The name is ADDED to the current list of names against this station If there is no name against this number a new telephone directory entry is created 2 replacement The name is used to REPLACE the first alphabetical name against this number All other names against this number are not altered If an invalid message is received from the PMS the system returns a NAK Wake up messages The PMS system can inform the system when to set a wake up call for a particular guest station The Wake up message has the following output format Page 29 30X 3CX Phone System for Windows www 3cx com a le feted ede n a na E ex FUNCTION STATUS EXTENSI N MUNBER CODE OODE FRNA where t is the wake up time n is an extension number digit The wake up time is specified in 24 hour time All four characters filled with ASCII blanks represent a deletion of the wakeup time time format HHmm Example of wake up call at 23 and 30 minutes to extension 100 2MW 2330 1003 DND Message The PMS system can inform the PBX when to set the DND status for a particular guest station by sending the following message The
34. tus via the phone e Allows minibar usage to be reported via the phone The hotel module can integrate with many Hotel software systems Property management systems PMS such as Micros Fidelio Roommaster Hilton and more Alternatively the receptionist can use the system directly through the provided web interface Components The hotel module consists of a front end application and a windows service The Windows Service operates in the background and allows for integration with the Property Management System With the integration many of the functions can be triggered from within the PMS software Page 7 3CX 3CX Phone System for Windows www 3cx com The Front Desk Phone Control Application is a simple to use windows or web based application that allows the front desk clerk to perform the above operations with a few mouse clicks This application can be used separately from or in tandem with the PMS system and thus requires no integration at all For many smaller hotels this can be good enough Operations functions performed by the Hotel Module The hotel module performs the following functions Operations on Check in e Sets Extension Name e Unblocks the extension to allow outbound calls e Deletes all voice mail messages e Clears any Do Not Disturb DND functions Check out operations e Sets name to blank so we can see that there is no one in the room e Deletes all voice mail messages e Disables outbound calls on extensi

User Manual

Contents

Download Pdf Manuals

Related Search

Related Contents