Home

xivo-14.08 PDF - Read the Docs

1. J Device successfully synchronize IPBX ERE O 1 3762 10 975 100 Technicolor 572030 xivo technicolor ST2030 2 74 EY Y rotocol Protocol 10 97 5 102 Aastra 6738i xivo aastra 3 2 2 56 ET T Notcemals Des 00 0e 08 dd 642e 10 97 5 103 Cisco SPA962 xivo cisco spa legacy Advanced 147161421 10975104 Technicolor 512030 xivo technicolor ST2030 2 74 O 00 1478 21 423 Devices rex c ENERO EEEE O EEE C RENNES UEM UEM ES Users i L Existent on the provisioning server Figure 1 40 Device successfully synchronize If synchronization fails an information balloon red warning you of success 2 fs oO wax IP Veors Modeles Pugin Adm Sere sorings O 1 2 10975100 Technicolor ST2030 xivo technicolor ST2030 2 74 d oe rotocol TAX Protocol 5 5 1097 5 102 Aastra 67391 xivo aastra 3 2 2 56 aoa cenas M 10975103 Cisco SPA962 xivo cisco spa legacy taoa ins Advanced 10975104 Technicolor 572030 xivo technicolor ST2030 2 74 E O 1 2 Devices Lines m i V Existent on the provisioning server Figure 1 41 Error during device synchronize Synchronize multiple device
2. Description Contexte par d faut Save CAD K i B Figure 1 32 Adding a directory LDAP to CTI Server Quick Summary In order to be able to use the boss secretary filter you have to Select a boss role for one the users Select a secretary role for one ot the users Create a filter to set a strategy for this boss secretary filter Add a function key for the user boss and the user secretary Defining a Role The secretary or boss role can be set in the user s configuration page under the service tab To use this feature at least one boss and one secretary must be defined Voice pitch L L Enable supervision Enable call transfer Incoming call filtering Do not disturb Filter Boss Secretary 4 Dee e Creating a Filter The filter is used to associate a boss to one or many secretaries and to set a ring strategy The call filter is added in the Services IPBX Call management Call filters page Different ringing strategies can be applied Boss rings first then all secretaries one by one Boss rings first then secretaries are all ringing simultaneously Secretaries ring one by one Secretaries are all ringing simultaneously 1 8 Administration 77 XiVO doc Documentation Release 14 08
3. JOins Figure 1 71 Search voicemail for specific user 2 On user s configuration The other way is to directly add the voicemail from user s configuration in the voicemail tab Warning In this way the language has to be set in user s general configuration 164 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 General Lines No answer Services Groups Keys SIP Protocol JAX Protocol Voice Mail Asterisk Voicemails Phonebook Enable voicemail Advanced Opion Add v Devices Full name User Test Lines UH Voicemail 1150 Groups Password Voicemails E mail Conference rooms Time zone M CE E Disable password checking Call permissions Attach the audio file Call filters Call pickups Delete message after notification Schedules Cals Logs ULL d 2 SIP Protocol 1 Figure 1 72 Add voicemail from user configuration Deactivating voicemail You can deactivate user s voicemail by un checking Enable voicemail option the Voicemail tab from user s configuration General Lines No answer Services Groups Func Keys
4. Empty lines and lines starting with are ignored AP netdevice name without postfix i e wlanO0 uses wlanO0ap for management frames athO for madwifi interface wlanO In case of madwifi atheros and n180211 driver interfaces an additional configuration parameter bridge may be used to notify hostapd if the interface is included in a bridge This parameter is not used with Host AP driver If the bridge parameter is not set the drivers will automatically figure out the bridge interface assuming sysfs is enabled and mounted to sys and this parameter may not be needed 314 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 For n180211 this parameter can be used to request the AP interface to be added to the bridge automatically brctl may refuse to do this before hostapd has been started to change the interface mode If needed the bridg interface is also created bridge br0 Driver interface type hostap wired madwifi test none n180211 bsd default hostap n180211 is used with all Linux mac80211 drivers Use driver none if building hostapd as a standalone RADIUS server that does not control any wireless wired driver driver hostap hostapd event logger configuration Two output method syslog and stdout only usable if not forking to background Module bitfield ORed bitfield of modules that will be logged 1 all
5. Figure 1 64 Creating a schedule 060006 Schedule Figure 1 65 Schedule calendar widget 148 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Schedule Action 09h00 to 18h00 Mon to Fri B 8 ae Hangup gt Months Hours ree JU e 18 0 0930 Figure 1 66 Schedule closed hours 1 editing the etc xivo asterisk xivo_globals conf file and setting XIVO_FWD_SCHEDULE_OUT_ISDAto 1 2 reloading the asterisk dialplan with an asterisk rx dialplan reload 1 8 26 Sound Files Add Sounds Files On a fresh install only en_US and fr_Fr sounds are installed Canadian French and German are available too To install Canadian French sounds you have to execute the following command in the cli root xivo apt get install asterisk sounds wav fr ca xivo sounds fr ca To install German sounds you have to execute the following command in the cli root xivo apt get install asterisk sounds wav de de xivo sounds de d Now you may select the newly installed language for yours users Convert Your Wav File Asterisk will read natively WAV files encoded in wav 8kHz 16 bits mono The following command will return the encoding format of the lt file gt file file RIFF little endian data WAVE audi
6. modules bit 0 1 IEEE 802 11 bit 1 2 IEEE 802 1 bit 2 4 RADIUS bit 3 8 WPA bit 4 16 driver interfac bit 5 32 IAPP bit 6 64 MLME Levels minimum value for logged events 0 verbose debugging debugging informational messages notification DCN D ll warning logger syslog 1 logger syslog level 2 logger stdout 1 logger stdout level 2 Dump file for state information on SIGUSR1 dump file tmp hostapd dump Interface for separate control program If this is specified hostapd will create this directory and a UNIX domain socket for listening to requests from external programs CLI GUI etc for status information and configuration The socket file will be named based on the interface name so multiple hostapd processes interfaces can be run at the same time if more than one interface is used var run hostapd is the recommended directory for sockets and by default hostapd cli will use it when trying to connect with hostapd ctrl interface var run hostapd Access control for the control interface can be configured by setting the directory to allow only members of a group to use sockets This way it is possible to run hostapd as root since it needs to change network configuration and open raw sockets and still allow GUI CLI components to be run as non root users However since the control interface can be used to change the netwo
7. Snom 370 710 715 720 760 821 870 Provisioning Y Y H A 3 Y Y Y Y Y Y Y Directory XIVO HK SK SK HK HK HK HK Funckeys 2 12 5 5 18 16 12 15 Supported programmable keys User with supervision function Y Y Y Y Y Y Y Group Y Y Y Y Y Y Y Queue Y Y Y Y Y Y Y Conference Room with supervision function Y Y Y Y Y Y Y General Functions Online call recording N N N N N N N Phone status Y Y Y Y Y Y Y Sound recording Y Y Y Y Y Y Y Call recording Y Y Y Y Y Y Y Incoming call filtering Y Y Y Y Y Y Y Do not disturb HK SK SK HK HK HK HK Group interception Y Y Y Y Y Y Y Listen to online calls Y Y Y Y Y Y Y Directory access Y Y Y Y Y Y Y Filtering Boss Secretary Y Y Y Y Y Y Y Transfers Functions Blind transfer Y SK SK HK HK HK HK Indirect transfer Y SK SK HK HK HK HK Forwards Functions Disable all forwarding Y Y Y Y Y Y Y Enable Disable forwarding on no answer Y Y Y Y Y Y Y Enable Disable forwarding on busy Y Y Y Y Y Y Y Enable Disable forwarding unconditional Y Y Y Y Y Y Y Voicemail Functions Enable voicemail with supervision function Y Y Y Y Y Y Y Activate voicemail Y Y Y Y Y Y Y Reach the voicemail HK HK HK HK HK HK HK Delete messages from voicemail Y Y Y Y Y Y Y Agent Functions Continued on next page 1 7 Ecosystem 65 XiVO doc Documentation Release 14 08 Table 1 5 continued from previous page
8. Channel number IEEE 802 11 default 0 i e not set Please note that some drivers do not use this value from hostapd and the channel will need to be configured separately with iwconfig channel 5 Beacon interval in kus 1 024 ms default 100 range 15 65535 beacon int 100 DTIM delivery traffic information message period range 1 255 number of beacons between DTIMs 1 every beacon includes DTIM element default 2 dtim period 2 Maximum number of stations allowed in station table New stations will be rejected after the station table is full IEEE 802 11 has a limit of 2007 different association IDs so this number should not be larger than that default 2007 max num sta 255 RTS CTS threshold 2347 disabled default range 0 2347 If this field is not included in hostapd conf hostapd will not control RTS threshold and iwconfig wlan rts lt val gt can be used to set it rts threshold 2347 Fragmentation threshold 2346 disabled default range 256 2346 If this field is not included in hostapd conf hostapd will not control fragmentation threshold and iwconfig wlan frag lt val gt be used to set it fragm threshold 2346 Rate configuration Default is to enable all rates supported by the hardware This configuration item allows this list be filtered so that only the listed rates will be left in the list If the list is empty
9. 8870 BRIDGE START 2012 03 29 08 18 23 174713 5555555555 5555555555 55555 8871 ANSWER 2012 03 29 08 18 23 175011 P re No l 1001 8872 HANGUP 2012 03 29 08 18 23 367533 No l 1001 1001 8873 CHAN END 2012 03 29 08 18 23 367547 P re 1 1001 1001 8874 HANGUP 2012 03 29 08 18 23 367592 5555555555 5555555555 55555 8875 CHAN END 2012 03 29 08 18 23 367604 5555555555 5555555555 55555 8876 HANGUP 2012 03 29 08 18 31 818877 444 8877 HANGUP 2012 03 29 08 18 31 818928 No l 1001 8878 CHAN END 2012 03 29 08 18 31 81938 P re No l 1001 8879 CHAN END 2012 03 29 08 18 31 819443 444 8880 HANGUP 2012 03 29 08 18 31 823143 5555555555 5555555555 55555 8881 CHAN END 2012 03 29 08 18 31 823175 5555555555 5555555555 55555 23 rows Call To the Operator External user calls 447 2 The call is routed to the operator Tux 1000 Agent 9999 3 The operator hangs up after a few seconds id eventtype eventtime userdeftype cid name cid num cid 4 4 4 8943 CHAN STAR 2012 03 29 08 47 54 875967 5555555555 5555555555 8944 ANSWER 2012 03 29 08 47 54 952265 5555555555 5555555555 55555 8945 APP START 2012 03 29 08 47 56 050332 5555555555 5555555555 55555 8946 CHAN STAR 2012 03 29 08 47 56 05637 8947 CHAN STAR 2012 03 29 08 47 56 056423 8948 CHAN STAR 2012 03 29 08 47 56 056462 8949 APP START 2012 03 29 08 47 56 10545 5555555555 5555555555 55555 8950 CHAN STAR 2012 03 29 08 47 56 105603 Tux 1000 8951 ANSWER 2012 03 29 08 47 59 401063
10. A a eee IPBX Are you sure you want to synchronise devices Cancel eae O 00 14 71 e1 37 62 Cancel 1 2030 274 CUIU e m MR Protocol 85413 05 1097 5 102 Aastra 67391 xivo aastra 3 2 2 56 Voicemails m Phonebook O 2 o0 0e 08 dd 64 2e 10 975 103 cisco SPA962 xivo cisco spa legacy Advanced 147f e1 10975 104 Technicolor ST2030 xivo technicolor ST2030 2 74 Dee 1 2 Figure 1 43 Synchronize selected devices confirmation 4 Seach oo Mass synchronize send to devices IPBX General settings 00 14 7 1 37 62 10 97 5 100 Technicolor 572030 xivo technicolor ST2030 2 74 Protool 4 00 08 54 13 ca 05 1097 5 102 Aastra 67391 xivo aastra 3 2 2 56 Phonebook 2 10975103 5 962 xivo cisco spa legacy EER 00 14 71 1423 10 975 104 Technicolor 572030 xivo technicolor ST2030 2 74 ma E lines Figure 1 44 Mass synchronize request successfully send Add a data source You can add new data sources via the Configuration Management Directories page File directories The source file of the directory must be in CSV format You will be able to choose the headers and the separator in the next steps For example the file will look like t
11. xdebug remote enable On xdebug remote host dev host gt xdebug remote port 9000 xdebug remote_handler dbgp 1 12 Developers 333 XiVO doc Documentation Release 14 08 where dev host gt 77 is the IP address of your machine where Eclipse is installed Of course your XiVO must be able to reach this IP address 3 Restart spawn fcgi etc init d spawn fcgi restart On your machine where Eclipse is installed 1 Make sure you have Eclipse PDT installed 2 In the Eclipse preferences on the PHP Debug page Set the PHP Debugger to XDebug Add a new PHP server with the following information Name anything you want Base URL https xivo ip 3 Createa new PHP Web Application debug configuration Choose the PHP server you create on last step Pick some file which can be anything if you don t break at first line Uncheck Auto Generate and set the path you want your browser to open when you ll launch this debug configuration Then to start a debugging session set some breakpoints in the code and launch your debug configuration This will open the page in your browser and when the code will hit your breakpoints you ll be able to go through the code step by step etc 1 12 14 XiVO Client Building the XiVO Client Building the XiVO Client on Windows platforms This page explains how to build an executable of the XiVO Client from its sources for Windows Windows Prerequ
12. 802 1D Tag UP to AC mappings WMM specifies following mapping of data frames to different ACs This mapping can be configured using Linux QoS tc and sch pktpri o module 802 1D Tag 802 1D Designation Access Category WMM Designation 1 BK AC BK Background Z Background 0 BE AC BE Best Effort 3 EF AC BE Best Effort 4 Gn AC VI Video 5 VI AC VI Video 6 VO AC VO Voice 7 NC AC VO Voice Data frames with no priority information AC BE Management frames AC VO PS Poll frames AC BE Default WMM parameters IEEE 802 11 draft 11 03 0504 03 000 802 11a or 802 11g networks These parameters are sent to WMM clients when they associate The parameters will be used by WMM clients for frames transmitted to the access point note txop limit is in units of 32microseconds 318 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 note acm is admission cont required 1 mandatory note here cwMin and cmMax will b 2 n 1 where n is t wmm enabled 1 Enable this flag if U APSD s uapsd advertisement enabled 1 Low priority AC BK wmm ac bk cwmin 4 wmm ac bk cwmax 10 wmm bk aifs 7 wmm ac bk txop limit 0 wmm bk acm 0 Note for IEEE 802 11b mode Normal priority AC BE be wmm ac be aifs 3 wmm ac be cwmin 4 wmm ac be cwmax 10 wmm ac txop limit 0 wmm ac
13. 1 Table of Contents 1 1 Introduction XiVO is a PABX application developed by the Avencall Group based on several free existent components including Asterisk and our own developments XiVO provides a solution for enterprises who whish to replace or add a telephony service PABX XiVO is free software Most of its distinctive components and XiVO as a whole are distributed under the GPLv3 license We are also working on a fully Open XiVO Hardware For more information see XiVO and Open Source 1 1 1 XiVO History XiVO was created in 2005 by Proformatique XiVO 1 2 was released on February 3 2012 1 2 Installation 1 2 1 Installing the System Please refer to the section Troubleshooting if ever you have errors during the installation There are three official ways to install XiVO using the official ISO image using a minimal Debian installation and the XiVO installation script using a PXE environment not detailed here XiVO can be installed on both virtual QEMU KVM VirtualBox and physical machines That said since Asterisk is sensible to timing issues you might get better results by installing XiVO on real hardware Installing from the ISO image The ISO image for XiVO 14 08 can be found at http mirror xivo fr iso xivo current Download the iso boot from it and follow the instructions on the installation prompt We suggest that you choose english as locale when prompted At the end of the ins
14. tipbxid xivo timenow 1362735061 17 user Return a user configuration tid is the userid returned by users message Client gt Server 1 12 Developers 293 XiVO doc Documentation Release 14 08 class getlist function updateconfig listname users Meas py tpbxid xivo commandid 5 Server gt Client olass i getilist function updateconfig listname users Merete Uim tipbxid xivo timenow 1362741166 4 1 enablednd 0 destrna enablerna 0 enableunc 0 destunc destbusy firstname Alice lastname Bouzat fullname Alice Bouzat voicemailid null incallfilter 0 enablevoicemail 0 profileclient null phones Client gt Server class getlist commandid 495252308 function listid listname phones tipbxid Server Client i elass getlist function stro Iirst s D 5 14 listname phones timenow 1364994093 38 tipbxid xivo Individual phone configuration request class getlist commandid 704096693 function updateconfig listname phones t Server Client class getlist config allowtransfer null context default identity SIP ihvbur iduserfeatu initialized null number 1000 protocol 51 function updateco
15. DELETE 1 1 users lt user_id gt lines lt line_id gt Error code Error message Description 400 User with id lt user_id gt is not associated with line id lt line_id gt Errors 3 400 Invalid parameters There secondary users associated to this user line 400 Invalid parameters A device is still associated to the line Example request Host xivoserver DELETE 1 1 users 59 lines 598 Content Type application json 258 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Example response HTTP 1 1 204 No Content Voicemails Voicemail Representation Field Val Description ues id inte Read only ger name string Voicemail name number string Voicemail number context string Voicemail s context password string Numeric password used to access the mailbox email string Email address where messages will be sent Description language string Language used for the voicemail menu prompt See Voicemail languages for a list of available languages timezone string Timezone used for announcing at what time a message was recorded See Voicemail timezones for a list of timezones max messageasinte Maximum number of messages to store ger at boolean Attach an audio file of the recorded message when sending an email tach audio delete messagdsoolean Delete messages once they have been listened to 2 boolean Ask for pas
16. Field Required Values Notes type yes string See Function Key Types for more details Input mp a destination yes string See Function Key destinations for speed dials for more details destination id yes integer destination s id Error Error message Description code 500 Error while creating Function Key See explanation for more details explanation 400 Missing parameters list of missing Errors Bee 400 Invalid parameters type type does Please use one of the function key types listed in not exist Function Key Types 400 Invalid parameters destination of type Please use one of the destination types listed in Function type does not exist Key destinations for speed dials 400 Nonexistent parameters The destination you are trying to associate with does not destination id does not exist exist Example request POST 1 1 func keys HTTP 1 1 Host xivoserver Accept application json Content Type application json speeddial destination user destination id 12 1 11 and SDK 237 XiVO doc Documentation Release 14 08 Example response HTTP 1 1 201 Created Location 1 1 func keys 1 Content Type application json yg WA type speeddial destination user destination_id 12 Links 1 rel func keys href https xivoserver 1 1 func keys 1 Delete a Function Key Destination Most function keys are automatically
17. WPS UPnP interface If set support for external Registrars is enabled upnp_iface br0 Friendly Name required for UPnP Short description for end use Should be less than 64 characters friendly_name WPS Access Point Manufacturer URL optional for UPnP manufacturer_url http www example com Model Description recommended for UPnP Long description for end user Should be less than 128 characters model_description Wireless Access Point Model URL optional for UPnP model_url http www example com model Universal Product Code optional for UPnP 12 digit all numeric code that identifies the consumer package upc 123456789012 Wi Fi Direct P2P Enable 2 Device management manage p2p 1 Allow cross connection allow cross connection 1 TDLS IE E 802 11z 2010 330 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Prohibi tdls pro t use of TDLS in this BSS hibit 1 Prohibi tdls pro t use of TDLS Channel Switching in hibit chan switch 1 I I Time advertisement 0 disabled default 2 UTC time at which the TSF timer is 0 time_advertisement 2 this BSS 802 11v 20
18. 1 11 and SDK 213 XiVO doc Documentation Release 14 08 8915 CHAN STAR 2012 03 29 08 41 15 38615 8916 CHAN STAR 2012 03 29 08 41 15 386214 8917 APP START 2012 03 29 08 41 15 449043 5055555555 5555555555 8918 CHAN STAR 2012 03 29 08 41 15 449351 Tux 1000 8919 ANSWER 2012 03 29 08 41 17 624003 Tux 1000 8920 ANSWER 2012 03 29 08 41 17 624122 5555555555 5555555555 8921 BRIDGE STAR 2012 03 29 08 41 17 624159 5555555555 5555555555 8922 ANSWER 2012 03 29 08 41 17 624454 Tux 1000 8923 ANSWER 2012 03 29 08 41 17 62448 447 8924 BRIDGE STAR 2012 03 29 08 41 17 632978 55055555555 5555555555 8925 HANGUP 2012 03 29 08 41 17 767612 Tux 1000 8926 CHAN END 2012 03 29 08 41 17 767645 Tux 1000 8927 HANGUP 2012 03 29 08 41 17 767733 5555555555 5555555555 8928 CHAN END 2012 03 29 08 41 17 76776 5555555555 5555555555 8929 BRIDGE END 2012 03 29 08 41 22 12071 00505555555 5555555555 8930 HANGUP 2012 03 29 08 41 22 125079 447 8931 HANGUP 2012 03 29 08 41 22 125103 Tux 1000 8932 CHAN END 2012 03 29 08 41 22 125151 Tux 1000 8933 CHAN END 2012 03 29 08 41 22 125209 447 8934 APP START 2012 03 29 08 41 22 194926 0555555555 5555555555 8935 CHAN START 2012 03 29 08 41 22 195135 P re No l 1001 8936 ANSWER 2012 03 29 08 41 25 236852 P re 1 1001 8937 BRIDGE START 2012 03 29 08 41 25 237116 5555555555 5555555555 8938 BRIDGE END 2012 03 29 08 41
19. L 0000 SIP Protocol Protocol Voice Mail Asterisk Voicemails Phonebook SCS Enable voicemail 2 Advanced Option User Test 1150 default 00000 Devices 0 Full name User Test Lines a 3 Voicemail 1150 Groups Password Voicemails a Conference rooms ideas Call management Time zone E Disable password checking _ Call permissions Attach the audio file Call filters Call pickups Delete message after notification _ Schedules Calls Logs Save _ gq SIP Protacal 1 Figure 1 73 Deactivate user s voicemail Disassociating voicemail You can disassociate a voicemail from a user by selecting the None option on Voice Mail select box from user s configuration General Lines No answer Services Voicemail Groups Func Keys SIP Protocol 1 Protocol Voice eS Phonebook Enable voicemail V Advanced Cice ERR Devices Full name Lines Voicemail Users Groups Password Voicemails Conference rooms mai Time zone Disable password checking Call permissions 0 Attach the audio file Call fiters Call pickups Delete message after notification Schedules Calls Logs Save a SIP Figure 1 74 Disassociate voicemail Warning Note that disassociating a voicemail from it
20. class featuresput commandid 568274890 function fwd value destbusy 1009 enablebusy true Server gt Client elass getlixst config destbusy 1009 enablebusy true function updateconfig listname users naque 2 Limenow 1361457163 77 tipbxid xivo IPBX Commands dial destination can be any number destination can be a pseudo URL of the form type ibpx id Client Server class ipbxcommand command dial commandid lt commandid gt destination exten xivo extension For example class ipbxcommand command commandid 1683305913 destination exten xivo 1202 The server will answer with either an error or a success class ipbxcommand error string unreachable extension 1202 300 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 class dial success exten 1202 originate Same message than the dial message with a source fied The source field is user xivo userid userid is replaced by a user identifer returned by the message getting users list Example olass command originate commandid 1683305913 source serx1ivo 34 destination exten xivo 1202 record Client gt Server e subcommand start or stop class ipbxcommand command record subcommand
21. Digium Digium phones D40 D50 D70 Provisioning Y NYT Y H A Y NYT Y Directory XIVO N NYT N Funckeys 2 14 106 Supported programmable keys User with supervision function N NYT N Group Y NYT Y Queue Y NYT Y Conference Room with supervision function Y NYT Y General Functions Online call recording N NYT N Phone status Y NYT Y Sound recording Y NYT Y Call recording NYT Y Incoming call filtering Y NYT Y Do not disturb HK NYT HK Group interception Y NYT Y Listen to online calls N NYT N Directory access N NYT N Filtering Boss Secretary Y NYT Y Transfers Functions Blind transfer HK NYT HK Indirect transfer HK NYT HK Forwards Functions Disable all forwarding Y NYT Y Enable Disable forwarding on no answer Y NYT Y Enable Disable forwarding on busy Y NYT Y Enable Disable forwarding unconditional Y NYT Y Voicemail Functions Enable voicemail with supervision function Y NYT Y Activate voicemail Y NYT Y Reach the voicemail HK NYT HK Delete messages from voicemail Y NYT Y Agent Functions Connect Disconnect a static agent Y NYT Y Connect a static agent Y NYT Y Disconnect a static agent Y NYT Y Parking Functions Parking N NYT N Parking position N NYT N Paging Functions Paging Y NYT Y Note Some function keys are shared with line keys 1 7 Ecosystem 63 XiVO doc Documentation Release 14 08 Particularities
22. Display format is a format string for example db firstname db lastname where db x will be replaced with the value from the data source is the identifier of the field con figured in the directory definition not the header of your data source Make your directory available Go in Services CTI Server Directories Reverse Direct directories select your display filter if needed and add the directory you just created You may have to restart the CTI Server or the AGI daemon to apply the change Service xivo ctid restart Service xivo agid restart 1 8 10 Directed Pickup Directed pickup allows a user to intercept calls made to another user For example if a user with number 1001 is ringing you can dial 81001 from your phone and it will intercept i e pickup the call to this user The extension prefix used to pickup calls can be changed via the Services IPBX IPBX services Extensions page Custom Line Limitation There is a case where directed pickup does not work which is the following Given you have a user U with a line of type customized Given this custom line is using DAHDI technology Given this user is a member of group G When a call is made to group G Then you won t be able to intercept the call made to U by pressing 8 lt line number of U gt If you find yourself in this situation you ll need to write a bit of dialplan For example if you have the following
23. echo Please execute this script in XIVO CLIENT plugins echo Snewname exit 1 fi cp r xletnull newname cd Snewname rm f Makefile for f 5 type f print do mv f echo f sed s xletnull newname done find type f sed i s xletnull newname g s X Ll etNull NewName g s XLETNULL SNEWNAME Before executing the script just replace the first three variables with the name of the new XLet Then you must add a line in xivoclient xlets pro to add your new directory to the SUBDIRS variable Then you can start implementing your new class The lt xletname gt Plugin class is only an interface between the main app and your XLet Translations If you want to localize your XLet there are four steps 340 Chapter 1 Table of Contents g XiVO doc Documentation Release 14 08 Modify the sources the lt xletname gt Plugin constructor add the line b engine registerTranslation xletname 961 before the return instruction Modify the project file Add these lines in the pro file in your XLet directory TRANSLATIONS lt xletname gt _fr ts TRANSLATIONS xletname nl ts RESOURCES res qrc Replace fr and nl with the languages you want Create the resource file In a file res qrc in your XLet directory put these lines lt DOCTYPE RCC gt lt RCC version 1 0 gt lt qresource gt lt file gt lt xletname gt _fr qm lt file gt lt
24. for subsections for subsubsections Punctuation characters should be exactly as long as the section text Correct Sectionl Incorrect Section2 There should be 2 empty lines between sections except when an empty section is followed by another section Correct Sectionl Section2 Bat Correct Sectionl target Section2 Correct Sectionl Foo Incorrect Sectionl FOO 1 12 Developers 271 XiVO doc Documentation Release 14 08 Bat Lists Bullet lists S irst item econd item Autonumbered lists Lite Use The First item Second item ral blocks on the same line as the line containing text when possible literal blocks must be indented with three spaces Correct Bla bla bla apt get update Incorrect Bla bla bla apt get update Inline markup Use the following roles when applicable e file for file i e The file dev null file menuselection for the web interface menu menuselection Configuration gt Management guilabel for designating a specific GUI element guilabel Action column Others gt Certificates page There must be no warning nor error messages when building the documentation with make html There should be one and only one newline character at the end of each file There should be no trailing whitespace
25. password music on hold default preprocess subroutine userfield Links i rel users href https xivoserver 1 1 users 1 Update a User Only the fields that need to be modified can be set If the firstname or the lastname is modified the name of associated voicemail is also updated Query PUT 1 1 users lt id gt Input Same as for creating a User Please see Create a User Errors Same as for creating a User Please see Create a User Example request PUT 1 1 users 67 HTTP 1 1 Host xivoserver Content Type application json firstname Jonathan Example response HTTP 1 1 204 No Content Delete User A user can not be deleted if he is associated to a line or a voicemail Any line or voicemail attached to the user must be dissociated first Consult the documentation on User Line Association and Voicemail Association for further details The user will also be removed from all queues groups or other XiVO entities whom he is member 254 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Query DELETE 1 1 users lt id gt Description Error code Error message 400 error while deleting User explanation Errors 400 Error while deleting User user still associated to a line 400 Error while deleting User user still associated to a voicemail 404 User with id X does not exist See error message for more details See exp
26. unlinked event Static Agent VS Dynamic agent in the XiVO client There is no longer a difference between a static or dynamic membership All agent memberships are now considered static Membership changes between the web interface and the XiVO client are now synchronized 26 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Updates Please note that when upgrading the following actions will take place automatically All agents will be logged off before migrating All agents with a dynamic membership will be removed from their queues Useful links server is frozen and won t come back online Another change is in effect beginning with XiVO 12 24 the field profileclient in the CSV user import sees its values change Old value New value client Client agent Agent switchboard Switchboard agentsup Supervisor oper removed clock removed 1 5 CTI Client This section describes the CTI Client and its various xlets 1 5 1 Getting the XiVO Client Binaries of the Client are available on our mirror Warning The installed version of the XiVO Client must match the XiVO server s version installation With our current architecture there is no way to guarantee that the XiVO server will be retro compatible with older versions of the XiVO Client Non matching XiVO server and XiVO Clients versions will bring inconsistencies Choose the version y
27. 370 710 715 720 760 821 870 Connect Disconnect a static agent Y Y Y Y Y Y Y Connect a static agent Y Y Y Y Y Y Y Disconnect a static agent Y Y Y Y Y Y Y Parking Functions Parking Y N N N N Y Y Parking position Y N N N N Y Y Paging Functions Paging Y Y Y Y Y Y Y Snom Vision the expansion module for snom 8xx series VoIP telephones are supported Snom extension modules V2 0 are supported Note For some models function keys are shared with line keys There s a known issue with the provisioning of Snom phones in XiVO After a factory reset of a phone if no language and timezone are set for the default config device in XiVO Configuration Provisioning Template device you will be forced to select a default language and timezone on the phone UI Yealink T19P T20P T21P T22P T26P T28P T32G T38G T4 Provisioning Y Y Y Y Y NT NT Y Y H A Y Y Y Y Y Y N N Y Directory XIVO MN N MN MN MN SK NT SK MN Funckeys N 2 2 3 13 16 3 16 15 Supported programmable keys User with supervision function N Y Y Y Y Y NYT Y Y Group N Y Y Y Y Y NYT Y Y Queue N Y Y Y Y Y NYT Y Y Conference Room with supervision function N Y Y Y Y Y NYT Y Y General Functions Online call recording N N N N N N NYT N N Phone status N Y Y Y Y Y NYT Y Y Sound recording N Y Y Y Y Y NYT Y Y Call recording N Y Y Y Y Y NYT Y Y Incoming call filtering N Y Y Y Y Y NYT Y Y Do not d
28. Fax Number Directory Choose File to Send Browse Send your File Figure 1 45 The fax Xlet in the XiVO Client The file to send must be in PDF format Warning Sending faxes is currently not supported if there is a network equipment that changes TCP port numbers or IP addresses like a router doing NAT or NAPT between the CTI client and the CTI server Fax reception Adding a fax reception DID If you want to receive faxes from XiVO you need to add incoming calls definition with the Application destination and the FaxToMail application for every DID you want to receive faxes from This applies even if you want the action to be different from sending an email like putting it on a FTP server You ll still need to enter an email address in these cases even though it won t be used Note that as usual when adding incoming call definitions you must first define the incoming call range in the used context 98 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 General settings General Fax detection Call permissions SIP Protocol IAX Protocol DID 5551234567 SCCP Protocol Voicemaiis from extern Pee Desinaton Advanced Call Center Application FaxToMail z Agoni E mail foo example org Queues foo example org Skills Ca
29. For best results activate DHCP Integration on your XiVO Impossible to do directed pickup using a BLF function key Only supports DTMF in RFC2833 mode Does not work reliably with Cisco ESW520 PoE switch When connected to such a switch the D40 tends to reboot randomly and the D70 does not boot at all It s important to not edit the phone configuration via the phones web interface when using these phones with XiVO Paging doesn t work Polycom SoundPoint IP SoundPoint SoundStation IP SPIP331 SPIP335 SPIP450 5 550 SPIP560 SPIP650 5 5000 Provisioning 4 Y Y Y N N 4 Directory XIVO N N N FK N N N Funckeys N 0 2 3 3 47 0 Supported programmable keys User with supervision function NYT N NYT Y NYT NYT NYT Group NYT N NYT Y NYT NYT NYT Queue NYT N NYT Y NYT NYT NYT Conference Room with supervision function NYT N NYT Y NYT NYT NYT General Functions Online call recording NYT N NYT N NYT NYT NYT Phone status NYT N NYT Y NYT NYT NYT Sound recording NYT N NYT Y NYT NYT NYT Call recording NYT N NYT Y NYT NYT NYT Incoming call filtering NYT N NYT Y NYT NYT NYT Do not disturb NYT SK NYT HK NYT NYT NYT Group interception NYT N NYT Y NYT NYT NYT Listen to online calls NYT N NYT Y NYT NYT NYT Directory access NYT N NYT Y NYT NYT NYT Filtering Boss Secretary NYT N NYT Y NYT NYT NYT Transfers Functions Blind transfer NYT SK NYT N NYT NYT N
30. The DHCP server is configured via the Configuration Network DHCP page SY Active Pool start Pool end Extra network interfaces Save XX Figure 1 54 Configuration Network DHCP Active Activate desactivate the DHCP server Pool start The lower IP address which will be assigned dynamically This address should be in the VoIP subnet Example 10 0 0 10 Pool end The higher IP address which will be assigned dynamically This address should be in the VoIP subnet Example 10 0 0 99 Extra network interfaces list of space separated network interface name Example et ho Useful if you have done some custom configuration in the etc dhcp dhcpd_extra conf file You need to explicitly specify the additional interfaces the DHCP server should listen on After saving your modifications you need to click on Apply system configuration for them to be applied Installing provd Plugins The installation and management of provd plugins is done via the Configuration Provisioning Plugin page The page shows the list of both the installed and installable plugins You can see if a plugin is installed or not by looking at the Action column Here s the list of other things that can be done from this page update the list of installable plugins by clicking on the top right icon On a fresh XiVO installation this is the first thing to do install a new plugin u
31. filter User lastname lastname filter User number number all Good Example user session query User filter User firstname firstname filter User lastname lastname filter User number number all Strings Avoid using the operator for concatenating strings Use string interpolation instead Bad Example phone interface SIP username password Good Example phone interface 5 5 5 username password Comments Redundant comments should be avoided Instead effort should be put on making the code clearer Bad Example Add the meeting to the calendar only if it was created on a week day monday to friday if meeting day 0 and meeting day 7 calendar add meeting Good Example 280 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 def created on week day meeting return meeting day gt 0 and meeting day 7 if created on week day meeting calendar add meeting Conditions Avoid using parenthesis around if statements unless the statement expands on multiple lines or you need to nest your conditions Bad Examples if x 3 print condition is true if x 3 and y 4 print condition is true Good Examples if x print condition is true if x 3 and y print condition is true if extremely_long_variable and another_long_variable and yet_another_variable 5 print c
32. 1 timenow 1364994093 48 tipbxid xivo Queuestatus Client gt Server commandid 17 class getlist tid 8 tipbxid xivo function updatestatus listname Server Client function updatestatus listname status agentmembers 1 5 Erd Ug elass Agent status tid is the agent id Client gt Server class getiist commandid random integer function updatestatus listname agents utu Ugo Server Client class i getlist listname agents function updatestatus tipbxrd s xivo Ead 355 status availability logged out availability since 1370868774 74 channel null groups on call acd false on call nonacd false on wrapup false phonenumber null queues tipbxid xivo timenow 1382710430 54 phonemembers 8 ky 296 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 113 availability can take the values logged out available unavailable on call nonacd incoming internal on call nonacd incoming external on call nonacd outgoing internal on call nonacd outgoing external availability since is the timestamp of the last availability change queues is the list of queue ids from which the agent receives calls Agent messages login Client gt Server age
33. 1010 Defaut defaut o o o simt Figure 1 35 Creating conference room 1010 In this example we have only filled the Name and Number fields the others have been left to their default value As you can see there s quite a few options when adding editing a conference room Here s a description of the most common one General PIN code Protects your conference room with a PIN number People trying to join the room will be asked for the PIN code 1 8 Administration 81 XiVO doc Documentation Release 14 08 General Don t play announce for first participant Don t play the you are currently the only person in this conference for the first participant General Max participants Limits the number of participants in the conference room A value of 0 means unlimited 1 8 6 CTI Server The CTI server configuration options can be found in the web interface under the services tab General Options The general options allow the administrator to manage network connections between the CTI server and other services and clients The section named AMI connection allows the administrator to configure the information required to connect to the Asterisk Manager Interface AMI These fields should match the entries etc asterisk manager conf r AMI Connection Login xivo_cti_u
34. Apply configuration When done you have to restart asterisk and dahdi etc init d monit stop etc init d asterisk stop etc init d dahdi stop etc init d dahdi start etc init d asterisk start etc init d monit start 112 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Check IRQ misses It s always useful to verify if there isn t any missed IRQ problem with the cards Check cat proc dahdi span number If the IRQ misses counter increments it s not good cat proc dahdi 1 Span 1 WCTDM O Wildcard TDM800P Board 1 MASTER IRQ misses 1762187 1 WCIDM 0 0 FXOKS 2 WCTDM 0 1 FXOKS 3 WCTDM 0 2 FXOKS In use 4 WCIDM 0 3 FXOKS Digium gives some hints in their Knowledge Base here http kb digium com entry 1 63 PRI Digium cards needs 1000 interuption per seconds If the systeme cannot supply them it increment the IRQ missed counter As indicated in Digium KB you should avoid shared IRQ with other equipments like HD or NIC interfaces Notes on configuration files etc dahdi system conf A span is created for each card port Below is an example of a standard 1 port span 1 1 0 ccs hdb3 dchan 16 bchan 1 15 17 31 echocancellerzmg2 1 15 17 31 Each span has to be declared with the following information Span spannum timing LBO framing coding crc4 e spannum corresponds to the span number It starts to 1 and has to be incremented by 1 at each n
35. PMK RO Key Holder identifier dotllFTROKeyHolderID 1 to 48 octet identifier This is configured with nas identifier see RADIUS client section above Default lifetime of the PMK RO in minutes range 1 65535 dotllFTROKeyLifetime rO key lifetime 10000 PMK R1 Key Holder identifier dotllFTR1KeyHolderID 6 octet identifier as a hex string rl key holder 000102030405 Reassociation deadline in time units TUs 1 024 ms range 1000 65535 dotllFTReassociationDeadline reassociation_deadline 1000 List of ROKHs in the same Mobility Domain format MAC address gt NAS Identifier 128 bit key as hex string This list is used to map ROKH ID NAS Identifier to a destination MAC address when requesting PMK R1 key from the ROKH that the STA used during the Initial Mobility Domain Association r0kh202 01 02 03 04 05 rOkh 1l example com 000102030405060708090 050 040 0 rOkh 202 01 02 03 04 06 rOkh 2 example com 00112233445566778899aabbccddeeff And so on One line per ROKH List of 5 in the same Mobility Domain format MAC address gt lt gt 128 bit key as hex string This list is used to map to a destination MAC address when sending PMK R1 key from the ROKH This is also the list of authorized R1KHs the MD that can request PMK R1 keys rlkh 202 01 02 03 04 05 02 11 22 33 44 55 000102030405060708090a0b0c0d0e0f rlkh 202 01 02 03 04 06 02 11 22 33 44 66 0011
36. l extensions 2 1 11 and SDK 231 XiVO doc Documentation Release 14 08 GET 1 1 exte Host xivoser Accept appli nsions 1 HTTP 1 1 ver cation json Example response HTTP 1 1 200 Content Type d context exten commente OK application json default 1234 d false Create Extension extension number must be included in one of the extension ranges for the given context Query POST 1 1 ext ensions Field Required Values Description exten es strin Input y mg context yes string commented no boolean If True the extension is disabled Error code Error message Description Errors 400 exten lt number gt not inside range of context lt context gt 400 error while creating Extension lt explanation gt See error message for more details Example request POST 1 1 ext Host xivoser Accept appli Content Type exten context commente ensions HTTP 1 1 ver cation json application json 1234 default d false Example response HTTP 1 1 201 Location 1 Content Type id 1 links Created 1 extensions 1 application json rel href extensions https xivoserver 1 1 extensions 1 232 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Update an Extension The update does not need to set all the fields of the edit
37. main line links T rel href rel href Associate a Line to a User Query application json true true lines https xivoserver 1 1 lines 132 users https xivoserver 1 1 users 20 POST 1 1 users lt user_id gt lines Field Required Values Description Input line_id yes int Must be an existing id 1 11 and SDK 257 XiVO doc Documentation Release 14 08 Error code Error message Description 400 Nonexistent parameters user id user id does not exist Errors 400 Nonexistent parameters line id line id does not exist 400 Invalid parameters user is already associated to this line 400 Invalid parameters There is an extension associated to this line Example request POST 1 1 users 59 lines Host xivoserver Content Type application json line id 432 Example response HTTP 1 1 201 Location 1 1 users 59 lines user id 59 line id 432 main user true main line true links rel lines href https xivoserver 1 1 lines 432 href rel users https xivoserver 1 1 users 59 Dissociate a User from a Line Any devices that are attached the line must be removed before dissociating a user from its line A device can be dissociated be resetting it to autoprov mode Consult the documentation on Devices for further details Query
38. E ee eee queue early rtp seis dire apd meena Ee 0 Penalty switchboard Send Incoming Calls to the Switchboard Queue Incoming calls must be sent to the Switchboard queue to be distributed to the operators To do this we have to change the destination of our incoming call for the switchboard queue In this example we associate our incoming call DID 444 to our Switchboard queue Set Answer Destinations on the Switchboard Queue When there are no operators available to answer a call No Answer destinations should be used to redirect calls towards another destination You also need to set the timeout of the Switchboard queue to know when calls will be redirected The reachability timeout must not be disabled nor be too short The time before retrying a call to a member should be as low as possible 1 second In this example we redirect No Answer Busy and Congestion calls to the everyone group and Fail calls to the guardian user You can also choose to redirect all the calls to another user or a voice mail XiVO Client configuration Directory xlet The transfer destination is chosen in the Directory xlet You must follow the Directory section to be able to use it 154 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Destination Redirect to Ring time CallerlD mode Preprocess subroutine Description Timeout prior
39. Mees TW velassa getixst timenow 1361440830 99 Unsolicited Messages These messages are received whenever one of the following corresponding event occurs sheet message on incoming calls or updatestatus when a phone status changes sheet This message is received to display customer information if configured at the server side timenow 1361444639 61 class sheet compressed true Serial xml payload AAADnnicndPBTONAEAbgV1n3XgFN1AP ce ees s channel SIP e6fhff 00000007 How to decode payload 1 12 Developers 291 XiVO doc Documentation Release 14 08 gt gt gt gt gt gt gt gt gt gt gt gt gt gt gt gt gt gt b64content base64 b64decode payload content 4 first cars are the encoded lenght of the xml string in Big Endian format xmllen struck unpack 1 b64content 0 4 the rest is a compressed xml string xmlcontent zlib decompress toto 4 print xmlcontent lt xml version 1 0 encoding utf 8 lt profile gt lt user gt internal name ipbxid gt lt CDATA xivo gt lt internal gt internal name where gt lt CDATA dial gt lt internal gt internal name channel CDATA SIP barometrix jyldev 00000009 internal internal name focus gt lt CDATA no internal internal name zip gt lt CDATA 1 gt lt internal gt lt sheet_qtui order 0010 name qtui type None
40. Preconditions Preparations Thing to test Assertions Sections are separated by a blank line Sections that become too big should be split into smaller functions Example class UserTestCase unittest TestCase def test fullname self user User firstname Bob lastname Marley expected Bob Marley fullname user fullname self assertEquals expected fullname def prepare expected user self firstname lastname number user User user firstname firstname user lastname lastname user number number return user def assert users ar qual expected user actual user 1 12 Developers 283 XiVO doc Documentation Release 14 08 self assertEquals expected user firstname actual user firstname self assertEquals expected user lastname actual user lastname self assertEquals expected user number actual user number def test create user self expected self prepare expected user Bob Marley 4185551234 user create user Bob Marley 4185551234 Self assert users ar qual expected user Exceptions Exceptions should not be used for flow control Raise exceptions only for edge cases or when something that isn t usually expected happens Bad Example def is user available user if user available return True else raise Exception User isn t available try is user available user except Exce
41. enablednd false longname Bient u 290 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 disconnected color 4202020 actions agentlogoff longname D u00e9con list of other status depends on the cti server configuration services fwdrna fwdbusy fwdunc enablednd phonestatus 16 color F7FF05 longname En Attente mes color FF032D longname En ligne OU appelle BM s color ODFF25 longname Disponible color FF0008 longname Occup u00e9 1 color 000000 longname D u00e9sactiv u00e9 ams color FFFFFF longname Indisponible 2 color 030303 longname Inexistant Nom s color FF0526 longname En Ligne OU Appelle ET Sonne wg color f1BOAFF longname Sonne ipbxcommands capaxlets zdentity grid search tab customerinfo tab 1 fax appliname Client Second message describes the current user configuration function updateconfig listname users timenow 1361440830 99 MeL tW config enablednd false class getlist Third message describes the current user status function updatestatus listname users status availstate available uipbsreg s sea wo
42. raw option if you want to see the raw traffic between the client and the server cti proxy ctispy xivo new raw Note that when using the option some other option doesn t work because the messages are not de coded analyzed If you want to remove some fields from the messages you can use the st rip option cti proxy ctispy xivo new strip timenow strip commandid strip replyid If you want to see only messages matching a certain key and value use the include option cti proxy ctispy xivo new include class getlist Finally you can ignore all the messages from the client or the server by using the 1 or no server option respectively By default ctispy will exit after the connection with the client is closed You can bypass this behavior with the loop option that will make the CTI proxy continue whether the client is connected or not ctisave ctisave save the messages from the client and the server in two separate files This is useful to do more careful post analysis The simplest invocation is cti proxy ctisave xivo new tmp cti client tmp cti server To do comparison it s often useful to strip some fields cti proxy ctisave xivo new tmp cti client tmp cti server strip timenow strip commandid strip replyid One useful thing to do with files generated from different ctisave invocation is to compare them with a tool like vimdiff for example 286 Chapter 1 T
43. spans spans spans Pp t xivo 1 xivo 2 P 4 1 10 High Availability 205 XiVO doc Documentation Release 14 08 One XiVO and one PBX This case is not currently supported You ll find a workaround in the Berofos Integra tion with PBX section Multiple berofos It s possible to use more than 1 berofos with XiVO For each supplementary berofos you want to use you must first configure it properly like you did for the first one The only difference is that you need to add berofos declaration to the etc bnfos conf file instead of creating overwriting the file Here s an example of a valid config file for 2 berofos 1 00 19 32 00 12 1 host 10 100 0 201 login admin foobar fos2 mac 00 11 22 33 44 55 host 10 100 0 202 login admin barfoo Warning berofos name must follow the pattern osX where X is a number starting with 1 then 2 etc The bnfos tool won t work properly if it s not the case Operation When your XiVO switch the relay mode of your berofos it logs the event the var log syslog file Default mode Note that when the berofos is off the A and D ports are connected together This behavior is not customizable Uninstallation It is important to remove the etc bnfos conf file on the slave node when you don t want to use anymore your berofos w
44. 1 XIVO PRESUBR GLOBAL USER xivo subrgbl user XIVO PRESUBR GLOBAL AGENT xivo subrgbl agent XIVO PRESUBR GLOBAL GROUP xivo subrgbl group XIVO PRESUBR GLOBAL QUEUE xivo subrgbl queue XIVO PRESUBR GLOBAL MEETME xivo subrgbl meetme XIVO PRESUBR GLOBAL DID xivo subrgbl did XIVO PRESUBR GLOBAL OUTCALL xivo subrgbl outcall XIVO PRESUBR GLOBAL PAGING xivo subrgbl paging So if you want to add a subroutine for all of your XiVO users you can do this xivo subrgbl user exten s 1 NoOp This is an example for all my users same n Return Forward subroutine You can also use a global subroutine for call forward Preprocess subroutine for forwards XIVO PRESUBR FWD ENABLE 1 XIVO PRESUBR FWD USER xivo subrfwd user XIVO PRESUBR FWD GROUP xivo subrfwd group XIVO PRESUBR FWD QUEUE xivo subrfwd queue XIVO PRESUBR FWD MEETME xivo subrfwd meetme XIVO PRESUBR FWD VOICEMAIL xivo subrfwd voicemail XIVO PRESUBR FWD SCHEDULE xivo subrfwd schedule 1 11 and SDK 269 XiVO doc Documentation Release 14 08 XIVO PRESUBR FWD VOICEMENU xivo subrfwd voicemenu XIVO PRESUBR FWD SOUND xivo subrfwd sound XIVO PRESUBR FWD CUSTOM xivo subrfwd custom XIVO PRESUBR FWD EXTENSION xivo subrfwd extension Dialplan variables Some of the XiVO variables c
45. 5551234 And you want to do direct lookup on the name column and reverse lookup on the phone column then you ll use Direct match name Match reverse directories phone Web service directories For web service directories the Direct match and the Match reverse directories must be filled with the name of the HTTP query parameter that will be used when doing the HTTP requests For example given you have the following directory definition Direct match search Match reverse directories phonesearch When a direct lookup for John is performed then the following HTTP request GET ws phonebook search John HTTP 1 1 is emitted When a reverse lookup for 5551234 is performed then the following HTTP request GET ws phonebook phonesearch 5551234 HTTP 1 1 is emitted Note that the CSV returned by the Web service is not further processed Reverse lookup To enable reverse lookup you need to add an entry in Mapped fields Fieldname reverse Value the header of your data source that you want to see as the caller ID on your phone on incoming calls Configure the display of the data Edit the default display filter or create your own in Services CTI Server Directories Display filters Each line in the display filter will result in a header in your XiVO Client Field title will be the text displayed in the header 96 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08
46. CTI Proxy Here s how to run the various CTI client server development debugging tools These tools can be found on GitHub in the XiVO project You can get the scripts by using Git git clone https github com xivo pbx xivo tools git General Information Both the ctispy ctisave and ctistat tools work in a similar way They both are proxies that need to be inserted between the CTI client and the CTI server message flow To do this you first start the given tool on your development machine giving it the CTI server hostname as the first argument You then configure your CTI client to connect to the tool on port 50030 notice the trailing 0 The tool should then accept the connection from the client and once this is done will make a connection to the server thereby being able to process all the information sent between the client and the server In the following examples we suppose that the CTI server is located on the host named xivo new Tools ctispy ctispy can be used to see the message flow between the client and the server in real time The simplest invocation is cti proxy ctispy xivo new You can pretty print the messages if you want by using the pretty print option 1 12 Developers 285 XiVO doc Documentation Release 14 08 cti proxy ctispy xivo new pretty print By default each message is displayed separately even though more than one message can be in a single TCP packet You can also use the
47. DATE must be in the following format YYYY MM DDTHH MM SS Note the T separating the date and time start date and end date must be given together the REST API will not accept start date without end date and vice versa Example request GET 1 1 call logs start date 2013 01 01T00 12 34 amp end date 2013 01 02T06 54 32 HTTP 1 1 Host xivoserver Accept text csv 1 11 and SDK 221 XiVO doc Documentation Release 14 08 Example response HTTP 1 1 200 OK Content Type text csv charset utf8 Call Date Caller Called Period user Field 2013 01 01T01 00 00 sourcel 1001 2001 1 2013 01 02T00 00 00 source2 1002 2002 2 userfield CTI Profiles CTI Profiles representation Field Values Description Description 14 integer Read only name string Display name Example ng s name Client CTI Profiles list Query GET 1 1 cti profiles Example requests Listing all available CTI profiles GET 1 1 profiles HTTP 1 1 Host xivoserver Accept application json Example response HTTP 1 1 200 OK Content Type application json roral 2 items ada 1 name Client ig 2 name Agent Get CTI Profile 222 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Query Example request Host xivoserver Accept application json Example response HTTP 1 1 200 OK Content Type
48. Here s an example on how to measure the code coverage of xivo ctid This can be useful when you suspect a piece of code to be unused and you want to have additional information about it 1 Install the following packages apt get install python pip build essential python dev Install coverage via pip pip install coverage 1 12 Developers 277 XiVO doc Documentation Release 14 08 3 Run the program in foreground mode with coverage run Service monit stop Service xivo ctid stop coverage erase coverage run usr bin xivo ctid d The Debugging Daemons section documents how to launch the various XiVO service in foreground debug mode 4 After the process terminates use coverage html to generate an HTML coverage report coverage html include xivo_ctix This will generate an ht 1mcov directory in the current directory 5 Browse the coverage report Either copy the directory onto your computer and open it with a web browser or start a web server on the XiVO cd htmlcov python m SimpleHTTPServer Then open the page from your computer i e not on the xivo firefox http xivo hostname 8000 External Links Official python documentation PyMOTW coverage py 1 12 6 Translating XiVO Supported languages are French and English This means that they are always maintained by Avencall Other languages are provided by the community We are now using a centralized tool for the XiVO
49. Host xivoserver Accept application json Search for devices containing the term aastra GET 1 1 devices search aastra HTTP 1 1 Host xivoserver Accept application json Example response HTTP 1 1 200 OK Content Type application json total 2 items id 412c212cff500cc158 373 00e078 7 T9050 mac 00 00 5e 00 00 01 sn null vendor Aastra model 6731i version 3 2 2 plugin xivo aastra 3 2 2 SP3 description null status configured options null Lemplate id defaultconfigdevice Links 1 rel devices href https xivoserver 1 1 devices 412c212cff500cc158 373 00e078 7 id 6ff76e09a7ab51ec3afel52a63324ff9 TEOR 05 0 2 mac 00 00 5e 00 00 02 sn nat vendor Snom model s 720 version 8 7 3 19 plugin xivo snom 8 7 3 19 description null status configured options null Lemplate id defaultconfigdevice links rel devices href https xivoserver 1l 1 devices 6ff76e09a7ab51ec3afel52a63324ff9 Get Device 1 11 and SDK 225 XiVO doc Documentation Release 14 08 Query GET 1 1 devices id Parameters id Device s id Error code Error message Description 404 Not found The requested device was not found Errors Example request GET 1 1 devices 412c212cff500cc158f373f 00e078
50. INACTIVE Use xivo fetchfw to find the name of the package You can search for digium occurences in the available packages xivo fetchfw search digium Install the package In our example we install the package named digium oct6114 064 xivo fetchfw install digium oct6114 064 Get help on xivo fetchfw xivo fetchfw h Activate the Hardware Echo cancellation To use the hardware echo canceller of the card you must activate itin etc asterisk chan dahdi conf file 1 8 Administration 107 XiVO doc Documentation Release 14 08 echocancel 1 Use the Hardware Echo canceller for DTMF detection If you have an hardware echo canceller it can be used to detect the DTMF Create the file etc modprobe d xivo hwec dtmf conf with the following content replace the dahdi module name word by the DAHDI module name options dahdi module name vpmdtmfsupport 1 Thus for a Digium card which uses the wct 4xxp module the content of the file will be options wct4xxp vpmdtmfsupport 1 Note You MUST restart dahdi for the new configuration to be enabled BRI card configuration Verifications Verify that the wcb4xxp module is uncommented in etc dahdi modules If it wasn t do again the step Load the correct DAHDI modules Generate DAHDI configuration Issue the command dahdi genconf Warning it will erase all exis ng configuraion in etc dahdi system conf etc asterisk dahdi chann
51. Inconnue db company st E mail j db mail Source xivo directory E Mobile phone db mobile Description Default display Adding the fax to the directory display 1 In the definition section add a field name fax with the value phonebooknumber fax number 2 In the display filter section add a field with field title Fax and display format db fax 3 Restart the CTI Server Now the fax should be available displayed in the Remote Directory xlet Reverse lookup It s possible to do reverse lookups on incoming calls to show a better caller ID name when the caller is in one of our directories Reverse lookup will only be tried if at least one of the following conditions is true The caller ID name is the same as the caller ID number The caller ID name is unknown Also reverse lookup is performed after caller ID number normalization since X1 VO 13 11 Some configuration must be in place to enable reverse directory lookups 1 8 Administration 131 XiVO doc Documentation Release 14 08 Match reverse fields The Match reverse directories field in Services CTI Server Directories Definitions should contains the fields that are used by the reverse lookup The list is comma separated and each field that appears in this list must also appear in the Value column of the Mapped Fields section or the reverse lookup won t work Example phonebooknumber office number phon
52. March 00 00 00 00 00 00 April 00 00 00 00 00 00 00 00 00 May 97 17 07 00 00 00 00 00 05 June 159 03 1 69 17 25 00 19 35 July 34 08 47 22 39 31 00 09 45 August 00 00 00 00 00 00 00 00 00 September 00 00 00 00 00 00 October 00 00 00 00 00 00 November 00 00 00 00 00 00 December 00 00 00 00 00 00 Total 87 16 55 00 24 40 P1 0 155 P2 16 205 P3 21 305 P4 31 605 5 615 1 9 Contact Center 191 XiVO doc Documentation Release 14 08 Period details by day P1 0 15s P2 16 20s P3 21 30s P4 31 60s P5 61s 9h 10h 10h 11h mem 1 Total calls handled Total abandoned calls Period details by week Period details by month Period details by year 1 9 7 Reporting You may use your own reporting tools to be able to produce your own reports provided you do not use the XiVO server original tables but copy the tables to your own data server You may use the following procedure as a template Allow remote database access on XiVO Create a postgresql account read only on asterisk database Create target tables in your database located on the data server Copy the statistic table content to your data server General Architecture 1 The queue log table of the asterisk database is filled by events from Asterisk and by custom dialplan events 192 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 P1 0 15s
53. Methad Address sd Nemas a Defaut gateway pm Description B Figure 1 21 Adding a new virtual interface 1 6 System 45 XiVO doc Documentation Release 14 08 Interfaces Add Physical Interface of VLAN emo IDof VLAN 101 Method Static Address 10 9762 Netmask 25525525507 Default gateway Du Description Figure 1 22 Adding a new virtual interface 1 gt emo 08 00 27 6 49 5 i 192 168 32 51 O 3 0 101 i 1097 62 08 00 27 e9 fa f4 ES dod CER ELLO 5 55 55 LLL LL NL TUM Enable gt Disable gt Not apply rer 08 00 27 6a 49 e5 Entities Web Services Access 08 00 27 e9 fa f4 08 00 27 6a 49 e5 Certificates Figure 1 24 Listing the network interfaces 46 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Add static network routes Static route can t be currently added via the web interface If you want static routes in your XiVO you should do the following steps described below It would ensure that your static routes are applied at startup in fact each time the network interface goes up 1 Create the file etc network if up d xivo routes touch etc network if up d xivo routes chmod 755 etc network if up d xivo routes 2 Insert the following content
54. Name Context Default default Cali from Mode Secretaries simultaneous Boss first then secretaries in serial Boss first then secretaries simultaneously Secretaries in serial Secretaries simultaneously Ringing time CallerID mode Identity tems selected Remove all Add au Jean Yves LEBLEU Boss and secretaries are ringing simultaneously Change the caller id if the secretary wants to know which boss was initialy called When one of serial strategies is used the first secretary called is the last in the list The order can be modified by drag and drop in the list Usage The call filter function can be activated and deactivated by the boss or the secretary using the 37 extension The extension is defined in PBX services gt Extensions The call filter has to be activated for each secretary if more than one is defined for a given boss The extension to use is 37 lt callfilter member id In this example you would set 2 Func Keys 373 and 374 on the Boss On the secretary Jina LaPlante you would set 373 On the secretary Ptit Nouveau you would set 374 Function Keys A more convenient way to active the boss secretary filter is to assign a function key on the boss phone or the secretary s phone In the user s configuration under Func Keys A function key can be added for each secretaries of a boss If supervision is activated the key will light up when filter is a
55. P2 16 20s P3 21 30s P4 31 60s P5 61s Total calls handled Total abandoned calls Epi Ep2 E p2 m P3 4 E p4 5 ps 2 xivo stat fill db is then used to read data from the queue log table and generate the tables stat call on queue and stat queue periodic 3 The web interface generate tables and graphics from the stat call queue and stat queue periodic tables depending on the selected configuration Statistic Data Table Content stat call on queue This table is used to store each call individually Each call received on a queue generates a single entry in this table containing time related fields and a foreign key to the agent who answered the call and another on the queue on which the call was received It also contains the status of the call ie answered abandoned full etc 1 9 Contact Center 193 XiVO doc Documentation Release 14 08 0 15s P2 16 205 P3 21 305 P4 31 605 Pe 615 Total calls handled Total abandoned calls mP2 IN P3 mp4 ms 194 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 P1 0 15s P2 16 20s P3 21 30s P4 31 60s P5 61s Calls handled Abandoned calls wT es ee Aoa ps P4 Ps January 0 0 0 0 UR RD M UNE RN GR March EET E DR RET S E ENTE CT HS
56. Please replace fr by the code of your locale 55 DIR variable references either xivoclient or baselib You can use a command like the following to automate this LANG is the new language find name x pro xec sed i S TRANSLATIONS ROOT_DIR i18n _en ts 0 nTI To actually create the files you will have to use the translation managing script But first you must tell the script about your new locale Edit the utils translations sh file and add your locale to the LOCALES variable Then you can run the script 5 utils translations sh update Embed the translation files For each project previously edited you should have a corresponding qrc file These resource files list all files that will be embedded in the XiVO Client binaries You should then add the corresponding translation files like below lt file gt obj xivoclient_fr qm lt file gt This embeds the French translation of the xivoclient module corresponding to the translation file above The path is changed to ob j because the qm file will be generated from the ts file You can use a command like the following to automate this SLANG is the new language find name x qrc xec sed i S N lt file gt obj _fr qm lt file gt 0 n 1 lt file gt 2 Display the new locale You have to edit the source file xivoclient src configwidget cpp and add the entry corresponding to your locale in the locale choosing combob
57. Std 802 11u 2011 dot11Hl this shall be identifical to one of 7 3 1 34 ESSID the BSSIDs in the homogeneous 1 12 Developers 331 XiVO doc Documentation Release 14 08 ESS and this shall be set to the same value across all BSSs in homogeneous ESS hessid 02 03 04 05 06 07 Roaming Consortium List Arbitrary number of Roaming Consortium OIs can be configured with each line adding a new OI to the list The first thr ntries are available through Beacon and Probe Response frames Any additional entry will be available only through ANOP queries Each OI is between 3 and 15 octets and is configured a a hexstring roaming consortium 021122 roaming consortium 2233445566 f44 Multiple BSSID support Above configuration is using the default interface wlan or multi SSID VLAN interfaces Other BSSIDs can be added by using separator bss with default interface name to be allocated for the data packets of the new BSS hostapd will generate BSSID mask based on the BSSIDs that are configured hostapd will verify that dev addr amp MASK dev addr If this is not the case the MAC address of the radio must be changed before starting hostapd ifconfig 1 0 hw ether MAC addr gt If a BSSID is configured for every secondary BSS this limitation is not applied at hostapd and other masks may
58. a user with a custom line with number 1001 in context default e a custom line with interface DAHDI g1 5551234 Then add the following or similar custom lines exten line1001 1 NoOp same n Set __PICKUPMARK 1001 default same n Dial DAHDI g1 5551234 same n Hangup do a dialplan reload in the asterisk CLI Then edit the line of the user and change the interface value to Local l1inel001Gcustom lines Note that you ll need to update your dialplan if you update the number of the line or the context 1 8 11 Entities Warning This feature is currently under development 1 8 Administration 97 XiVO doc Documentation Release 14 08 Purpose In some cases as the telephony provider you want different independent organisation to have their telephony served by your XiVO e g different departments using the same telephony infrastructure but you do not want each organisation to see or edit the configuration of other organisations Configuration In Configuration Entities you can create entities one for each independant organisation In Configuration Users you can select an entity for each administrator Note Once an entity is linked with an administrator it can not be deleted You have to unlink the entity from all administrator to be able to delete it 1 8 12 Fax Fax transmission It s possible to send faxes from XiVO using the fax Xlet in the XiVO client Choose Destination Number
59. application json de cT name Client Devices Device Representation GET 1 1 cti_profiles lt id gt GET 1 1 cti profiles 1 HTTP 1 1 Field Values Description id string Read only 1 string formatted as an IP address IP address 10 0 0 0 mac string formatted as a MAC address MAC address aa bb cc dd ee ff sn string Serial number vendor string Vendor name model string Device model version string Firmware version plugin string Provisioning plugin to be used by the device description string Sus configured configured Device is config autoprov ured and ready to be used Description not configured autoprov Device can be pro visionned using a provision ing code not configured Device has not been completely config ured options object List of standard keys switchboard a boolean in dicating if this device is a switchboard template id string ID of the device template de vices using a device template will have a certain number of common parameters preconfigured for the device 1 11 and SDK 223 XiVO doc Documentation Release 14 08 Example id 412c212cff500cc158 373f f 00e078 f7 00S 00 Ser 00 0001 null vendor Aastra model 67571 wersdqggon s 3 2 2 plugin xivo aastrta 3 2 2 5P3 description null status configured options switchboard true tem
60. based parking when picking up parked call None Allow DTMF based hangups when picking up parked call None gt Allow DTMF based one touch recording when picking up parked None gt MOH class to play to parked calls default j Use ADSI announces parkedcallstimeout You can define this context in dialplan configuration file Service Configuration Files where you may define this context with dialplan commands Example parkedcallstimeout exten s l Noop park call time out same Playback hello world same n Hangup It is also usual to define supervised phone keys to be able to park and unpark calls as in the example below m 21 user m Jean rves LEDLEU Yj 99 P 5 s 2 2 S zi Parking postion z ror amp Parking postion z E Parking postion z w Embed sj amp Parking postion z M 7 g Sw 1 8 22 Phonebook A global phone book be defined PBX Service gt Phone book phone book be used from the XiVO client from the phones directory look key if the phone is compatible and are used to set the Caller ID for incoming calls You can add entries one by one or you can mass import from a CSV file Mass import contacts Go in the PBX Services gt Phonebook section and move your mouse cursor on the button in the
61. f d f for foreground d for debug Starting xivo agentd Executing statuses command Log file var log daemon 1log Lines start with xivo agid Oct 29 11 03 53 hostname xivo agid 25724 xivo agid starting Oct 29 11 03 54 hostname xivo agid 25724 executing update command update config Oct 29 11 03 54 hostname xivo agid 25724 executing update command update phonebook amid xivo amid f v f for foreground y for verbose 274 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Log file var log xivo amid log 2014 01 15 10 36 42 372 5252 INFO Starting xivo amid 2014 01 15 10 36 42 372 5252 INFO Connecting socket 2014 01 15 10 36 42 372 5252 INFO Connecting AMI client to localhost 5038 call logd xivo call logd f v f for foreground v for verbose Log file var log xivo call logd log 2014 02 12 14 58 05 051 14650 INFO Starting xivo call logd 2014 02 12 14 58 05 178 14650 INFO Running confgend twistd no python usr bin xivo confgend No debug mode in confgend Log file var log xivo confgend log 2013 10 29 11 03 50 0400 Starting factory lt confgen confgen ConfgendFactory instance at 2013 10 29 11 03 55 0400 Confgen 0 127 0 0 1 serving asterisk features conf 2013 10 29 11 03 55 0400 Confgen 1 127 0 0 1 serving asterisk musiconhold conf ctid xivo ctid d d for foreground and debug Log fil
62. it can be associated with different kinds of resources These associations determine where a call will be routed when the extension 15 dialed An extension is composed of an exten the number to dial and a context from where are we allowed to dial The context restrains what source a call will come in from e g DID calls will come from the context from extern Extension Representation Field Values Description id int Read only Description ovd smg context string commented boolean If True the extension is disabled links list The link to the resource Example bil Ors ake X context default exten 1234 commented false rel extensions href https xivoserver 1 1 extensions 1 230 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 List Extension Query GET 1 1 extensions Example request GET 1 1 extensions HTTP 1 1 Host xivoserver Accept application json Example response HTTP 1 1 200 OK Content Type application json totale 2 items ids Ly context default exten 1234 commented false links rel extensions href https xivoserver 1 2 Context default exten 6789 commented true links rel extensions href https xivoserver 1 Get Extension Query GET 1 1 extensions id Example request l extensions 1
63. po EE Ed E EIE M A ainda Figure 1 3 Basic configuration 1 2 Installation XiVO doc Documentation Release 14 08 Configuration 1 Enter the hostname Allowed characters are A Z a z 0 9 Boi Enter the domain name Allowed characters are A Z a z 0 9 Enter the password for the root user of the web interface IP and gateway of the network interface on which you are connected Configure the IP address and gateway used by your XiVO by default it pre fills the fields with the current Note The network configuration will be applied at the end of the wizard 5 Finally modify the DNS server information if needed Entities and Contexts Contexts are used for managing various phone numbers that are used by your system e The Interal calls context is used for managing phone numbers for devices that are connected to your system The Incalls context will intercept all incoming calls from the exterior The Outcalls context is used for managing ougoing calls to the exterior XiVO Installation Steps Welcome Licence Components check Configuration Entities and contexts Validation 1 Enter the entity name e g your organization name Allowed characters are A Z a z 0 9 2 Enter the number interval for you internal context The interval will define the users s phone numbers for Printed name Defaul
64. provd Provd logs are send to the system s syslog See log files above for global configuration info sysconfd Sysconfd logs are send to the system s syslog See log files above for global configuration info 1 6 System 49 XiVO doc Documentation Release 14 08 web interface The web interface s log file is managed by logrotate It s configuration file is etc logrotate d xivo web interface Default configuration Rotation frequence Daily Number of archived files 21 e File location var log xivo web interface log xivo confgend The xivo confgend daemon output is sent to the file specified with the logfile parameter when launched with twistd The file location can be changed in etc init d xivo confgen Search the line begining with logfile var log xivo confgend log and change it to your liking Default configuration File location var log xivo confgend log xivo ctid The xivo ctid log file is managed by logrotate It s configuration file is etc logrotate d xivo ctid Default configuration Max log file size 100M Number of archived log files 15 Rotation frequence Daily File location var log xivo ctid pid 1 6 5 Configuration Files This section describes some of the XiVO configuration files xivo ring conf Path etc xivo asterisk xivo ring conf Purpose This file can be used to change the ringtone played by the phone depending
65. start Channel SIP x2gjtw 0000000d commandid 1423579492 Server gt Client response ok request was correctly processed ko unable to process the request command record replyid 1423579492 class ipbxcommand ipbxreply true timenow replyid 1423579492 command record class ipbxcommand timenow 1361798879 13 hangup Client gt Server class ipbxcommand command hangup Channelids chan xivo channel id commandid command id For example class ipbxcommand command hangup channelids chan xivo SIP im2p7kzr 00000003 commandid 177773016 Server Client class ipbxcommand command hangup 1 12 Developers 301 XiVO doc Documentation Release 14 08 ipbxreply 1 replyid 177773016 Limenow 1395756534 64 Statistics subscribetoqueuesstats This message can be sent from the client to enable statitics update on queues Client Server commandid 36 class subscribetoqueuesstats Server gt Client getqueuesstats When statistic update is enable by sending message subscribetoqueuesstats The first element of the message is the queue id stats 10 Xivo LoggedAgents 0 class getqueuesstats timenow 1384509582 88 states VIN s T Xivo WaitingCalls QT class getqueuesstats timenow 1384509582 89 stats 1 Xivo TalkingAgen
66. the CTI call form result event looks like this name call form result data events have the same basic structure namely a JSON object with two keys name string representing the name of the event Each event type has a unique name data The data specific part of the event This is documented on a per event type if not this is assumed to be null 1 11 and SDK 215 XiVO doc Documentation Release 14 08 AMI AMI related events are sent to the xivo ami exchange which is an exchange of type topic To subscribe to event with name X you must create a binding between the exchange and your queue with the binding routing key X Example event with binding key QueueMembersStatus name QueueMemberStatus data StetusUs T Penalty 10 CallsTaken Moki iss MemberName sip m3ylhs Queue petak Lastcali s p Membership static Location sipV maylhs Privilege agent all Paused 0 StateInterface sip m4ylhs CTI CTI related events are sent to the xivo cti exchange which is an exchange of type direct To subscribe to event with name X you must create a binding between the exchange and your queue with the binding routing key X call form result The call form result event is sent when a custom call form is submitted by a CTI client routing key call form result event specific data a dictionary wit
67. uptime ressource usage and controls to Restart service blue button stop service red button and stop monitoring service grey button 1 8 20 Paging With XiVO you can define paging i e intercom extensions to page a group of users When calling a paging extension the phones of the specified users will auto answer if they support it You can manage your paging extensions via the Services IPBX Paging page General Users o o Pp Number Full duplex audio Ignore attempts to forward the call Record the page into a file Quiet do not play beep to caller Timeout Le Do not play simultaneous announcement to caller Play simultaneous announcement to called users 4 The announcement to playback in all devices Description Save When adding a new paging extension the number can be any numeric value to call it you just need to prefix the paging number with 11 1 8 21 Parking With XiVO it is possible to park calls the same way you may park your car in a car parking If you define supervised keys on a phone set for all the users of a system when a call is parked all the users are able to see that some one is waiting for an answer push the phone key and get the call back to the phone There is a default parking number 700 which is already configured when you install XiVO but you may change the default configuration by editing the parking extension in menu
68. 0 0 00 00 05 100 96 0 0 0 0 0 00 00 04 190 4 week Monday 24 24 0 0 0 0 0 00 00 04 100 96 0 Tuesday i 0 0 0 0 00 00 08 Wednesday 28 24 4 0 0 0 0 00 00 26 B5 0 Thursday 40 37 0 3 0 0 0 00 00 09 100 0 Friday 2 0 0 0 0 00 00 06 5 week Monday 43 43 0 0 0 0 0 00 00 07 100 0 Tuesday 35 32 1 0 0 0 2 00 00 06 91 0 Wednesday 31 28 1 0 0 0 2 00 00 07 90 0 Thursday 27 15 1 0 0 0 11 00 00 49 55 0 Total 640 583 21 3 0 0 33 00 00 13 91 0 Total call distributed m Answered Abandoned Received Answered Abandoned Answered rate QoS 0 0 0 00 00 08 00 00 10 00 00 11 October 46 00 00 13 74 0 November i 00 00 06 96 0 December 8 00 00 07 93 0 Total 89 00 00 09 86 0 Total call distributed Answered 4 Abandoned 188 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Blocking Calls received when no agents were available or when there were no agents to take the call join an empty queue condition or remove callers if there are no agents condition is reached advanced queue parameter tab Average waiting time AWT The average waiting time of call on wait Answered rate HR The ratio of answered calls over received calls closed calls Quality of service QoS Percentage of calls answered in less than x seconds ove
69. 05 The order of softkeys on SCCP phones has changed e g the Bis button is now at the left 13 04 Consult the 13 04 Roadmap Upgrade procedure for HA Cluster has changed Refer to Specific Procedure Upgrading a Cluster Configuration of switchboards has changed Since the directory xlet can now display any column from the lookup source a display filter has to be configured and assigned to the switchboard directory context Refer to Directory xlet documenttion There is no more context field directly associated with a call filter Boss and secretary users associated with a call filter must necessarily be in the same context 2012 1224 Consult the 12 24 Roadmap XiVO 12 24 has some limitations mainly affecting the contact center features due to the rewriting of the code handling agents Please consult the following detailed upgrade notes for more information 1 4 Upgrading 25 XiVO doc Documentation Release 14 08 Contact Center XiVO 12 24 order to fix problems related to Asterisk freezing through the chan agent mod ule XiVO 12 24 implements a new way of managing agents Warning contact center XiVO 12 24 does not implement all the features available in 12 22 Therefore you must not upgrade your XiVO if you depend on these features These features will be reimplemented in the future starting with version 13 01 Missing Features e Skill based routing Penalities Call listening Liv
70. 1 same n Return xten not locked 1 NoOp same n Log ERROR Could not obtain lock same n Wait 0 5 same Hangup xten too many calls 1 NoOp same n Log WARNING Not calling agent ID XIVO_AGENT_ID because already in use same n Wait 0 5 same n Hangup This workaround only applies to queues with agent members it won t work for queues with user members Also the subroutine prevent asterisk from calling an agent twice by hanguping the second call In the agent statistics this will be shown as a non answered call by the agent 1 14 Documentation changelog 350 Chapter 1 Table of Contents 2 Changelog The Documentation changelog is available 351 XiVO doc Documentation Release 14 08 352 Chapter 2 Changelog CHAPTER 3 Indices and tables genindex search 353 XiVO doc Documentation Release 14 08 354 Chapter 3 Indices and tables Index C Contacts 28 ctiserver 82 D devices 92 Dial 37 interconnections 114 116 L Local directory 35 M mail 58 N network 42 5 36 U users 160 V VLAN 42 W wizard 4 X XiVO Client 334 335 337 CTI Client 27 Xlets 27 355
71. 14 07 or later the options used in this procedure are not available in versions before 14 07 The following upgrade procedure suppose that you are using an Aastra phone as your switchboard phone The same upgrade procedure apply for Snom phones with the only difference being the different plugin name 1 Update the list of installable plugins 2 Install the latest xivo aastra plugin or upgrade it to the latest version if it is already installed 3 Install the needed language files and firmware files 4 For each phone used for the switchboard change the plugin and activate the switchboard option Select the generic xivo aastra plugin Check the switchboard checkbox Synchronize the phone 5 Once this is completed you can uninstall the xivo aastra switchboard plugin An unofficial script that automates this procedure is also available on github cd tmp wget no check certificate https raw githubusercontent com xivo pbx xivo tools master scripts i python migrate switchboard 1407 py 1 4 Upgrading 17 XiVO doc Documentation Release 14 08 14 06 Consult the 14 06 Roadmap The XiVO client now uses Qt 5 instead of Qt 4 There is nothing to be aware of unless you are building your own version of it 14 05 Consult the 14 05 Roadmap The CTI Protocol has been updated The specification of the answered rate queue statistic has changed to exclude calls on a closed queue The switchboard can now
72. 24 586868 5555555555 5555555555 55 8837 HANGUP 2012 03 29 07 57 24 587584 No l 1001 10 8838 CHAN END 2012 03 29 07 57 24 588184 P re No l 1001 10 8839 HANGUP 2012 03 29 07 57 24 588304 5555555555 5555555555 55 8840 CHAN_END 2012 03 29 07 57 24 588359 5555555555 5555555555 D9 11 rows Call To a Queue 1 External user calls 444 2 The call is distributed to queue service 3 Agent 1234 P re No l 1001 answers 4 External user hangs up after a few seconds id eventtype eventtime userdeftype cid_name cid_num cid 4 4 8859 CHAN START 2012 03 29 08 18 13 983343 5555555555 5555555555 8860 ANSWER 2012 03 29 08 18 14 049882 5555555555 5555555555 55555 8861 ANSWER 2012 03 29 08 18 19 042273 5555555555 5555555555 55555 8862 APP START 2012 03 29 08 18 20 113057 5555555555 5655555555 55555 8863 CHAN STAR 2012 03 29 08 18 20 116129 8864 CHAN STAR 2012 03 29 08 18 20 116184 8865 CHAN STAR 2012 03 29 08 18 20 11623 8866 APP START 2012 03 29 08 18 20 213517 5555555555 5955555555 55555 8867 CHAN STAR 2012 03 29 08 18 20 213719 P re No8l 1001 8868 ANSWER 2012 03 29 08 18 23 174506 P re No8l 1001 1001 8869 ANSWER 2012 03 29 08 18 23 174666 5555555555 5555555555 55555 212 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08
73. Documentation Release 14 08 GET 1 1 lines sip HTTP 1 1 Host xivoserver Accept application json Example response HTTP 1 1 200 OK Content Type application json total 2 items agp 215 Context default username abcdef secret secret_password provisioning_extension 123456 device_slot 1 callerid John Doe lt 1002 gt v rel 11 _51 href https xivoserver 1 1 lines sip 1 Context default username stuvwx secret super secret password provisioning extension 987456 device slot 1 callerid Mary Lin lt 1003 gt links rel lines_sip href https xivoserver 1 1 lines_sip 2 Get SIP Line Query GET 1 1 lines_sip lt id gt Example request GET 1 1 lines sip 1 HTTP 1 1 Host xivoserver Accept application json Example response HTTP 1 1 200 OK Content Type application json vige siy Context default 242 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 username abcdef secret secret password provisioning extension 123456 device slot 1 Callerid John Doe lt 1002 gt links rel lines_sip href https xivoserver 1 1 lines_sip 1 Create SIP Line The username secret and provisioning extension are autogenerated Query POST 1 1 lines_sip Input Fi
74. E RE NE PEE Directories i Web Services Access Remote address 192 168 1 2 Certificates mc c SEE rie High Availability Network Interfaces Save Resolver _ SSS uu Sy Mail Figure 1 88 HA Dashboard Master Important You have to restart all services xivo service restart once the master node is configured Slave node In choosing the method Slave you must enter the IP address of master node Configuration MighAvallabliy 00 Type of this node Save Entities 5 Directories Web Services Access Remote address 192 168 1 1 Certificates LN tua ld sdri AT ET il lul ad N E High Availability N Network Interfaces Resolver O Figure 1 89 HA Dashboard Slave Configuration Replication Once master slave configuration is completed XiVO configuration is replicated from the master node to the slave every hour 00 Replication can be started manually by running the replication script on the master 200 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 xivo master slave db replication slave ip The replication does not copy the full XiVO configuration of the master Notably these are excluded
75. Firmware load requires a power cycle wctel3xp 0000 03 0c Running firmware version 6 0017 0 0 0 0 0 wctel3xp 0000 03 0c Loaded firmware version 780017 Will load after next power cycle wctel3xp 0000 03 0c FALC version 5 wctel3xp 0000 03 0c Setting up global serial parameters for T1 wctel3xp 0000 03 0c VPM450 firmware dahdi fw oct6114 032 bin not available from userspace wctel3xp 0000 03 0c Found a Wildcard TE132 TE134 SN 1 134 DF05132600690 20130702 CX CX D C69 C3 CX C For the firmware update to complete you must halt the machine a reboot won t be enough before restarting it 18 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 SCCP Upgrade Notes Important modification have been made to the internal structure of the SCCP channel driver xivo libsccp The modifications mostly affect administrators users are not affected Major changes are Improved support for live modifications no more manual intervention in the asterisk CLI is needed Improved handling of concurrency crash and deadlock due to concurrency problems should not occur anymore CLI following commands have been removed because they were not needed sccp resync sccp set directmedia sccp show lines sccp update config The behavior of the following commands have been changed module reload chan_sccp reloads the module configuration without
76. IPBX configuration Configuration files add a new file containing the following dialplan allow transfer exten 1 Setting transfer context same n Set TRANSFER CONTEXT internal context same n Return Do not forget to substitute lt internal context gt with your internal context Some places where you might want to add this preprocess subroutine is on queues and outgoing calls to be able to transfer the called person to another extension 1 13 2 Fax detection XiVO does not currently support Fax detection The following describe a workaround to use this feature The behavior is to answer all incoming external call wait for a number of seconds 4 in this example if a fax is detected receive it otherwise route the call normally Note This workaround works only on incoming calls towards an User and an User only if the incoming trunk is a DAHDI or a SIP trunk if the user has a voicemail which is activated and with the email field filled XiVO 13 08 needs asterisk 11 Be aware that this workaround will probably not survive any upgrade 1 In the Web Interface and under Services IPBX configuration Configuration files add a new file named fax detection conf containing the following dialplan Fax Detection pre user global faxdetection exten s l1 NoOp Answer call to be able to detect fax if
77. IVO Search O General settings General Lines No answer j Groups FuncKeys SIP Protocol 1 Protocol Voicemails Phonebook En 55s eli Number Line Advanced IPBX settings Devices Lines Users Groups Voicemails Figure 1 12 Line information By default the selected protocol is SIP which is what we want for now Click on Save to create the line xus General settings Groups Func Keys TAX Protocol Entity mae e Phonebook Number IPBX settings 1000 Figure 1 13 Save Yahoo we now have a user named Alice Wonderland with the phone number 10007 N 5 OO IPBX General settings SIP Protocol IAX Protocol i Alice Wonderland Phonebook Figure 1 14 User added information Now we need to go get the SIP username and password to configure our phone Go back to the IPBX menu on the left and click on Lines You will see a line associated with the user we just created Click on the pencil icon to edit the line We can now see the username and password for the SIP line you can configure your softphone your linksys PAP2 or your SIP device by using the IP for your server the username a
78. Minimum time of the round trip RTT messages 100 milliseconds 1 T1 timer 500 milliseconds 1 Configuration timer 32000 milliseconds J Relax DTMF Compensating for RFC 2833 DTMF from another IP PBX _ RTP timeout Disabled v RTP hold timeout Disabled 8 RTP keepalive Disabled Enable RTP Direct _ Compact headers MIME type notification application simple message summary DNS request 9 Conform to standards 21 Maximum 5 minutes 8 Minimum expiry 3 minutes Default expiry time 4 minutes MWI expiry Figure 1 85 Services IPBX General Settings SIP Protocol The provisioning server configuration will be automatically updated in order to allow phones to switch from XiVO power failure Configuration G mm d Management Unique name default Users Entities Display name local Directories Web Services Access Certificates High Availability E Secondary Main Interfaces 1 DHCP Support 1 xiVO Alerts Li
79. Preprocess subroutine field pre incall fax 4 For each Outgoing call rule add the the following string in Preprocess subroutine field pre outcall fax 1 8 13 Graphics The Services Graphics section gives a historical overview of a XiVO system s activity based on snapshots recorded every 5 minutes Graphics are available for the following resources CPU Entropy nterruptions Stats e System Load Memory Usage Open Files Open Inodes Swap Usage Each section is presented as a series of 4 graphics daily weekly monthly and yearly history Each graphic can be clicked on to zoom information presented is read only 1 8 14 Groups Groups are used to be able to call a set or users Group name cannot be general reserved in asterisk configuration 1 8 Administration 103 XiVO doc Documentation Release 14 08 7 E lla dala 104 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 1 8 15 Group Pickup Pickup groups allow users to intercept calls directed towards other users of the group This is done either by dialing a special extension or by pressing a function key The group pickup is limited to 64 groups Quick Summary In order to be able to use group pickup you have to Create a pickup group Enable an extension to intercept calls Add a function key to interceptors Creating a Pickup Group Pickup groups can be create in t
80. Table widget XIVOFORM lastname 2 QLineE diteur de propri t s du ZI widget QWidget croup Box Scroll Area B Tool Box Tab widget stacked widget Frame Widget MdiArea Dock Widget Combo Box Font Combo Box Line Edit Text Edit Plain Text Edit Propri t Valeur Cr n Antia PreferDefault cursor Wy Fl che mouseTr focusPo NoFocus context DefaultContextMenu acceptD 7 window Form Tradu d sa Explorateur de ressources Filtre ae lt resource root gt Explorateur de Disabled 7 Qt interface SS Disabled Ot interface fileviAmpnestdesignerui 88 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 form show the form from an ui predefined It s an xml ui You need to define qtui in display format Default value if given this value will be used when all substitutions in the display value field fail Display value you can define text variables or both See the variable list for more information Variables Three kinds of variables are available xivo prefix is reserved and set inside the CTI server xivo where for sheet events event triggering the sheet xivo origin place
81. Tested Fkeys XiVO HA SPA501G Yes 8 No SPA502G No 1 No SPA504G Yes 4 No 5 508 8 5 509 12 SPA512G No 1 No SPA514G No 4 No SPA525G Yes 5 No SPA525G2 No 5 No The 500 expansion module is supported Cisco Small Business IP Phones previously known as Linksys IP Phones Model Tested Fkeys XiVO HA SPA901 No 1 5 921 1 5 922 1 5 941 4 SPA942 Yes 4 No SPA962 Yes 6 No Note You must install the firmware of each SPA9xx phones you are using since they reboot in loop when they can t find their firmware The SPA932 expansion module is supported ATAs Model Tested Fkeys XiVO HA PAP2 No 0 No SPA2102 No 0 No 5 8800 No 0 No For best results activate DHCP Integration on your XiVO Note These devices can be used to connect Faxes For better success with faxes some parameters must be changed You can read the Using analog gateways section Note If you want to manually resynchronize the configuration from the ATA device you should use the following url 68 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 http ATA IP admin resync http XIVO IP 8667 CONF FILE where ATA IP is the IP address of the ATA XIVO IP is the IP address of your XiVO e CONF FILE is one of spa2102 cfg spa8000 cfg Gig
82. The result of this evaluation will determine if this rule can be kept or if the selection is to be done with the next rule This can be understood as an if statement if this condition is true then select agents with skills evaluate second part else valuate next rul On this part these variables can be used Warning you need two persons waiting in the queue for these variables be taken into account EWT Estimated Waiting Time The waiting time estimated for the current selection of members WT Waiting time The time that caller has been waiting Example WT 60 french 100 french 50 If the waiting time is less than 60 seconds select an agent speaking good french 100 otherwise select an agent with low level of french 1 9 Contact Center 181 XiVO doc Documentation Release 14 08 Skill Part This second part is evaluated against every queue member s skills to know if it is selected or not Variables are skills names which you can check with operators above You can also use meta variables starting with a to substitute them with data set on the Queue call For example if you call Queue with the skill rule set argument equal to select lang lang german Then every lang occurrence will be replaced by german Name select lang Rules WT lt 10 lang gt 90 lang gt 40 Save Figure 1 80 Create Skill Rule Sets Examples tech
83. The Advanced Autopause agents option has to be disabled Other important fields The General Display name field is the name displayed in the XiVO client xlets and in the statistics The General Number field is the number that will be used to reach the switchboard internally typically 9 Create a Queue for Your Switchboard on Hold The switchboard uses a queue to track its calls on hold To create this queue go to Services Call center Queues and click the add button The Following configuration is mandatory The General Name field has to be switchboard hold The General Number field has to be a valid number in a context reachable by the switchboard Other important fields The General Display name field is the name displayed in the XiVO client xlets and in the statistics Warning This queue MUST have NO members 1 8 Administration 151 XiVO doc Documentation Release 14 08 Create the Users that Will be Operators Each operator needs to have a user configured with a line The XiVO client profile has to be set to Switchboard The following configuration is mandatory for switchboard users The General First name field has to be set The General Enable XiVO Client option has to be enabled The General Login field has to be set The General Password field has to be set The General Profile field has to be set to Switchboard The Lines Number field has to hav
84. The local directory xlet allow a user to add personnal contacts to the XiVO client History Services Contacts Conference Directory Personal Directory New Contact Export Contacts Import Contacts Search Remove all Contacts First Name Last Name Phone Numbe Email Address Company Fax Number Mobile Numbe 1 Robert Toto 5555555555 2 Robert De Niro 6666666666 Usage The New Contact button allow the user to add a new contact to his local contact file The Export Contacts button allow the user to save a copy of his local contacts in a file in CSV format 1 5 CTI Client 35 XiVO doc Documentation Release 14 08 The Import Contacts button allow the user to import a CSV file containing new contacts into his local directory The Search button allow the user to find an occurence of a string in his local directory Clicking the OK button multiple times in the search dialog will find the next occurence of the searched string The Remove all contacts button deletes all contacts from the user s local directory File format Imported files should have the following structure firstname lastname phonenumber emailaddress company faxnumber mobilenumber Robert Toto 5555555555 my email xivo 1234 5551231234 Remote Directory Xlet Overview The remote directory xlet allows the user to search through the configured directories of the CTI server Contacts Sheets Fax History Remote Directory Services Personal Dir
85. Tux 1000 1000 8952 ANSWER 2012 03 29 08 47 59 401188 5555555555 5555555555 55555 8953 BRIDGE STAR 2012 03 29 08 47 59 401228 2055555555 5555555555 55555 8954 ANSWER 2012 03 29 08 47 59 40153 Tux 1000 8955 ANSWER 2012 03 29 08 47 59 401556 447 8956 BRIDGE STAR 2012 03 29 08 47 59 417761 5555555555 5555555555 55555 8957 HANGUP 2012 03 29 08 47 59 535268 Tux 1000 1000 8958 CHAN END 2012 03 29 08 47 59 535306 Tux 1000 1000 8959 HANGUP 2012 03 29 08 47 59 535397 5555555555 5555555555 55555 8960 CHAN END 2012 03 29 08 47 59 535425 0055555555 5555555555 55555 8961 2012 03 29 08 48 03 879393 Tux 1000 8962 CHAN END 2012 03 29 08 48 03 87946 Tux 1000 8963 BRIDGE END 2012 03 29 08 48 03 87952 5555555555 5555555555 55555 8964 2012 03 29 08 48 03 882675 447 8965 CHAN END 2012 03 29 08 48 03 882709 447 8966 HANGUP 2012 03 29 08 48 03 882873 5555555555 5555555555 55555 8967 CHAN END 2012 03 29 08 48 03 883324 5555555555 5555555555 55555 25 rows External user calls 447 2 The call is routed to the operator Tux 1000 Agent 9999 3 The operator transfers the call to 1001 id eventtype eventtime userdeftype cid name cid num cid 8911 CHAN STAR 2012 03 29 08 41 14 215721 5555555555 5555555555 8912 ANSWER 2012 03 29 08 41 14 301682 5555555555 5555555555 55555 8913 APP START 2012 03 29 08 41 15 37998 5555555555 5555555555 55555 8914 CHAN STAR 2012 03 29 08 41 15 386099
86. Warning The switchboard configuration must be completed before using the switchboard This includes Device User Agent and Queues configuration see above Directory xlet configuration see Directory If it s not the case the user must disconnect his XiVO client and reconnect The XiVO Client Switchboard Profile When the user connects with his XiVO Client he gets the Switchboard profile 1 Current Call frame Answer button Call button Blind transfer button Attended transfer button QN A W N Hold button 156 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Connection Account GUI Settings Functions Advanced Presence reporting Customer Info esence reporting Customer Info Dialer Switchboard Switchboard queue name switchboard Switchboard call on hold queue name switchboard hold XiVO Client Availability Help VoiceMailBox 1002 1002 1002 fm 1002 i 0 old 8 Connected to En ligne OU appelle E Disponible X 2 E Unpaused No option Switchboard Current Call Enter G F3 FA 5 sy O Name Number Call Blind T Attended T Hold Hangup M Alice 1001 ie Alice 1001 02 54 Alice Gopher 1007 B b 1002 Incoming Calls Waiting Calls F9 Carl s 1003 1 call 1 call Dave 1004 Number Time Name Number Time Frank 1006 Carlos 4185551234 00 04 Frank 100
87. a rules order key anymore 13 09 Consult the 13 09 Roadmap The Restart CTI server link has been moved from Services CTI Server Control to Services IPBX Control The Agent Status Dashboard has been optimized The Directory xlet can now be used to place call 13 08 Consult the 13 08 Roadmap asterisk has been upgraded from version 1 8 21 0 to 11 3 0 which is a major asterisk upgrade The switchboard s queue now requires the xivo subr switchboard preprocess subroutine A fix to bug 4296 introduced functional changes due to the order in which sub contexts are included Please refer to ticket for details Please consult the following detailed upgrade notes for more information Asterisk 1 8 to 11 Upgrade Notes Table of modules that were available in the asterisk 1 8 package but that are not available anymore in the asterisk 11 package 1 4 Upgrading 23 XiVO doc Documentation Release 14 08 Name Description Loaded in Asterisk Replaced By AST1 8 Status app dahdibarge Barge in on DAHDI channel Yes Deprecated app chanspy application app readfile Stores output of file into a variable Yes Deprecated func env FILE app_saycountpl Say polish counting words Yes Deprecated say conf app setcallerid Set CallerID Presentation Yes Deprecated func callerid Application cdr sglite SQLite CDR Backend No Removed cdr_sqlite3_custom chan_gtalk Gtalk Channel Driver No Deprec
88. activated Services gt IPBX gt IPBX services Extension Client gt Server class featuresput commandid 1088978942 function enablerecording value true Server Client class getiist config enablerecording true function updateconfig listname users Meas uw Limenow 1361456614 55 tipbxid xivo Unconditional Forward Forward the call at any time call does not reach the user function fwd Client Server class featuresput commandid 2082138822 function fwd value destunc 1002 enableunc true Server gt Client class getiist config destunc 1002 enableunc true function updateconfig listname users do Se ITEM Limenow 1361456777 98 tipbxid xivo Forward On No Answer Forward the call to another destination if the user does not answer function fwd Client gt Server class featuresput commandid 1705419982 function fwd value destrna 1003 enablerna true 1 12 Developers 299 a XiVO doc Documentation Release 14 08 Server Client class getlist config destrna 1003 enablerna true function updateconfig listname users iae 2 timenow 1361456966 89 tipbxid xivo Forward On Busy Forward the call to another destination when the user is busy function fwd Client gt Server
89. allowed in your CTI profile Configuration You can modify the display of contacts within the XLet Go in the menu XiVO Client gt Con figure tab Functions sub tab Contacts You get two options The maximum number of contacts displayed The number of columns used to display the contacts A value of 0 will automatically display the contacts with the maximum number of columns allowed by the width of the window Transfers Many transfers scenarios are supported from the XiVO contact xlet Blind and attended tranfers can be done by right clicking a contact Important To be able to transfer calls using the XiVO client you have to enable the transfer service from the user configuration or the queue configuration if used form in the web interface Attended Transfers Important For the Attended Transfer to work properly in all expected cases you must take care of the value of the options below Services IPBX Services IPBX Extensions Advanced Parking option Allow DTMF based transfers when picking up parked call should be set to Caller to be able to initiate an attended transfer for a call picked from a parking option Allow DTMF based hangups when picking up parked call should be set to Caller to be able to abort an attended transfer picked up from a parking Usage 1 Answer an incoming call 2 Search an user in the Contact xlet 3 Right clic on the user icon and choose Atte
90. an email that clearly explain your setup and what you would like to do and we will see what we can do We don t provide any timeline Q I want to use the Page application to call many phones at the same time A Here a Page example for a one way call half duplex exten gt 1000 1 Verbose 2 Paging to external cisco phone same n Page sccp 100 autoanswer amp sccp 101 autoanswer i 120 for a two way call full duplex exten gt 1000 1 Verbose 2 Paging to external cisco phone same n Page sccp 100 autoanswer amp sccp 101 autoanswer di 120 Network Configuration for 7920 7921 Here s how to to configure a hostapd based AP on a Debian host so that both a 7920 and 7921 Wi Fi phone can connect to it The 7920 is older than the 7921 and is pretty limited in its Wi Fi functionnality 802 11b WPA no WPA2 TKIP no CCMP AES Which means that the most secure WLAN you can set up if you want both phones to connect to it is not that secure 1 Make sure you have a wireless NIC capable of master mode 2 If needed install the firmware lt vendor gt package For example if you have a ralink card like I do apt get install firmware ralink 3 Install the other dependencies apt get install wireless tools hostapd bridge utils 4 Create an hostapd configuration file in etc hostapd hostapd sccp conf with content hostapd configuration file
91. at the end of lines Paragraphs must be wrapped and lines should be at most 100 characters long 272 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 1 12 2 Debugging Asterisk To debug asterisk crashes or freezes you need the following packages on your xivo apt get install gdb asterisk dbg xivo libsccp dbg Warning When installing theses packages you should take care that it doesn t drag a new version of asterisk since it would restart your asterisk Debugging Asterisk Crash When asterisk crashes it usually leaves a core file in var spool asterisk You can create a backtrace from a core file named core file with gdb batch ex bt full ex thread apply all bt asterisk core file bt threads txt Debugging Asterisk Freeze You can create a backtrace of a running asterisk process with gdb batch x thread apply all bt asterisk pidof asterisk gt bt threads txt If your version of asterisk has been compiled with the THREADS flag you can get more information about locks with asterisk rx core show locks core show locks txt Note Debugging freeze without this information is usually a lot more difficult Optionally other information that can be interesting e the output of asterisk rx core show channels the verbose log of asterisk just before the freeze Recompiling Asterisk It s relatively straightforward to recompile the asterisk versio
92. be added to the same bridge by default This can be overridden with the wds bridge parameter to use a separate bridg bridge wds brO0 Client isolation can be used to prevent low level bridging of frames between associated stations in the BSS By default this bridging is allowed ap isolate 1 IEEE 802 11n related configuration ieee80211n Whether 0 disabled default 1 enabled Note You will also need to enable WMM for full HT functionality 80211 1 E 802 11 HT is enabled ht capab HT capabilities list of flags LDPC coding capability LDPC supported Supported channel width set HT40 both 20 MHz and 40 MHz with secondary channel below the primary channel HT40 both 20 MHz and 40 MHz with secondary channel below the primary channel 20 MHz only if neither is set Note There are limits on which channels can be used with HT40 and HT40 Following table shows the channels that may be available for 40 and HT40 use per IEEE 802 11n Annex J freq 40 HT40 2 4 GHz 5 3 1 7 1 9 Europe Japan 5 GHz 40 48 56 64 36 44 52 60 depending on the location not all of these channels may be available for use Please note that 40 MHz channels may switch their primary and secondary channels if needed or creation of 40 MHz channel
93. be used if the driver supports them e g swap the locally administered bit BSSIDs are assigned in order to each BSS unless an explicit BSSID is Specified using the bssid parameter If an explicit BSSID is specified it must be chosen such that it results in a valid MASK that covers it and the dev addr is not the same as the MAC address of the radio is not the same as any other explicitly specified BSSID Please note that hostapd uses some of the values configured for the first BSS as the defaults for the following BSSes However it is recommended that all BSSes include explicit configuration of all relevant configuration items bss wlanO 0 ssid test2 most of the above items can be used here apart from radio interface specific items like channel bss wlanO 1 bssid 00 13 10 95 fe 0b 5 Update the following parameters if applicable in the configuration file interface ssid channel wpa passphrase 6 Create a new stanzain etc network interfaces iface wlan sccp inet manual hostapd etc hostapd hostapd sccp conf 7 Up the interface 332 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 ifup wlan0 wlan sccp 8 Configure your 7920 7921 to connect to the network To unlock the phone s configuration menu on the 7921 Press the Navigation Button downwards to enter SETTINGS mode Navigate to and select Network Profiles Unlock the IP phone s configuration
94. bin sh if S IFACE lt network interface then ip route add lt destination gt via lt gateway gt ip route add lt destination gt via lt gateway gt fi 3 Fields lt network interface gt lt destination gt and lt gateway gt should be replaced by your specific configuration For example if you want to add a route for 192 168 50 128 25 via 192 168 17 254 which should be added when eth0 100 goes up bin sh if S IFACEJ eth0 100 then ip route add 192 168 50 128 25 via 192 168 17 254 fi Note You need to check which interface goes up to add routes only if the right interface goes up Otherwise the system will try to set the routes each time any interface goes up Change interface MTU Warning Changing the MTU is risky You should know what you are doing If you need to change the MTU here is how you should do it 1 Create the file etc network if up d xivo mtu touch etc network if up d xivo mtu chmod 755 etc network if up d xivo mtu 2 Insert the following content bin sh Set MTU per iface if S IFACE lt data interface gt then ip link set IFACE mtu lt data mtu gt elif S IFACE lt voip interface gt then ip link set IFACE mtu voip mtu fi 3 Change the data interface to the name of your interface e g ethO and the data mtu to the new MTU e g 1492 4 Change the voip interface to the name of your inter
95. calls received when queue was full closed Number of calls received on close joinempty Number of calls received no agents available leaveempty Number of calls diverted agents not available during the wait di Number of calls diverted due to the number of agent number versus calls waiting configured vert ca ratio was exceeded di Number of calls diverted because the maximum expected waiting time configured was vert waittime exceeded timeout Number of calls diverted because the maximum time allowed in queue parameter was exceeded queue id stat agent This table is used to match agents to an id that is different from the id in the agent configuration table This is necessary to avoid loosing statistics on a deleted agent This also means that if an agent changes number Agent 1001 to Agent 1202 the supervisor will have to take this information into account when viewing the statistics Affecting an old number to a another agent also means that the supervisor will have to ignore entries for this given agent for the period before the number assignment to the new agent stat queue This table is used to store queues in a table that is different from the queue configuration table This is necessary to avoid losing statistics on a deleted queue Renaming a queue is also not handled at this time 1 9 Contact Center 197 XiVO doc Documentation Release 14 08 1 10 High Availability HA The HA High Availability solution in XiVO makes i
96. choose which incoming call to answer The package versions do not necessarily contain the current XiVO version it may contain older versions Only the package xivo is guaranteed to have the current XiVO version Please consult the following detailed updated notes for more information DAHDI 2 9 0 Upgrade Notes These notes only apply to Digium TE133 or TE134 cards that are in firmware version 770017 or earlier Warning The system will need to be power cycled after the upgrade Your cards will not be usable until then Afterthe upgrade First you need to install the latest firmware for your TE133 or TE134 cards xivo fetchfw install digium tel133 xivo fetchfw install digium tel134 Then stop all the services and reload the DAHDI modules Reloading the DAHDI module might take up to 30 seconds xivo service stop service dahdi stop service dahdi start Following this manipulation you should see something similar at the end of the var log messages file dahdi Telephony Interface Unloaded dahdi Version 2 9 0 dahdi Telephony Interface Registered on major 196 wctel3xp 0000 03 0c Firmware version 6 0017 is running but we require version 780017 wctel3xp 0000 03 0c firmware agent loaded dahdi fw tel34 bin into memory wctel3xp 0000 03 0c Found dahdi fw tel34 bin version 780017 Preparing for flash wctel3xp 0000 03 0c Uploading dahdi fw tel34 bin This can take up to 30 seconds wctel3xp 0000 03 0c Delaying reset
97. deps 5 QT PATH bin PATH bin xivoclient Package To create the installer mingw32 make pack This will result in a exe file in the current directory Build options add a console CONFIG console To generate debug symbols mingw32 make DEBUG yes Clean mingw32 make distclean Building the XiVO Client on GNU Linux platforms This page explains how to build an executable of the XiVO Client from its sources for GNU Linux 1 12 Developers 335 XiVO doc Documentation Release 14 08 Prerequisites Qt5 library development files Ot website Git package git e Generic software building tools make g package build essential Get sources In a bash shell git clone git github com xivo pbx xivo client qt git Building You need to have the Qt5 binaries qmake lrelease in your PATH Launch qmake to generate the Makefile cd xivo client qt path to qt5 bin qmake This will also generate a file versions mak that contains version informations about the code being compiled It is necessary for compilation and packaging You can then launch make make Binaries are available in the bin directory The version of the executable is taken from the git describe command Build options generate debug symbols make DEBUG yes To compile the unit tests of the XiVO Client 5 CONFIG tests or if you have a recent version o
98. enabled not configured 2 WPS enabled configured wps state 2 AP can be configured into a locked state where new WPS Registrar are not accepted but previously authorized Registrars including the internal one can continue to add new Enrollees ap setup locked 1 Universally Unique IDentifier UUID see RFC 4122 of the device This value is used as the UUID for the internal WPS Registrar If the AP is also using UPnP this value should be set to the device s UPnP UUID If not configured UUID will be generated based on the local MAC address uuid 12345678 9abc def0 1234 56789abcdef0 Note If wpa psk file is set WPS is used to generate random per device PSKs that will be appended to the wpa psk file If wpa psk file is not set the default PSK wpa psk wpa passphrase will be delivered to Enrollees Use of per device PSKs is recommended as the more secure option i e make sure to set wpa psk file when using WPS with WPA PSK When an Enrollee requests access to the network with PIN method the Enrollee PIN will need to b ntered for the Registrar PIN request notifications are sent to hostapd ctrl iface monitor In addition they can be written to a text file that could be used e g to populate the AP administration UI with pending PIN requests If the following variable is set the PIN requests will be written to the configured file Wps pin requests var run hostapd pin requests Device Name
99. file gt lt xletname gt _nl qm lt file gt lt qresource gt lt RCC gt These files will be embedded in the Xlet library binary Create the translation files In your XLet directory run lupdate xletname pro This creates as much ts translation files as specified in the pro file You can now translate strings in these file The XLet will now be compiled and translated Add a new XLet For now it is not possible to add easily an XLet without changing the CTI server configuration files If you just want to test your new XLet you can add the following line in baseengine cpp m_capaxlets push_back QVariantList lt lt QVariant lt xletname gt lt lt QVariant tab right after the line m capaxlets datamap value capaxlets toList You can replace tab with grid or dock Add a translation This is definitely not something funny and not easy to automatize You have to add in every pro file of the project except xlets pro and all those that don t need translations a line TRANSLATIONS project lang ts Replace project with the project name xivoclient baselib xlet and lang by the identifier of your language en fr nl Then you have to add in every qrc file the qm files corresponding to the ones you added in the pro files such as lt file gt lt project gt _ lt lang gt qm lt file gt in the lt qresource gt section of these XML qrc file
100. for more information 2006 2012 Avencall Figure 1 79 Apply Skills to Agents Skill Rule Sets Once skills are created rule sets can be defined 180 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Rules are the way to reach the right agent Rules can be composed and dynamically modified A rule set is a list of rules Rules are evaluated against each queue member agent in order to see if it matches The call is distributed according to the matching rule Each rule has two parts the first part is a dynamical condition If its evaluation is false the next rule is tried the second part is tested against queue member s skills to define a selection Operators Arithmetic and logical operators can be applied to rules operandl operand2 division operandl operand2 multiplication operandl operand2 substraction 1 operand2 addition operandl operand2 is not equal operandl operand2 is equal operandl gt operand2 is greater than operandl lt 2 is lesser than operandl amp operand2 both are true operandl operand2 at least one of them are true is the operator with the higher priority and the one with the lower priority You can use brackets Y to overload operator priorities Dynamical Part The first part is evaluated after a selection of queue members is created with the rules from the second part
101. g1 trunk2 dahdi g2 Description When the caller s caller ID is not usable to the called party the outgoing call s caller id can be fixed to a given value that is more use full to the outside world Giving the public number here might be a good idea Exen Call permissions 7 Schedules Extern prefix Prefix Exten Stripnum Callerid B 99x EM xivo 5555555555 A user can also have a forced caller ID for outgoing calls This be use full for someone who has his own public number This option can be set in the user s configuration page The Outgoing Caller ID id option must be set to Customize The user can also set his outgoing caller ID to anonymous The order of precedence when setting the caller ID in multiple place is the following 1 Internal 2 User s outgoing caller ID 3 Outgoing call 4 Default caller ID 1 8 19 Monitoring The Monitoring section gives an overview of a XiVO system s status and of all monitored processes It is divided into 6 sections 1 8 Administration 123 XiVO doc Documentation Release 14 08 es o answer es c Oups nc Frstname Useri 0 0 pstname 0 User itur Mobile phone T Schedules f Ringing time 30 seconds Simultaneous calls On Hold Music default 7 Language rR gt Timezone I caller User Outgoing
102. gt lt CDATA gt lt sheet_qtui gt sheet info order 0010 name Nom type title gt lt CDATA 0230210083 gt lt sheet_info gt sheet info order 0030 name Origine type text gt lt CDATA extern gt lt sheet_info gt sheet info order 0020 name Num xc3 xa9ro type text gt lt CDATA 0230210083 sheet systray info order 0010 name Nom type title gt lt CDATA Maric xc3 xa9 Sapr xc3 xaftc systray info order 0030 name Origine type body CDATA extern systray info systray info order 0020 name Num xc3 xa9ro type body gt lt CDATA 0230210083 gt lt syst user profile The xml file content is defined by the following xsd file xivo javactilib src main xsd sheet xsd online version phone status update Received when a phone status change class getlist function updatestatus e listname phones getixst function updatestatus listname phones svo timenow 1361447017 29 tid is the the object identification Example of phone messages received when a phone is ringing arene EERE status channels SIP x2gjtw 0000000b tid 3 status channels SIP x2gjtw 0000000b queues hintstatus 0 groups status hintstatus S Eid 3 channel status update class getlist function updatestatus listname channels status directio
103. must contain values that were created in the Directory definition The title used for the Number column is the title of the first field whose type starts with number Note The field title of the first number column will be used for the header title in the xlet Warning Make sure that the fields entered in the display format are also available in the directory definition otherwise the filter will not return any results Context and filter association new Display filter has to be assigned to the switchboard directory context _swichboard Bs tter Presences Directories Phone hints Definitions Reverse directories Display ters Models Events a cna DC MDC CIC MC Description SS 1 5 CTI Client 33 XiVO doc Documentation Release 14 08 You can then choose which directories will be searched by the Xlet Warning You must not select internal directory as it is already handled LDAP Configuration To search in ldap directories you must have an LDAP server configured See LDAP for more details LDAP filter If you already have an LDAP filter configured for the Remote directory Xlet you can use it If not please refer to Add a LDAP Filter Include the
104. not been initialized When the XiVO client is restarted the counters are always displayed and calculated as if the application was not restarted When the server is restarted counters are reinitialized Enabling the xlet The xlet can be added to any CTI profile from the web interface Server DES General settings General Xlets Preferences General Profiles Status Presence Xlet Position Floating Closable Movable Scroll Number Phone Hints Queues detail Y dock Yes Yes v Yes v Yves v N A 8 Agents Directories boxe Definitions Reverse directories Save Direct directories Qi EO PS DDpbDNGD 9 G Display filters Actions Events Control Restart CTI server Configuration 172 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Some values can be configured for the xlet The statistic fetch timer can be set in the CTI profile preferences This option is expressed in seconds and the default is 30 seconds General settings General Xlets Preferences General Preference name Preference value Statistics fetch period Queues list xlet The statistical period can be configured through the XiVO client once logged in by right clicking on the Queue s name in the Queues xlet For each queue you can configure the fo
105. of physical function keys the device has for example a 6757i has 12 physical keys but you can configure 30 function keys because of the page system STested means the device has been tested by the XiVO development team and that the developers have access to this device devices are marked as Not Tested because other similar models using the same firmware have been tested instead If these devices ever present any bugs they will be troubleshooted by the XiVO support team 7xiVO HA means the device is confirmed to work with XiVO HA 8Fkeys is the number of programmable function keys that you can configure from the XiVO web interface It is not necessarily the same as the number of physical function keys the device has for example a 6757i has 12 physical keys but you can configure 30 function keys because of the page system 60 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 SPA122 SPA3102 SPA8000 Provisioning 4 Directory XIVO N N N Funckeys 0 0 0 Note For best results activate DHCP Integration on your XiVO Note These devices can be used to connect Faxes For better success with faxes some parameters must be changed You can read the Using analog gateways section Note If you want to manually resynchronize the configuration from the ATA device you should use the following url http ATA IP admin resync http XIVO IP
106. on IEEE Std 802 1X 2004 which defines EAPOL t ersion 2 However there are many client implementations that do not handle he new version number correctly they seem to drop the frames completely In order to make hostapd interoperate with these clients the version number can be set to the older version 1 with this configuration value apol version 2 Optional displayable message sent with EAP Request Identity The first 0 in this string will be converted to ASCII 0 nul This can be used to Separate network info comma separated list of attribute value pairs see e g RFC 4284 ap message hello ap_message hello Onetworkid netw nasid foo portid 0 NAIRealms example com WEP rekeying disabled if key lengths are not set or are set to 0 Key lengths for default broadcast and individual unicast keys 5 40 bit WEP also known as 64 bit WEP with 40 secret bits 13 104 bit WEP also known as 128 bit WEP with 104 secret bits wep_key_len_broadcast 5 wep_key_len_unicast 5 Rekeying period in seconds 0 do not rekey 1 set keys only once wep_rekey_period 300 EAPOL Key index workaround set bit7 for WinXP Supplicant needed only if only broadcast keys are used apol key index workaround 0 EAP reauthentication period in seconds default 3600 seconds 0 disable reauthentication ap reauth period 3600 Use PAE group address 01 80 c2
107. on XiVO A will dial 99101 and the user someone will ring on XiVO B Interconnect a XiVO to a PBX via an ISDN link The goal of this architecture can be one of start a smooth migration between an old telephony system towards IP telephony with XiVO bring new features to the PBX like voicemail conference IVR etc First XiVO is to be integrated transparently between the operator and the PBX Then users or features are to be migrated from the PBX to the XiVO It requires a special call routing configuration both on the XiVO and on the PBX Hardware General uses You must have an ISDN card able to support both the ISDN provider and ISDN links with PBX Note If you have two ISDN provider links to PBX XiVO should have a card with 4 spans two to the provider and two to the PBX 116 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 ISDN PROVIDER Figure 1 47 Interconnect a XiVO to a PBX If you use two cards If you use two cards you have to Use cable for clock synchronization between the cards Configure the wheel to define the cards order in the system The ISDN links used by XiVO to synchronize have to be plugged on the card number one Please refer to the section Sync cable Configuration You have now to configure two files 1 etc dahdi system conf 2 etc asterisk dahdi channels conf system conf Clock configuration Provider side XiVO will get the
108. on to the target XiVO server and run xivo call 1logs To avoid running for too long in one time the call logs generation is limited to the N last unprocessed CEL entries default 20 000 This means that successive calls to xivo call 1logs will process more CELs making about N 10 more calls available in call logs going further back in history while processing new calls as well You can specify the number of CEL entries to consider For example to generate calls using the 100 000 last unprocessed CEL entries xivo call logs c 100000 1 8 5 Conference Room Adding a conference room In this example we ll add a conference room with number 1010 First you need to define a conference room number range for the default context via the Services IPBX IPBX configuration Contexts page Users Incoming calls General Gro ps Queues Conference rooms Number range end 1019 Number range start EET I Figure 1 34 Adding a conference room number range to the default context You can then create a conference room via the Services IPBX IPBX settings Conference rooms page General User Guests Name Number PIN code Context Don t play announce for first participant Recording Max participants Preprocess subroutine Description 1010
109. retrying a call Reachability time out to a member tiie mene 15 25 10s Ringingtime 60s Timeout priority conf jo Timeout priority app 40 10s No Answer Call can be diverted on no answer Destination Redirect to ses Sete ccceuscaspeecesenseccse Choice eR SEES d ms Destination Redirect to Play occupation message _ Do not play introduction message Do not play unavailable message Use n 101 method E amm E do d austro dr Ru GR f i GA n nd a n No answer The call reach the Ringing time in Application tab and no agent has answered the call e Congestion The number of calls waiting have reach the Maximum number of people allowed to wait limit of advanced tab Fail No agent was available to answer the call when call entered the queue join an empty queue condition advanced tab or the call was queued and no agents was available to answer Remove callers if there are no agents advanced tab 1 9 Contact Center 169 XiVO doc Documentation Release 14 08 Diversions Diversions can be used to redirect calls towards another destination when a queue is very busy Calls are redirected using one of the two following scenarios Advanced Schedules Dive
110. running we re enable wdog and re set the mod usr bin bnfos set mode 1 f fosl s usr bin bnfos set modedef 1 f fosl s usr bin bnfos set wdog 1 f fosl s Now kick berofos ten times each 5 seconds for 1 i lt 10 1 7 do usr bin bnfos kick f fosl s bin sleep 5 done else usr bin logger 50 Asterisk is not running fi 4 Add execution rights to script 348 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 chmod x usr local sbin berofos workaround 5 Create a cron to launch the script every minutes etc cron d berofos cron workaround 4 Workaround to berofos integration MAILTO x l x root usr local sbin berofos workaround 1 13 4 Upgrading from XiVO 1 2 3 1 There is an issue with xivo libsccp and pf xivo base config during an upgrade from 1 2 3 dpkg error processing var cache apt archives pf xivo base config 13 3a1 2 4 1 all deb ur trying to overwrite etc asterisk sccp conf which is also in package xivo libsccp 1 2 3 1 Errors wer ncountered while processing var cache apt archives pf xivo base config 13 3a1 2 4 1 all deb E Sub process usr bin dpkg returned an error code 1 2 You have to remove var lib dpkg info xivo libsccp conffiles rm var lib dpkg info xivo libsccp conffiles 3 You have to edit var lib dpkg info xivo libsccp list and remove the following line etc asterisk sccp conf 4 and re
111. stat fill db can be a long operation when used for the first time or after a xivo stat clean db Warning The current events have an end date of the launch date of the script xivo stat as the end date Clearing the cache If for some reason the cache generation fails or the cache becomes unusable the administrator can safely clean the cache using xivo stat clean db and then regenerate it This operation will only clear the cache and does not erase any other data Queue statistics Queue statistics can be viewed in Services Statistics Queue The first table displays a list of queues with all the counters for the period choosen from the Dashboard panel Dissuaded or Overflowed _ Received Answered Abandoned Closed Saturated Blocking Answered rate 005 5 1 1749 1521 84 21 0 0 123 00 00 13 88 0 5 2 1713 1454 73 38 0 0 148 00 00 11 86 0 5 1529 1367 76 23 0 0 63 00 00 10 90 0 5 4 2147 1776 115 17 0 0 239 00 00 16 83 0 STAS 1800 1594 93 28 0 0 85 00 00 13 89 0 By clicking on a queue name you may display detailed queue statistics Statistics can be displayed By week By month By year Counters Received Total number of received calls Answered Calls answered by an agent Abandoned Calls that were hung up while waiting for an answer Dissuaded or Overflowed Closed Calls received when the queue was closed No answer Calls that reached the ri
112. still associated with a user an extesion or a device Any user extension or device attached to the line must be dissociated first Consult the documentation on User Line Association Line Extension Association and Devices for further explanations Query DELETE 1 1 lines_sip lt id gt Errors Error Error message Description code 400 error while deleting Line See error message for more details explanation 400 Error while deleting Line line still Line is still associated to a user extension or device see has a link explanation above 404 Line with line id X does not exist The requested line was not found Example request DELETE 1 1 lines sip 1 HTTP 1 1 Host xivoserver Example response HTTP 1 1 204 No Content User Line Association See User Line Association Line Extension Association See Line Extension Association Line Extension Association 244 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Association Representation Field Value Description Description line id int Line s ID Read only extension id int Extension s ID Get the Extension associated to a Line Query GET lines line id extension Error code Error message Description Errors 404 Line with id lt line_id gt does not exist 404 Line with id line id does not have an extension Example Reque
113. template named device specific file with extension tpl in the var templates directory e for an Aastra phone if you want to customize the file 0008521 template file named 00085D2EECFB cfg tpl ECFB cfg you will have to create a I 5 e for a Snom phone if you want to customize the file 000413470411 xml you will have to create a template file named 000413470411 xml tpl 3 for a Polycom phone if you want to customize the file 0004 2211c8b user cfg you will have to create a template file named 0004 2211c8b user cfg tpl and so on Lr Here we want to customize the content of a device specific file named 00085D21 a template named 00085D2EECFB cfg tpl ECFB cfg we need to create I cp templates 6739i tpl var templates 00085D2bEECFB cfg tpl vi var templates 00085D2EECFB cfg tpl provd pycli c devices using mac 00085D2bEECFB reconfigure Note The choice to use this syntax comes from the fact that provd supports devices that do not have MAC addresses namely softphones Also some devices have more than one file like Snom so this way make it possible to customize more than 1 file The template to use as the base for a device specific template will vary depending on the need Typically the model template will be a good choice but it might not always be the case Changing the Plugin Used by a Device From tim
114. the RADIUS server to a network interface Each station is bound to one interface in the same way as with multiple BSSIDs or SSIDs Each line in this text file is defining a new interface and the line must include VLAN ID and interface name separated by white spac space or tab 324 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 vlan file etc hostapd vlan Interface where 802 1q tagged packets should appear when a RADIUS server is used to determine which VLAN a station is on hostapd creates a bridge for each VLAN Then hostapd adds a VLAN interface associated with the interface indicated by vlan tagged interface and the appropriate wireless interfac to the bridge vlan tagged interface ethO0 RADIUS authentication server configuration 4HHEHESSESSHESTASESAHSAHETAHSAEAAHEHS hostapd can be used as a RADIUS authentication server for other hosts This requires that the integrated EAP server is also enabled and both authentication services are sharing the same configuration File name of the RADIUS clients configuration for the RADIUS server If this commented out RADIUS server is disabled radius server clients etc hostapd radius clients The UDP port number for the RADIUS authentication server radius server auth port 1812 Use IPv6 with RADIUS server IPv4 will also be supported using IPv6 API radius server ipv6 1 WPA IEEE 802 111 configura
115. the status of the master and enable or disable services accordingly 1 10 5 Limitations When the master node is down some features are not available and some behave a bit differently This includes Call history call records are not recorded Voicemail messages saved on the master node are not available Custom voicemail greetings recorded on the master node are not available 1 10 High Availability HA 201 XiVO doc Documentation Release 14 08 Configuration Host address CTI port Main server C Encrypt Connection Backup server C Encrypt Connection Try to reconnect Checking this box disables the Error Popups Tytoreconnectintenal ceepalveintenal a 5 202 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 More generally custom sounds are not available This includes music on hold and recordings Custom dialplan i e dialplan found in the etc asterisk extensions extra d directory or in the Services IPBX configuration Configuration files page is not available Note that on failover and on failback DND call forwards call filtering statuses may be lost if changed recently f you are connected as an agent then you might need to reconnect as an agent when the master goes down Since it s hard to know when the master goes down if your CTI client disconnect and you can t reconnect it then it s a sign the master might be down Ad
116. the timeout before a CTI connection is dropped if the authentication is not completed Parting options are used to isolate XiVO users from each other These options should be used when using the same XiVO for different enterprises 82 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Socket timeout 10 il Login timeout 5 1 Context separation is based on the user s line context A user with no line is not the member of context and will not be able to do anything with the CTI client Note The CTI Server must be restarted to take into account this parameter Contexts Separation Presence Option In the Status menu under Presences you can edit presences group The default presence group is xivo When editing a group you will see a list of presences and there descriptions O gt available Disponible O gt away Sorti oe gt berightback Bient t de retour O gt disconnected D connect 0 3 donotdisturb Ne pas d ranger 3 outtolunch Parti Manger 2G Available configuration Presence name is the name of the presence Display name is the human readable representation of this presence Color status is the color associated to this presence Other reachable statuses is the list of presence that can be switched from this presence state Actions are post selection actions that are triggered by selecting this presence Actions action param Enab
117. to set the line mode as or Contrarily to other cards there is no jumper to change the line mode The configuration below sets the card in E1 mode 106 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 cat EOF etc modprobe d xivo wctel3xp conf set wctel3xp cards in 1 2 mode options wctel3xp default linemode el EOF Then restart dahdi xivo service restart Hardware Echo cancellation It is recommended to use telephony cards with an hardware echo canceller module Warning with TE13X cards you MUST install the echo canceller firmware Otherwise the card won t work properly Hardware Echo cancellation Module If you have an hardware echo canceller module you HAVE TO install its firmware This can be achieved via the xivo fetchfw tool Know which firmware you need The simplest way is to restart dahdi and then to lookup in the dmesg which firmware does DAHDI request at startup dmesg grep firmware 7 781192 wet4xxp 0000 05 0e 0 firmware requesting dahdi fw oct6114 064 bin Otherwise you can also issue with DAHDI gt 2 5 0 the cat proc dahdi 1 command assuming that the span 1 is a PRI port and you should see lines containing something like VPMOCT64 which tells you the echo canceller module you have cat proc dahdi 1 Span 1 TE2 0 1 T2XXP PCI Card 0 Span 1 HDB3 CCS ClockSource 1 TE2 0 1 1 Clear In use EC 064
118. upper right corner Select Import a file 128 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 The file to be imported must be a CSV file with a pipe character as field delimiter The file must be encoded in UTF 8 Mandatory headers are e title possible values mr mrs ms displayname Optional headers are firstname lastname society mobilenumber email url description officenumber faxnumber officeaddress1 officeaddress2 officecity officestate officezipcode officecountry homenumber e homeaddress1 homeaddress2 homecity homestate homezipcode homecountry othernumber e otheraddress1 otheraddress2 othercity otherstate otherzipcode othercountry 9 These fields must contain only numeric characters no space point etc 10 These fields must contain ISO country codes The complete list is described here 1 8 Administration 129 XiVO doc Documentation Release 14 08 Displayed fields It s possible to add more fields to the display in the CTI client The display can be customized in the web interface under Services CTI server Directories Display filter Fields that can be displayed are set in Directories gt Definitions gt xivodir The field name will be used to refer to this field in the directory display The fields in definition can be used with the following syn
119. user name and password you provided For instance the following command line allows to retrieve XiVO users through the REST API using the login admin and the password passadmin curl digest insecure u admin passadmin https xivo address 50051 1 1 users The REST API is also available on the loopback interface via HTTP on port 50050 with no authentication needed HTTP status codes Standard HTTP status codes are used For the full definition see IANA definition 200 Success 201 Created 400 Incorrect syntax 404 Resource not found 406 Not acceptable 412 Precondition failed 415 Unsupported media type 500 Internal server error General URL parameters URL s starts by 1 1 1 1 is the current protocol version Example usage of general parameters GET http 127 0 0 1 50050 1 1 voicemails limit X amp skip Y Parameters order Sort the list using a column e g number See specific resource documentation for columns allowed direction asc or desc Sort list in ascending asc or descending desc order 218 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 limit total number of resources to show in the list Must be a positive integer skip number of resources to skip over before starting the list Must be a positive integer search Search resources Only resources with a field containing the search term will be listed Data representation Data retri
120. xivo etc resolv conf etc wanpipe var lib asterisk var lib xivo var lib xivo provd var log asterisk var spool asterisk The following files folders are excluded from this backup folders var spool asterisk monitor var spool asterisk meetme log files coredump files audio recordings and files greater than 10 MiB or folders containing more than 100 files if they belong to one of these folders var lib xivo sounds var lib asterisk sounds custom 52 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 var lib asterisk moh var spool asterisk voicemail var spool asterisk monitor Database Creating a database backup file manually Warning A backup file may take a lot of space on the disk You should check the free space on the partition before doing it You can manually create a database backup file named do manual tgzin var tmp by issuing the following commands xivo backup db var tmp db manual Creating a data backup file manually Warning A backup file may take a lot of space on the disk You should check the free space on the partition before doing it You can manually create a data backup file named data manual tgzin var tmp by issuing the following commands xivo backup data var tmp data manual 1 6 7 Restore Introduction A backup of both the configuration files and the database use
121. xivo snom 9 4 35 u xivo snom 8 75 3 25 u xivo aastra switchboard xivo aastra 95 2 2 9P23 u xivo aastra 3 2 2 1136 u xivo c4sco sccpe9 0 3 unall u xivo snom 8 7 3 25 5 provpy gt p plugins xivo snom 8 7 3 25 5 provpy gt p install all Uploading to stable Once checked you must synchronize the plugin from testing to stable If applicable you should also update the archive repo To download the stable and archive plugins make download stable make download archive Go to the plugins build directory and delete the plugins that are going to be updated Note that if you are not updating a plugin but you are instead removing it once and for all you should instead move it to the archive directory rm fi stable xivo cisco spax Copy the files from the directory testing to stable 5 cp testing xivo cisco spa stable Go back to the plugins directory and upload the files to the stable and archive repo make upload stable make upload archive The file are now up to date and you can test by putting back the stable url in the web interface s configuration http provd xivo fr plugins 1 stable Testing a new SIP phone Let s suppose you have received a brand new SIP phone that is not supported by the provisioning system of XiVO You would like to know if it s possible to add auto provisioning support for it That said you have never tested the phone before This guide will help you ge
122. 00 00 03 instead of individual target address when sending EAPOL frames with driver wired This is the most common mechanism used in wired authentication but it also requires that the port is only used by one station 1 12 Developers 321 XiVO doc Documentation Release 14 08 use pae group addr 1 Integrated EAP server Optionally hostapd be configured to use an integrated EAP server to process EAP authentication locally without need for an external RADIUS Server This functionality can be used both as a local authentication server for IEEE 802 1X EAPOL and as a RADIUS server for other devices Use integrated EAP server instead of external RADIUS authentication Server This is also needed if hostapd is configured to act as a RADIUS authentication server eap server 0 Path for EAP server user database ap user file etc hostapd eap user CA certificate PEM or DER file for EAP TLS PEAP TTLS ca cert etc hostapd ca pem Server certificate PEM or DER file for EAP TLS PEAP TTLS server cert etc hostapd server pem Private key matching with the server certificate for EAP TLS PEAP TTLS This may point to the same file as server cert if both certificate and key are included a single file PKC
123. 1000 answers External user 555 555 5555 calls 445 1001 answers and talks to 1001 1000 initiate an attended transfer to 1001 210 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 5 1000 completes the transfer 6 1001 hangs up after a few seconds id eventtype eventtime userdeftype cid name cid num ead t 4 4 8768 2012 03 28 14 52 41 916113 5595555555 5555555555 55555 8769 CHAN END 2012 03 28 14 52 41 916516 5555555555 5555555555 55555 8770 CHAN STAR 2012 03 28 14 52 56 055872 5555555555 5555555555 8771 APP START 2012 03 28 14 52 56 130032 2555555555 5555555555 55555 8772 CHAN STAR 2012 03 28 14 52 56 130213 Tux 1000 8773 ANSWER 2012 03 28 14 52 57 701373 Tux 1000 1000 8774 ANSWER 2012 03 28 14 52 57 701866 5555555555 5555555555 55555 8775 BRIDGE START 2012 03 28 14 52 57 701925 5555555555 5555555555 55555 8776 CHAN STAR 2012 03 28 14 53 04 604461 Tux 1000 8771 APP START 2012 03 28 14 53 04 665818 Tux 1000 1000 8778 CHAN STAR 2012 03 28 14 53 04 665996 P re No l 1001 8779 ANSWER 2012 03 28 14 53 06 314275 P re No l 1001 1001 8780 ANSWER 2012 03 28 14 53 06 314717 Tux 1000 1000 8781 BRIDGE START 2012 03 28 14 53 06 314762 Tux 1000 1000 8782 HANGUP 2012 03 28 14 53 12 226404 Tux 1000 1000 8783 CHAN END 2012 03 28 14 53 12 2264
124. 11 Local tim zone specified 8 3 of I Std 1003 1 2004 dst offset start time end stdoffset EST5 time zone time I 802 11u 2011 Enable Interworking service interworking 1 Access Network Type 0 Private network 1 Private network with guest access 2 Chargeable public network 3 Free public network 4 Personal device network 5 Emergency services only network 14 Test or experimental 15 Wildcard access_network_type 0 Whether the network provides connectivity 0 Unspecified 1 internet 1 Additional Step Required for Access Emergency services reachabl esr 0 Unauthenticated emergency servic Note This is only used with open network RSN is used asra 0 HE EEE HE EE EE EE AE FE FE E EE EEE to the Internet Network provides connectivity to the Internet i e ASRA shall ne set to 0 if accessibl uesa 0 Venue Info optional The available values are defined in IEEE Example values group type 0 0 Unspecified 1 7 Convention Center 1 13 Coffee Shop 2 0 Unspecified Business 7 1 Private Residence venue group 7 venue type 1 Homogeneous ESS identifier If set optional
125. 11RSNAConfigGroupRekeyStrict wpa_strict_rekey 1 Time interval for rekeying master key used internally to generate GTKs in seconds wpa_gmk_rekey 86400 aximum lifetime for PTK in seconds PTK to mitigate some attacks against wpa_ptk_rekey 600 This can be used to enforce rekeying of TKIP deficiencies Enable IEEE 802 11i RSN WPA2 pre authentication This is used to speed up roaming be pre authenticating IEEE 802 1X EAP part of the full RSN authentication and key handshake before actually associating with a new AP dot11RSNAPreauthenticationEnabled rsn_preauth 1 Space separated list of interfaces from which pre authentication frames are accepted e g eth0 or ethO wlanOwdsO This list should include all interface that are used for connections to other APs This could include wired interfaces and WDS links The normal wireless data interface towards associated stations e g wlan0 should not be added since pre authentication is only used with APs other than the currently associated one rsn preauth interfaces eth0 peerkey Whether PeerKey negotiation for direct links IE allowed This is only used with RSN WPA2 0 disabled default 1 enabled peerkey 1 802 11 ieee80211w Whether management frame protection is enabled 0 disabled default 1 optional 2 required ieee80211w 0 Association SA Qu
126. 13 44 01 720574 Tux 1000 1000 8537 CHAN END 2012 03 28 13 44 01 720985 Tux 1000 1000 11 rows 1 1000 calls 1001 2 1001 ignores the call id eventtype eventtime userdeftype cid name cid num cid ani al al al 4 m 8578 CHAN STAR 2012 03 28 14 02 11 862776 Tux 1000 8579 APP START 2012 03 28 14 02 11 924236 Tux 1000 1000 8580 CHAN STAR 2012 03 28 14 02 11 924434 P re No l 1001 8581 HANGUP 2012 03 28 14 02 21 05216 P re No l 1001 1001 8582 CHAN END 2012 03 28 14 02 21 052217 1 1001 1001 8583 ANSWER 2012 03 28 14 02 21 0547 Tux 1000 1000 8584 HANGUP 2012 03 28 14 02 27 164036 Tux 1000 1000 8585 CHAN END 2012 03 28 14 02 27 164529 Tux 1000 1000 8 rows Internal Call Using Originate 1 1000 calls 1001 from his XiVO client 2 1001 answers 3 1001 hangs up after a few seconds id eventtype eventtime userdeftype cid name cid num cid ani aj 4 E 4 al 8538 CHAN STAR 2012 03 28 13 46 29 539804 Tux 1000 8539 ANSWER 2012 03 28 13 46 31 570207 1001 1001 1001 8540 APP START 2012 03 28 13 46 31 633132 Tux 1000 1001 8541 CHAN STAR 2012 03 28 13 46 31 633316 P re No l 1001 8542 ANSWER 2012 03 28 13 46 33 356198 P re No l 1001 1001 8543 BRIDGE START 2012 03 28 13 46 33 356388 Tux 1000 1001 8544 BRIDGE END 2012 03 28 13 46 39 145872 Tux 1000 1001 8545 HANGUP 2012 03 28 13 46 39 146556 P re No l 1001 1001 8546 CHAN END 2012 03 28 13 46 39 146633 P re No l 1001 1001 8547 HANGUP 2012 03 28 13 46 39 14673 Tux 1000 1001 8548 C
127. 2 20 02 29 01 00 05 45 Tuesday 2 22 02 17 11 07 31 53 03 36 46 00 05 30 Wednesday 3 19 01 40 33 07 27 13 02 34 03 00 04 45 Thursday 4 22 02 26 24 07 57 25 02 13 23 00 05 30 Friday 5 0 00 00 00 00 00 00 00 00 00 00 00 00 Total 87 09 59 57 30 58 51 10 53 16 00 21 30 Agent per month Agent per year Period details Display by period defined in configuration i e between 0 and 10s 10s and 30s etc and the number of abandonned calls You may click on a queue name to get more information for this queue the number of handled calls 190 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Monday 0 00 00 00 Tuesday 0 00 00 00 Wednesday 0 00 00 00 Thursday 0 00 00 00 Friday 0 00 00 00 24 week Monday 0 00 00 00 Tuesday 0 00 00 00 Wednesday 0 00 00 00 Thursday 0 00 00 00 135 25 15 01 20 19 08 17 50 03 02 58 Tuesday 3 00 13 52 08 22 51 07 06 44 Wednesday si 00 20 02 08 28 03 06 12 39 Thursday 0 00 Friday 1 00 09 22 05 27 33 00 00 15 26 week Monday 10 00 36 41 08 23 33 00 02 30 Tuesday 11 01 08 46 08 30 00 00 02 45 Wednesday 3 00 07 48 08 29 34 00 00 45 Thursday 5 00 40 10 04 00 58 07 26 52 00 01 15 Friday 9 01 12 33 08 19 18 04 27 04 00 02 15 Total 70 07 13 31 150 38 3 64 37 24 00 14 50 3 Pause Wrapup January 00 00 00 00 00 00 February 00 00 00 00 00 00
128. 2233445566778899aabbccddeeff And so on One line per 1 1 12 Developers 327 XiVO doc Documentation Release 14 08 Whether PMK R1 push is enabled at ROKH 0 do not push PMK R1 to all configured R1KHs default push PMK R1 to all configured R1KHs whenever a new PMK RO is derived pmk rl push 1 Neighbor table Maximum number of entries kept in AP table either for neigbor table or for detecting Overlapping Legacy BSS Condition The oldest entry will be removed when adding a new entry that would make the list grow over this limit Note WFA certification for IEEE 802 11g requires that OLBC is enabled so this field should not be set to 0 when using IEEE 802 11g default 255 ap table max size 255 I Number of seconds of no frames received after which entries be deleted from the AP table Since passive scanning is not usually performed frequently this should not be set to very small value In addition there is no guarantee that every scan cycle will receive beacon frames from the neighboring APs default 60 ap table expiration time 3600 Wi Fi Protected Setup WPS WPS state 0 WPS disabled default 1 WPS
129. 25 829818 5555555555 5555555555 8939 HANGUP 2012 03 29 08 41 25 830079 No l 1001 8940 CHAN END 2012 03 29 08 41 25 830118 P re No l 1001 8941 HANGUP 2012 03 29 08 41 25 830213 0055555555 5555555555 8942 CHAN END 2012 03 29 08 41 25 83061 5555555555 5555555555 32 rows Userfield with CEL The CEL table has a field named userfield which is used on outgoing calls when the caller has a userfield set in his configuration The userfield can be enriched from the dialplan with context information To set the value of the field from the dialplan you have to you the asterisk function CHANNEL userfield for example Set CHANNEL userfield MY_DIALPLAN_VAR Note for those who used the same userfield information in the CDR by calling the function CDR userfield you have to replace it with the function CHANNEL userfield 1 11 2 Message Bus The message bus is used to receive events from XiVO It is provided by an AMQP 0 9 1 broker namely Rab bitMQ that is integrated XiVO Warning Interaction with the bus is presently experimental and some things might change in the next XiVO versions Usage At the moment the AMQP broker only listen on the 127 0 0 1 address This means that if you want to connect to the AMQP broker from a distant machine you must modify the RabbitMQ server configuration which is not yet an officially supported operation Otherwise the default connection information is 214 Cha
130. 26 203237 5555555555 5555555555 5555555 8 rows Blind Transfer 1 External user 555 555 5555 calls 445 2 1000 answers 1 11 and SDK 209 XiVO doc Documentation Release 14 08 3 1000 blind transfer to 1001 4 1001 answers 5 1001 hangs up after a few seconds id eventtype eventtime userdeftype cid name cid num cid_ 8689 CHAN_STAR 2012 03 28 14 21 05 928445 5555555555 5555555555 8690 APP START 2012 03 28 14 21 06 016235 5555555555 5555555555 55555 8691 CHAN STAR 2012 03 28 14 21 06 016426 Tux 1000 8692 ANSWER 2012 03 28 14 21 07 600329 Tux 1000 1000 8693 ANSWER 2012 03 28 14 21 07 600741 5555555555 5555555555 55555 8694 BRIDGE START 2012 03 28 14 21 07 6008 59559555959 5555555555 55555 8695 BRIDGE END 2012 03 28 14 21 13 11719 5555555555 5555555555 55555 8696 HANGUP 2012 03 28 14 21 13 117526 Tux 1000 1000 8697 CHAN END 2012 03 28 14 21 13 117574 Tux 1000 1000 8698 APP START 2012 03 28 14 21 13 199251 5555555555 5555555555 55555 8699 CHAN START 2012 03 28 14 21 13 199432 P re 1 1001 8700 ANSWER 2012 03 28 14 21 16 573668 P re No l 1001 1001 8701 BRIDGE START 2012 03 28 14 21 16 573876 5955555555 5555555555 55555 8702 BRIDGE END 2012 03 28 14 21 23 120075 5555555555 5555555555 55555 8703 HANGUP 2012 03 28 14 21 23 120393 P re No l 1001 1001 8704 CHA
131. 3 Try to reconnect will reconnect the client when the connection is dropped Try to reconnect interval is the reconnection delay before the auto reconnection is tryed Keep alive interval is the number of seconds between keepalives messages 1 5 5 Handling callto and tel URLs The XiVO client can handle telephone number links that appear in web pages The client will automatically dial the number when you click on a link 1 5 CTI Client 39 XiVO doc Documentation Release 14 08 Note You must already be logged in for automatic dialing to work otherwise the client will simply start up and wait for you to log in Warning The option in the XiVO Client GUI Options Allow multiple instances of XiVO Client must be disabled else you will launch one new XiVO Client with every click Mac OS callto and tel links will work out of the box in Safari and other web browsers after installing the client Windows The following popups might appear When you open a callto ortel link for the first time in Internet Explorer Internet Explorer 24 Do you want to allow this website to open a program on your computer Program xivoclient exe Address callto 1602 Always ask before opening this type of address Aow Cae potentially harm your computer Do not allow it unless you trust e Allowing web content to open a program can be useful but it can 4 the source of the content V hat s th
132. 45 Tux 1000 1000 8784 HANGUP 2012 03 28 14 53 12 22654 Tux 1000 1000 8785 CHAN END 2012 03 28 14 53 12 226566 Tux 1000 1000 8786 BRIDGE END 2012 03 28 14 53 18 145645 5555555555 5555555555 55555 8787 HANGUP 2012 03 28 14 53 18 146582 P re No l 1001 1001 8788 CHAN END 2012 03 28 14 53 18 14666 P re No l 1001 1001 8789 HANGUP 2012 03 28 14 53 18 146789 5555555555 5555555555 55555 8790 CHAN END 2012 03 28 14 53 18 147343 5555555555 5555555555 55555 23 rows Voice Mail 1 External user 555 555 55555 calls 445 2 1000 ignores the call 3 External user leaves a message 4 External user hangs up id eventtype eventtime userdeftype cid name cid num cid an 8814 CHAN_STAR 2012 03 28 15 18 11 270723 5555555555 5555555555 8815 APP START 2012 03 28 15 18 11 347544 5555555555 5555555555 5555555 8816 CHAN STAR 2012 03 28 15 18 11 347707 Tux 1000 8817 HANGUP 2012 03 28 15 18 11 644857 Tux 1000 1000 8818 CHAN END 2012 03 28 15 18 11 645103 Tux 1000 1000 8819 HANGUP 2012 03 28 15 18 11 645858 5555555555 5555555555 5555555 8820 CHAN END 2012 03 28 15 18 11 645891 5555555555 5555555555 5555555 7 rows 1 1000 consults his voicemail 2 1000 presses 1 to hear his message 3 1000 presses 7 to delete his message 4 1000 hangs up id eventtype eventtime userdeftype cid name cid num cid ani ci t 8821 CHAN_START 2012 03 28 15 24 27 929536 Tux 1000 8822 ANSWER 2012 03 28 15 24 27 946719 Tux 1000 1000 8823 H
133. 5 kb lou xivo cisco pap2t 5 1 6 Greffon pour Cisco PAP2T en version 5 1 6 Edit this plugin 0 10 92 kb 7 xivo cisco sccp 9 0 3 Greffon pour Cisco 7911G 7941G 7941G GE and 7961G en version 9 0 2 0 3 8 6 9 kb i299 xivo cisco sccp legacy Greffon pour Cisco 7912G 7940G et 7960G en version 8 1 2 du logi 0 2 0 3 amp 7 05 E xivo cisco spa 7 4 8 Greffon pour Cisco SMB SPA301 303 501G 502G 504G 508G 509 0 3 11 99 kb lod xivo cisco spa legacy Greffon pour Cisco auparavant connu comme Linksys SPA901 921 0 3 12 02 kb 7 Xivo cisco spa2102 5 2 12 Greffon pour Cisco SPA2102 en version 5 2 12 Uninstall this pl ug in 10 89 kb oJ Xivo cisco spa3102 5 1 10 pour Cisco SPA3102 en version 5 1 10 I Wer T xivo cisco spa8000 6 1 3 Greffon pour Cisco SPA8000 en version 6 1 3 03 10 91kb oJ Xivo cisco spaB800 6 1 7 Greffon pour Cisco SPABBOO en version 6 1 7 0 3 10 9 kb 7 xivo digium 1 1 0 0 Greffon pour Digium D40 D50 et D70 en version 1 1 0 0 0 3 4 09 kb S xivo gigaset C470 Greffon pour Gigaset aussi connu comme Siemens C470 IP C475 IP 0 10 4 79 kb 7 xivo gigaset C590 Greffon pour Gigaset aussi connu comme Siemens C590 IP C595 0 10 5 2kb lod xivo jitsi 1 Greffon pour Jitsi en version 1 0 0 1 1 3 04 kb 7 Figure 1 55 Configuration Provisioning Plugin Warning If you uninstall a plugin that is used by some of your devices they will be left in an unconfigured state and
134. 6 0314 Gnu Linux 1006 GreatLord MacDonnell 1043 10 G Enter Number x e 1 8 Administration 157 XiVO doc Documentation Release 14 08 7 Hangup button 8 Incoming Calls list 9 Waiting Calls list 10 Directory Xlet 11 Dial Xlet Note If you don t see the Switchboard Xlet right click on the grey bar at the right of the Help menu and check Switchboard XivO Client Availability Help Dial Directory The operator can login his agent using a function key or an extension to start receiving calls Call flow Answering an incoming call When the switchboard receives a call the new call is added to the Incoming Calls list on the left and the phone starts ringing The user can answer this call by clicking on any call in the list clicking the Answer button pressing the Enter key Note The XiVO Client must be the active window for the keyboard shortcuts to be handled The operator can select which call to answer by clicking directly on the incoming call e pressing to select the incoming calls frame and pressing the up and down arrow keys Selecting a call to answer while talking will not answer the call Once the call has been answered it is removed from the incoming calls list and displayed in the Current Call frame Making a Call The switchboard operator can do the following operations Press the Call button or press F3 Search for the call de
135. 7 0 0 1 service ipbx json php private pbx settings users agentid null bstilter no callerid User 2 callrecord false commented false description t destbusy destrnma s m Tt enableautomon false enablebusy false enableclient true enablednd false enablehint true enablerna false enableunc false enablevoicemail false enablexfer false entityid 1 firstname User fullname User 2 2 identity User 2 incallfilter false Alternatively you can pass a file path as an argument curl s https localhost service ipbx json php private ctiserver configuration cticonf ppcticonf cticonf agentstatus 306 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 bench 0 078904151916504003 Certfile var lib xivo certificates test2 crt channelstatus contexts 1 uU didextens xiyvodirt Fy default directories xavoeduir internal 1 display Display 1 12 9 Database Adding a Migration Script Strating with XiVO 14 08 the database migration is handled by alembic The XiVO migration scripts can be found in the xivo manage db repository On XiVO they are located in the usr share xivo manage db directory To add a new migration script from your developer machine go into the root direct
136. 8 simple skill english exten S 1 Set XIVO QUEUESKILLRULESET english rule set same n Return simple skill french exten s 1 Set XIVO QUEUESKILLRULESET french rule set same n Return In this example you just need to create two simple skill rule sets one named english rule set with a rule english gt 90 and the other named french rule set Monitoring You may monitor your waiting calls with skills using the asterisk CLI and the command queue show queue name xivo jylebleu CLI queue show services Services has 1 calls max unlimited in ringall strategy 0s holdtime 2s talktime W 0 C 1 Members Agent 2000 Not in use skills agent 1 has taken no calls yet Agent 2001 Unavailable skills agent 4 has taken no calls yet Virtual queue english Virtual queue french 1 SIP jyl dev assur 00000017 wait 0 05 prio 0 Callers You may monitor your skills groups with the command queue show skills groups agent name xivo jylebleu CLI queue show skills groups PRESS TAB agent 2 agent 3 agent 4 agent 48 agent 7 agent 1 xivo jylebleu CLI gt queue show skills groups agent 1 Skill group agent 1 bank 50 english 100 You may monitor your skills rules with the command queue show skills rules rule name xivo jylebleu CLI queue show skills rules PRESS TAB english french select lang xivo jylebleu CLI queue show skills rule
137. 8 Adjusting Options of the DHCP server Once you have created the subnet in the DHCP server you must edit each configuration file the files in etc dhcp dhcpd sites and modify the different parameters In section subnet write the IP subnet and change the following options underlined fields in the example subnet 172 30 8 0 netmask 255 255 255 0 subnet mask option subnet mask 255 255 255 0 broadcast address option broadcast address 172 30 8 255 routers specify the IP address of the router that will be the default gateway of the site option routers 172 30 8 1 In section pool modify the options pool log add the name of the site or of the subnet log concat binary to ascii 16 8 hardware POOL VoIP Site XXX range it will define the range of IP address the DHCP server can use to address the devices of that subnet range 172 30 8 10 172 30 8 200 Warning XiVO only answers to DHCP requests from supported devices In case of you need to address other equipment use the option allow unknown clients in the etc dhcp dhcpd_sites files At this point you can apply the changes of the DHCP server with the command etc init d isc dhcp server restart After that XiVO will start to serve the DHCP requests of the devices located on other site or other subnet than the VOIP subnet You will see var 10g daemon log all the DHCP requests receided and how they are
138. 8 millions CELs xivo upgrade will thus be slightly longer Two new daemons are now operationnal xivo amid and xivo call logd 1 4 Upgrading 19 XiVO doc Documentation Release 14 08 xivo amid constantly reads the AMI and sends AMI events to the RabbitMQ bus xivo call logd generates call logs in real time based on AMI LINKEDID END events read on the bus An increase in load average is expected with the addition of these two new daemons The cron job calling xivo call logs now runs once a day at 4 25 instead of every 5 minutes 14 02 Consult the 14 02 Roadmap PHP Web services has been removed from documentation REST API 1 0 Web services has been removed from documentation REST API 1 1 User Line Extension service is replaced by User Line and Line Extension services 14 01 Consult the 14 01 Roadmap The following paths have been renamed etc pf xivo to etc xivo var lib pf xivoto var lib xivo usr share pf xivoto usr share xivo You must update any dialplan or configuration file using these paths Archives Archived Upgrade Notes 2013 13 25 Consult the 13 25 Roadmap Debian has been upgraded from version 6 Squeeze to 7 Wheezy which is essentially a complete system upgrade Please consult the following detailed upgrade notes for more information Debian GNU Linux Wheezy Upgrade Notes Before the upgrade The upgrade will take longer than usual because the whole Debia
139. 8667 CONF FILE where ATA IP is the IP address of the ATA XIVO IP is the IP address of your XiVO CONF FILE is one of spa3102 cfg spa8000 cfg Warning Access to CISCO firmware updates requires a CISCO account with sufficient privileges The account requires paying for the service and remains under the responsibility of the client or partner Avencall is not responsible for these firmwares and does not offer any updates Cisco 7900 series SCCP mode only 7905G 7906G 7911G 7912G 7920 7921G 7940G 7941 Provisioning N4 N N Y Y Y Y Y H A N Y Y Y NT NT Y Y Directory XIVO N N N FK N N FK FK Funckeys 2 N 4 4 4 0 0 1 1 Supported programmable keys User with supervision function NT N N N N N Y Y Group NT N N Y N N Y Y Queue NT N N Y N N Y Y Conference Room with supervision function NT N N N N N Y Y General Functions Online call recording NT N N N N N N N Phone status NT N N Y N N Y Y Sound recording NT N N Y N N Y Y Call recording NT N N N N N Y Y Incoming call filtering NT N N N N N Y Y Do not disturb NT N N SK N N SK SK Group interception NT N N N N N N N Listen to online calls NT N N Y N N Y Y Directory access NT N N Y N N Y Y Filtering Boss Secretary NT N N N N N Y Y Transfers Functions Blind transfer NT N N N N N N N Indirect transfer NT N N SK N N SK SK Forwards Functions 1 7 Ecosystem 61 XiVO doc Documentation Release 14 08 Table 1 2 c
140. ANGUP 2012 03 28 15 25 09 215869 Tux 1000 1000 1 11 and SDK 211 XiVO doc Documentation Release 14 08 8824 CHAN END 2012 03 28 15 25 09 215914 Tux 1000 1000 4 rows Call Forward 1 1000 enable unconditional call forwarding to 1001 using 27 001 id eventtype eventtime userdeftype cid name cid num cid ani ci 8825 CHAN_START 2012 03 29 07 48 37 660366 Tux 1000 8826 ANSWER 2012 03 29 07 48 37 662976 Tux 1000 1000 8827 HANGUP 2012 03 29 07 48 41 12148 Tux 1000 1000 8828 CHAN END 2012 03 29 07 48 41 121864 Tux 1000 1000 4 rows External user calls 445 2 The call is forwarded to 1001 3 1001 answers 4 External user hangs up after a few seconds id eventtype eventtime userdeftype cid name cid num C fe al am M S 8829 CHAN START 2012 03 29 07 57 05 918708 5555555555 5555555555 8830 XIVO USER FWD 2012 03 29 07 57 05 982490 XIVO USER FWD 5555555555 5555555555 55 8831 ANSWER 2012 03 29 07 57 05 982497 5555555555 5555555555 55 8832 APP START 2012 03 29 07 57 10 269364 5555555555 5555555555 55 8833 CHAN_START 2012 03 29 07 57 10 26958 P re No l 1001 8834 ANSWER 2012 03 29 07 57 13 744093 P re No l 1001 10 8835 BRIDGE_START 2012 03 29 07 57 13 744248 5555555555 5555555555 55 8836 BRIDGE END 2012 03 29 07 57
141. Agent 2003 switchboar Agent 2003 blue Agent 108 blue Agent 2002 blue timenow 1382717016 23 class getluist Status messages These messages can also be received without any request as unsolicited messages User status User status is to manage user presence Request user status update Client Server class getlist commandid 107712156 function updatestatus listname users Eig AU xryoW Server Client class getlist function updatestatus listname users status availstate outtolunch connection yes Erg I1 timenow 1364994093 48 tipbxid Change User status Client Server availstate away class availstate commandid 1946092392 3pbxid ziyo userig s TIT Server Client 1 12 Developers 295 XiVO doc Documentation Release 14 08 class getlist function updatestatus listname users status availstate away tig 1 timenow 1370523352 9 Phone status tid is the line id found in linelist from message user Client gt Server class getlist commandid 107712156 function updatestatus listname phones tid 8 tipbxid Server Client xivo class getlist function updatestatus listname phones status channels groups hintstatus 0 queues Lid
142. April 4 0 0 0 0 0 0 n July 569 11 3 4 5 August 0 0 0 0 0 September 0 0 0 0 0 0 0 aT E E E December 0 0 0 0 0 0 0 0 0 Total 2028 25 140 153 257 a 15 24 33 Total calls handled Total abandoned calls 2 iN P2 BH P3 mP3 m P4 p4 5 ps Field Values Description id gener ated cal nu This call id is also used in the CEL table and can be used to get call detail information lid meric value time Call time ring Ringing duration time in seconds time talk Talk time duration in seconds time wait Wait time duration in seconds time sta See status description below tus queue id Id of the queue the name of the queue be found in table stat queue using this name queue details can be found in table queuefeatures agent jd Id of the agent the agent name can be found in table stat agent using this name agent details can be found in table agent features using the number in the second part of the name Exemple Agent 1002 is agent with number 1002 in table agent features 1 9 Contact Center 195 XiVO doc Documentation Release 14 08 configuration stat cal Lon queue 4 queue log Asterisk database stat queue periodic xivo stat Figure 1 84 Statistics Architecture 196 Chapter 1 Table of Co
143. Caller ID Customize Bob lt 5555551234 Subroutine preprocess User field 7 71 XiVO Client i 124 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 System Device CPU e Network Memory Other Services System CPU Name 00 git Percent User System Wait Operating system T Linux BENE 3 66 30 54 10 9 90 2 30 Kernel version 3 2 0 4 686 pae IP address 10 33 255 1 DNS address 10 33 2551 Interface Received Transmitted z Error Drop Uptime day s 05 44 09 lo 222 30 Mib 222 30 Mib 0 0 Load average 0 65 0 73 0 51 cun RES Pi RSS un etho 40 63 MiB 61 63 MiB 0 0 Device _ Partition Percent Free Used Total data system MENT 3 61 70 0 37921 6138 0 data var 1 55 50 0 1683 5 2854 0 d r Memory Free Used Buffers Cached Total Physical memory 59 54 5 9 70 MiB 218 25 31 25 KiB 138 56 MiB 366 54 MiB Swap partition 1 8 80 872 83 MiB 84 20 MiB 957 03 MiB Other services Process Status Uptime Action asterisk Running 1 day s 02 41 40 0 20 KEEN 3 85 14 10 MiB eo data sy
144. Client implies working with phone numbers But how to interpret them easily when we are not sure of the format they re in You can use the PhoneNumber namespace baselib src phonenumber h to do that it contains routines for recog nition extraction of phone numbers that way you don t have to parse manually These subroutines are pretty basic for the moment if you need want to improve them feel free to do it Retrieving CTI server infos Informations are synchronized from the server to the BaseEngine when the client connects It is stored BaseEngine in lists It is stored in a format close to the one used to transmit it so you see the CTI protocol definition for further documentation Each list contains objects of different type These types are channel user phone trunk agent queue group meetme voicemail queuemember parking Each type corresponds to a class derived from XInfo e g channel infos are stored in ChannelInfo objects The basic attributes of all objects are 3 strings the IPBX ID the XiVO object ID and the extended ID of the object which is the two previous attributes linked with a 1 12 Developers 339 XiVO doc Documentation Release 14 08 Listen to IPBX events If you want your XLet to receive IPBX CTI events you can do so by inheriting the IPBXListener interface You must specify which type of events you want to listen This depends of the implemented functio
145. Conf rences 20 39 47 Nom Prenom Sexe Masculin 2 The Qt Designer screenshot Warning In Qt Designer one must set vertical layout on the top widget right click on the top widget gt Lay out gt Vertical layout You can download the file generated by this example from Qt Designer example form ui Text fields QLineEdit QLabel QPlainTextEdit can contain variables that will be substituted See the variable list for more information List of fields Default XiVO sheet example Example showing all kinds of fields Each field is represented by the following parameters Field title name of your line used as label on the sheet Field type define the type of field displayed on the sheet Supported field types title to create a title on your sheet text show a text url simple url link open your default browser urlx an url button picture show a picture from an internal user in your sheet you need to use variable phone create a tel link you can click to call on your sheet 1 8 Administration 87 XiVO doc Documentation Release 14 08 Boite de widget Filtre List View 4 8 Tree View ta Table View G Column view Inspecteur d objet 8 Objet Classe v B widget v sans nom amp QGr 0 List Widget 4 8 Tree widget E
146. ER 2012 03 29 09 50 06 680481 dial 54052 ANSWER 2012 03 29 09 50 06 680634 5555556666 5555556666 54053 BRIDGE START 2012 03 29 09 50 06 680678 5555556666 5555556666 54054 BRIDGE END 2012 03 29 09 50 13 90645 5555556666 5555556666 54055 HANGUP 2012 03 29 09 50 13 906764 dial 54056 CHAN END 2012 03 29 09 50 13 906803 dial 54057 HANGUP 2012 03 29 09 50 13 906855 5555556666 5555556666 54058 CHAN END 2012 03 29 09 50 13 907034 5555556666 5555556666 11 rows Internal Call 1 1000 calls 1001 2 1001 answers 3 1001 hangs up after a few seconds 1 11 and SDK 207 XiVO doc Documentation Release 14 08 id eventtype eventtime userdeftype cid name cid num cid ani A 4 4 4 pone al 8527 CHAN_STAR 2012 03 28 13 43 55 379674 Tux 1000 8528 APP START 2012 03 28 13 43 55 435472 Tux 1000 1000 8529 CHAN STAR 2012 03 28 13 43 55 435726 P re No l 1001 8530 ANSWER 2012 03 28 13 43 56 672155 P re No l 1001 1001 8531 ANSWER 2012 03 28 13 43 56 672554 Tux 1000 1000 8532 BRIDGE START 2012 03 28 13 43 56 6726 Tux 1000 1000 8533 BRIDGE END 2012 03 28 13 44 01 719856 Tux 1000 1000 8534 HANGUP 2012 03 28 13 44 01 720438 No l 1001 1001 8535 END 2012 03 28 13 44 01 720481 P re No l 1001 1001 8536 2012 03 28
147. F bursting tx queue queue name param queues data0 datal data2 data3 after beacon beacon 1 12 Developers 317 XiVO doc Documentation Release 14 08 data0 is the highest priority queue parameters aifs AIFS default 2 cwmin cwMin 1 3 7 15 31 63 127 255 511 1023 cwmax cwMax 1 3 7 15 31 63 127 255 511 1023 cwMax gt cwMin burst maximum length in milliseconds with precision of up to 0 1 ms for bursting Default WMM parameters IEEE 802 11 draft 11 03 0504 03 000e These parameters are used by the access point when transmitting frames to the clients Low priority AC BK background tx queue data3 aifs 7 tx queue data3 cwmin 15 tx queue data3 cwmax 1023 tx queue data3 burst 0 Note for IEEE 802 11b mode cWmin 31 cWmax 1023 burst 0 Normal priority AC BE best effort tx queue data2 aifs 3 tx queue data2 cwmin 15 tx queue data2 cwmax 63 tx queue data2 burst 0 Note for IEEE 802 11b mode cWmin 31 cWmax 127 burst 0 High priority AC VI video tx queue datal aifs 1 tx queue datal cwmin 7 tx queue datal cwmax 15 tx queue datal burst 3 0 Note for IEEE 802 11b mode cWmin 15 cWmax 31 burst 6 0 Highest priority AC VO voice tx queue 0 aifs 1 tx queue data0 cwmin 3 tx queue data0 cwmax 7 tx queue 0 burst 1 5 Note for IEEE 802 11b mode cWmin 7 cWmax 15 burst 3 3
148. General Configuration You can configure general settings for your voicemail service in Services IPBX General Settings Voice mails page Adding voicemail There are 2 ways to add a voicemail First is with Services IPBX IPBX settings Voicemails page 2nd is editing user s configuration 1 Via Services IPBX IPBX settings Voicemails In here you can add some voicemails and configure them by clicking on the plus button IPBX General setings i CE O No voicemail found Figure 1 70 Add voicemail from voicemails menu Once your voicemails are configured you have to edit the users configuration to search the voicemails previously created and then associate them to your users T General settings 7771 General Lines No answer Services Voicemail Groups Func Keys Protocol Protocol Voicemails Voice Asterisk Phonebook Advanced Groups Voicemails Conference rooms Incoming calls Enable voicemail Option Search Y Search fiter Use L Password E mail Outgoing calls Time zone M N Call permissions Disable password checking Call filters lin file Callpickups SS Attach the audio file Schedules Delete message after notification Calls Logs Trunk management SIP Protocol Save Protocol
149. HAN END 2012 03 28 13 46 39 147224 Tux 1000 1001 11 rows 1 1000 calls 1001 from his XiVO client 2 1001 ignores the call id eventtype eventtime userdeftype cid name cid num cid ani t t t t t 8594 CHAN START 2012 03 28 14 06 36 616875 Tux 1000 8595 ANSWER 2012 03 28 14 06 41 370874 1001 1001 1001 8596 APP START 2012 03 28 14 06 41 431579 Tux 1000 1001 208 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 8597 CHAN START 2012 03 28 14 06 41 431737 P re 1 1001 8598 2012 03 28 14 06 47 283285 1 1001 1001 8599 CHAN END 2012 03 28 14 06 47 283344 1 1001 1001 8600 2012 03 28 14 06 53 200459 Tux 1000 1001 8601 CHAN END 2012 03 28 14 06 53 200924 Tux 1000 1001 8 rows 1 1000 calls 1001 from his XiVO client 2 1000 ignores the originate id eventtype eventtime userdeftype cid name cid num cid ani ci t t t t t 8602 CHAN_START 2012 03 28 14 08 21 083271 Tux 1000 8603 2012 03 28 14 08 34 431701 1001 1001 1001 8604 CHAN END 2012 03 28 14 08 34 431759 1001 1001 1001 3 rows External Call External user 555 555 5555 calls 445 2 1000 answer
150. Host xivoserver Content Type application json 1 11 and SDK 249 XiVO doc Documentation Release 14 08 extension id 46 Example response HTTP 1 1 201 Location 1 1 lines 75 extension totals 1 items line id 75 extension id 46 links rel lines href https xivoserver 1 1 lines 75 rel extensions href https xivoserver 1 1 extensions 46 Dissociate an Extension from a Line Any devices that are attached to a line must be removed before disso ciating an extension from its line device can be dissociated by resetting it to autoprov mode Consult the documentation on Devices for further details Query DELETE 1 1 lines line id extensions extension id Error code Error message Description Errors 404 Line with id lt line_id gt does not exist 404 Extension with id lt extension_id gt does not exist 400 Invalid parameters A device is still associated to the line Example request DELETE 1 1 1ines 32 extensions 16 Host xivoserver Example response HTTP 1 1 204 No Content Users User Representation 250 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Field Val Description ues id int Read only firstname string User s first name lastname string User s last name timezone string User s timezone language string U
151. N END 2012 03 28 14 21 23 120436 P re No l 1001 1001 8705 HANGUP 2012 03 28 14 21 23 120533 5555555555 5555555555 55555 8706 CHAN END 2012 03 28 14 21 23 120981 2555555555 5555555555 55555 18 rows External user 555 555 5555 calls 445 2 1000 answers 3 1000 blind transfer to 1001 from his XiVO client 4 1001 ignores the call id eventtype eventtime userdeftype cid name cid num cid t 8736 CHAN STAR 2012 03 28 14 37 16 228527 5555555555 5555555555 8737 APP START 2012 03 28 14 37 16 310874 5555555555 5555555555 55555 8738 CHAN STAR 2012 03 28 14 37 16 311033 Tux 1000 8739 ANSWER 2012 03 28 14 37 18 863805 Tux 1000 1000 8740 ANSWER 2012 03 28 14 37 18 863995 5555555555 5555555555 55555 8741 BRIDGE START 2012 03 28 14 37 18 86402 5555555555 5555555555 55555 8742 BRIDGE END 2012 03 28 14 37 23 50673 5555555555 5555555555 55555 8743 HANGUP 2012 03 28 14 37 23 506776 Tux 1000 1000 8744 CHAN END 2012 03 28 14 37 23 507286 Tux 1000 1000 8745 APP START 2012 03 28 14 37 23 568572 20555555555 5555555555 55555 8746 CHAN START 2012 03 28 14 37 23 568773 P re No l 1001 8747 HANGUP 2012 03 28 14 37 28 065358 P re No l 1001 1001 8748 CHAN END 2012 03 28 14 37 28 065415 P re No l 1001 1001 8749 ANSWER 2012 03 28 14 37 28 067965 5555555555 5555555555 55555 8750 HANGUP 2012 03 28 14 37 33 132613 2555555555 5555555555 55555 8751 CHAN END 2012 03 28 14 37 33 133324 5555555555 5555555555 55555 16 rows Attended transfer Beg dg
152. Network Jitter Level line no gt Jitter Buffer Adjustment line no ua na disable Jitter Buffer Adjustment 11 line nc 5 endfor lt 1 SIP Parameters gt lt RTP_Packet_Size ua na gt 0 020 lt RTP_Packet_Size gt RTP Start Loopback Codec ua na gt G71la lt RTP Start Loopback_Codec gt Regional parameters gt Ring Waveform ua rw gt Sinusoid lt Ring_Waveform gt options Sinusoid Trapezoid gt Ring Frequency ua 2 rw 550 Ring Frequency Ring Voltage ua 2 rw 585 Ring Voltage lt 5 Port Impedance gt 600 2 160 lt Port Impedance Caller ID Method ua na gt Bellcore N Amer China lt Caller_ID_Method gt Caller ID FSK Standard ua na gt bell 202 Caller ID FSK Standard lt CUSTOM TPL for faxes END gt 3 Reconfigure the devices with provd pycli c devices using plugin xivo cisco spa3102 5 1 10 reconfigure 4 Then reboot the devices provd pycli c devices using plugin xivo cisco spa3102 5 1 10 synchronize Most of this template can be copy pasted for a SPA2102 or SPA8000 Using a SIP Trunk Fax transmission to be successful MUST use G 711 codec Fax streams cannot be encoded with lossy compres sion codecs like G 729a That said you may want to establish a SIP trunk using G 729a for all other communications to save bandwith Here s a way to be able to receive a fax in this configuratio
153. P general settings Services IPBX IPBX settings SCCP general settings At this point you should have a fully functional DHCP server that provides IP address to your phones Depending on what type of CISCO phone you have you need to install the plugin sccp legacy sccp 9 0 3 or both Please refer to the Provisioning page for more information on how to install CISCO firmwares Once your plugin is installed you ll be able to edit which firmwares and locales you need If you are unsure you can choose all without any problem Now if you connect your first SCCP phone you should be able to see it in the device list Listing the detected devices Services IPBX IPBX settings gt Devices When connecting a second SCCP phone the device will be automatically detected as well The last step is to create a user with a SCCP line Creating a user with a SCCP line Services IPBX IPBX settings Users 1 8 Administration 143 XiVO doc Documentation Release 14 08 I LLL LHMuI SOCP protmcotproperies LLL Enable direct media Dialtimeout 5 Default language en_US vj Customize codecs Disabled codecs G 711 u law Audio G 711 A law Audio Figure 1 57 SCCP general settings Users Entities General Directories Web Services Access Description lugin for Cisco 7912G 7940G and 7960G in version 8 1 2 of the SCCP software lease see the documentation if you want to ins
154. S 12 PFX file p12 pfx can also be used by commenting out server cert and specifying the PFX file as the private key private key etc hostapd server prv Passphrase for private key private key passwd secret passphrase Enable CRL verification Note hostapd does not yet support CRL downloading based on CDP Thus a valid CRL signed by the CA is required to be included in the ca cert fil This can be done by using PEM format for CA certificate and CRL and concatenating these into one file Whenever CRL changes hostapd needs to be restarted to take the new CRL into use 0 do not verify CRLs default 1 check the of the user certificate 2 check all CRLs in the certificate path check crl 1 dh file File path to DH DSA parameters file in PEM format This is an optional configuration file for setting parameters for an ephemeral DH key exchange In most cases the default RSA authentication does not use this configuration However it is possible setup RSA to use ephemeral DH key exchange In addition ciphers with DSA keys always use ephemeral DH keys This can be used to achieve forward secrecy If the file is in DSA parameters format it will be automatically converted into DH params This parameter is required if anonymous EAP FAST is used You can generate DH parameters file with OpenSSL e g openssl dhparam out etc hostapd dh pem 1024 dh file etc hostapd dh pem Fragment size for EAP
155. Service IPBX Services Exten sions Advanced Parking Using this extension you may define the parking number used to park call the parking lots wether the sytem is rotating over the parking lots to park the calls enable parking hint if you want to be able to supervise the parking using phone keys and other system default parameters You have two options in case of parking timeout Callback the peer that parked this call In this case the call is sent back to the user who parked the call Send park call to the dialplan In case you don t want to call back the user who parked the call you have the option to send the call to any other extension or application If the parking times out the call is sent back to the dialplan in context 126 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Push to park calls Call is parked here DXX Push to talk to caller 1 8 Administration 127 XiVO doc Documentation Release 14 08 eral Voicemail Agents Advanced Context parkedcalls Watdey 3Usecomds sj Extension to parked cal 901 9310 Look for the next call Parkings hints 5 Allow dynamically created parkinglots On parkedcali timeout Send parked calito the 2 Who to play courtesy tone when picking up parked call Caller 7 Allow based transfers when picking up parked None Allow
156. User friendly description of device up to 32 octets encoded in UTF 8 device name Wireless AP Manufacturer The manufacturer of the device up to 64 ASCII characters manufacturer Company 328 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Model Name Model of the device up to 32 ASCII characters model name WAP Model Number Additional device description up to 32 ASCII characters model number 123 Serial Number Serial number of the device up to 32 characters serial number 12345 Primary Device Type Used format categ OUI subcateg categ Category as an integer value OUI OUI and type octet as a 4 octet hex encoded value 0050F204 for default WPS OUI subcateg OUI specific Sub Category as an integer value Examples 1 0050F204 1 Computer PC 1 0050F204 2 Computer Server 5 0050F204 1 Storage NAS 6 0050F204 1 Network Infrastructure AP device 6 0050 204 1 OS Version 4 octet operating system version number hex string os version 01020300 Config Methods List of the supported configuration methods Available methods usba ethernet label display ext nfc token int nfc token interface push button keypad virtual display physical display virtual push button physical push button config methods label virtual display virtual push button keypad WPS capability discovery workaround for PBC with Windows 7 Windows 7 uses incorrect wa
157. XiVO the contact center is implemented to fulfill the following objectives Call routing Includes basic call distribution using call queues and skills based routing e Agent and Supervisor workstation Provides the ability to execute contact center actions such as agent login agent logout and to receive real time statistics regarding contact center status Statistics reporting Provides contact center management reporting on contact center activities 166 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Advanced functionalities Call recording Screen Pop up 1 9 1 Agents Introduction A call center agent is the person who handles incoming or outgoing customer calls for a business A call center agent might handle account inquiries customer complaints or support issues Other names for a call center agent include customer service representative CSR telephone sales or service representative TSR attendant associate operator account executive or team member SearchCRM In this respect agents in XiVO have no fixed line and can login from any registered device Getting Started Create a user with a SIP line and a provisioned device Create agents Create a queue adding created agent as member of queue Creating agents Service Call center Agents General These settings are specific for a given agent Service Call center Agents Users These settings ar
158. XiVO doc Documentation Release 14 08 Avencall January 30 2015 Contents 1 Table of Contents 14 lntroducton 2 4i ev 12 Installation s ux Rok SOY X 1 3 Getting Started 2224 e ead od Brive eS ERE S wx LA pgradinp 2 22 2252 Ra eA gee AG ERE 1 9 sCTVChent 44229 9939 RR E RR LO uu mirena e By a ee e aee dece eS 17 Ecosystem ues ee x Ga L8 1 9 Contact Cente os p 2 se 8a don eis ee RS 110 High Availability BA 3 264 246 eR RES 12111 APLand SDR son 53 eR Oe ERG RS S 142 4 ode SS HS EG Se s 113 Troubleshooung s i geryp en pees dae bbs 1 14 Documentation changelog 2 Changelog 3 Indices and tables XiVO doc Documentation Release 14 08 XiVO is an application suite developed by Avencall Group based on several free existing components includ ing Asterisk and our own developments to provide communication services IPBX Unified Messaging to businesses XiVO is free software Most of its distinctive components and XiVO as a whole are distributed under the GPLv3 license You may also check XiVO blog and XiVO wiki for more information XiVO documentation is also available as an EPUB file or as a PDF file Contents 1 XiVO doc Documentation Release 14 08 2 Contents
159. YT Indirect transfer NYT SK NYT HK NYT NYT NYT Forwards Functions Disable all forwarding NYT N NYT Y NYT NYT NYT Enable Disable forwarding on no answer NYT SK NYT Y NYT NYT NYT Enable Disable forwarding on busy NYT SK NYT Y NYT NYT NYT Enable Disable forwarding unconditional NYT SK NYT Y NYT NYT NYT Voicemail Functions Enable voicemail with supervision function NYT N NYT Y NYT NYT NYT Activate voicemail NYT N NYT Y NYT NYT NYT Reach the voicemail NYT SK NYT HK NYT NYT NYT Delete messages from voicemail NYT N NYT Y NYT NYT NYT Agent Functions Connect Disconnect a static agent NYT N NYT Y NYT NYT NYT Connect a static agent NYT N NYT Y NYT NYT NYT Disconnect a static agent NYT N NYT Y NYT NYT NYT 64 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Table 1 4 continued from previous page SoundPoint SoundStation IP Parking Functions Parking Parking position Paging Functions Paging NYT NYT N NYT N NYT NYT NYT N N Y NYT NYT NYT NYT NYT NYT NYT NYT NYT Particularities Directed pickup doesn t work when using a BLF function key The workaround is to put both the user and the supervised user in the same call pickup group VVX the french translation is incomplete Note XiVO HA cluster BLF function key saved on the master node are not available Polycom SoundPoint IP Backlit Expansion Module are supported
160. _passwpinlo booleanDefault value is false Error Error message Description code 500 Error while creating Voicemail lt explanation gt See explanation for more details 400 Error while creating Voicemail number A voicemail with the same number already lt number gt already exists exists Use another number 400 Invalid parameters password Only numeric passwords are supported 400 Invalid parameters number lt number gt must be The string must only have positive numbers a sequence of positive numbers Errors 400 Invalid parameters max_messages must be Only positive integers are accepted greater than 0 400 Nonexistent parameters context lt context gt The context used by the voicemail does not exist does not exist You must create the context first 400 Nonexistent parameters language lt language gt Consult Voicemail Languages for a list of does not exist available languages 400 Nonexistent parameters timezone lt timezone gt Consult Voicemail Timezones for a list of does not exist available timezones 400 Missing parameters lt list of missing fields gt Example request POST 1 1 voicemails HTTP 1 1 Host xivoserver Accept application json 262 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Content Type application json name John Doe number 1000 context default Example response HTTP 1 1 201 Created Location 1 1 voicemails 1 Content Type appli
161. able of Contents XiVO doc Documentation Release 14 08 File Edit View Terminal Tabs Help etienn X etienn X X lt root X etienn x x etienn x etienn x etienn X etienn X XiVO CTI Server Version xx on Linux skaro new 2 6 32 5 686 class login id version 7777 xivoversion 1 2 A capalist client 311 lines enablexfer false entityid 1 firstname User fullname User B1 incallfilter false lastname B1 loginclient userbl mobilephonenumber profileclient client ringseconds 30 simultcalls 5 voicemailid null 152 lines enablexfer false entityid 1 firstname User fullname User B1 incallfilter false lastname B1 loginclient userbl mobilephonenumber profileclient client ringseconds 30 simultcalls 5 cti server 1 cti server 2 827L 18998C 0 CTI Server Version xx on Linux skaro new 2 6 32 5 686 class login id version xivoversion UIT 1 2 capalist client 311 lines enablexfer false entityid 1 firstname User fullname User B1 incallfilter false lastname B1 loginclient userbl mobilephon
162. achable directly by the other end of the trunk This setting can ease configuration if you manage both ends of the trunk f you are establishing a trunk with a provider you probably don t want everything to be available to every one else so you can set the Context field to Incalls By default there is no extension available in this context so we will be able to configure which extension are reachable by the other end This is the role of the incoming calls making bridges from the Incal1s context to other contexts On XiVO A create the other end of the SIP trunk on the Services IPBX Trunk management SIP Protocol Name xivo trunk Username xivo trunk Password pass Identified by Friend Connection type Static Address XiVO B IP address or hostname Context Incalls Register tab Register checked Transport udp Username xivo trunk Password pass Remote server XiVO B IP address or hostname On both XiVO activate some codecs Services IPBX General Settings SIP protocol tab Signaling Enabled codecs at least GSM audio At that point the Asterisk command sip show registry on XiVO B should print a line showing that XiVO A is registered meaning your trunk is established Set the outgoing calls The outgoing calls configuration will allow XiVO to know which extensions will be called through the trunk On the call emitting server s go on the page Services IPBX Ca
163. all permissions Active call 9 fitters Calls Processed 0 Call pickups Schedules Calls Logs Figure 1 8 Users settings 1 3 Getting Started 9 XiVO doc Documentation Release 14 08 LES Figure 1 9 Adding a new line SIP Protocol IAX Protocol Voicemails Devices Mobile phone number Lines Create a schedules Ringing time 30 seconds v Voicemails Simultaneous calls 5 zj On Hold i Timezone Caller ID Alice Wonderland Schedules Outgoing Caller ID Deas vj Preprocesssubroutine SIP Protocol User field 1 Protocol XiVO Client Save ny Figure 1 10 User information serwees Voicemail Groups Fine Keys SIP Protocol UX Proc machine dest Voicemails Phonebook Protocol Name Context Number Site Device Line N Devices Lines Users Groups Voicemails Conference rooms Figure 1 11 Lines menu 10 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Enter a number for your phone If you click inside the field you will see the range of numbers you can use For our example we will use 10007 ax
164. all rates are used This list can have 316 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 entries that are not in the list of rates the hardware supports such entries are ignored Th ntries in this list are in 100 kbps i e 11 Mbps 110 If this item is present at least one rate have to be matching with the rates hardware supports default use the most common supported rate setting for the selected hw mode i e this line can be removed from configuration file in most cases supported rates 10 20 55 110 60 90 120 180 240 360 480 540 Basic rate set configuration List of rates in 100 kbps that are included in the basic rate set If this item is not included usually reasonable default set is used basic rates 10 20 basic rates 10 20 55 110 basic rates 60 120 240 Short Preamble This parameter can be used to enable optional use of short preamble for frames sent at 2 Mbps 5 5 Mbps and 11 Mbps to improve network performance This applies only to IEEE 802 11b compatible networks and this should only enabled if the local hardware supports use of short preamble If any of the associated STAs do not support short preamble use of short preamble will be disabled and enabled when such STAs disassociate dynamically 0 do not allow use of short preamble default 1 allow use of short preamble preamble 1 Station MAC address based authentication Please n
165. alledidname body xivo calleridnum Origine body xivo origin Save Warning The popup message on MacOSX works with Growl http growl info We could get simple sheet popup to work using the free Growl Fork http www macupdate com app mac 4 1038 growl fork Note that this is not officially supported 90 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Actions The action is for the xivo client so if you configure an action please be sure you understand it s executed by the client You need to allow this action in the client configuration too menu XiVO Client gt Configure tab Functions tick option Customer Info and in sub tab Customer Info tick the option Allow the Automatic Opening of URL The field in this tab receives the URL that will be displayed in your browser You can also use variable substitution in this field http example org foo opens the URL on the default browser e http example org xivo did opens the URL the default browser after substituting the xivo did variable If the substitution fails the URL will remain http example org xivo did ie the curly brackets will still be present e http example org xivo did origin xivo origin opens the URL on the de fault browser after substituting the variables If at least one of the substitution is successful the failing substitutions will be replaced by an emp
166. aller ID vj Preprocesssubrouine i 0001 r a a a E E A E E a a E E EEEE Logn ae 1 T T Description gt Supervisor switchboard 1 8 Administration 85 XiVO doc Documentation Release 14 08 1 8 7 Display customer informations Sheet Configuration Sheets can be defined under Services CTI Server Models in the web interface Once a sheet is defined it has to be assigned to an event in the Services CTI Server Events menu Model The model contains the content of the displayed sheet Event Events are actions that trigger the defined sheet A sheet can be assigned to many events In that case the sheet will be raised for each event CTI Server scription Adio gt custom sheet action 1 oe enera Profiles O gt dial sheet_action_dial oe gt Demo Demo sheet eoe Presences Phone hints gt queue sheet action queue oe Directo m E a gt xivo Mod le de fiche de base oe Reverse directories UMOR Direct directories Display filters Sheets Models Events Control Restart CTI server General settings General settings Sheet Systray Actions Description Mod le de fiche de base You must give a to
167. an be used in subroutines XIVO CALLORIGIN intern for internal calls extern for external calls 1 12 Developers General information 1 12 1 Contributing to the Documentation XiVO documentation is generated with Sphinx The source code is available on GitHub at https github com xivo pbx xivo doc Provided you already have Python installed on your system You need first to install Sphinx easy install 11 U Sphinx Quick Reference http docutils sourceforge net docs user rst cheatsheet txt http docutils sourceforge net docs user rst quickref html e http openalea gforge inria fr doc openalea doc build html source sphinx rest syntax html Documentation guideline Here s the guideline conventions to follow for the XiVO documentation Language The documentation must be written in english and only in english Sections The top section of each file must be capitalized using the following rule capitalization of all words except for articles prepositions conjunctions and forms of to be Correct The Vitamins are in My Fresh California Raisins Incorrect The Vitamins Are In My Fresh California Raisins Use the following punctuation characters x with overline for file title l easy install can be found in the debian package python setuptools sudo apt get install python setuptools 270 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 for sections
168. ap provisioning extension 342395 device slot 1 device id 2b63136208fb117335ce874e65eba2a3 its s rel lines sip href https xivoserver 1 1 lines_sip 1 Custom example Warning Not yet implemented pgs 25 context default name custom protocol custom provisioning extension 438111 device slot 2 e rel lines custom href https xivoserver 1 1 lines custom 2 SCCP example Warning Not yet implemented context default name SCCP 1234 protocol seep provisioning extension 382731 device slot 1 6 rel lines sccp 1 11 and SDK 239 XiVO doc Documentation Release 14 08 href https xivoserver 1 1 lines_sccp 3 List Lines Query G 1 1 lines E Example request GET 1 1 lines HTTP 1 1 Host xivoserver Accept application json E Example response HTTP 1 1 200 OK Content Type application json toral s 3 items Td Ly context default name alb2c4 protocol sip provisioning_extension 342395 device_slot 1 device_id 2b63136208fb117335ce874e65eba2a3 lt 2 rel lines_sip href https xivoserver 1 1 lines_sip 1 aM 2 context default name custom protocol custom provisioning extension 438111 d
169. apter 1 Table of Contents XiVO doc Documentation Release 14 08 Interface Method Static Address EJ Nemas Default gateway Descriptian Interface ei 1 6 System 43 XiVO doc Documentation Release 14 08 Web Services Access interfaces Resolver Mal 0 DHCP General 002 Template line Template device Apply network confiquration Apply system confiquration Figure 1 19 Apply after modify interface Adding a VLAN interface First we see there s already a configured network interface on our system gt eho 08 00 27 6a 49 e5 Data Static 192 168 32 51 192 168 32 254 gt eti 08 00 27 e9 fa t4 VolP Static 10 57 52 Listing the network interfaces To add and configure a new VLAN interface we click on the small plus button in the top right corner and we get to this page In our case since we want to configure this interface with static information Click on Save list the network interfaces The new virtual interface has been successfully created Note Do not forget after you finish the configuration of the network to apply it with the button Apply network configuration After applying the network configuration 44 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Figure 1 20 Adding button Physical Interface of VLAN ethO D af VLAN Daa
170. arting from your current version to the current prod version If in a specific configuration follow the specific procedure described below example cluster To download the packages beforehand run xivo upgrade d will upgrade xivo upgrade xivo service and download all packages necessary prior to stopping services for upgrade making the upgrade faster When ready services will be stopped run xivo upgrade which will actually start the migration When finished check that the services are correctly running with xivo service status command and with actual checks like SIP registration ISDN links status internal incoming outgoing calls XiVO Client connections etc 1 4 2 Specific procedure XiVO 14 01 14 02 14 03 14 04 installed from the ISO file In those versions xivo upgrade keeps XiVO on the same version You must do the following before the normal upgrade 1 4 Upgrading 13 udp dpt 5060 XiVO doc Documentation Release 14 08 echo deb http mirror xivo fr debian xivo five main etc apt sources list d xivo upgrade li amp amp apt get update amp amp apt get install xivo fai amp amp rm etc apt sources list d xivo upgrade list amp amp apt get update 1 4 3 Specific procedure XiVO 13 03 and before When upgrading from XiVO 13 03 or earlier you must do the following before the normal upgrade wget http mirror xivo fr xivo current key O apt key add 1 4 4 Specific pr
171. aset Also known as Siemens Model Tested Fkeys XiVO HA C470 IP No 0 No C475 IP No 0 No C590 IP No 0 No C595 IP No 0 No C610 IP No 0 No C610A IP No 0 No S675 IP No 0 No S685 IP No 0 No N300 IP No 0 No N300A IP No 0 No N510 IP PRO No 0 No Jitsi Model Tested Fkeys XiVO HA Jitsi Yes Panasonic Panasonic KX HTXXX series Model Tested Fkeys XiVO HA KX HT113 No No KX HT123 No No KX HT133 No No KX HT136 No No Note This phone is for testing for the moment Polycom Model Tested Fkeys SPIP320 No 0 No SPIP321 No 0 No SPIP330 No 0 No SPIP430 No 0 No SPIP501 Yes 0 No SPIP600 No 0 SPIP601 No 0 No SPIP670 No 47 No 1 7 Ecosystem 69 XiVO doc Documentation Release 14 08 SoundStation IP Model Tested Fkeys XiVO HA SPIP4000 No 0 No Others Model Tested Fkeys XiVO HA VVX1500 No 0 No Snom Model Tested Fkeys XiVO HA 300 No 6 Yes 320 Yes 12 Yes 360 No Yes 820 Yes 4 Yes MP No Yes PAI No 0 Yes There s a known issue with the provisioning of Snom phones in XiVO After a factory reset of a phone if no language and timezone are set for the default config device in XiVO Configuration Provisioning Te
172. ated chan_motif chan_jingle Jingle Channel Driver No Deprecated chan_motif chan_vpb Voicetronix API driver No Supported format 51016 Raw Signed Linear 16KHz Audio Yes Removed format sin support res ais SAForum AIS No Removed res corosync res jabber AJI Asterisk Jabber Interface No Deprecated res xmpp List of modules that were loaded in asterisk 1 8 but that are not loaded anymore in asterisk 11 see modules conf res calendar so res calendar caldav so res calendar ews so res calendar exchange so res calendar icalendar so res config sglite so res stun monitor so List of debian packages that are not available anymore for asterisk 11 asterisk config asterisk mysql asterisk web vmail Note These packages were not installed by default for asterisk 1 8 If you are using some custom dialplan or AGIs it is your responsibility to make sure it still works with asterisk 11 See the External Links for more information External Links e http svnview digium com svn asterisk branches 11 UPGRADE 10 txt e http svnview digium com svn asterisk branches 11 UPGRADE txt e https wiki asterisk org wiki display AST New in 10 e https wiki asterisk org wiki display AST New in 1 1 The switchboard s queue preprocess subroutine The switchboard s queue now uses a preprocess subroutine named xivo_subr_switchboard This preprocess subroutine will be associated with all queues named __switch board that h
173. ault context Create the to extern context the webi create a context named to pabx Name to pabx Display Name to pabx Context type Outcall Include sub contexts No context inclusion This context allows to route incoming calls from the XiVO to the PBX Create incoming calls In our example incoming calls on spans and 3 spans pluged to the provider are routed by from extern context We are going to create a default route to redirect incoming calls to the PBX Create an incoming call as below DID XXXX according to the number of digits sent by the provider Context Incoming calls Destination Customized Command Goto to pabx S XIVO 5 1 Create the interconnections You have to create two interconnections provider side dahdi gO PBX side dahdi g2 In the menu Services IPBX Trunk management Customized page Name t2 operateur Interface 90 Contexte to extern The second interconnection 1 8 Administration 119 XiVO doc Documentation Release 14 08 Appels internes default Appels sortants to extern Figure 1 48 to extern context m DID XXXX Contes Appel entrants rom exe Desinaton Customized Command Goto default S XIVO DSTT Calero mode Preprocess subroutne 0 Saw E Figure 1 49 Incoming call XXXX Figure 1 50 Customized interconnection 120 Chapter 1 Table of Conte
174. ave no preprocess subroutine defined before the upgrade If your switchboard queue is named anything other than __switchboard you should add the preprocess subroutine manually If your switchboard queue already has a preprocess subroutine you should add a Gosub xivo_subr_switchboard to you preprocess subroutine 24 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Consult the 13 07 Roadmap Agent Status Dashboard has more features and less limitations See related agent status dashboard docu mentation XiVO call centers have no more notion of disabled agents All previously disabled agents in web interface will become active agents after upgrading asterisk has been upgraded from version 1 8 20 1 to 1 8 21 0 Please note that in XiVO 13 08 asterisk will be upgraded to version 11 DAHDI has been upgraded from version 2 6 1 to 2 6 2 libpri has been upgraded from version 1 4 13 to 1 4 14 PostgreSQL upgraded from version 9 0 4 to 9 0 13 13 06 Consult the 13 06 Roadmap The new Agent Status Dashboard has a few known limitations See related dashboard xlet known issues section Status Since counter in xlet list of agents has changed behavior to better reflect states of agents in queues as seen by asterisk See Ticket 4254 for more details 13 05 Consult the 13 05 Roadmap The bug 4228 concerning BS filter only applies to 13 04 servers installed from scratch Please upgrade to 13
175. b asterisk sudo u postgres pg restor C d postgres asterisk x dump Restoring and Keeping System Configuration System configuration like network interfaces is stored in the database It is possible to keep this configuration and only restore xivo data Rename the asterisk database to asterisk previous sudo u postgres psql c ALTER DATABASE asterisk RENAME TO asterisk previous Restore the asterisk database from the backup sudo u postgres pg restor C d postgres asterisk x dump Restore the system configuration tables from the asterisk previous database sudo u postgres pg dump c t dhcp t netifac t resolvconf asterisk previous sudo u postgre Drop the asterisk previous database sudo u postgres dropdb asterisk previous Warning Restoring the data tgz file restore also system files as host hostname network interfaces etc You will need to reapply network configuration if you restore the data tgz file After Restoring The System Restart the services you stopped at the first step xivo service start You may also reboot the system 54 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 1 6 8 DHCP Server XiVO includes a DHCP server that must be used to address telephony devices Basic Configuration of the VOIP subnet This section describes how to configure DHCP server for other subnets or with advanced options Activation of DHCP server DHCP Serve
176. be acm 0 4 Note for IEEE 802 11b mode High priority AC VI vide wmm ac vi aifs 2 wmm ac vi cwmin 3 wmm ac vi cwmax 4 wmm vi txop limit 94 wmm ac vi acm O0 4 Note for I Highest priority AC VO wmm ac vo aifs 2 wmm ac vo cwmin 2 wmm ac vo cwmax 3 wmm ac vo txop limit 47 wmm vo acm 0 Note for I EEE 802 11b mode 802 11b mode i tatic WEP key number to use when t t must be between 0 3 default not set default 0 he keys to use H A default not set wep key0 123456789a keyl 2 vwxyz wep key3 2 4 6 8 0 23 Station inactivity limit WMM PS Unscheduled Automatic Power Sav key configuration rol mandatory flag 0 admission control not are in exponent form the actual cw value used he value given her Delivery U APSD upported outside hostapd eg Firmware driver background cWmin 5 cWmax 10 st effort cWmin 5 cWmax 7 o cWmin 4 cWmax 5 txop limit 188 voice cWmin 3 cWmax 4 burst 102 ransmitting and the corresponding key must be set key may be a quoted string or unquoted hexadecimal digits The key length should be 5 13 or 16 characters or 10 26 or 32 digits depending on whether 40 bit 64 bit 104 bit 128 bit or 128 bit 152 bit WEP is used Only the default key must be supplied the others ar
177. become End call while transfering a call Note that this is a work in progress and some models still need some tweaking 13 22 Consult the 13 22 Roadmap PostgreSQL will be upgraded from 9 0 to 9 1 The upgrade of XiVO will take longer than usual depending on the size of the database Usually the database grows with the number of calls processed by XiVO The upgrade will be stopped if not enough space is available on the XiVO server 13 21 Consult the 13 21 Roadmap tis no more possible to delete a device associated to a line using REST API 13 20 Consult the 13 20 Roadmap xivo libsccp now supports direct media on wifi phone 7920 and 7921 xivo restapi now implements a voicemail list 13 19 Since XiVO 13 18 was not released the 13 19 release contains all developments of both 13 18 and 13 19 therefore please consult both Roadmaps Consult the 13 19 Roadmap Consult the 13 18 Roadmap Call logs are now generated automatically incrementally and regularly Call logs generated before 13 19 will be erased one last time The database was highly modified for everything related to devices table devicefeatures does not exist anymore and now relies on information from xivo provd 1 4 Upgrading 21 XiVO doc Documentation Release 14 08 13 17 Consult the 13 17 Roadmap There is a major change to call logs They are no longer available as a web report but only as a csv export See the call logs docu
178. call is external AND user has an eme same n Gotolf XIVO_CALLORIGIN extern return same GotoIf XIVO_USEREMAIL return same n Set FAXOPT faxdetect yes Activate dynamically fax detection same n Answer same n Wait 4 You can change the number of seconds it will wait for fax 4 to 6 is gc same n Set FAXOPT faxdetect no If no fax was detected deactivate dyamically fax dete Same n return Return exten 1 detected from S CALLERID num towards 5 DSTNUM will be sent same n GotoIf S S CHANNEL channeltype DAHDI changeechocan continue same n changeechocan Set CHANNEL echocan_mode fax if chan type is dahdi set echo same n continue Gosub faxtomail s 1 XIVO_USEREMAIL 2 In the file etc xivo asterisk xivo_globals conf set the global user subroutine to pre user global faxdetection this subroutine will be executed each time a user is called XIVO PRESUBR GLOBAL USER pre user global faxdetection 3 Reload asterisk configuration both for dialplan and dahdi asterisk rx core reload 1 13 3 Berofos Integration with PBX You can use a Berofos failover switch to secure the ISDN provider lines when installing a XiVO in front of an existing PBX The goal of this configuration is to mitigate the consequences of an outage of the XiVO with this 1 13 Troubleshooting 347 XiVO doc Documentation Relea
179. can be assigned to each agent and call can be distributed to the most suitable agent In skills based routing you will have to find a way to be able to tag the call for a specific skill need This can be done for example by entering the call distribution system using different incoming call numbers using an IVR to let the caller do his own choice or by requesting to the information system database the customer profile Getting Started Create the skills Apply the skills to the agents Create a skill rule sets Assign the skill rule sets using a configuration file Apply the skill rule sets to call qualification i e incoming calls by using the preprocess routine field 1 9 Contact Center 179 XiVO doc Documentation Release 14 08 cdi Figure 1 77 Skills Based Routing Skills Skills are created using the menu Services Call center Skills Each skill belongs to a category First create the category and in this category create different skills Note that the skill names can t contain upper case letters Category Business Values 7 DispaySceen 2 e je ba 1 mk mk 8 Figure 1 78 Skills Creation Once all the skills are created you may apply them to the agents Agents may have one or more skills from different categories eomm ee Queues Advanced 5 A KIKIKI 1 ion 1 2 5 Skaro Visit xivo fr
180. can see contact objects Here s what a contact object looks like B r nice Martin a You can see three informations The person s full name A person icon it displays the status of its XiVO Client Usually green means connected gray means disconnected A phone icon it displays the status of the phone of the user if it has a configured phone Usually green means that the phone is activated and hanged up red means that the phone is activated and in communication white means that the phone is not registered i e not functional The colors and label of these two statuses may be configured within the XiVO Web interface You can interact in several ways with a person object Holding your mouse cursor on the person or phone icon will display more details about the person and its phone Double clicking on it will call the person if its phone is activated Right clicking on it will display the list of possible actions 1 5 CTI Client 29 XiVO doc Documentation Release 14 08 Dragging and dropping it on another person icon will make the dragged user call the dropped user Possible actions available through right click are Call Hangup Chat ntercept call Transfer a call to this user Cancel a transfer nvite to a conference room The available actions may differ depending on your current phone situation available busy in a conference room and on the actions
181. cation json In name John Doe number 1000 Context default password null email null language null timezone eu fr max messages null attach audio false delete messages false ask password false links rel voicemails href https xivoserver 1 1 voicemails 2 Update a Voicemail Only the fields that need to be updated must be sent during an update A voicemail can only be updated if it isn t associated to a user Query PUT 1 1 voicemails lt id gt Parameters id Voicemail s id Input Same as for creating a voicemail Please see Create a Voicemail Errors Same as creating a voicemail See Create a Voicemail with the following additions Error code Error message Description 400 Error while editing Voicemail cannot edit a voicemail associated to a user Example request PUT 1 1 voicemails 1 1 1 Host xivoserver Content Type application json 1 11 and SDK 263 XiVO doc Documentation Release 14 08 number 2000 attach audio true Example response HTTP 1 1 204 No Content Delete a Voicemail voicemail can not be deleted if it is still attached to a user The user must be dissociated first Consult the documentation on Voicemail Association for futher details Error Error message Description code 400 error while deleting Voicemail explanation See error message for
182. ce synchronisation does not work in the situation where multiple devices are connected from behind a NAPT network equipment The devices must be resynchronised manually External links ntroduction to provd plugin model HTTP TFTP requests processing in provd part 1 HTTP TFTP requests processing in provd part 2 Basic Configuration You have two options to get your phone to be provisioned Set up a DHCP server Tell manually each phone where to get the provisioning informations You may want to manually configure the phones if you are only trying XiVO or if your network configuration does not allow the phones to access the XiVO DHCP server You may want to set up a DHCP server if you have a significant number of phones to connect as no manual intervention will be required on each phone 1 8 Administration 133 XiVO doc Documentation Release 14 08 Configuring the DHCP Server XiVO includes a DHCP server that facilitate the auto provisioning of telephony devices It is not activated by default There s a few things to know about the peculiarities of the included DHCP server it only answers to DHCP requests from supported devices it only answers to DHCP requests coming from the VoIP subnet see network configuration This means that if your phones are on the same broadcast domain than your computers and you would like the DHCP server on your XiVO to handle both your phones and your computers that won t do it
183. check NTP synchroniza tion status then it should work 1 6 10 Mail This section describes how to configure the mail server shipped with XiVO Postfix and the way XiVO handles mails In Configuration Network the following options can be configured Domain Name messaging the server s displayed domain Will appear in Received mail headers Source address of the server domain part of headers Return Path and From Relay SMTP and FallBack relay SMTP relay mail servers Rewriting shipping addresses Canonical address Rewriting See Postfix canonical documentation for more info Warning Postfix the mail server shipped with XiVO should be stopped on an installed XiVO with no valid and reachable DNS servers configured If Postfix is not stopped messages will bounce in queues and could end up affecting core pbx features If you need to disable Postfix here is how you should do it etc init d postfix stop insserv r postfix If you ever need to enable Postfix again 58 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 insserv postfix etc init d postfix start Alternatively you can empty Postfix s queues by issuging the following commands on the XiVO server postsuper d ALL 1 7 Ecosystem 1 7 1 Devices Supported device Official support XiVO provides official support for the following phones These phones will be supported across upgrades and phone f
184. clock from the provider the timing value is to be different from 0 see etc dahdi system conf section PBX side XiVO will provide the clock to the PBX the timing value is to be set to 0 see etc dahdi system conf section Example Below an example for interconnection with two ISDN provider Span 1 4 0 1 TE4XXP PCI Card 0 Span 1 MASTER span 1 1 0 ccs hdb3 Span towards Provider bchan 1 15 17 31 dchan 16 echocanceller mg2 1 15 17 31 Span 2 4 0 2 TE4XXP PCI Card 0 Span 2 span 2 2 0 ccs hdb3 Span towards Provider 1 8 Administration 117 XiVO doc Documentation Release 14 08 bchan 32 46 48 62 dchan 47 echocanceller mg2 32 46 48 62 Span 3 TE4 0 3 TE4XXP PCI Card 0 Span 3 span 3 0 0 ccs hdb3 Span towards PBX bchan 63 77 79 93 dchan 78 echocanceller mg2 63 77 79 93 Span 4 TE4 0 4 TE4XXP PCI Card 0 Span 4 span 4 0 0 ccs hdb3 Span towards PBX bchan 94 108 110 124 dchan 109 echocanceller mg2 94 108 110 124 dahdi channels conf Configuraton Modify the file etc asterisk dahdi channels conf group 40 provider side g2 PBX side context from extern or from pabx signalling pri cpe provider side pri net PBX side Warning Towards certains destinations some PBX use an overlapdialing digits are sent one by one In this case we have to activate a parameter on the spans concerned overlapdial incoming This can be seen with pri intense debug B
185. com plugin enables the phone lock feature with a default user password of 123 Polycom phones used with XiVO also have a default admin password In order for the phone lock feature to be secure one should change every phone s admin AND user passwords WebServices for SIP trunks lines field nat value yes changed to force rport comedia The database has beed updated in order to remove deprecated tables generalfeatures extenumbers exten hash cost center 13 13 Consult the 13 13 Roadmap 13 12 Consult the 13 12 Roadmap CTI protocol Modified values of agent availability Read CTI Protocol changelog Clean up was made related to the minimization of the XiVO Client Some visual differences have been observed on Mac OS X that do not affect the XiVO Client in a functional way 22 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 13 11 Consult the 13 11 Roadmap Asterisk has been upgraded from version 11 3 0 to 11 4 0 API changes e Dialplan variable XIVO INTERFACE 0 is now XIVO INTERFACE Dialplan variable XIVO INTERFACE NB and XIVO INTERFACE COUNT have been removed The following fields have been removed from the lines and users web services line num roles group rules order time rules type 13 10 Consult the 13 10 Roadmap API changes CTI protocol for messages of class getlist and function updateconfig the config ob ject dictionary does not have
186. context protocol incallexten incallcontext l John Doe 1000 default sip 2050 from extern Function keys Function keys can be configured to customize the user s phone keys Key types are pre defined and can be browsed through the Type drop down list The Supervision field allow the key to be supervised supervised key will light up when enabled Warning SCCP device only supports type Customized General Lines No answer Services Voicemail Groups Func Keys Key Type Destination Label Supervision 1 zj Do not disturb 21 Enabled v TE Incoming call filtering 21 Enabled Enable Disable forwarding unc 102 Enabled amp gt Enable Disable forwarding on t 102 Enabled v E 5 E 155 Enable Disable forwarding E EIE 102 E B Enabled E ji 6 Enable Disable forwarding unc 103 Enabled Save LS SSS For User keys start to key in the user name in destination XiVO will try to complete with the corresponding user If the forward unconditionnal function key is used with no destionation the user will be prompted when the user presses the function key and the BLF will monitor ALL unconditionnal forward for this user Extensions 3 online call recording To enable online call recording you must check the Enable online call recording box in the user
187. count GUI Settings Functions Advanced Presence reporting _ Customer Info Presence reporting Customer Info Dialer History Contacts Queues Queue Members Green Orange Queue thresholds waiting calls 2 114 _ Display queue s longest wait Queue thresholds longest wait 0 110 1 Display queue number Cancel gt xivoclient stylesheet big fonts qss Windows and Mac xivoclient stylesheet big fonts qss GNU Linux The big fonts qss file should contain QueuesView font size 40 QueuesView QHeaderView font size 40 Units of size that can be used are described on the Qt documentation Agent List General information The queue list is a dashboard displaying each agent configured on the XiVO Agents List plain Joined Paused queues Number First name Last name Listen Status since Paused queues 101 Alice Wonderland Listen 1 102 Bob Cat Listen 3 Listen 103 Charlie Columns Number The agent s number First name amp Last name The agent s first name and last name Listen A clickable cell to listen to the agent s current call Clicking on the cell will make your phone ring When you ll answer you ll hear the conversation the agent is having You ll then be able to press the following digits on your phone to switch between the different listen modes 174 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 4 spy
188. cription Caller id John Doe outgoing caller id default mobile phone number username password music on hold default preprocess subroutine userfield Create a User Query POST 1 1 users Field Required Values firstname yes string lastname no string timezone no string Must be a valid timezone language no string Must be a valid language description no string caller_id no string Input outgoing caller id no string default anonymous or custom mobile phone number no string of digits username no string password no string Minimum of 4 characters music on hold no string Must be a valid category preprocess subroutine no string userfield no string Error code Error message Description Errors z z z z 400 error while creating User lt explanation gt See error message for more details Example request POST 1 1 users 1 1 Host xivoserver Accept application json Content Type application json firstname John lastname Doe userfield 1 11 and SDK 253 XiVO doc Documentation Release 14 08 Example response HTTP 1 1 201 Created Location 1 1 users 1 Content Type application json firstname John lastname Doe timezone language en_US description Caller id John Doe outgoing_caller_id default mobile phone number username
189. cription 404 Extension with id lt extension_id gt does not exist Example Request GET extensions 48 lines Host xivoserver Accept application json Example Response HTTP 1 1 200 OK Content Type application json 248 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 25 items line id 34 extension id 48 links rel lines href https xivoserver 1 1 lines 34 rel extensions href https xivoserver 1 1 extensions 48 Wane 1a 35 gt extension_id 48 links rel lines href https xivoserver 1 1 lines 35 rel extensions href https xivoserver 1 1 extensions 48 Associate an Extension to a Line Note Because of technical limitations a line can only have a single internal extension associated i e an extension with a context of type internal Query POST lines lt line_id gt extensions Field Required Values Description Input Pree extension_id yes int Must be an existing id Error Error message Description code Errors 404 Line with id line id does not exist 400 Invalid parameters line with id line id already has Only one extension with a context of type an extension with a context of type internal internal can be associated to a line Example request POST 1 1 lines 75 extensions
190. ctivated for this secretary If a secretary also has a function key on the same boss secretary combination the function key s BLF will be in sync between each phones 78 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 2 items selected Remove all Add all 1 Jina LaPlapf John Smith 1 Ptit Nouve um Warning With SCCP phones you must configure a custom Func Keys 1 8 3 Call Permissions You can manage call permissions via the Services IPBX Call management Call permissions page Call permissions can be used for denying a user from calling a specific extension denying a user of a group from calling a specific extension denying a specific extension on a specific outgoing call from being called denying an incoming call coming from a specific extension from calling you More than one extension can match a given call permission either by specifying more than one extension for that permission or by using extension patterns You can also create permissions that allow a specific extension to be called instead of being denied This make it possible to create a general deny all permission and then an allow for some one Finally instead of unconditionally denying calling a specific extension call permissions can instead challenge the user for a password to be able to call that extension As you can see you can do a lot of things with XiVO s call permissions They can b
191. cy amp OG rotoci Protocol o0 1aa27abb fc 10 97 5 103 Cisco 79125 xivo cisco sccplegacy 0 Voicemails Phonebook Advanced H IS M Existent on the provisioning server Devices inexistent on the provisioning server Users Device properly configured Groups H Device configured in autoprov mode 4 figured check if a plugin is installed for this devi Conference not configured check if a plugin is installed for this device Figure 1 60 Device list Devices Lines Users Groups Tue Figure 1 61 Add a new user cnerar seuungs emes 7 Ne wer tives vue OrUups runc weys 7 SIP Protocol Protocol Frtname 71 poems Last name T User picture E Browse Mobile phone number Create a schedules Ringing time 30 seconds l Figure 1 62 Edit user informations Groups J Fine Keys iy 5565 Number Figure 1 63 Add a line to a user 1 8 Administration 145 XiVO doc Documentation Release 14 08 Before saving the newly configured user you need to select the Lines menu and add a SCCP line Now you can save your new user Congratulations Your SCCP phone is now ready to be called Direct Media SCCP Phones support directmedia direct RTP In o
192. d The server expects to receive JSON encoded data Only one item can be processed per request The data format and required data fields are illustrated in the following example Request data format ig e oropl test When updating only the id and updated properties are needed omitted properties are not updated Some properties can also be optional when creating an object Errors A request to the web services may return an error An error will always be associated to an HTTP error code and eventually to one or more error messages The following errors are common to all web services Error Error Description code message 406 empty Accept header missing or contains an unsupported content type 415 empty Content Type header missing or contains an unsupported content type 500 list oferrors An error occured on the server side the content of the message depends of the type of errors which occured The 400 404 and 412 errors depend on the web service you are requesting They are separately described for each of them The error messages are contained in a JSON list even if there is only one error message message 1 message 2 API Beta version REST API 1 1 Note REST API 1 1 is currently evolving New features and small fixes are regularly being added over time We invite the reader to periodically check the changelog for an update on new features and changes Warning Some s
193. d Jitsi will launch a windows and you can click 3 Use online provisioning Otherwise go to Tools gt Options gt Advanced gt Provisioing Click on Enable provisioning 4 Select Manually specify a provisioning URI 5 Enter the folowing URI where provd ip is the VoIP interface IP address of your XiVO and provd port is the provd port default 8667 http lt provd_ip gt lt provd_port gt jitsi uuid uuid 6 When done quit Jitsi 7 Launch Jitsi again You should now be connected with in autoprov mode You could see a new device in the devices list 8 You can now provision the phones by typing the provisioning code you get it in the Lines list 9 Quit Jitsi again configuration syncing is not available with the Jitsi plugin 10 And launch Jitsi again you should now be connected with you phone account 1 8 24 SCCP Configuration Activating DHCP Server Configuration Network DHCP Activating DHCP Integration Configuration Provisioning General Installing a plugin for SCCP Phone Configuration Provisioning Plugins R CC O Configuration Management xivo cisco sccp 9 2 1 Plugin for Cisco 79416 and 7941G GE in version 9 2 1 of the SCCP 0 18 895kb U 8 Xivo cisco sccp legacy Plugin for Cisco 7940G in version 8 1 2 of the SCCP software 0 18 834kb o Directories Web Services Access Certificates Figure 1 56 Installing xivo cisco sccp plugin Review SCC
194. d by a XiVO installation is done automatically every day These backups are created in the var backups xivo directory and are kept for 7 days Before Restoring the System Warning Before restoring a XiVO on a fresh install you have to setup XiVO using the wizard see Running the Wizard section Stop monit and all the xivo services xivo service stop Restoring System Files System files are stored in the data tgz file located in the var backups xivo directory This file contains for example voicemail files musics voice guides phone sets firmwares provisioning server configuration database To restore the file 1 6 System 53 XiVO doc Documentation Release 14 08 tar xvfp var backups xivo data tgz C Restoring the Database Warning This will destroy all the current data in your database You have to check the free space on your system partition before extracting the backups Database backups are created as db t gz files in the var backups xivo directory These tarballs contains a dump of the database used in XiVO In this example we ll restore the database from a backup file named db tgz placed in the home directory of root Then extract the content of the do tgz file into the var tmp directory and go inside the newly created directory tar xvf db tgz C var tmp cd var tmp pg backup Drop the asterisk database and restore it with the one from the backup sudo u postgres dropd
195. d codec Codec list G 711 A Law G 722 G 729A H 264 1 3 Getting Started This section will show you how to create a user with a SIP line This simple use case covers what a lot of people need to start using a phone You can use these steps for connectinhg a softphone a Linksys PAP2 or a SIP phone via the web interface This tutorial doesn t cover how to automatically provision a supported device For this you must refer to the provisionning section We first need to log into the XiVO web interface The web interface is where you can administer the whole system root z Language English Figure 1 5 Logging into the XiVO When logged in you will see a page with all the status information about your system This page helps you monitor the health of your system and gives you information about your network Please note the IP address of your server you will need this information later on when you will configure your device e g phone To configure a device for a user start by navigating to the IPBX menu Hover over the Services tab a dropdown menu will appear Click Select the Users setting in the left menu From here press on the plus sign A pop up will appear where you can click on Add We now have the form that will allow us to create a new user The three most important fields are First name Last name and Language in the fields and click on Sa
196. d is encoded as UTF 8 eap fast a id info test server Enable disable different EAP FAST provisioning modes provisioning disabled only anonymous provisioning allowed only authenticated provisioning allowed both provisioning modes allowed default eap_fast_prov 3 WNrR ll EAP FAST PAC Key lifetime in seconds hard limit key lifetime 2604800 EAP FAST PAC Key refresh time in seconds soft limit on remaining hard limit The server will generate a new PAC Key when this number of seconds or fewer of the lifetime remains pac key refresh time 86400 EAP SIM and EAP AKA protected success failure indication using AT RESULT IND default 0 disabled eap sim aka result ind 1 Trusted Network Connect TNC If enabled TNC validation will be required before the peer is allowed to connect Note This is only used with EAP TTLS and EAP FAST If any other EAP method is enabled the peer will be allowed to connect without TNC tnc 1l T IE E 802 11f Inter Access Point Protocol IAPP Interface to be used for IAPP broadcast packets iapp interface eth0 RADIUS client configuration for IEEE 802 1X with external Authentication Server IEEE 802 11 authentication w
197. d link the event Agent linked to the sheet you just created That s it you can assign agents to your queue log the agents and make them answer calls with the XiVO Client opened and your browser should open the specified URL 1 8 8 Devices Synchronize a device You first have to display list devices Figure 1 36 Click on synchronize button for a device 00 1471 e1 37 62 10 97 5 100 Technicolor ST2030 Xivo technicolor ST2030 2 74 4 00 08 50 13 ca 05 10 97 5 102 Aastra 67391 xivo aastra 3 2 2 56 EF C 00 0e 08 dd 64 2e 10 97 5 103 Cisco SPA962 xivo cisco spa legacy A oo147t614253 10 975 104 Technicolor ST2030 xivo technicolor ST2030 2 74 2300 Figure 1 37 List devices You will see a pop up to confirm synchronization Click on ok button 92 Chapter 1 Table of Contents mysheeturl XiVO doc Documentation Release 14 08 Confirm Synchronize Cancel Figure 1 38 Alert confirm synchronize Figure 1 39 Request synchronisation processing 1 8 Administration 93 XiVO doc Documentation Release 14 08 You must wait until the full synchronization process to determine the state back This can take several seconds It is important to wait and do nothing during that time If synchronization is successful an information balloon green warn you of success
198. de to current version from an archive apt get update apt get install xivo fai squeeze xivo skaro cat usr share xivo XIVO VERSION xivo fai skaro apt get update xivo upgrade As a result xivo upgrade will always upgrade XiVO to the latest stable version From the current version use an archive version Downgrades are not supported you can only upgrade to a greater version Current version between 1 2 and 13 24 apt get update apt get install xivo fai skaro 13 23 apt get purge xivo fai skaro apt get update Current version after 13 25 apt get update apt get install xivo fai 13 25 apt get purge xivo fai apt get update As a result xivo upgrade will not upgrade XiVO to a greater version than the archive you chose Upgrade from an archive version to another archive version Downgrades are not supported you can only upgrade to a greater version Source and destination archive version between 1 2 to 13 24 apt get update apt get install xivo fai skaro 13 24 apt get purge xivo fai skaro 13 02 apt get update xivo upgrade Source or destination archive version after 13 25 apt get update echo deb http mirror xivo fr archive xivo 13 25 main gt etc apt sources list d xivo 13 25 1is apt get update apt get install xivo fai 13 25 1 4 Upgrading 15 XiVO doc Documentation Release 14 08 rm etc apt sources list d xivo 13 25 list apt get purge xivo fai skaro 13 02 apt get update xiv
199. default tftpd hpa file restart t tpd hpa after modifcation FTP_USERNAME tftp FTP_DIRECTORY srv tftp FTP_ADDRESS 0 0 0 0 69 FTP OPTIONS 2 secur verbose With this configuration files served via TFTP will be in the srv t ftp directory and those served via HTTP in the var www directory Testing Adding auto provisioning support for a phone is mostly a question of finding answers to the following questions 1 Is it worth the time adding auto provisioning support for the phone Indeed Adding quality auto provisioning support for a phone to XiVO requires a non negligible amount of work if you don t meet any real problem and are comfortable with provisioning in XiVO Not all phones are born equal Some are cheap Some are old and slow Some are made to work on proprietary system and will only work in degraded mode on anything else That said if you are uncertain testing will help you clarifying your idea 1 12 Developers 311 XiVO doc Documentation Release 14 08 What is the vendor model MAC address and firmware version if available of your phone Having the vendor and model name is essential when looking for documentation or other information The MAC address will be needed later on for some tests and it s always good to know the firmware version of the phone if you are trying to upgrade to a newer firmware version and you re having some troubles and when reading the d
200. ditionally only on failback Voicemail messages are not copied from the slave to the master i e if someone left a message on your voicemail when the master was down you won t be able to consult it once the master is up again More generally custom sounds are not copied back This includes recordings Here s the list of limitations that are more relevant on an administrator standpoint n the case a DHCP server is running on the master node then when the master is down phones won t be able to get a new DHCP lease so it is advised not to restart the phones The master status is up or down there s no middle status This mean that if Asterisk is crashed the XiVO is still up and the failover will NOT happen 1 10 6 Berofos Integration Berofos Integration XiVO offers the possibility to integrate a berofos failover switch within a HA cluster This is useful if you have one or more ISDN lines i e T1 E1 or TO lines that you want to use whatever the state of your XiVO HA cluster To use a berofos within your XiVO HA installation you need to properly configure both your berofos and your XiVOs then the berofos will automatically switch your ISDN lines from your master node to your slave node if your master goes down and vice versa when it comes back up You can also use a Berofos failover switch to secure the ISDN provider lines when installing a XiVO in front of an existing PBX The goal of this configuration is to mitigate the con
201. e cache plugin True Empty var cache xivo provd and restart provd Make your changes in provd plugins update the plugin version to the new one and upload to testing see below Now every time you uninstall install the plugin the new plugin will be fetched from testing instead of being cached even without changing the version Uploading to testing Before updating a plugin it must be passed through the testing phase Once it has been approved it can be uploaded to the production server Important Before uploading a plugin in the testing provd repository make sure to git pull the xivo provd plugins git repository To upload the modified plugin in the testing repo on provd xivo fr you can execute the following command 5 make upload Afterwards in the web interface you must modify the URL in section Configuration Provisioning General to http provd xivo fr plugins 1 testing You can then update the list of plugins and check the version number for the plugin that you modified Don t forget to install the plugin to test it 1 12 Developers 309 XiVO doc Documentation Release 14 08 Mass install all firmwares related to a given plugin Using provd pycli on a xivo server one can mass install firmwares Following example installs all firmwares for xivo snom 8 7 3 25 5 plugin note the auto completion provpy gt plugins installed keys a xivo snom 9 57 9515 u xivo cisco sccp legacy u
202. e var log xivo ctid log 2013 10 29 11 03 58 789 xivo ctid 25914 INFO main CTI Fully Booted in 0 660311 seconds 2013 10 29 11 03 58 789 xivo ctid 25914 INFO interface ami Asterisk Call Manager 1 3 2013 10 29 11 03 58 827 xivo ctid 25914 INFO AMI logger Event received Privilege gt system al dxtora dxtora f f for foreground Log file var log daemon 1log Lines start with xivo dxtora Oct 28 09 24 48 hostname xivo dxtora 1399 Received signal exiting Oct 28 09 24 58 hostname xivo dxtora 8562 Pulling DHCP info from unix socket provd twistd no r epoll xivo provd s v s for logging to stderr 1 12 Developers 275 XiVO doc Documentation Release 14 08 y for verbose Log file var log daemon 1log Lines start with xivo provd Oct 29 06 24 05 hostname xivo provd 8596 TFTP read request from 192 168 1 1 53014 Oct 29 06 24 05 hostname xivo provd 8596 Processing TFTP request il8n france 7960 tones xml Oct 29 06 24 05 hostname xivo provd 8596 14 Extracted device info u ip u 192 168 1 1 Oct 29 06 24 05 hostname xivo provd 8596 14 Retrieved device id caddf5dcfcc34e088687a6589b63 Oct 29 06 24 05 hostname xivo provd 8596 14 Routing request to plugin xivo cisco sccp 9 0 3 restapi xivo restapid f d f for foreground d for debug messages Log file var log xivo restapid log 2013 10 28 10 02 00 352 xivo restapid 8905 INFO xivo restapi f
203. e this is this modified caller id number which will be used in the reverse directory lookup Examples if you use a prefix to dial outgoing numbers like a 0 you should add a 0 to all add sections you may want to display incoming numbers in E 164 format For example you can change the nationall section to callerid 0 1 9 d 8 strip 1 add 33 To enable the changesyou have to restart xivo agid service xivo agid restart Time and date Configure your locale and default time zone in device template gt Configuration Provisioning plate Device by editing the default template e Configure the Timezone in gt Services IPBX General settings Advanced Timezone Reconfigure your timezone for the system dpkg reconfigure tzdata Codecs You should also select default codecs It obviously depends on the telco links the country the phones the usage etc Here is a typical example for Europe the main goal in this example is to select only G 711 A Law instead of both G 711 A Law and G 711 u Law by default SIP Services IPBX General settings SIP Protocol Signaling Customize codec activate Disable codec All Codec list 1 2 Installation 7 XiVO doc Documentation Release 14 08 G 711 A Law G 722 G 729A H 264 AX2 Services IPBX General settings IAX Protocol Default Customize activate Disallowe
204. e Call logs Call center statistics All the network configuration i e everything under the Configuration Network section the support configuration i e everything under the Configuration Support section HA settings Less importantly these are also excluded Queue logs CELs The replication only includes a partial replication of the database used by XiVO so everything that is stored outside the database is also not copied Here s an non exhaustive list of things that are not stored in the database and thus are not copied Certficates Audio files On hold music Custom dialplan Voicemail messages Provisioning configuration XiVO Client You have to enter the master and slave address in the Connect ion tab of the XiVO Client configuration The main server is the master node and the backup server is the slave node When connecting the XiVO Client with the main server down the login screen will hang for 3 seconds before connecting to the backup server 1 10 4 Internals 3 scripts are used to manage services and data replication xivo master slave db replication slave ip is used on the master to replicate the master s data on the slave server It runs on the master xivo manage slave services start stop is used on the slave to start stop monit and asterisk The services won t be restarted after an upgrade or restart e xivo check master status master ip is used to check
205. e a valid extension The Lines Device field has to be a supported device The Services Enable call transfer option has to be enabled General Lines No answer Services Voicemail Groups Func Keys First Bob Last name User picture Parcourir Aucun fichier s lectionn Mobile phone number Ringing time 30 seconds Simultaneous cals 5 vj On Hold Music default x Language z Timezone zi Caller ID Bob Outgoing Caller ID Defaut vj Preprocess subroutine User field Client Password password Profile Switchboard Description Activate the Switchboard Option for your Phone For the switchboard to work properly your Aastra or Snom phone must use a xivo aastra or xivo snom provision ing plugin respectively 152 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 The switchboard option must also be activated on the phone It s possible to activate this option only on supported phones and plugins e Edit device associated to your user in Services Devices Check the switchboard checkbox and save e Synchronize your phone to apply the changes 10 34 1 163 MAC 00 08 50 33 5 76 Plugin xiva aastra 3 3 1 SP2 Device config template Default contig device Warning be able to use a Snom phone for the switchboard you have t
206. e list using a column e g destination Columns allowed type destination direction asc or desc Sort list in ascending asc or descending desc order limit total number of function keys to show in the list Must be a positive integer skip number of function keys to skip over before starting the list Must be a positive integer search Search function keys Only function keys with a field containing the search term will be listed Error Error message Description code 400 Invalid parameters limit must be a positive the limit parameter must be a number number 400 Invalid parameters skip must be a positive the skip parameter must be a number number 400 Invalid parameters ordering parameter you must use one of the fields available in a lt field gt does not exist device when sorting a list 400 Invalid parameters direction parameter use either asc or desc as a direction when direction does not exist sorting a list Example requests List all available function key destinations GET 1l 1 func keys HTTP 1 1 Host xivoserver Accept application json List function key destinations sort by destination in descending order 1 11 and SDK 235 XiVO doc Documentation Release 14 08 G Host xivoserver Accept application json ET 1 1 func keys order destination amp direction desc List only the first 10 function key destination
207. e optional wep_key2 0102030405060708090a0b0c0d 1 12 Developers 319 XiVO doc Documentation Release 14 08 If station does not send anything in ap max inactivity seconds an empty data frame is sent to it in order to verify whether it is Still in range If this frame is not ACKed the station will be disassociated and then deauthenticated This feature is used to clear station table of old entries when the STAs move out of the range The station can associate again with the AP if it is still in range this inactivity poll is just used as a nicer way of verifying inactivity i e client will not report broken connection because disassociation frame is not sent immediately without first polling the STA with a data frame default 300 i e 5 minutes ap max inactivity 300 Disassociate stations based on excessive transmission failures or other indications of connection loss This depends on the driver capabilities and may not be available with all drivers disassoc low ack 1 Maximum allowed Listen Interval how many Beacon periods STAs are allowed to remain asleep Default 65535 no limit apart from field size max listen interval 100 WDS 4 address frame mode with per station virtual interfaces only supported with driver n180211 This mode allows associated stations to use 4 address frames to allow layer 2 bridging to be used wds sta 1 If bridge parameter is set the WDS STA interface will
208. e reload via the web interface Agents must be logged out for the following operations Adding or removing agents from the queues When changing the name of a queue only the name not the displayed name You can logoff all the agents with the following command xivo agentctl c logoff all Preprocess subroutines Subroutines on users are currently no longer executed when an agent receives a call from the queue High availability HA HA for the contact center is not supported for the moment When switching from a master to a slave you must relog all your agents SCCP Devices Available In use statuses for agents that are logged in do not work for the moment Changes in behavior In use indicator in the XiVO client XiVO 12 22 an agent is seen as In use when The agent s phone is ringing or has answered a call coming only from a queue In XiVO 12 24 The agent s phone is In use no matter where the call comes from Available indicator in the XiVO client XiVO 12 22 an agent is seen as Available when The agent is not in pause wrapup and his phone isn t ringing in conversation for a call coming from a queue In XiVO 12 24 The agent is not in pause wrapup and his phone is in the idle state Agent linked Agent unlinked Events The Agent linked event no longer exists in XiVO 12 24 xivo upgrade will automatically migrate Agent linked Agent unlinked sheets to the linked
209. e risk Simply click on allow to dial the number using the XiVO client Note If you do not want these warnings to appear each time do not forget to check uncheck the checkbox at the bottom of the popups Ubuntu There is no configuration needed GNU Linux Debian If the XiVO Client is not listed in the proposition when you open the link browse your files to find usr bin xivoclient 40 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Internet Explorer Security This program does not have a valid digital signature that verifies its publisher This program will open outside of Protected mode putting your computer at risk You should only run programs from publishers you trust FH Name rogram Files x86 VXiVO yxivoclient exe Publisher Unknown Publisher Do not show me the warning for this program again Manual association in firefox If for some reason firefox does not recognize callto ortel URIs you can manually associate them to the XiVO client using the following steps 1 Type about config in the URL bar Click the be careful I promise button to close the warning Right click anywhere in the list and select New gt Boolean Enter network protocol handler external callto as preference name N Select false as value 6 Repeat steps 3 to 6 but replace callto by telatstep 4 The next time that you click on a tel
210. e specific for a given agent Service Call center Agents Queues These settings are specific for a given agent Service Call center Agents Advanced These settings are specific for a given agent Service IPBX General settings Advanced Agent These settings are global for all agents 1 9 Contact Center 167 XiVO doc Documentation Release 14 08 General Announces Members Application No answer Advanced Schedules Diversions Name Display name Number 22 Ring strategy Ringall 000 zj Context Default default a On Hold Music default Announce when a member picks up the call J Customize the name of the caller zi Preprocess subroutine Save Figure 1 75 Services Call Center Queues Add 1 9 2 Queues Call queues are used to distribute calls to the agents subscribed to the queue Queues are managed on the Services Call Center Queues page A queue can be configured with the following options Name used as an unique id cannot be general Display name Displayed on the supervisor screen A ring strategy defines how queue members are called when a call enters the queue queue can use one of the following ring strategies Linear for each call call the first member then the second etc Least recent call the member who has least recently hung up a call Fewest calls call the member with the fewest com
211. e to time new firmwares are released by the devices manufacturer This sometimes translate to a new plugin being available for these devices When this happens it almost always means the new plugin obsoletes the older one The older plugin is then considered end of life and won t receive any new updates nor be available for new installation Let s suppose we have the old xivo aastra 3 2 2 1136 plugin installed on our xivo and want to use the newer xivo aastra 3 2 2 SP3 plugin Both these plugins can be installed at the same time and you can manually change the plugin used by a phone by editing it via the Services gt IPBX Devices page If you are using custom templates in your old plugin you should copy them to the new plugin and make sure that they are still compatible Once you take the decision to migrate all your phones to the new plugin you can use the following command provd pycli c helpers mass update devices plugin xivo aastra 3 2 2 1136 xivo aastra 3 2 2 8S Or if you also want to synchronize i e reboot them at the same time provd pycli c helpers mass update devices plugin xivo aastra 3 2 2 1136 xivo aastra 3 2 2 8S You can check that all went well by looking at the Services IPBX Devices page 1 8 Administration 141 XiVO doc Documentation Release 14 08 Remote directory If you have a phone provisioned with XiVO and its one of the supported ones you ll be able to sea
212. e used to create fairly complex rules That said it is probably not a good idea to so because it s pretty sure you ll get it somehow wrong Examples Note that when creating or editing a call permission you must at least fill the Name field have one extension extension pattern in the Extensions field Denying a user from calling a specific extension Add the extension in the extensions list n the Users tab select the user Warning The extension can be anything but it will only work if it s the extension of a user or an extension that pass through an outgoing call It does not work for example if the extension is the number of a conference room 1 8 Administration 79 XiVO doc Documentation Release 14 08 Denying a user of a group from calling a specific extension First you must create a group and add the user to this group Note that groups aren t required to have a number Then Add the extension in the extensions list n the Groups tab select the group Denying users from calling a specific extension on a specific outgoing call Add the extension in the extensions list n the Outgoing calls tab select the outgoing call Note that selecting both a user and an outgoing call for the same call permission doesn t mean the call permission applies only to that user In fact it means that the user can t call that extension and that the extension can t be called on the specific outgoing call Thi
213. eatures are guaranteed to be supported on the latest version xivo provd plugins for these devices can be installed from the officially supported devices repository Warning Funckeys work using the extensions in Services Extensions It is important to enable the function keys you want to use Warning The enable transfer option in the user configuration services tab must be enabled to use transfer function keys FK Funckey HK HardKey Y Supported MN Menu Not supported NT Not tested NYT z Not yet tested SK SoftKey Aastra 67001 series 67311 6735i 67371 67391 67551 6757 Provisioning Y Y Y Y Y Y H A Y Y Y Y Y Y Directory XIVO Y Y Y Y Y Y Funckeys 8 26 30 55 26 30 Supported programmable keys User with supervision function Y Y Y Y Y Y Group Y Y Y Y Y Y Queue Y Y Y Y Y Y Conference Room with supervision function Y Y Y Y Y Y General Functions Online call recording N N N N N N Phone status Y Y Y Y Y Y Continued on next page 1 7 Ecosystem 59 XiVO doc Documentation Release 14 08 Table 1 1 continued from previous page 67311 6735i 6737i 67391 6755i 6757 Sound recording Y Y Y Y Y Y Call recording Y Y X Y Y Y Incoming call filtering Y Y Y Y Y Y Do not disturb Y Y Y Y Y Y Group interception Y Y Y Y Y Y Listen to online calls Y Y Y Y Y Y Directory access Y Y Y Y Y Y Filtering Boss Secretary Y Y Y Y Y Y Transfers Functio
214. ebooknumber mobile number phonebooknumber home number This line would match office home and mobile numbers on incoming calls Name xivodir URI phonebook Delimiter Direct match phonebook firstname phonebook lastname phonebook Match reverse directories phonebooknumber office number phonebooknumber m amp Mapped fields r Fieldname Value kel company phonebook society E firstname phonebook firstname fullname phonebook fullname lastname phonebook lastname phonebook email mobile phonebooknumber mobile number fas phonebooknumber office number gt reverse phonebook society phonebooknumber home number g Displayed field You have now to define which field should be used to display the result This is done by defining a mapping between the field named reverse on the Mapped fields list and a database field Examples reverse gt phonebook society or reverse gt phonebook fullname The first example would show the contact s company name the caller ID name the second would show his full name Include the directory To include a directory in reverse directory definition go to Services CTI Server Directories Reverse directories and add the di
215. ecretary enablehint enablexfer section line phonenumber context protocol linename linesecret section incall incallexten incallcontext incallringseconds section voicemail voicemailname voicemailmailbox voicemailpassword voicemailemail voicemailattach voicemaildelete voicemailskippass To add a user int string string enum de en_US es ES fr fr CA bool 0 1 string string string string string string enum no boss secretary bool 0 1 bool 0 1 To add a line to an user string string enum sip sccp string string To add an incall to an user string string int To add a voicemail to a user string string string string bool 0 1 bool 0 1 bool 0 1 entity id configuration menu Must be a val User firstname User lastname LocaleMust be set if you add a voi If set to 1 username and password fields have to t XiVO Client username XiVO Client password XiVO Client profile defined in menu Services gt Customize outgoing caller id for this user Associated agent number Mobile phone number Filter Boss Secretary Enable Disable supervision Enable Disable call transfers User phone number creates aline Must exist context name internal context must ex Line protocol Line name SIP only Line secret SIP only DID number incallexten must exist ii Context name inca
216. ectory Confere lt gt Remote Directory Nom Num ro Entreprise E mail Source 1 Marty McFly 1981 McFly Inc marty mcfly com R pertoire Externe 2 Francis Lalannix 1900 Inconnue R pertoire Interne Usage Type the search term in the search box and click on the search button If the search box is empty all phonebook entries will be displayed Results can be sorted by clicking on one of the column headers By default results are sorted using the first column Your sorting preference will be saved and restored every time you reconnect 36 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Contacts Sheets Fax History Remote Directory Services Personal Directory Conference Nom Num ro Entreprise E mail Source 1 B laine Alog 988 Inconnue 2 Bruce Willis 4182552510 Inconnue 3 Etienne Lagouste 12345 Inconnue 4 Hakuna Matata 6666426 Inconnue 5 Linus Torvalds 4183333333 Inconnue Figure 1 18 Example of contacts sorted by name Service Xlet Overview The service xlet allows the user to enable and disable telephony services such as call forwarding call filter and do not disturb History Services Contacts Conference Directory Personal Directory Services Call Filtering O Do Not Disturb Call Forwards Please enter a destination to activate the checkboxes No call forward Unconditional Forward to 101 Simple call forwards 111 125 Fo
217. ed extension The update only needs to set the modified fields The new extension number must be included in one of the extension ranges for the new context Query PUT 1 1 extensions lt id gt Error code Error message Description Errors 400 error while editing Extension lt explanation gt See error message for more details 400 exten lt number gt not inside range of lt context gt 404 Not found The requested extension was not found Example request PUT 1 1 extensions 42 HTTP 1 1 Host xivoserver Content Type application json context my_context Example response HTTP 1 1 204 No Content Delete Extension An extension can not be deleted if it is associated to a line You must delete the association first Consult the documentation on Line Extension Association for further details Query DELETE 1 1 extensions lt id gt Error code Error message Description 400 error while deleting Extension lt explanation gt See error message for more details 400 Error while deleting Extension extension still has a See explanation above Errors link 404 Not found The requested extension was not found Example request DELETE 1 1 extensions 1 HTTP 1 1 Host xivoserver Example response HTTP 1 1 204 No Content Line Extension Association See Line Extension Association 1 11 API and SDK 233 XiVO doc Documentation Release 14 08 Function Ke
218. eed to put your berofos into flash mode e press and hold the black button next to the power button e power on your berofos e release the black button when the red LEDs of port D start blinking Then you can issue the following command by first replacing the network configuration with your one bnfos netconf f fosl 10 34 1 20 255 255 255 0 g 10 34 1 1 d 0 Note iis the IP address n is the netmask e g is the gateway e dq 0 is to disable DHCP You can then update your berofos firmware to version 1 53 wget http www beronet com downloads berofos bnfos_v153 bin bnfos flash bnfos_v153 bin f fosl Once this is done you ll have to reboot your berofos in operationnal mode that is in normal mode Then you must rewrite etc bnfos conf mainly if you changed the IP address bnfos scan x h berofos ip Now that your berofos has proper network configuration and an up to date firmware you might want to set a password on your berofos bnfos set apwd lt password gt f fosl bnfos set pwd 1 f fosl You must then edit the etc bnfos conf and replace the login line to something like login admin lt password gt Next configure your berofos for it to work correctly with the XiVO HA bnfos set wdog 0 f fosl bnfos set wdogdef 0 f fosl bnfos set scenario 0 f fosl bnfos set mode 1 f fosl bnfos set modedef 1 f fosl This among other things disable the watc
219. efault Internal pcm dev pcm dev eo LI gt from extern Incalls Incall pcm dev pcm dev e L1 gt invalid invalid Incall pem dev pem dev gt pcm dev pcm dev Internal pem dev pcm dev 02 gt statscenter statscenter Internal pem dev pcm dev e gt switchboard directory Switchboard Other pem dev pem dev o gt to extern Outcalls Outcall pem dev pcm dev e Display filter new display filter must be created for the directory xlet The following fields must be configured with the correct value for the Field type column in order for entries to be displayed in the xlet l status is the column that will be used to display the status icon the title can be empty 32 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Name switchboard Available display formats db phone db firstname db lastname db fullname db company db mail Lu 8 Description name is displayed in the Name column of the xlet number office is displayed in the Number column with a phone icon in the xlet number mobile is displayed in the Number column with a mobile icon in the xlet A N number any other field starting with number will be displayed in the Number column of the xlet with a generic directory icon 6 Any other field will be displayed in their own column of the directory xlet The values in the Display format column
220. eld Required Description context yes device_slot yes Line position on device Errors Error code Error message Description 400 error while creating Line lt explanation gt See explanation for more details 400 Invalid parameters context lt context gt does not exist 400 Invalid parameters device_slot must be numeric Use a positive number for the device slot Example request POST 1 1 lines_sip HTTP 1 1 Host xivoserver Accept application json Content Type application json context default device slot 1 Example response HTTP 1 1 201 Created Location 1 1 lines_sip 1 Content Type application json var d Context default username abcdef secret secret password provisioning extension 123456 device slot 1 callerid null Links rel ines sip href https xivoserver 1 1 lines_sip 1 1 11 and SDK 243 XiVO doc Documentation Release 14 08 Update a SIP Line Only fields that need to be updated should be sent other fields will remain unmodified during the update Query PUT 1 1 lines sip id Errors Same as for creating a SIP line Please see Create SIP line Example request PUT 1 1 lines sip 67 HTTP 1 1 Host xivoserver Content Type application json context my context Example response HTTP 1 1 204 No Content Delete SIP Line SIP line can not be deleted if it is
221. elow an example of file etc asterisk dahdi channels conf Be careful to three parameters group context signalling Example Span 1 4 0 1 TE4XXP PCI Card 0 Span 1 MASTER group 0 11 context from extern switchtype euroisdn signalling pri cpe channel 1 15 17 31 Span 2 4 0 2 TEAXXP PCI Card 0 Span 2 group 0 12 context from extern switchtype euroisdn signalling pri cpe channel 32 46 48 62 Span 3 4 0 3 TE2XXP PCI Card 0 Span 3 group 2 13 context from pabx overlapdial incoming switchtype euroisdn signalling pri net 118 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 channel gt 63 77 79 93 Span 4 4 0 4 TAXXP PCI Card 0 Span 4 group 2 14 context from pabx overlapdial incoming switchtype euroisdn signalling pri net channel 94 108 110 124 Passthru function Create the from pabx context Create a file named xxxxx conf where xxxxx is the customer name in the directory etc asterisk extensions extra d Add the following lines in the file f rom pabx exten X 1 NoOp Appel depuis Pabx exten _X n goto default EXTEN 1 This dialplan allows to route incoming calls from the PBX in the default context of XiVO Then calls are routed Or to a SIP phone in default context Orto the outgoing to extern context included in def
222. els conf files Configure Modify the etc dahdi system conf file Check the span numbering f needed change the clock source Usually at least in France you should remove the crc4 Following is an example etc dahdi system conf file for a B410P 4 ports for French net work check the comments and see the etc dahdi system conf section Span 1 B4 0 1 BAXXP PCI Card 0 Span 1 MASTER RED Span 1 this is the first span 1 0 this is the primary clock source ccs use ccs framing ami use ami coding span 1 1 0 ccs ami dE db dE db db dE 108 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 termtype te bchan 1 2 hardhdlc 3 echocanceller mg2 1 2 Span 2 4 0 2 B4XXP PCI Card 0 Span 2 RED span 2 2 0 ccs ami termtype te bchan 4 5 hardhdlc 6 echocanceller mg2 4 5 Span 3 B4 0 3 B4XXP PCI Card 0 Span 3 RED span 3 3 0 ccs ami termtype te bchan 27 8 hardhdlc 9 echocanceller mg2 7 8 Span 4 4 0 4 BAXXP PCI Card 0 Span 4 R span 4 this is the fourth span 0 won t use this span as a sync source 0 ccs use ccs framing ami use ami coding span 4 0 0 ccs ami termtype nt bchan 10 11 hardhdlc 12 echocanceller mg2 10 11 Modify the etc asterisk dahdi channels conf file remove the unused lines like context default group 63 Change the context lines if needed e The s
223. ember count Started since conf2 801 No 2 00 14 27 conf3 802 No 0 Not started my test conferen 800 Yes 0 Not started Usage The Conference room list tab show all available conference rooms configured on the XiVO The user can right click on a conference to join the conference When a user joins a conference his phone will ring and the conference will be joined when the user answers the phone When left clicking on a conference room a new tab is opened for the selected conference room The new tab contains information about the members of the conference The name and number of the member will be displayed when available Users can also mute and unmute themselves using the microphone icon on the left Contacts Fax History Directory Services Personal Directory Conference Conference room list 801 X Conference room 801 M Name Number Since P re No l 1000 00 18 45 Fernando L Ig ane 1001 00 18 29 28 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Contact Xlet Overview The Contacts XLet lists the people of your company giving you access to their phone and XiVO Client status Name or number to search Albert Dupond B r nice Martin m Claire Tremblay 3 m Usage The Search text input allows you to filter the list of people according to their name or phone number An empty filter displays all contacts found If the filter matches some contacts you
224. en a configuration has been modified and the changes need to be sent to the device Query GET 1 1 devices lt id gt synchronize Parameters id Device s id Example request GET 1 1 devices 412c212cff500cc158f373f 00e078f7 synchronize Host xivoserver Example response HTTP 1 1 204 No Content Associate a line to a device Warning This feature is not yet accessible nor functional After associating a line the device needs to be synchronized for the changes to take effect Please see Synchronize a device Query GET 1 1 devices lt id gt associate_line lt lineid gt Parameters id Device s id line id Line id Example request GET 1 1 devices 412c212cff500cc158 373 00e078 7 associate line 2 Host xivoserver 1 11 and SDK 229 XiVO doc Documentation Release 14 08 Example response HTTP 1 1 204 No Content Remove a line from a device Warning This feature is not yet accessible nor functional After removing a line the device needs to be synchronized for the changes to take effect Please see Synchronize a device Query GET 1 1 devices id remove line lineid Parameters id Device s id line id Line id Example request GET 1 1 devices 412c212cff500cc158 373 f 00e078f7 remove line 2 Host xivoserver Example response HTTP 1 1 204 No Content Extensions extension represents a number that can be dialed on a phone Once an extension is created
225. ension your phone will ring and you will be told that the extension is not valid The numbers you dialed are stored in the drop down list of the text box Configuration In the menu XiVO Client Configure Functions Dial you can choose how much dialed extensions will be saved between two connections In the menu XiVO Client Configure GUI Settings you can enable the integration of the clipboard in the XiVO Client all text selected in other programs will be automatically pasted in the Dial text box This feature currently only works on GNU Linux systems 1 5 4 Configuration The XiVO client configuration options can be accessed under XiVO client configure 38 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Connection Configuration Configuration Connection Account GUI Settings Functions Advanced Server Host 192 168 32 127 Login Port 5003 Encrypt Connection Try to reconnect Checking this box disables the Error Popups 0500 Keep alive interval 10 2 Came This page allows the user to set his network information to connect to the xivo ctid server Server Host is the IP adress of the server Login Port is the port on wich xivo ctid is listening for connections default 5003 Encrypt Connection is the option to encrypt messages between the client and the server default port 501
226. ension determines from what source a call can arrive Currently this service only supports extensions inside the following context types internal Used for calling a line with an internal number e g 1000 default incall Used for calling a line from the outside e g from extern with a DID Field Value Description Association Representation line id int Line s ID extension id int Extension s ID Get the Extension associated to a Line Query GET lines line id extensions Error code Error message Description Beros and Line with id lt line_id gt does not exist Example Request GET lines 34 extensions Host xivoserver Accept application json 1 11 and SDK 247 XiVO doc Documentation Release 14 08 Example Response HTTP 1 1 200 OK Content Type application json toral s 2 items line id 34 extension id 12 21 rel 11 href https xivoserver 1 1 lines 34 rel extensions href https xivoserver 1 1 extensions 12 line_id 34 extension_id 13 rel lines href https xivoserver 1 1 lines 34 rel extensions href https xivoserver 1 1 extensions 13 Get the Lines associated to an Extension Query GET extensions lt extension_id gt lines Errors Error code Error message Des
227. enter 177 XiVO doc Documentation Release 14 08 orange if In use Note that the agent status will only change when the communication is established not when phones are ringing Known bugs 1 If an agent emits a call via his XiVO Client the status will change to Int Outgoing or Ext Outgoing when the destination phone rings instead of when the destination answers 2 Given the agent is on an ACD call When the agent logs out When the agent hangs up the ACD call When the agent logs back in via CTI Client Then the agent may be seen as outgoing non ACD communication whether there is a non ACD com munication or not To make the agent Not in use again make a non ACD call and hangup 3 Given the agent is on ACD call When the agent calls someone else e g his supervisor When the ACD call hangs up while the agent talks to his supervisor Then the agent is seen as available instead of in outgoing non ACD communication This applies to all kinds of non ACD calls Changing the disposition The disposition of the Xlet can be changed in two ways Placement of queues Which queues are displayed The disposition is saved whenever the XiVO Client is closed and restored when it is opened again Changing the placement of queues The little windows containing each queue can be resized and moved around That way any layout can be achieved according to the size and importance of each queue Choosing which
228. enumber profileclient client ringseconds 30 simultcalls 5 voicemailid null 152 lines enablexfer false entityid 1 firstname User fullname User Bl incallfilter false lastname Bl loginclient userbl mobilephonenumber profileclient client ringseconds 30 simultcalls 5 ctistat ctistat display various statistic about a CTI session when it ends The simplest invocation is cti proxy ctistat xivo new CTI Protocol Protocol Changelog Warning CTI server protocol is subject to change without any prior warning If you are using this protocol in your own tools please be sure to check that the protocol did not change before upgrading XiVO 14 06 the dial success message was added 14 05 the unhold switchboard command was renamed resume switchboard 13 22 the actionfiche message was renamed call form result 1 12 Developers 287 XiVO doc Documentation Release 14 08 13 17 e for messages of class 1ogin capas from server to client the key presence has been removed 13 14 e for messages of class get list list agents and function updatestatus the key availability in the status object dictionary has changed values deleted values call non acd incoming and call non acd outgoing added values on call incoming internal on cal
229. ephone link firefox will ask you to choose an application You will then be able to choose the XiVO client for handling telephone numbers 1 6 System 1 6 1 XiVO service XiVO has many running services To restart the whole stack the xivo service command can be used to make sure the service is restarted in the right order Usage Show all services status xivo service status Stop XiVO services xivo service stop Start services 1 6 System 41 XiVO doc Documentation Release 14 08 xivo service start Restart XiVO services xivo service restart The commands above will only act upon XiVO services Appending an argument a11 will also act upon nginx and postgresql Example xivo service restart all UDP port 5060 will be closed while services are restarting 1 6 2 Network You must configure your network interfaces directly from the XiVO web interface via the Configuration Network Interfaces page The Voip interface is used by the DHCP server and the provisioning server How to You can only have one VoIP interface which is ethO by default This interface is configured during the wizard The DHCP server and provisioning server among other use information from the VoIP interface in its configura tion For example the DHCP server will only listen on the VoIP interface per default To change this interface you must either create a new one or edit an existing one and change its type to V
230. ervices are still being developped and can be changed without prior warning Use at your own risk Here is a list of services in BETA stage Function Keys Line Extension Associations Call Logs Call Logs Representation 220 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Field Values Description Calldate date YYYY MM DDTHH MM SS ae Caller string Description Called string Period integer Number of seconds of the call 0 if not answered user Field string Example Call Date Caller Called Period user Field 2013 01 02T00 00 00 source2 1002 2002 2 userfield Format Calllogs are presented in CSV format with the following specifications field names are listed on the first line fields are separated by commas if there is a comma in a field value the value is surrounded by double quotes the CSV file uses the character encoding UTF 8 List Call logs Note Call logs are generated automatically but not immediately See Call Logs Query GET 1 1 11 1095 Example request GET 1 1 call logs HTTP 1 1 Host xivoserver Accept text csv Example response HTTP 1 1 200 OK Content Type text csv charset utf8 Call Date Caller Called Period user Field 2013 01 01T00 00 00 sourcel 1001 2001 1 2013 01 02T00 00 00 source2 1002 2002 2 userfield Filtering by period Query GET 1 1 call logs start date DATE amp end date DATE
231. ery maximum timeout in TU 1 024 ms for maximum time to wait for a SA Query response dotllAssociationSAQueryMaximumTimeout 1 4294967295 assoc sa query max timeout 1000 326 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Association SA Query retry timeout in TU 1 024 ms for time between two subsequent SA Query requests dotllAssociationSAQueryRetryTimeout 1 4294967295 assoc sa query retry timeout 201 disable pmksa caching Disable PMKSA caching This parameter can be used to disable caching of PMKSA created through EAP authentication RSN preauthentication may still end up using PMKSA caching if it is enabled preauth 1 0 PMKSA caching enabled default 1 PMKSA caching disabled disable pmksa caching 0 okc Opportunistic Key Caching aka Proactive Key Caching Allow PMK cache to be shared opportunistically among configured interfaces and BSSes i e all configurations within a single hostapd process 0 disabled default 1 enabled okc 1 t IEEE 802 11r configuration Mobility Domain identifier dotll1FTMobilityDomainID MDID MDID is used to indicate a group of APs within an ESS i e sharing the same SSID between which a STA can use Fast BSS Transition 2 octet identifier as a hex string mobility domain alb2
232. es are not migrated automatically so you must manually copy them from the old plugin directory to the new one This does not apply for a plugin upgrade Let s suppose we have installed the xivo aastra 3 2 2 SP3 plugin and want to write some custom tem plates for it First thing to do is to go into the directory where the plugin is installed var lib xivo provd plugins xivo aastra 3 2 2 S8P3 Once you are there you can see there s quite a few files and directories 1 8 Administration 139 XiVO doc Documentation Release 14 08 tree common py t enLry py t pkgs pkgs db plugin info README templates 6730i tpl 67313 tpl 6739i tpl 6753i tpl 6755i tpl t 675 i tpl 9143i tpl 9480i tpl base tpl F var cache installed templates tftpboot Aastra aastra cfg The interesting directories are templates This is where the original templates lies You should not edit these files directly but instead copy the one you want to modify in the var templates directory var templates This is the directory where you put and edit your custom templates var tftpboot This is where the configuration files lies once they have been generated from the templates You should look at them to confirm that your custom templates are giving you the result you are expecting Warning When you uninstall a plugin the plugin d
233. es or add new profiles in the menu CTI Server Profiles Xlets To choose which features are available to users using a profile you have to select which Xlets will be available The Xlets are detailed in 15 The Position attribute determines how the Xlets will be laid out dock will display a Xlet in its own frame This frame can have some options Floating means that the frame can be detached from the main window of the CTI Client Closable means that the Xlet can be hidden Movable means that the Xlet can be moved either inside the main window or outside Scroll means that the Xlet will display a scroll bar if the Xlet is too large grid will display a Xlet inside the main window and it will not be movable Multiple grid Xlets will be laid out vertically the second below the first fab will display a Xlet inside a tab of the Xlet Tabber Thus the Xlet Tabber is required and can t be in a tab position The Number attribute gives the order of the Xlets beginning with 0 The order applies only to Xlets having the same Position attribute 84 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 First name Last name Wonderland User picture Browse Mobile phone number 41 Schedules Ringing time 30 seconds Simultaneous calls 52 On Hold Music defaut Language d sl Caller ID Alice Wonderland Outgoing C
234. esget featuresput directory Request directory information names matching pattern ignore case Client gt Server class directory commandid 1079140548 pattern pau Server gt Client class directory headers Nom NumNu00e9ro Mobile Autre numNu00e9ro E mail Fonction Site replyid 1079140548 resultlist Claire Mapaurtal 33644558899 31256 cmapaurtal societe com Paul Salvadier 33445236988 33678521430 31406 psalvadier societe com status ok timenow 1378798928 26 parking logfromclient keepalive 1 12 Developers 303 XiVO doc Documentation Release 14 08 availstate filetransfer faxsend getipbxlist class getipbxlist commandid commandid ipbxcommand class ipbxcommand command originate commandid lt commandid gt destination user special myvoicemail source user special me CTI server implementation In the git repository git github com xivo pbx xivo ctid git under xivo ctid cti config handles the configuration coming from the WEBI interfaces interface ami together with asterisk ami definitions amiinterpret and ami handle the AMI connections asterisk interfaces interface fagi handles the FAGI connections still asterisk interfaces interface info handles the CLI like connections interfaces interface webi handles the requests and signals coming fro
235. eters line with id line id already has an extension You must unassociate the current extension before reassociating a new one Example request POST 1 1 lines 75 extension Host xivoserver Content Type application json extension id 46 Example response HTTP 1 1 201 Location 1 1 lines 75 extension Whine Tes 75 extension_id 46 Wan kiss AF rel lines_sip href https xivoserver 1 1 lines_sip 75 246 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 rel extensions href https xivoserver 1 1 extensions 46 Dissociate an Extension from a Line Any devices that are attached to the line must be removed before dis sociating an extension from its line A device can be dissociated be resetting it to autoprov mode Consult the documentation on Devices for further details Query DELETE 1 1 lines lt line_id gt extension Error code Error message Description Errors 404 Line with id lt line_id gt does not exist 400 Invalid parameters A device is still associated to the line Example request DELETE 1 1 lines lt line_id gt extension Host xivoserver Example response HTTP 1 1 204 No Content Line Extension Associations Connects an extension with a line allowing the line to be called by dialing a number A line can be associated with one or more extensions The context of an ext
236. eue Client gt Server class ipbxcommand command queueadd commandid 542766213 member agent xivo 3 Remove an agent from a queue Client gt Server class ipbxcommand command queueremove commandid 742480296 member agent xivo Listen to an agent Client gt Server class ipbxcommand command listen commandid 1423579492 destination xivo 1 Service Messages class featuresput Call Filtering function incallfilter value true false activate deactivate filtering Client gt Server class featuresput commandid 1326845972 function incallfilter value true Server Client class getirst config incallfilter true function updateconfig listname users werde Wow Limenow 1361456398 52 tipbxid xivo DND function enablednd value true false activate deactivate DND Client gt Server class featuresput commandid 1088978942 function enablednd value true Server Client 298 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 class getlist config enablednd true function updateconfig listname users TAN Limenow 1361456614 55 tipbxid xivo Recording function enablerecording value true false Activate deactivate recording for a user extension call recording has to be
237. eved from the REST server JSON is used to encode returned or sent data Therefore the following headers are needed when the request is supposed to return JSON Accept application json when the request s body contains JSON Content Type application json Note Optional properties can be added without changing the protocol version in the main list or in the object list itself Properties will not be removed type and name will not be modified Getting object lists GET 1 1 objects When returning lists the format is as follows total number of items in total in the system configuration optional items returned data as an array of object properties list Other optional properties can be added later Response data format Totals 2y items 1 propl test WoW propri Getting An Object Format returned is a list of properties The object should always have the same attributes set the default value being the equivalent to NULL in the content type format GET 1 1 objects lt id gt Response data format ig IT propi Wes 1 11 and SDK 219 XiVO doc Documentation Release 14 08 Data sent to the REST server The XiVO REST server implements POST and PUT methods for item creation and update respectively Data is created using the POST method via a root URL and is updated using the PUT method via a root URL suffixed by lt i
238. evice slot 2 device id 4c63136208fb117935ce874e6eeba25e links rel lines custom href https xivoserver 1 1 lines custom 2 1 Fy gs 525 Context default name SCCP 1234 protocol scop provisioning extension 382731 device slot 1 device id 3s631t620gfb717835ce8a4e6efba85g links 240 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 rel href Get Line Query GET 1 1 lines line id Example request GET 1 1 lines 42 HTTP 1 1 Host xivoserver Accept application json Example response HTTP 1 1 200 OK lines sccp https xivoserver 1 1 lines sccp 3 Content Type application json 42 Context default name alb2c4 protocol sip provisioning extension 342395 device slot 1 device id 2b63136208fb117335ce874e65eba2a3 Ixnks ez rel lines sip href https xivoserver 1 1 lines sip 42 1 SIP Lines Line Representation Description Field Value Description id int Read only context string username string Read only secret string Read only provisioning extension int Read only device slot int Line s position on the device callerid string Read only links list The link to the resource List SIP Lines Query GET 1 1 lines_sip Example request 1 11 and SDK 241 XiVO doc
239. ew span This number MUST be unique timing describes the how this span will be considered regarding the synchronisation 0 do not use this span as a synchronisation source 1 use this span as the primary synchronisation source 2 use this span as the secondary synchronisation source etc LBO 0 not used framing correct values are ccs or cas For ISDN lines ccs is used e coding correct valus are hdb3 or ami For example hdb3 is used for an E1 PRI link whereas ami is used for TO french BRI link crc4 this is a framing option for PRI lines For example it is rarely use in France Note that the dahdi genconf command should usually give you the correct parameters if you correctly set the cards jumper these information should be checked with your operator 1 8 Administration 113 XiVO doc Documentation Release 14 08 letc asterisk chan dahdi conf This file contains the general parameters of the DAHDI channel It is not generated via the dahdi genconf command etc asterisk dahdi channels conf This file contains the parameters of each channel It is generated via the dahdi_genconf command 1 8 17 Incall General Configuration You can configure incoming calls settings in Services IPBX Call Management Incoming calls DID Direct Inward Dialing Configuration When character is prepended a called DID the character is discarded Example Bob has a DID w
240. f Google Mock e g on Debian Wheezy 5 CONFIG tests CONFIG gmock To compile the XiVO Client ready for functional tests make FUNCTESTS yes Cleaning make distclean Launch You can launch the built executable with LD LIBRARY PATH bin bin xivoclient Package To create the Debian package usable on Debian and Ubuntu you first need to modify build deps to locate the Qt 5 installation directory path to qt5 bin qmake spec linux g 4 make make pack 336 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 This will result in a deb file in the current directory The version of the package is taken from the describe command Building the XiVO Client on Mac OS This page explains how to build an executable of the XiVO Client from its sources for Mac OS Mac OS Prerequisites Developer tools You will need an Apple developer account to get development tools such as GCC To log in or sign in go to http connect apple com In the Downloads section get the Command line Tools for XCode and install them You might want to get XCode too but it is rather big Qt SDK You need the development files of the Qt 5 library available on the Qt website Get sources bash shell enter git clone git github com xivo pbx xivo client qt git Building Launch qmake to generate the Makefile cd xivo client qt path to qt5 bin qmake spec macx g This will als
241. f7 HTTP 1 1 Host xivoserver Accept application json Example response HTTP 1 1 200 OK Content Type application json id 412c212cff500cc158 373 00e078 f7 Oy mac 00 00 5e 00 00 01 sn null vendor Aastra model 67311 version 3 2 2 plugin xivo aastra 3 2 2 SP3 description null status configured options null Lemplate id defaultconfigdevice I rel devices href https xivoserver 1 1 devices 412c212cff500cc158 373 00e078 7 Create a Device Query POST 1 1 devices Field Required Values Description 1 no string see above mac no string see above sn no string see above Input vendor no string see above model no string see above version no string see above description no string see above options no object see above template id no string see above 226 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Error Error message Description code 400 error while creating Device explanation See explanation for more details 400 Invalid parameters ip ip address is not formatted correctly 400 Invalid parameters mac mac address is not formatted correctly 400 Invalid parameters options options is not an object Errors 400 Invalid parameters options switchboard switchboard option is not a boolean 400 device lt mac gt already exis
242. face e g eth0 10 and the voip mtu to the new MTU e g 1488 1 6 System 47 XiVO doc Documentation Release 14 08 Note In the above example you can set a different MTU per interface If you don t need a per interface MTU you can simply write bin sh ip link set IFACE mtu my mtu 1 6 3 Proxy Configuration If you use XiVO behind an HTTP proxy you must do a couple of manipulations for it to work correctly Global configuration Some programs are able to use proxy information the http proxy environment variables You can set and export this variable with export http proxy http domainNusername password8 proxyip proxyport where domain the user s domain username the username used to login via the proxy password the password used to login via the proxy proxyip the IP of the proxy proxyport the port used by the proxy If you need to have these settings ready at each connection you can store them in your bashrc file If you need to reset the http proxy environment variable issue the command unset http proxy apt Create the etc apt apt conf d 90proxy file with the following content Acquire http Proxy http domain username password proxyip proxyport provd Proxy information is set via the Configuration Provisioning General page dhcp update This step is needed if you use the DHCP server of the XiVO Otherwise the DHCP configuration won t be co
243. fault a mail backend named ma i1 is defined You can define more mail backends if you want Just look what the default mail backend looks like Using the log backend There s also a log backend available which can be used to write a line to a file every time a fax is received Fax detection XiVO does not currently support Fax Detection A workaround is described in the Fax detection section Using analog gateways XiVO is able to provision Linksys SPA2102 SPA3102 and SPA8000 analog gateways which be used to connect fax equipments This section describes the creation of custom template for SPA3102 which modifies several parameters Note Be aware that most of the parameters are or could be country specific i e Preferred Codec FAX Passthru Codec RTP Packet Size RTP Start Loopback Codec Ring Waveform Ring Frequency Ring Voltage FXS Port Impedance Create custom template for the SPA3102 base template cd var lib xivo provd plugins xivo cisco spa3102 5 1 10 var templates cp templates base tpl 2 Add the following content before the 1at profile tag lt CUSTOM TPL for faxes START gt for line no line in sip lines iteritems Dial Plan L line no gt 1 8 Administration 101 XiVO doc Documentation Release 14 08 Dial Plan line no _ ua na gt x lt Dial_Plan_ line no _ gt Call Waiting Serv line no _
244. form When this option is activated the user can press during a conversation to start stop online call recording The recorded file will be available in the monitor directory of the Services IPBX Audio files menu 26 call recording You can enable disable the recording of all calls for a user in 2 different way 1 By checking the Call recording box of the user form 162 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 General Enable call transfer Enable online call recording Call recording Incoming call filtering Do not disturb Filter Boss Secretary s Figure 1 68 Users Services Voicemail JGroups Func Keys Enable supervision Enable call transfer Enable online call recording Call recording C Incoming call filtering Do not disturb Filter Boss Secretary Figure 1 69 Users Services 1 8 Administration 163 XiVO doc Documentation Release 14 08 2 By using the extension 26 from your phone the call recording option must be activated in Services gt IPBX Extensions When this option is activated all calls made to or made by the user will be recorded in the monitor directory of the Services IPBX Audio files menu 1 8 29 Voicemail Voicemail Configuration
245. from where the lookup is requested did internal forcelookup xivo direction incoming or internal xivo did DID number xivo calleridnum xivo calleridname xivo calleridrdnis contains information whether there was a transfer xivo calleridton Type Of Network national international xivo calledidnum xivo calledidname xivo ipbxid xivo astid in 1 1 xivo directory for directory requests it is the directory database the item has been found xivo queuename queue called xivo agentnumber agent number called xivo date formatted date string xivo time formatted time string when the sheet was triggered xivo channel asterisk channel value for advanced users xivo uniqueid asterisk uniqueid value for advanced users db prefixed variables are defined when the reverse lookup returns a result For example if you want to access to the reverse lookup full name you need to define a field fullname in the directory definition mapping to the full name field in your directory The db fullname will be replaced by the caller full name Every field of the directory is acces sible this way dp prefixed ones are the variables set through the dialplan through UserEvent application For example if you want to access from the dialplan to a variable dp test you need to add in your dialplan this line in a subroutine UserEvent dialplan2cti UNIQUEID UNIQUEID CHANNEL S CHANNEL VARIABLE
246. g a LDAP Filter Enter the following information Name the filter s display name LDAP server the LDAP server this filter applies to 74 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 User the dn of the user used to do search requests Password the password of the given user Base DN the base dn of search requests Filter if specified it replace the default filter Phone number type this string is appended next to each result display name You ll also probably need to modify some values in the Attributes tab General Attributes NL LL PEE RE P LEEREN ET AM ul 1 DIDIT ITI D II TL telephoneNumber dE 8 Figure 1 30 Adding a LDAP Filter In the Display name section add and order the attributes that are going be used to display the results The first attribute will be used for each result which have this attribute else the second will be used etc The Phone number section is similar but is used for the phone number in the results Use a Custom Filter some cases you might have to use a custom filter for your search requests instead of the default filter By default the search tries to match any attribute you choose in the Attributes tab In custom filters occurrence of the pattern Q is replaced by what the user entered on its phone Here s some exam
247. g id enabled yes bool Enable disable the CTI Error Error message Description code 404 User with id lt user_id gt does not exist Errors 400 Nonexistent parameters cti profile id cti profile id does not exist 400 Error while editing user id the user must have a username Add a username and a and password to enable the CTI password to the user Example request PUT 1 1 users 75 cti Host xivoserver Content Type application json cti profile id 3 enabled true Example response HTTP 1 1 204 No Content User Line Association Service for associating a user with a line Association Representation 256 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Description Field Value Description line id bool Line s ID main user boolean Read only True if the user is the first to have been associated to the line main line boolean Read only To be implemented later Always true links list The links to the related resources Get the Lines associated to a User Query Errors GET 1 1 users user id lines Error code Error message Description 404 User with id lt user_id gt does not exist Example request GET 1 1 users 20 lines Host xivoserver Accept application json Example response HTTP 1 1 200 OK Content Type total items user id 20 line id 132 main user
248. gent time callid queuename agent event 2012 07 04 07 33 23 085718 1341401601 24 1 Agent 3001 CONNECT 2 2012 07 04 07 33 21 165823 1341401601 24 ql NONE ENTERQUEUE Agent or caller ends the call after 12 seconds time callid queuename agent event t 2012 07 04 07 37 46 601754 1341401851 34 ql Agent 3001 COMPLETEAGENT 2 Call on a full queue time callid queuename agent event 2012 07 04 07 40 17 339945 1341402016 44 ql NONE FULL Call closed queue time callid queuename agent event t 2012 07 04 07 48 03 455999 1341402482 49 ql NONE CLOSED 1 11 and SDK 217 XiVO doc Documentation Release 14 08 Caller abandon before an answer time callid queuename agent event 2012 07 04 07 49 52 939802 1341402586 51 ql NONE 1 11 4 REST API The XiVO REST is the privileged way to programmatically interact with XiVO The current API version is Configuration ABANDON The REST API is available via HTTPS on port 50051 Accessing the REST API requires to create a webservices user in the web interface Configuration Management Web Services Access if an IP address is specified for the user no authentication is needed if you choose not to specify an IP address for the user you can connect to the REST API with a HTTP Digest authentication using the
249. h 2 keys user id an integer corresponding to the user ID of the client who saved the call form variables a dictionary holding the content of the form Example name call form result data 4 user id 40 variables filrstname John lastname Doe 1 11 3 Queue logs Queue logs are events logged by Asterisk in the queue log table of the asterisk database Queue logs are used to generate XiVO call center statistics 216 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Queue log sample Agent callback login time callid queuename agent event 2012 07 03 15 27 23 896208 1341343640 4 NONE Agent 3001 AGENTCALLBACKLOGIN 100 Agent callback logoff Agent 3001 is logged in queues q1 and q2 time callid queuename agent event 2012 07 03 15 28 07 348244 q2 Agent 3001 UNPAUSE 2012 07 03 15 28 07 346320 91 Agent 3001 UNPAUSE 2012 07 03 15 28 07 327425 NONE Agent 3001 UNPAUSEALL 2012 07 03 15 28 06 249357 NONE Agent 3001 AGENTCALLBACKLOGOFF 100 Call on a Queue with join empty conditions met time callid queuename agent event t 2012 07 04 07 27 55 640421 1341401275 9 1 NONE JOINEMPTY Enter the queue and get answered by an a
250. handled by XiVO 1 6 9 NTP XiVO has a NTP server that must be synchronized to a reference server This can be a public one or customized for specific target networking architecture XiVO s NTP server is used by default as NTP server for the devices time reference Usage Show NTP service status etc init d ntp status Stop NTP service etc init d ntp stop Start NTP service 1 6 System 57 XiVO doc Documentation Release 14 08 etc init d ntp start Restart NTP service etc init d ntp restart Show NTP synchronization status ntpq p Configuring NTP service 1 Edit etc ntp conf 2 Give your NTP reference servers server 192 168 0 1 LAN existing NTP Server server O0 debian pool ntp org iburst dynamic default in ntp conf server l debian pool ntp org iburst dynamic default in ntp conf 3 f no reference server to synchronize to add this to synchronize locally server 127 127 1 0 local clock LCL fudge 127 127 1 0 stratum 10 LCL is not very reliable 4 Restart NTP service 5 Check NTP synchronization status Warning If 5 shows that NTP doesn t use NTP configuration in etc ntp conf maybe have you done a dhclient for one of your network interface and the dhcp server that gave the IP address also gave a NTP server address Thus you might check if the file var lib ntp ntp conf dhcp exists if yes this is used for NTP configuration prior to etc ntp conf Remove it and restart NTP
251. hdog The switching from one relay mode to the other will be done by the XiVO slave node once it detects the master node is down and vice versa 204 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Finally you can make sure everything works fine by running the xivo berofos command xivo berofos master The green LEDs on your berofos should be lighted on ports A and B Connection Two XiVOs Here s how to connect the ISDN lines between your berofos with two XiVOs in high availability In this configuration you can protect up two 4 ISDN lines If more than 4 ISDN lines to protect you must set up a Multiple berofos configuration Here s an example with 4 ISDN lines coming from your telephony provider ISDN lines provider A B C D 1121314 1121314 1121314 1121314 Two XiVOs and PBX Here s how to connect your berofos with two XiVOs in high availability one PBX In this configuration you can protect up two 2 ISDN lines If more than 2 ISDN lines to protect you must set up a Multiple berofos configuration Logical view PBX Phones Provider xivo 1 ISDN Interconnection xivo 2 This example shows the case where there are 2 ISDN lines coming from your telephony provider ISDN lines provider C D 1121314 112 314 1121314 112 314 NET CPE NET spans
252. he Services Call management Call pickups page In the general tab you can define a name and a description for the pickup group In the Interceptors tab you can define a list of users groups or queues that can intercept calls In the ntercepted tab you can define a list of users groups or queues that can be intercepted General Interceptors Intercepted Groups 0 items selected Remove all Add huge 30008 pcm dev Queues Create queue Users 5 3 items selected Remove all Add all 1 P re User 0500 3 Linda 0501 3 Fernando L Ig ane User 0502 N User 0503 d User 0504 User 0505 User 0506 5 Save Enabling an Interception Extension The pickup extension can be defined in the Services Extensions page 1 8 Administration 105 XiVO doc Documentation Release 14 08 The extension used by group pickup is called Group interception it s default value is 8 Warning The extension must be enabled even if a function key is used Adding a Function Key to an Interceptor To assign a f
253. he current voicemail already has a voicemail before reassociating a new one Example request POST 1 1 users 59 voicemail Host xivoserver Content Type application json voicemail id 432 enabled false 266 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Example response HTTP 1 1 201 Location 1 1 users 59 voicemail voicemail id 432 user id 59 enabled false rel voicemails href https xivoserver 1 1 voicemails 432 rel users href https xivoserver 1 1 users 59 Deassociate a User from a Voicemail Query D EL 1 1 users lt user_id gt voicemail Example request DELETE Host 1 1 users 20 voicemail xivoserver Example response HTTP 1 1 204 No Content Configuration Parameter Values Description Configuration parameters live_reload bool Get live reload status Query GET 1 1 configuration live_reload Example requests GET 1 1 configuration live_reload HTTP 1 1 Host xivoserver Accept application json Example response 1 11 and SDK 267 XiVO doc Documentation Release 14 08 HTTP 1 1 200 OK Content Type application json enabled true Links T rel configuration href https xivoserver 1 1 configuration live_reload Change live reload status Query PUT 1 1 configuratio
254. he phone app services Start a custom application on the phone Function Key destinations for speed dials destination determines the number to dial when using speeddial function keys Destinations are configured by specifying the type of destination and its id Destinations are pre generated every time a new resource is created In other words a new destination will appear in the List of Function Key Destinations every time a user group queue etc is created Therefore function keys do not need to be created manually However there is an exception to this rule Function keys of type custom cannot be pre generated because the user must manually enter the number to dial Here is a list of available destination types user A User group Conference group 234 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 queue Calling queue conference Conference room custom A custom number to dial defined by the user bs filter Boss Secretary filter voicemail A voicemail paging Paging Example To configure a function key that would dial the extension of user Bob who has the id 12 you would have a destination of type user with the destination id 12 Here is an example of the JSON representation for this user type speeddial destination user destination_id 12 List of Function Key Destinations Query Parameters GET 1 1 func_keys order Sort th
255. i Data quality Allow callee to hang up the call C Allow caller to hang up the call No retry when time has elapsed Ring instead of On Hold Music Member reachability timeout Time before retrying call to a member Delay before reassigning a call Disabled 9 Maximum number of people allowed to wai 0 1 8 Administration 155 XiVO doc Documentation Release 14 08 General Announces Members Application Noanswer y Advanced Schedules Diversions 1 lt 52 2 2542 224 2 55 50528522465 5 EE does Su Destination z Redirect to everyone 200 amp defauk Ring time Destination Group Redirect to everyone 200 defauitt Ring time Destination Group Redirect to everyone 200 defaut Ringtime pec Destination User 71 i Redirect to Guardian 21 Ring ime Configuration for multiple switchboards The above documentation can be used for multiple switchboards on the same XiVO by replacing the switch board and switchboard hold queues name and configuring the operators XiVO client accordingly in the XiVO Client Configure Functions Switchboard window Usage
256. ibed in previous part Also verify that routing is configured between the distant router and the choosen interface otherwise DHCP requests will never reach the XiVO server Configuring DHCP server for other subnets This section describes how to configure XiVO to serve other subnets that the VOIP subnet As you can t use the Web Interface to declare other subnets for example to address DATA subnet or a VOIP subnet that isn t on the same site that XiVO server you ll have to do the following configuration in Command Line Interface Creating extra subnet configuration files First thing to do is to create a directory and to copy into it the configuration files mkdir etc dhcp dhcpd sites cp etc dhcp dhcpd subnet conf etc dhcp dhcpd sites dhcpd siteXXX conf cp etc dhcp dhcpd subnet conf etc dhcp dhcpd sites dhcpd lanDATA conf Note In this case we ll create 2 files for 2 differents subnets You can change the name of the files and create as many files as you want in the folder etc dhcp dhcpd sites Just adapt this procedure by changing the name of the file in the different links After creating one or several files etc dhcp dhcpd sites you have to edit the file etc dhcp dhcpd extra conf and add the according include statement like include etc dhcp dhcpd sites dhcpd siteXXX conf include etc dhcp dhcpd sites dhcpd lanDATA conf 56 Chapter 1 Table of Contents XiVO doc Documentation Release 14 0
257. ice s id Input Same as for creating a device Please see Create a Device Errors Same as for creating a device Please see Create a Device Example request PUT 1 1 devices 42 HTTP 1 1 Host xivoserver Content Type application json xps TI Example response HTTP 1 1 204 No Content Delete a Device device can not be deleted if it is linked to a line You must deassociate the line and the device first Query DELETE 1 1 devices id Error code Error message Description Errors 400 error while deleting Device explanation See error message for more details 404 Not found The requested device was not found Example request DELETE 1 1 devices 412c212cff500cc158f373 00e078f7 HTTP 1 1 Host xivoserver Example response HTTP 1 1 204 No Content Reset a device to autoprov Warning The device s configuration will be lost when reset to autoprov mode Resets a device into mode Once in autoprov a device can be reprovisionned using another provisioning code Query 228 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 GET 1 1 devices lt id gt autoprov Parameters id Device s id Example request GET 1 1 devices 412c212cff500cc158 373 00e078 7 autoprov Host xivoserver Example response HTTP 1 1 204 No Content Synchronize a device Synchronize a device s configuration Used wh
258. ices Device not configured verified it the plugin is installed for this device ou i though existing in the provisioning ing server Phonebook Nonexistent in the provisioning server Advanced Device property configured Device configured mode Autoprov Devices gt not configured verified if the plugin is installed for this device xivo snom 8 4 31 Bee 138 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Device With one User Only Associated Edit the user associated to the device and put the device field to null click on the Save button on the web interface The phone doesn t restart and the phone is in autoprov mode in the device list You can synchronize the device to reboot it Device with Several Users Associated Edit the primary user associated to the terminal one with the line 1 and put the device field to null click on the Save button on the web interface The primary line of the phone has been removed so the device will lose its funckeys associated to primary user but there others lines associated to the device will stay provisionned The phone doesn t restart and the phone is in autoprov mode in the device list You can synchronize the device for reboot it From a Device Dial guest 48378 on the phone dialpad followed by x
259. ices 1 10 2 Quick Summary You need two configured XiVO wizard passed Configure one XiVO as a master gt setup the slave address Restart services xivo service restart on master Configure the other XiVO as a slave setup the master address Start configuration synchronization by running the script xivo master slave db replication slave ip on the master Resynchronize all your devices Configure the XiVO Clients That s it you now have a HA configuration and every hour all the configuration done on the master will be reported to the slave 1 10 3 Configuration Details First thing to do is to install 2 XiVO Important When you upgrade a node of your cluster you must also upgrade the other so that they both are running the same version of XiVO Otherwise the replication might not work properly You must configure the HA in the Web interface Configuration Management High Availability page You can configure the master and slave in whatever order you want Warning When the is configured some changes will be automatically made to the configuration of XiVO 198 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 SIP expiry value on master and slave will be automatically updated min 3 minutes max 5 minutes default 4 minutes General Network Security Signaling T38 Jitter Buffer Default Real time Internals Auth credentials
260. ignaling should be one of bri net bri cpe bri net ptmp bri ptmp Following is an example etc asterisk dahdi channels conf file for a B410P 4 ports for French network check the comments and the etc asterisk dahdi channels conf section Span 1 4 0 1 PCI Card 0 Span 1 MASTER RED group 0 11 belongs to group 0 and 11 context from extern incoming call to this span will be sent in from extern context switchtype euroisdn signalling bri cpe use bri cpe signaling channel 1 2 the above configuration applies to channels 1 and 2 Span 2 4 0 2 PCI Card 0 Span 2 RED group 0 12 context from extern Switchtype euroisdn signalling bri cpe channel gt 4 5 Span 3 4 0 3 BA4XXP PCI Card 0 Span 3 R group 0 13 context from extern Switchtype euroisdn signalling bri cpe 1 8 Administration 109 XiVO doc Documentation Release 14 08 channel gt 7 8 Span 4 4 0 4 BAXXP PCI Card 0 Span 4 RED group 1 14 belongs to groups 1 and 14 context default incoming call to this span will be sent in defaul context Switchtype euroisdn signalling bri net use bri net signaling channel 10 11 the above configuration applies to channels 10 and 11 Special cases Here are some special cases where you might need to modify the default options if your telecom operator brings layer 1 down when the
261. ike context default group 63 Change the context lines if needed Voice Compression Card configuration Here s how to install a Digium 400 card used for G 729a and or G 723 1 codecs Verify that the wct c4xxp module is uncommented etc dahdi modules If it wasn t do again the step Load the correct DAHDI modules install the card firmware xivo fetchfw install digium tc400m comment out the following line in etc asterisk modules conf noload codec dahdi so restart asterisk etc init d asterisk restart depending on the codec you want to transcode you can modify the mode parameter of the module by creating a file in etc modprobe d This parameter can take the following value mode mixed this the default value which activates transcoding for 92 channels in G 729a or G 723 1 5 3 Kbit and 6 3 Kbit mode g729 this option activates transcoding for 120 channels in G 729a mode g723 this option activates transcoding for 92 channels in G 723 1 5 3 Kbit et 6 3 Kbit Example cat EOF etc modprobe d xivo transcode conf options 4 mode g729 EOF After having applied the configuration see Apply configuration section you can verify that the card is correctly seen by asterisk with the transcoder show CLI command this command should show the encoders decoders registered by the TC400 card xCLI transcoder show 0 0 encoders decoders of 120 channels are in us
262. il Association Representation Field Value Description Description voicemail id int Voicemail s ID enabled bool Enable voicemail for user Get the Voicemail associated to a User Query GET 1 1 users user id voicemail Error code Error message Description Errors 404 Invalid parameters user with 14 lt id does not have a voicemail 404 User with id lt user_id gt does not exist 1 11 and SDK 265 XiVO doc Documentation Release 14 08 Example request GET 1 1 users 20 voicemail Host xivoserver Accept application json Example response HTTP 1 1 200 OK Content Type application json voicemail id 132 user id 20 enabled true rel voicemails href https xivoserver 1 1 voicemails 132 rel users href https xivoserver 1 1 users 20 Associate a User to a Voicemail Query POST 1 1 users lt user_id gt voicemail Field Required Values Description Input voicemail_id yes int Must be an existing id enabled no bool Default value true Error Error message Description code 400 Nonexistent parameters voicemail_id riors lt voicemail_id gt does not exist 400 Invalid parameters user with id lt user_id gt A user needs to have a line to associate a does not have any line voicemail 400 Invalid parameters user with id lt user_id gt You must unassociate t
263. in your queue log table with sudo u postgres psql c SELECT count FROM queue log asterisk On ordinary hardware you can expect that it will take 10 minutes for every 2 5 million of rows So if you have 5 million of rows in your queue log table you can expect that the upgrade will take an extra 20 minutes It is possible to reduce the amount of additional time the upgrade will take by either removing rows from the table or altering the table before the upgrade Both these commands can be run while the XiVO services are up For example if you want to remove all the rows before march 2014 you can use rj I sudo u postgres psql c DELE FROM queue log WHERE time 2014 03 01 asterisk If you want to alter the table before the upgrade you can use sudo u postgres psql c ALTER TABLE queue log ADD COLUMN id SERIAL PRIMARY KEY GRANT ALL ON SE Note It is recommended to execute this command when there s no activity on the system 16 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 More Technical Information way the database is initially provisioned and the way it is altered during an upgrade has also been changed In XiVO 14 07 earlier the database was provisioned executing usr share xivo manage db datastorage asterisk sqgl SQL script Starting with XiVO 14 08 the xivo init db is responsible for p
264. interrupting the telephony ser vice device will only be resetted restarted if needed and only once the device is idle Some changes don t even require the device to be resetted sccp show config output format has been changed a little sccp show devices only show the connected devices instead of all the devices This might change in the future To get a list of all the devices use sccp show config Configuration File format of the sccp conf configuration file has been changed This will only impact you if you are using xivo libsccp without using XiVO The format has been changed because the module is now using the ACO module from asterisk which expect configuration file to have a specific format See sccp conf sample for a configuration file example Other Each SCCP session connection now use 3 file descriptors instead of 1 previously On XiVO the file descriptor limit for the asterisk process is 8192 which means that the increase in used file descriptors should not be a problem even on a large installation 14 04 Consult the 14 04 Roadmap Live reload of the configuration can be enabled and disabled using the REST API The generation of call logs for unanswered calls from the XiVO client have been improved 14 03 Consult the 14 03 Roadmap A migration script adds an index on the linkedid field in the cel table Tests have shown that this operation can last up to 11 5 minutes on a XiVO Corporate with 1
265. irectory is removed altogether including all the custom templates A few things to know before writing your first custom template templates use the Jinja2 template engine when doing an include extend from a template the file is first looked up in the var templates directory and then in the templates directory e device in autoprov mode are affected by templates because from the point of view of prova there s no difference between a device in autoprov mode or fully configured This means there s usually no need to modify static files in var tftpboot And this is a bad idea since a plugin upgrade will override these files Custom template for every devices cp templates base tpl var templates vi var templates base tpl provd pycli c devices using plugin xivo aastra 3 2 2 SP3 reconfigure Once this is done if you want to synchronize all the affected devices use the following command provd pycli c devices using plugin xivo aastra 3 2 2 SP3 synchronize Custom template for a specific model Let s supose we want to customize the template for our 67391 140 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 cp templates 6739i tpl var templates vi var templates 6739i tpl provd pycli c devices using plugin xivo aastra 3 2 2 SP3 reconfigure Custom template for a specific device To create a custom template for a specific device you have to create device specific
266. isites Cygwin Cygwin Web site Click the setup link and execute During the installer check the package Devel git Qt SDK You need the development files of the Qt 5 library available on the Qt website NSIS optional You will only need NSIS installed if you want to create an installer for the XiVO Client NSIS download page During the installer choose the full installation 334 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Get sources a Cygwin shell git clone git github com xivo pbx xivo client qt git cd xivo client qt Building Path configuration You must change the values in C Cygwin home user xivo client qt build deps to match the paths of your installed programs You must use an editor capable of understanding Unix end of lines such as Notepad Replace C with cygdrive c and backslashes with slashes You must respect the case of the directory names Paths containing spaces must be enclosed in double quotes For example if you installed NSIS in C Program Files x86 nsis you should write WIN NSIS PATH cygdrive c Program files x86 nsis Build Ina Cygwin shell source build deps export PATH SWIN QT PATH bin S WIN MINGW PATH bin PATH qmake mingw32 make Binaries are available in the bin directory The version of the executable is taken from the git describe command Launch You can launch the built executable with source build
267. isturb N Y SK SK SK SK NYT SK SK Group interception N Y Y Y Y Y NYT Y Y Listen to online calls N Y Y Y Y Y NYT Y Y Directory access N Y Y Y Y Y NYT Y Y Filtering Boss Secretary N Y Y Y Y Y NYT Y Y Transfers Functions Blind transfer N HK HK HK HK HK NYT HK SK Indirect transfer N HK HK HK HK HK NYT HK SK Forwards Functions Disable all forwarding N Y Y Y Y Y NYT Y Y Enable Disable forwarding on no answer N Y Y Y Y Y NYT Y Y Enable Disable forwarding on busy N Y Y Y Y Y NYT Y Y 66 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Table 1 6 continued from previous page Voicemail Functions Activate voicemail Reach the voicemail Agent Functions Connect a static agent Parking Functions Parking Parking position Paging Functions Paging Enable voicemail with supervision function Delete messages from voicemail Connect Disconnect a static agent Disconnect a static agent T19P 20 T21P T22P T26P T28P T32G T38G T4 Enable Disable forwarding unconditional N Y Y Y Y Y NYT Y Y N Y Y Y Y Y NYT Y Y N Y Y Y Y Y NYT Y Y N HK HK HK HK HK NYT HK HK N Y Y Y Y Y NYT Y Y I Y Y Y Y Y NYT Y Y N Y Y Y Y Y NYT Y Y N Y Y Y Y Y NYT Y Y N Y Y Y Y Y NYT N Y N Y Y Y Y Y NYT N Y N Y Y Y Y Y NYT NYT Y Note Some function keys are shared with line keys The EXP38 EXP39 and EXP40 expansion modules are supported Compatible device Commun
268. ith external ACL for MAC addresses and accounting The own IP address of the access point used as NAS IP Address own ip addr 127 0 0 1 Optional NAS Identifier string for RADIUS messages When used this should be 1 12 Developers 323 XiVO doc Documentation Release 14 08 a unique to the NAS within the scope of the RADIUS server For example a fully qualified domain name can be used her When using IEEE 802 11r nas identifier must be set and must be between 1 and 48 octets long nas identifier ap example com I RADIUS authentication server auth server addr 127 0 0 1 auth server port 1812 auth server shared secret secret RADIUS accounting server acct server addr 127 0 0 1 acct server port 1813 acct server shared secret secret Secondary RADIUS servers to be used if primary one does not reply to RADIUS packets These are optional and there can be more than one secondary server listed auth server addr 127 0 0 2 auth server port 1812 auth server shared secret secret2 acct server addr 127 0 0 2 acct server port 1813 acct server shared secret secret2 Retry interval for trying to return to the primary RADIUS server in seconds RADIUS client code will automatically try to use the next server when the current server is not replying to requests If this interval is set primary server will be retried after configured amo
269. ith number 1000 Alice can call Bob by dialing either 1000 or 1000 without configuring another DID 1 8 18 Interconnections Interconnect two XiVO directly Figure 1 46 Situation diagram Interconnecting two XiVO will allow you to send and receive calls between the users configured on both sides The steps to configure the interconnections are Establish the trunk between the two XiVO that is the SIP connection between the two servers Configure outgoing calls on the server s used to emit calls Configure incoming calls on the server s used to receive calls For now only SIP interconnections have been tested 114 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Establish the trunk The settings below allow a trunk to be used in both directions so it doesn t matter which server is A and which is B Consider XiVO A wants to establish a trunk with XiVO B On XiVO B go on page Services IPBX Trunk management SIP Protocol and create SIP trunk Name xivo trunk Username xivo trunk Password pass Connection type Friend IP addressing type Dynamic Context see below Note For the moment Name and Username need to be the same string The Context field will determine which extensions will be reachable by the other side of the trunk If Context is set to default then every user group conf room queue etc that have an extension if the default context will be re
270. ith your XiVOs Reset the Berofos You can reset the berofos configuration 1 Power on the berofos 2 When red and green LEDs are still lit press amp hold the black button 3 Release it when the red LEDs of the D port start blinking fast 4 Reboot the beronet it should have lost its configuration External links nstall BeroFos in French berofos user manual 206 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 1 11 and SDK 1 11 1 Channel Event Logging CEL CELs are the mechanism used by Asterisk to store telephony events XiVO uses CELs instead of CDRs since they are more accurate and flexible Official Documentation Asterisk s CEL documentation can be accessed online on the Asterisk wiki CEL Samples The following configuration will be used for the following examples User Tux with extension 7000 e User P re No l with extension 1001 External User with number 555 555 5555 e External calls to DID 445 are sent to 1000 External calls to DID 446 are sent to 7001 Our DID number is 555 555 6666 Outgoing Call 1 1000 calls 555 555 5555 2 555 555 5555 answers 3 555 555 5555 hangs up after a few seconds id eventtype eventtime userdeftype cid name cid num 54048 CHAN START 2012 03 29 09 50 00 295885 Tux 1000 54049 APP START 2012 03 29 09 50 00 322427 5555556666 5555556666 54050 CHAN START 2012 03 29 09 50 00 322539 54051 ANSW
271. itle firstname lastname displayname society mobilenumber email mr Emmett Brown Brown Emmett DMC 5555551234 emmet brown dmc example com Example Directory name csv phonebook Type File URI data csv phonebook csv Web service directories The data returned by the Web service must have the same format than the file directory In the same way you will be able to choose the headers and the separator in the next step Example Directory name ws phonebook Type Webservices URI http example org 8000 ws phonebook Configure the access to the data source Go in Services CTI Server Directories Definitions and add a new directory definition e URTI your data source Delimiter the field delimiter in your data source Direct match the key used to match entries for direct lookup 1 8 Administration 95 XiVO doc Documentation Release 14 08 Match reverse directories idem but for reverse lookup Mapped field the fieldname is the identifier of the field It will be used in the display filter so look there if you want to use an existing one or make it up if you want a custom display filter the value is the corresponding header of your data source File directories For file directories the Direct match and the Match reverse directories must be filled with the name of the column used to match entries For example given you have the following CSV name John
272. ity support The following phones are only supported by the community In other words maintenance bug corrections and features are developed by members of the XiVO community XiVO does not officially endorse support for these phones xivo provd plugins for these devices can be installed from the community supported devices repository Aastra 67001 and 90001 series Model Tested Fkeys XiVO HA 67301 No 8 Yes 67531 Yes 6 Yes 67571 Yes 30 Yes 91431 Yes T Yes 94801 6 9480 6 Alcatel Lucent IP Touch series Model Tested Fkeys XiVO HA 4008 Extended Edition Yes 4 No 4018 Extended Edition Yes 4 No Note that you must not download the firmware for these phones unless you agree to the fact it comes from a non official source For the plugin to work fully you need these additional packages apt get install p7zip python pexpect telnet 1 7 Ecosystem 67 XiVO doc Documentation Release 14 08 Avaya 1200 series IP Deskphones previously known as Nortel IP Phones Model Tested Fkeys XiVO HA 1220IP Yes 0 No 1230IP No 0 No Cisco Cisco Small Business SPA300 series Model Tested Fkeys XiVO HA SPA301 No 1 SPA303 No 3 No Note Function keys are shared with line keys for all SPA phones Cisco Small Business 5 500 series Model
273. ivo 9486 as a password The phone restarts and display autoprov ready to be used for another user Advanced Configuration DHCP Integration If your phones are getting their network configuration from your XiVO s DHCP server it s possible to activate the DHCP integration on the Configuration Provisioning General page What DHCP integration does is that on every DHCP request made by one of your phones the DHCP server sends information about the request to provd which can then use this information to update its device database This feature is useful for phones which lack information in their TFTP HTTP requests For example without DHCP integration it s impossible to extract model information for phones from the Cisco 7900 series Without the model information extracted there s chance your device won t be automatically associated to the best plugin This feature can also be useful if your phones are not always getting the same IP addresses for one reason or another Again this is useful only for some phones like the Cisco 7900 it has no effect for Aastra 6700 Creating Custom Templates Custom templates comes in handy when you have some really specific configuration to make on your telephony devices Templates are handled on a per plugin basis It s not possible for a template to be shared by more than one plugin since it s a design limitation of the plugin system of prova Note When you install a new plugin templat
274. k and used by the web interface Here is a partial glimpse of what can be configured in file ipbx ini 1 Enable Disable modification of SIP line username and password user readonly idpwd true When editing a SIP line the username and password fields cannot be modified via the web interface Set this option to false to enable the modification of both fields This option is set to true by default Warning This feature is not fully tested It should be used only when absolutely necessary and with great care 1 6 6 Backup Periodic backup A backup of the database and the data are launched every day with a logrotate task It is run at 06 25 a m and backups are kept for 7 days Logrotate task etc logrotate d xivo backup Logrotate cron 1 6 System 51 XiVO doc Documentation Release 14 08 etc cron daily logrotate Retrieve the backup You can retrieve the backup from the web interface in Services IPBX IPBX Configuration Backup Files page Otherwise with a shell access you can retrieve them in var backups xivo In this directory you will find db tgz and data tgz files for the database and data backup Backup script usr sbin xivo backup Backup location var backups xivo What is actually backuped Data Here is the list of the folder and files backuped etc asterisk etc dahdi e etc dhcp etc hostname etc hosts etc network interfaces etc ntp conf etc
275. l Query GET 1 1 voicemails id Example request GET 1 1 voicemails 1 HTTP 1 1 Host xivoserver Accept application json Example response HTTP 1 1 200 OK Content Type application json age mm name John Doe number 1000 Context default password null email john doe example com language en US timezone eu fr max messages null attach audio false delete messages false ask password false links l voicemails 1 l voicemails 2 1 11 and SDK 261 XiVO doc Documentation Release 14 08 rel href Create a Voicemail Query voicemails POST 1 1 voicemails https xivoserver 1 1 voicemails 2 Field Re Val Notes quired ues name yes string number yes string Must be a string of positive numbers context yes string pass no string Must be a string of positive numbers word email no string language no string Consult Voicemail Languages for a list of valid languages The system default Input will be used if none is specified timezone no string Consult Voicemail Timezones for a list of valid timezones The system default will be used if none is specified max messages in Valid values are te 1 10 15 20 25 50 75 100 125 150 175 200 300 400 500 600 700 800 900 1000 2000 3000 4 ger at no booleanDefault value is false tach_audia delete messages booleanDefault value is false ask
276. l non acd incoming external on call non acd outgoing internal on call non acd outgoing external 13 12 e for messages of class get list list agents and function updatestatus the key availability in the status object dictionary has changed values deleted value on call non acd added values on call non acd incoming andon call non acd outgoing 13 10 for messages of class get list and function updateconfig the config object dictionary does not have a rules order key anymore Commands Objects have the format lt type gt lt xivoid gt lt typeid gt type can take any of the following values user agent queue phone group meetme xivoid indicates on which server the object is defined lt typeid gt is the object id type dependant e g user xivo test 5 I m looking for the user that has the ID 5 on the xivo test server Here is a non exaustive list of types exten user ym consult voicemail Class list LOGINCOMMANDS Once the network is connected at the socket level the login process requires three steps If one of these steps is omitted the connection is reseted by the cti server e login id the username is sent as a login to the cti server cti server answers by giving a sessionid e login pass the password combined with the sessionid is sent to the cti server cti server answers by giving a capaid login capas the capaid is returned to the server
277. lanation above See explanation above The requested user was not found Example request DELETE 1 1 users 67 HTTP 1 1 Host xivoserver Example response HTTP 1 1 204 No Content ct ser Line Association See User Line Association Users Voicemails Association See Voicemail Association E sers CTI profiles Association See User CTI configuration ser CTI configuration CTI Configuration Representation Field Value Description Description user id int User s ID Read only cti profile id int CTI Profile s ID enabled bool Status of the CTI configuration Get the CTI Configuration for a User Query GET users lt user_id gt cti Error code Error message Description Errors 404 User with id user id does not exist Example Request GET users 34 cti Host xivoserver Accept application json 1 11 and SDK 255 XiVO doc Documentation Release 14 08 Example Response HTTP 1 1 200 OK Content Type application json user id 34 cti profile id 2 Links s rel users href https xivoserver 1 1 users 34 rel cti profiles href https xivoserver 1 1 cti profiles 2 Edit the CTI configuration of a user Query PUT users lt user_id gt cti Field Required Values Description Input cti profile id yes int Must be an existin
278. lask http server POST http 2013 10 28 10 04 35 815 xivo restapid 8905 INFO xivo restapi flask http server GET http 1 sysconfd xivo sysconfd 1 debug f debug for debug level logging f for foreground Log file var log daemon 1log Lines start with xivo sysconfd Oct 29 11 03 45 hostname xivo sysconfd 24522 locking PID Oct 29 11 03 45 hostname xivo sysconfd 24522 pidfile ok Oct 29 11 03 45 hostname xivo sysconfd 24522 will now serve Oct 29 11 04 33 hostname xivo sysconfd 24522 status check 1 1 200 17 1 12 4 XiVO Guidelines Inter process communication Our current goal is to use only two means of communication between XiVO processes a REST API over HTTP for synchronous commands a software bus RabbitMQ for asynchronous events Each component should have its own REST API and its own events and can communicate with every other component from across a network only via those means Service API The current xivo dao Git repository contains the basis of the future services Python API The API is split between different resources available in XiVO such as users groups schedules For each resource there are different modules service the public module providing possible actions It contains only business logic and no technical logic There must be no file name no SQL queries and no URLs in this module 276 Chapter 1 Table of Contents XiVO doc Documentati
279. le DND true false Pause agent in all queues Unpause agent in all queues Agent logoff Enable encryption To enable encryption of CTI communications between server and clients you have to create a certificate in Con figuration Certificates Then go in the menu CTI Server General settings General and in the section Listening ports check the line CTIS and select both the certificate and the private key you created earlier By default the CTIS port is 5013 1 8 Administration 83 XiVO doc Documentation Release 14 08 Presence name donotdisturb Display name pas d ranger The human readable name to be displayed Color status Search E D connect Disponible 4 gt Sorti Parti Manger Bient t de retour E 1 Action Params ael Activate mode Activate pause to all queue Save In your XiVO Client in the menu XiVO Client Configure Connection check the option Encrypt connection and adjust the server port if necessary Warning For now there is no mechanism for strong authentification of the server The connection is encrypted but the identity of the server is not verified CTI profiles The CTI profiles define which features are made available to a user You can configure which profile will be used by a user in the menu PBX PBX Settings Users You can also customize the default profil
280. les and attach Act ions to them such as Set in pause or Enable DND You can then attach an action Set in pause for multiple presence states and attach an action Cancel the pause for the presence state Available For now the actions attached to the mandatory presence Disconnected will not be taken into account 1 9 4 Agent Status Dashboard Overview The goal of the agent status dashboard xlet is to give contact center supervisors a better overview of agent status evolution in active queues Agent status dashboard Queue 11002 8 X Queue 11000 X Queue 11007 Usage The xlet is read only and presents a list of queues For each queue the xlet displays a status box for each logged in agent Each status box gives the following information Agent name Agent status Shows the agent s status An agent can have six statuses Not in use when he is ready to answer an ACD call Int Incoming when he answered an internal call not from a queue Int Outgoing when he emitted an internal call not from a queue Ext Incoming when he answered an external call not from a queue Ext Outgoing when he emitted an external call not from a queue In use when he is either on call a from a queue on pause or on wrapup Agent status since Shows the time spent in the current status Background color green if Not in use purple if nt Incoming or Int Outgoing pink if Ext Incoming or Ext Outgoing 1 9 Contact C
281. line is idle you should add the following option in etc asterisk chan dahdi conf and restart asterisk works with XiVO 12 20 and above layer2 persistence keep up PRI card configuration Verifications Verify that one of the wct1xxp wctellxp wctel2xp wctel3xp wct4xxp module is uncommented in etc dahdi modules depending on the card you installed in your server If it wasn t do again the step Load the correct DAHDI modules Warning TE13XP cards these cards need a specific dahdi module configuration See Load the correct DAHDI modules paragraph you MUST install the correct echo canceller firmware to be able to use these cards See Hardware Echo cancellation paragraph Generate DAHDI configuration Issue the command dahdi genconf Warning it will erase all existing configuration in etc dahdi system conf and etc asterisk dahdi channels conf files Configure Modify the etc dahdi system conf Check the span numbering f needed change the clock source Usually at least in France you should remove the crc4 Modify the etc asterisk dahdi channels conf file remove the unused lines like context default group 63 110 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Change the context lines if needed The signaling should be one of pri net pri Sync cable You can link several PRI Digium card between themselves with a sync cable to share
282. ll context must exi Ring time in seconds You must set a language to use this section Voicemail fullname Mailbox number Password voicemail Mail to send a notification when a message is rece Enable Disable attach the audio file to your mail Enable Disable delete message after notification Enable Disable password checking Warning Warning Examples this field is required valid by section 5 this field is required if you add a voicemail First step is to create a text file containing the users you want to create Here s a basic example entityid firstname lastnam l John Doe 1000 default sip 00123456789 l George Clinton 1001 default sip 00123456789 1 Bill Bush 1002 default sip 00123456789 This example defines 3 users John Doe with one SIP line with number 1000 phonenumber context protocol mobilephonenumber 1 8 Administration 161 XiVO doc Documentation Release 14 08 George Clinton with one SIP line with number 1001 Bill Bush with one SIP line with number 1002 Note Note that the number you use must all be in the range you defined for your default context Text file to add a simple user with a line and voicemail entityid firstname lastname language phonenumber context protocol voicemailname voicemailmailbox l John Doel en US 1000 default sip John Doe 1000 1234 Text file to add a simple user with a line and incall entityid firstname lastname phonenumber
283. ll fiters Call pickups Schedules You can then power on your devices on your LAN For example after you power on an Aastra 67311 and give it the time to boot and maybe upgrade its firmware you should then see the phone having its first line configured as autoprov and if you refresh the devices page you should see that your XiVO now knows about your 67311 You can then dial from your Aastra 67311 the provisioning code associated to a line of one of your user You will hear a prompt thanking you and your device should then reboot in the next few seconds Once the device has rebooted it will then be properly configured for your user to use it And also if you update the device page you ll see that the icon next to your device has now passed to green Resetting a Device From the Device List in the Webi remove a phone from XiVO or enable a device to be used for another user there are two different possibilities click on the reset to autoprov button on the web interface The phone will restarts and display autoprov ready to be used for another user From the User Form in the Webi 1 8 Administration 137 XiVO doc Documentation Release 14 08 oO Voicemail 8 existing in the provisioning server Phonebook Nonexistent in the provisioning server Advanced device property configured Device configured mode Autoprov Dev
284. ll management Outgoing calls and add an outgoing call Tab General 1 8 Administration 115 XiVO doc Documentation Release 14 08 Trunks xivo trunk Tab Exten Exten 99 note the period at the end Stripnum 4 This will tell XiVO if any extension begins with 99 then try to dial it on the trunk xivo trunk after removing the 4 first characters the 99 prefix The most useful special characters to match extensions are period will match one or more characters X will match only one character You can find more details about pattern matching in Asterisk hence in XiVO on the Asterisk wiki Set the incoming calls Now that we have calls going out from a XiVO we need to route incoming calls on the XiVO destination Note This step is only necessary if the trunk is linked to an Incoming calls context To route an incoming call to the right destination in the right context we will create an incoming call in Services IPBX Call management Incoming calls Tab General DID 101 Context Incalls Destination User Redirect to someone This will tell XiVO if you receive an incoming call to the extension 101 in the context Incalls then route it to the user someone The destination context will be found automatically depending on the context of the line of the given user So with the outgoing call set earlier on XiVO A and with the incoming call above set on XiVO B a user
285. llerID mode Skill Rules IPBX settings Preprocess subroutine Users Description Groups Voicemails Conference rooms Call management Incoming calls Outgoing calls Call permissions Call fiters Save Schedules u e 1 Voice menus Changing the email body You can change the body of the email sent upon fax reception by editing etc xivo mail txt The following variable can be included in the mail body dstnum s the DID that received the fax If you want to include a regular percent character i e you must write it as in mail txt or an error will occur when trying to do the variables substitution The agid service must be restarted to apply changes etc init d xivo agid restart Changing the email subject You change subject of the email sent upon fax reception by editing etc xivo asterisk xivo fax conf Look for the mail section and in this section modify the value of the subject option The available variable substitution are the same as for the email body The agid service must be restarted to apply changes etc init d xivo agid restart Changing the email from You can change the from of the email sent upon fax reception by editing etc xivo asterisk xivo fax conf Look for the mail section and in this section modify the value of the email from option The agid service must be res
286. llowing information Qos maximum wait time for a call in seconds Window period of time used for accumulating statistics in seconds The data used to compute statistics on the XiVO server is only kept for a maximum of 3 hours The window period cannot be configured to go beyond this limit Choose which queue should be displayed and the queues parameters for the Stats on slice Display Queue Qos X s whypdow s radio 60 3600 gt ventexivo 20 3600 service 60 3600 gt Display options can also be set on the client side A threshold can be configured to change the color of a column using the following parameters Queue thresholds waiting calls number of waiting calls in the queue Display queue s longest wait Add a column displaying the number of seconds the longest call has waited Queue thresholds longest wait number of seconds for the longest waiting call in the queue Display queue number Add a column displaying the queue s number Monitoring queues on high dimension screens You may want to display the queue list on one big screen visible by multiple people However the default font will not be large enough so the information will not be readable You can change the font size of this Xlet by giving a configuration file when launching the XiVO Client 1 9 Contact Center 173 XiVO doc Documentation Release 14 08 Configuration Connection Ac
287. m the WEBI interfaces interface cti handles the clients connections with the help of client connection and it often involves cti command too interfaces interface rcti handles the connections from the CTI server to other ones in the multi xivo frame work innerdata is meant to be the place where all statuses are computed and stored The main loop uses select syscall to dispatch the tasks according to miscellaneous incoming requests Requirements for innerdata the properties fetched from the WEBI configuration shall be stored in the relevant xod config structure the properties fetched from elsewhere shall be stored in the relevant xod status structure at least two kinds of objects are not predefined as are the phones or the queues for instance the channels in the asterisk SIP 345 0x12345678 meaning the group and queue members shall be handled in a special way each most statuses of the calls should be set inside the channel structure The purpose of the relations field in the various structures is to keep track of relations and cross relations between different objects a phone logged in as an agent itself in a queue itself called by some channels belonging to phones 304 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 CTI server Message flow Messages sent from the CTI clients to the server are received by the CTIServer class CTIServer then calls interface c
288. maybe rejected based 320 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 on overlapping BSSes These changes are done automatically when hostapd is setting up the 40 MHz channel Spatial Multiplexing SM Power Save SMPS STATIC or SMPS DYNAMIC SMPS disabled if neither is set HT greenfield GF disabled if not set Short GI for 20 MHz SHORT GI 20 disabled if not set Short GI for 40 MHz SHORT GI 40 disabled if not set Tx STBC TX STBC disabled if not set Rx STBC RX STBC1 one spatial stream RX STBC12 one or two spatial Streams or RX STBC123 one two or three spatial streams Rx STBC disabled if none of these set HT delayed Block Ack DELAYED BA disabled if not set aximum A MSDU length MAX AMSDU 7935 for 7935 octets 3839 octets if not set DSSS CCK Mode in 40 MHz DSSS CCK 40 allowed not allowed if not set PSMP support PSMP disabled if not set L SIG TXOP protection support LSIG TXOP PROT disabled if not set ht capab HT40 SHORT GI 20 SHORT GI 40 Require stations to support HT PHY reject association if they do not require ht 1 IEEE 02 1 2004 related configuration Require IEEE 802 1X authorization 8021 1 IEEE 802 1X EAPOL version hostapd is implemented based
289. mentation Furthermore call logs are now fetched with the new REST API See Call Logs Paging group numbers are now exclusively numeric All non numeric paging group numbers are converted to their numeric only equivalent while upgrading to XiVO 13 17 58 becomes 58 for example 13 16 Consult the 13 16 Roadmap A migration script modifies the user and line related tables and the way users lines and extensions are associated As a consequence of this script it is not possible any more to associate a user and a line without extensions Existing associations between users and one or more lines having no extensions will be removed Users and lines will still exist unassociated The call logs page is able to display partial results of big queries instead of displaying a blank page Two new CEL messages are now enabled LINKEDID END and BRIDGE UPDATE Those events will only exist in CEL for calls passed after upgrading to XiVO 13 16 The new REST API now makes possible to associate multiple user to a given line and or extension There are currently some limitations on how those users and lines can be manipulated using the web interface Please read the REST 1 1 documentation and more precisely the Associate Line to User section for more information 13 15 There was no production release of XiVO 13 15 13 15 developments are included in the official 13 16 release 13 14 Consult the 13 14 Roadmap The latest Poly
290. menu by pressing The padlock icon on the top right of the screen will change from closed to open When asked for the authentication mode select something like Auto or You don t have to enter anything for the username password 9 You ll probably want to bridge your wlan interface with another interface for example a VLAN interface brctl addbr br0 brctl addif br0 wlanO brctl addif brO eth0 341 ip link set br0 up 10 If you are using virtualbox and your guest interface is bridged to eth0 341 you ll need to change its config uration and bridge it with brO instead else it won t work properly 1 12 13 Web Interface Configuration for development Default error level for XiVO web interface is E ALL amp DEPRECATED amp E USER DEPRECATED amp E RECOVERABLE ERROR amp E STRICT If you to display warning other error your browser edit the etc xivo web interface xivo ini andreplace report type level to 3 error level 2047 report type 3 report mode 1 report func 1 email john doe example com file var log xivo web interface error log You may also edit etc xivo web interface php ini and change the error level but you will need to restart the cgi etc init d spawn fcgi restart Interactive debugging in Eclipse On your XiVO 1 Install php5 xdebug apt get install php5 xdebug 2 Edit the etc php5 con d xdebug ini and add these lines at the end
291. methods fragment size 1400 Configuration data for EAP SIM database authentication gateway interface This is a text string in implementation specific format The example implementation in eap sim db c uses this as the UNIX domain socket name for the HLR AuC gateway e g hlr auc gw In this case the path uses unix 322 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 prefix eap sim db unix tmp hlr auc gw sock Encryption key for EAP FAST PAC Opaque values This key must be a secret random value It is configured as a 16 octet value in hex format It can be generated e g with the following command od txl v N16 dev random colrm 1 8 tr d opaque encr 000102030405060708090 050 04 0 0 EAP FAST authority identity A ID A ID indicates the identity of the authority that issues PACs The A ID should be unique across all issuing servers In theory this is a variable length field but due to some existing implementations requiring A ID to be 16 octets in length it is strongly recommended to use that length for the field to provid interoperability with deployed peer implementations This field is configured in hex format eap fast 14 101112131415161718191 161 1 1 1 EAP FAST authority identifier information A ID Info This is a user friendly name for the A ID For example th nterprise nam and server name in a human readable format This fiel
292. mits Provisioning General Template ne Template device Main Secondary Figure 1 86 Configuration Provisioning Template Line Edit default Warning Especially not change these values when the HA is configured this could cause problems These values will be reset to blank when the HA is disabled Important For the telephony devices to take the new proxy registrar settings into account you must resynchro nize the devices or restart them manually 1 10 High Availability HA 199 XiVO doc Documentation Release 14 08 Disable node Default status of HIGH AVAILABILITY HA is disabled Note You can reset at any time by choosing a server mode disabled Configuration Management A of this node Disabled Entities Directories Web Services Access Certificates High Availability Network Figure 1 87 HA Dashboard Disabled default state Important You have to restart services xivo service restart once the master node is disabled Master node In choosing the method Master you must enter the IP address of the slave node Configuration nt 1 Users Type of this node Master Entities NO RD E IE E E T REED EN EM EA
293. mode default No one hears you 5 whisper mode Only the agent hears you e 6 barge mode Both the agent and the person he s talking to hear you Status since Shows the agent s status and the time spent in this status An agent can have three statuses Not in use when he is ready to answer an ACD call Out of queue when he called or answered a call not from the queue use when he is either on call from a queue on pause or on wrapup Logged A clickable cell to log or unlog the agent Joined queues The number of queues the agent will be receiving calls from Paused A clickable cell to pause or unpause the agent Paused queues The number of queues in which the agent is paused Agent Details General information Display advanced informations of an agent and enable to login logoff add remove to a queue and pause unpause 1 This is the status information of agent 2 Button to login logoff agent 3 Supervision button of the Xlet Calls of a queue 4 Pause Unpause button for given queue 5 Add Remove agent for given queue Queue members queue members lists which agents or phones will receive calls from the selected queue and some of their attributes Columns Number The agent number or the phone number of the queue member Firstname and Lastname First name and last name of the agent or the user to which the phone belongs Logged Whether the agent is logged or not Blank for a phone Paused Whether the agent is paused
294. more details Errors 400 error while deleting Voicemail Cannot delete a You must unassociate a user from his voicemail associated to a user voicemail before deleting it 404 Voicemail with uniqueid X does not exist The requested voicemail was not found or does not exist Query DELETE 1 1 voicemails id Example request DELETE 1 1 voicemails 1 HTTP 1 1 Host xivoserver Example response HTTP 1 1 204 No Content Voicemail Languages Warning Not yet implemented Returns a list of languages that can be used when creating or updating a voicemail Query GET 1 1 voicemails languages Example request GET 1 1 voicemails languages HTTP 1 1 Host xivoserver Content Type application json Example response HTTP 1 1 200 OK Content Type application json 264 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 total 7 items de D en es ES fr FR Wir CAN it IT nl NL Voicemail Timezones Warning Not yet implemented Returns a list of timezones that can be used when creating or updating a voicemail Query GET 1 1 voicemails timezones Example request GET 1 1 voicemails timezones HTTP 1 1 Host xivoserver Content Type application json Example response HTTP 1 1 200 OK Content Type application json Cotas 1 items eu fr Voicemail Association Service for associating a user with a voicema
295. move etc asterisk sccp conf rm etc asterisk sccp conf 5 Now you can launch xivo upgrade to finish the upgrade process 1 13 5 CTI server is frozen and won t come back online You must ensure that the partition containing var always has at least 100 MiB of free disk space If it does not the symptoms are the CTI server is frozen after logging unlogging an agent or adding removing a member from a queue trying to log unlog an agent via a phone is not possible To get the system back on tracks after freeing some space in var you must do xivo service restart 1 13 6 Agents receiving two ACD calls An agent can sometimes receive more than 1 ACD call at the same time even if the queues he s in have the ringinuse parameter set to no default This behaviour is caused by a bug in asterisk https issues asterisk org Jira browse AS TERISK 16115 It s possible to workaround this bug in XiVO by adding an agent subroutine The subroutine can be either set globally or per agent pre limit agentcallback exten s 1 NoOp same n Set LOCKED S LOCK agentcallback same Gotolf LOCKED not locked 1 same n Set GROUP agentcallback XIVO_AGENT_ID 1 13 Troubleshooting 349 XiVO doc Documentation Release 14 08 same n Set COUNT GROUP COUNT 5 AGENT ID Gagentcallback same NoOp UNLOCK agentcallback same n GotoIf S S COUNT lt 1 too many calls
296. mplate device you will be forced to select a default language and timezone on the phone UI Technicolor Previously known as Thomson Model Tested Fkeys XiVO HA ST2022 No No ST2030 Yes 10 No Note Function keys are shared with line keys Yealink Model Tested Fkeys XiVO HA T20P No 2 No T26P No 13 No Note Some function keys are shared with line keys Zenitel Model Tested Fkeys XiVO HA IPstation Yes 1 Caption 70 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 1 8 Administration 1 8 1 Advanced Configuration This section describes the advanced system configuration XiVO General Settings XiVO offers the possibility to configure the general settings via the Configuration Management General page Live reload configuration v Save Figure 1 26 Configure XiVO General Settings Live reload configuration permit to reload its configuration on command received from WEBI this option is enabled by default Certificates XiVO offers the possibility to create and manage 509 certificates via the the Configuration Management Certificates page These certificates can be used for enabling SIP TLS enabling encryption between the CTI server and the XiVO clients Creating certificates You can add a certificate by clicking on the add button at the top
297. n Note There are some prerequisites your SIP Trunk must offer both G 729a and G 711 codecs your fax users must have a customized outgoing calleridnum for the codec change is based on this variable 102 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 1 We assume that outgoing call rules and fax users with their DID are created 2 Create the file etc asterisk extensions extra d fax conf with the following content For faxes The following subroutine forces inbound and outbound codec to alaw For outbound codec selection we must set the variable with inheritance Must be set on each Fax DID pre incall fax exten s 1 NoOp Force alaw codec on both inbound operator side and outbound analog gv xten s n Set SIP CODEC INBOUND alaw xten s n Set SIP CODEC OUTBOUND alaw xten s n Return The following subroutine forces outbound codec to alaw based on outgoing callerid number For outbound codec selection we must set the variable with inheritance Must be set on each outgoing call rule pre outcall fax exten s 1 NoOp Force alaw codec if caller is Fax exten s n Gotolf CALLERID num 0112697845 alaw exten s n Gotolf S CALLERID num 0112697846 alaw end exten s n alaw Set SIP CODEC OUTBOUND alaw xten s n end Return 3 For each Fax users DID add the following string in the
298. n Click on the Support menu Click on the Downloads tab then on Voice amp Unified Communications Select IP Telephony then Unified Communications Endpoints then the model of your phone in this example the 7940G Click on Skinny Client Control Protocol SCCP software Choose the same version as the one shown in the plugin Download the file with an extension ending in zip which is usually the last file in the list In the XiVO web interface you ll then be able to click on the install button for the firmware The procedure is similar for the network locale and the user locale package but Instead of clicking on Skinny Client Control Protocol SCCP software click on Unified Communica tions Manager Endpoints Locale Installer Click on Linux Choose the same version of the one shown in the plugin For the network locale download the file named po locale combined network cop sgn For the user locale download the file named po locale locale name cop sgn for example po locale fr_FR cop sgn for the fr_FR locale 62 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 e Both files must be placed in var lib xivo provd plugins plugin name var cache di rectory Then install them in the XiVO Web Interface Note Currently user and network locale 9 0 2 should be used for plugins xivo sccp legacy and xivo cisco sccp 9 0 3
299. n in out 292 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 state Down Ring Unknown commstatus ready calling ringing elass get list function updatestatus listname channels tipbxrd zivo timenow 1361447017 29 Example of phone messages received when a phone is ringing status timestamp 1361447017 22 holded false commstatus ready parked false status timestamp 1361447017 29 holded false commstatus ready parked false status talkingto kind channel direction out timestamp 1361447017 29 holded status direction in timestamp 1361447017 29 holded false talkingto id SIP Configuration Messages The following messages are used to retrieve XiVO configuration Common fields class getlist function listid commandid tipbxid listname Name of the list to be retreived users phones agents queues voicemails queuemembers Class getlist commandid 489035169 function s Lstid tipbxid xivot L3stname 1 users Return a list of configured user id s Client gt Server class getlist commandid 489035169 function listid listname users tipbxid Server Client class getlist function iisrtid listname users Wee ge alt 12 MIPE
300. n Release 14 08 Use Case Update Firmwares for a given plugin Let us suppose we want to update firmwares for xivo snom from 8 7 3 25 to 8 7 3 25 5 Here are the steps to follow 1 Copy folder plugins xivo snom 8 7 3 25 to plugins xivo snom 8 7 3 25 5 Update VERSION number in plugins xivo snom 8 7 3 25 5 entry py Update VERSION number in plugins xivo snom 8 7 3 25 5 plugin info Download new firmwares bin files from snom website Update VERSION number and URIs in plugins xivo snom 8 7 3 25 5 pkgs pkgs db with uris of down loaded files from snom website wu oue co 9 6 Update sizes and shalsums in plugins xivo snom 8 7 3 25 5 pkgs pkgs db using helper script xivo tools dev tools check fw 7 Update plugins xivo snom build py duplicate and update section 8 7 3 25 8 7 3 25 5 Test your changes You have three different methods to test your changes on your development machine Always increase plugin version easiest If the production version is 0 4 change the plugin version to 0 4 01 make your changes and upload to testing see below Next modification will change the plugin version to 0 4 02 etc When you are finished making changes change the version to 0 5 and upload one last time Edit directly on XiVO Edit the files in var lib xivo provd plugins To apply your changes go in pycli and run plugins reload xivo cisco spa 7 5 4 Disable plugin caching Edit etc xivo provd provd conf and add the lin
301. n live_reload Example request PUT 1 1 configuration live_reload HTTP 1 1 Host xivoserver Content Type application json enabled false Example response HTTP 1 1 204 No Content Migration from 1 0 URL e Occurences of 1 0 have been replaced for 1 1 Trailing slashes have been removed For example in 1 0 the URL to list users is 1 0 users In 1 1 it is 1 1 users 1 11 5 Subroutine What is it The preprocess subroutine allows you to enhance XiVO features through the Asterisk dialplan Features that can be enhanced are User Group 268 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Queue Meetme Incoming call Outgoing call There are three possible categories e Subroutine for one feature e Subroutine for global forwarding Subroutine for global incoming call to an object Adding new subroutine If you want to add a new subroutine we propose to edit a new configuration file in the directory etc asterisk extensions extra d You also add this file by the web interface An example myexemple exten s 1 NoOp This is an example same n Return Don t forget to finish your subroutine by a Return Global subroutine There is predefined subroutine for this feature you can find the name and the activation in the etc xivo asterisk xivo_globals conf The variables are Global Preprocess subroutine XIVO_PRESUBR_GLOBAL_ENABLE
302. n of your xivo with the DEBUG_THREADS and DONT OPTIMIZE flag which make debugging an asterisk problem easier The steps are 1 Uncomment the deb src line for the xivo sources sed i s deb src deb src etc apt sources list d xivox 2 Fetch the asterisk source package mkdir p ast rebuild cd ast rebuild apt get update apt get source asterisk 3 Install the build dependencies apt get install build essential apt get build dep asterisk 4 Enable the DEBUG THREADS and DONT OPTIMIZE flag 1 12 Developers 273 XiVO doc Documentation Release 14 08 cd asterisk source folder vim debian rules 5 Update the changelog by appending debug1 in the package version vim debian changelog 6 Rebuild the asterisk binary packages dpkg buildpackage us uc This will create a couple of deb files in the parent directory which you can install via dpkg External links https wiki asterisk org wiki display AST Debugging http blog xivo fr index php post 2012 10 24 Visualizing asterisk deadlocks 1 12 3 Debugging Daemons Here s how to run the various daemons present in XiVO in foreground and debug mode Note that it s usually a good idea to stop monit before running a daemon in foreground agentd xivo agentd f v f for foreground v for verbose Log file var log xivo agentd log 2013 10 29 11 03 55 799 25830 INFO 2013 10 29 11 03 58 632 25830 INFO agid xivo agid
303. n system will be upgraded The system must be restarted after the upgrade because the Linux kernel will also be upgraded LDAPS case XiVO is using a LDAP server through SSL TLS LDAPS the documentation instructed you to append the certificate to etc ssl certs ca certificates crt However this is the wrong way to add a new certificate because it will be erased by the upgrade To keep your certificate installed through the upgrade you must follow the instructions given in the LDAP docu mentation 20 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 After the upgrade GRUB Cloned Virtual Machines only GRUB installations on cloned virtual machines may lead to un bootable systems if not fixed properly before restarting the system If xivo upgrade detects your system is in a broken state it will display a few commands to repair the GRUB installation 13 24 Consult the 13 24 Roadmap Default Quality of Service QoS settings have been changed for SCCP The IP packets containing audio media are now marked with the EF DSCP 13 23 Consult the 13 23 Roadmap The New call softkey has been removed from SCCP phones in connected state To start a new call the user will have to press Hold then New call This is the same behavior as a Call Manager Some softkeys have been moved on SCCP phones We tried to keep the keys in the same position at any given time As an example the transfer key will not
304. n the XiVO Legend Users available Users ringing Users talking C m Users 1 5 CTI Client 31 XiVO doc Documentation Release 14 08 Mobile phone External contacts Current search not contact x Known issues Typing enter while the focus is on a directory entry will have the same behavior as clicking on the transfer button on the Switchboard xlet This unexpected behavior will be fixed when we implement other actions to the directory xlet Phonebook Phonebook searches are triggered after the user has entered 3 characters Results from remote directories will appear after 1 second If a directory entry as the same number as a mobile or a phone configured on the XiVO it s extra columns will be added to the corresponding entry instead of creating a new line in the search result For example If User 1 has number 1000 and is also in a configured LDAP with a location in Qu bec if the display filter contains the Location column the entry for User 1 will show Qu bec in the Location column after the search results are received Configuration Context directory xlet needs a special context named switchboard directory In Services gt IPBX IPBX configuration Contexts add a new context with the followong parameters switchboard directory Type of context Other Display name Switchboard O gt detaut d
305. nd supp with Valgrind suppressions to avoid displaying errors in code you have no control over Here is a template valgrind supp you can use All memory in the XiVO Client is allocated using the new operator so all calls to malloc co must come from libraries malloc Memcheck Leak fun malloc calloc 342 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Memcheck Leak fun calloc realloc Memcheck Leak fun realloc memalign Memcheck Leak fun memalign Figures Here s a call graph for the presence features Not complete but gives a good global view of the internal mecha nism Figure 1 90 Xivo Client presence call graph Here s a call graph describing the chaining of calls when the XiVO Client connects to the server Manage Translations of the XiVO Client This sections describes how to manage XiVO Client translations from a developer point of view If you want to help translate the XiVO Client see Translating XiVO You need to install these tools pip install transifex client apt get install qt4 dev tools How to Add a New Translated String String to be translated is marked using the tr macro in the source code Example 1 12 Developers 343 XiVO doc Documentation Release 14 08 Figure 1 91 Xivo Client login call graph tr Number Updating translations on transifex Run the following commands from the root of the xivo client qt project utils translati
306. nd the password 1 4 Upgrading Upgrading a XiVO is done by executing commands through a terminal on the server You can connect to the server either through SSH or with a physical console 1 4 Upgrading 11 XiVO doc Documentation Release 14 08 Sach Context 8 104962 Alice Wonderland 1000 eoe XIVO D Figure 1 15 Lines information Emay Context v SIP Protocol Protocol Voicemails Phonebook Advanced IPBXsettings Devices Lines Users Groups Voicemails Conference rooms D lt lt lt 255 lt 26 lt lt 5 lt lt lt lt 2 Line associated to device Line not associated to a device ETE ERU IS EE ER E TIE SE ETT IA LLLI LE ILI ace ese PL TI Figure 1 16 Edit line zc O SIP Protocol IAX Protocol Voicemails Incoming calis Call fiters Default default Verify new messages presence RFC non conformant zj Figure 1 17 General line information Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 To upgrade your XiVO to the latest version you must u
307. nd written configuration file 1 8 25 Schedules Schedules are specific time frames that can be defined to open or close a service Within schedules you may specify opening days and hours or close days and hours A default destination as user group can be defined when the schedule is in closed state Schedules can be applied to Users Groups nbound calls Outbound calls Queues Creating Schedules A schedule is composed of a name a timezone one or more opening hours or days that you may setup using a calendar widget a destination to be used when the schedule state is closed With the calendar widget you may select months days of month days of week and opening time You may also optionaly select closed hours and destination to be applied when period is inside the main schedule For example your main schedule is opened between 08h00 and 18h00 but you are closed between 12h00 and 14h00 Using Schedule on Users When you have a schedule associated to a user if this user is called during a closed period the caller will first hear a prompt saying the call is being transferred before being actually redirected to the closed action of the schedule If you don t want this prompt to be played you can change the behaviour by 1 8 Administration 147 XiVO doc Documentation Release 14 08 San oe E E A E St ne de S ERE E E E n
308. nded transfer a If the selected user has also a mobile you can choose its mobile b You can abort the attended transfer by dialing 0 on your phone see note below c You can finish the attended transfer by hanging up the call Other important options to look to are Services IPBX Services IPBX Extensions General gt Transfers option Timeout for answer on attended transfer should be set to a value below the mean ringing time of most users on the XiVO if you want the attented transfer be aborted automatically after this timeout 30 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 e Services IPBX Services IPBX Extensions General the option Hangup must be set to 0 if you want to use 0 to abort attended transfer Directory Overview The goal of the directory xlet is to allow the user to search through XiVO users directory entries and arbitrary numbers to be able to transfer calls to these destinations Directory 100 Name Number Location E Alice 1001 Qu bec B b 1002 _ Carl s 1003 1004 100 Usage The list of entries in the xlet is searched using the top field Entries are filtered by column content The entry list will initally appear as empty If the current search term is a valid number it will be displayed in the result list with no name to allow transfer to numbers that are not currently in the phonebook or configured o
309. ne For quality auto provisioning support you must find how to configure and make the following features work NTP server MWI function keys speed dial BLF directed pickup call interception timezone and DST support multi language DTMF hard keys like the voicemail hard key on some phone non ASCII labels line name function key label non ASCII caller ID backup proxy registrar paging Once you have answered all these questions you ll have a good idea on how the phone works and how to configure it Next step would be to start the development of a new provd plugin for your phone for a specific firmware version 1 12 12 SCCP Introduction SCCP or skinny is a stimulus protocol used to fully interact with Cisco phones What is xivo libsccp It s a SCCP channel driver written for Asterisk by Avencall based on the channel skinny Installation The following packages are required to compile xivo libsccp on a XiVO build essential asterisk dev apt get update amp amp apt get install build essential asterisk dev git clone https github com xivo pbx xivo libsccp git cd xivo libsccp xivo libsccp make make install 1 12 Developers 313 XiVO doc Documentation Release 14 08 Configuration See sccp conf sample for a configuration file example FAQ Q When is this xfeature will be available A The order in which we implement features is based on our client needs Write us
310. ne agent logged no call will distributed since one waiting call one agent 100 170 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 1 9 3 Supervision Introduction Allows a contact center supervisor to monitor contact center activities such as Monitoring real time information from call queues Agent activities per call queues Agent detailed activities XiVO client as a Supervision Platform Configuration A supervisor profile defined in Service CTI Server Profiles menu usually contains the following Xlets Identity Queues Queue members Queues entries detail Agents list Agents detail Note You may also see the Agent Status Dashboard Supervision Panel Queues Calls of a Queue vela Bakery 301 on xivo default 1 call s 1 Alice Wonderland 101 00 08 Number Queues green 3000 Grocery store 0000 00 00 3008 SuperQueue 0000 0000 Bakery 301 default 3 agent s and 0 phone s Number Firstname Lastname Logged Paused Answered calls Last call Penalty ice Wonderland Not paused o 0 Cat Not paused Charlie Chaplin Paused 0 0 Agents List plain E Agent Details Bob Cat 102 on xivo default Logged out since 01 14 Login v Queues Joined Pays GEJ Listen Stetussnce Logged paused Last Grocery sto
311. new directory for lookup You must use the new LDAP filter in the Context and filter association step Fax Xlet Overview The Fax xlet allows the user to send faxes from his XiVO client Contacts Fax History Directory Services Personal Directory Confe Choose Destination Number Fax Number Directory Choose File to Send pi Browse Send your File Usage The Fax number field is the fax destination directory search can be used to find the fax number in available directories The Choose a file to send field is used to select which file you want to send Supported file type pdf 4 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 History Xlet Overview The history xlet allow the user to view his sent received and missed calls Contacts Sheets History Directory Services Personal lt C calls Received calls Missed calls Duration User 2 lt 1002 gt Saturday May 26 2012 1 24 48 PM EDT ls User 2 lt 1002 gt Saturday May 26 2012 11 34 35 AM EDT ls Usage The history xlet is made of 3 different call categories each of them being mutually exclusive ie a missed call is not in the incoming call list The user can right click on the caller to initiate a new call with a given correspondant Warning The column content is only refreshed when moving from one column to the other Local Directory Xlet Overview
312. nfig listname phones tid 3 timenow 1364994093 43 tipbx agents Client gt Server class getlist commandid 1431355191 function listid listname agents tipbxi queues Client gt Server class getlist commandid 719950939 function listid listname queues tipbxid Server gt Client unction listid listname queues tipbxid zivo Wist S 10 AUS m m 5 8 timenow 1382704649 64 Tela queue tid is the id returned in the list field of the getlist response message Client gt Server 294 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 commandid 7 class getlist tig 3 tipbxid xivo function updateconfig listname Server gt Client function updateconfig listname queues tipbxid xivo timenow 1382704649 69 i config displayname red name red context default number 3002 class getlist voicemails Client Server class getlist commandid 1034160761 function listid listname voicemails tij queuemembers Client gt Server class getlist commandid 964899043 function listid listname queuemembers t Server gt Client function listid listname queuemembers tipbxid xivo list Agent 2501 blue Agent 2500 yellow Agent 2002 yellow
313. ng all available users GET 1 1 users HTTP 1 1 Host xivoserver Accept application json Searching for a user called john 1 11 and SDK 251 XiVO doc Documentation Release 14 08 GET 1 1 users q john 1 1 Host xivoserver Accept application json Example response HTTP 1 1 200 OK Content Type application json total 2 items lg 1y firstname John lastname Doe timezone language en US description Caller id John Doe outgoing caller id default mobile phone number username password music on hold default preprocess subroutine userfield Was 2y firstname Mary lastname Sue timezone language fr_FR description Caller id Mary Sue outgoing_caller_id default mobile phone number username password music on hold default preprocess subroutine userfield 1 Get User GET 1 1 users id Parameters include See List Users Example request GET 1 1 users 1 HTTP 1 1 Host xivoserver Accept application json 252 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Example response HTTP 1 1 200 OK Content Type application json i firstname John lastname Doe timezone language en US des
314. ng out from the switchboard queue Set no answer destinations on the switchboard queue Supported Devices The supported phones for the switchboard are Aastra 6755i Aastra 6757i Snom 720 150 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Create a Queue for Your Switchboard calls to the switchboard will first be distributed to a switchboard queue To create this queue go to Services Call center Queues and click the add button General Announces Members Application No answer Advanced Schedules Diversions Name Display name Switchboard Number 9 07 Ring strategy Ring all 4 j Context pem dev pcm dev z On Hold J Add an announce Customize the name of the caller j Preprocess subroutine xivo_subr_switchbe Save The Following configuration is mandatory The General Name field has to be __ switchboard The General Preprocess subroutine field has to be xivo_subr_switchboard The Application Allow caller to hang up call option has to be enabled The Application Allow callee to transfer the call option has to be enabled The Advanced Member reachability timeout option has to be disabled The Advanced Time before retrying call to a member option has to be 1 second The Advanced Delay before reassigning a call option has to be disabled The Advanced Call a member already on option has to be disabled
315. ng timeout delay Satured Calls received when the queue was already full Maximum number of people allowed to wait limit of advanced tab or when one of the diversion parameters were reached 186 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Dissuaded or Overflowed 10h 11h 11h 12h 12h 13h 13h 14h 14h 15h 15h 16h zs 39 2 o o 2 oowzs s2 0 Total call distributed m Answered 18 Abandoned Closed Saturated Bi Blocking Queues Performance 110 278s 253s ETMA 83 005 55 28 0 9 AL RN 5 e 5 e 9 o ME od od 5 00 01 25 o o 590 000007 10 0 EN ue NER TNR IS NN CERNI CES Total call distributed Answered Abandoned 1 9 Contact Center 187 XiVO doc Documentation Release 14 08 Tuesday 0 0 Wednesday 10 0 Thursday 28 27 0 0 0 o 1 10 Tuesday 1 0 0 0 2 00 00 04 0 Wednesday 23 19 2 0 0 2 00 01 25 82 0 Thursday 21 21 0 0 0 0 o 00 00 07 100 o Friday 34 30 1 0 0 0 00 00 08 88 0 3 week Monday 36 35 0 0 0 0 1 00 00 11 97 0 Tuesday 40 36 4 0 0 0 0 00 00 07 90 0 Wednesday 35 35 0 0 0 0 0 00 00 07 100 0 Thursday 51 51 0 0 0
316. now 1361268824 68 Note the first element of the capalist is used in the next step login_capas login_capas Client gt Server loginkind user 3 lastconnwins False commandid lt commandid gt state available class login capas loginkind can be user or agent if agent the property agentphonenumber can be added Server gt Client First message describes all the capabilities of the client configured at the server level presence actual presence of the user userid the user id can be used as a reference capas userstatus a list of available statuses status name color selectionnable status from this status default action to be done when this status is selected long name services list of availble services phonestatus list of available phonestatuses with default colors and descriptive names capaxlets List of xlets configured for this profile appliname elass Login capas presence available userid 3 sivo timenow 1361440830 99 replyid 3 cepas e d regcommands preferences false userstatus available color 08FD20 allowed available away outtolunch donotdistu actions enablednd false longname Disponible Er berightback color FFB545 allowed available away outtolunch donotdi actions
317. nown hosts By default the DHCP server serves only known hosts That is either hosts which MAC address prefix the OUI is known or hosts which Vendor Identifier is known Known OUIs and Vendor Class Identifiers are declared update files If you want your XiVO DHCP server to serve also unknown hosts like PCs follow these instructions 1 6 System 55 XiVO doc Documentation Release 14 08 1 Create a custom template for the dhcpd_subnet conf tail file mkdir p etc xivo custom templates dhcp etc dhcp cd etc xivo custom templates dhcp etc dhcp cp usr share xivo config templates dhcp etc dhcp dhcpd subnet conf tail 2 Edit the custom template vim dhcpd subnet conf tail 3 And add the following line at the head of the file allow unknown clients 4 Re generate the dhcp configuration xivo update config DHCP server should have been restarted and should now serve all network equipments DHCP Relay If your telephony devices aren t located on the same site and the same broadcast domain as the DHCP server you will have to add the option DHCP Relay to the site s router This parameter will permit the DHCP requests from distant devices to be transmitted to the IP address you specify as DHCP Relay Warning Please make sure that the IP address used as DHCP Relay is one of the XiVO interface and that this interface is configured to listen to DHCP requests as decr
318. ns Blind transfer HK Y Y HK Y Y Indirect transfer HK Y Y HK Y Forwards Functions Disable all forwarding Y Y Y Y Y Y Enable Disable forwarding on no answer Y Y Y Y Y Y Enable Disable forwarding on busy Y Y Y Y Y Y Enable Disable forwarding unconditional Y Y Y Y Y Y Voicemail Functions Enable voicemail with supervision function Y Y Y Y Y Y Activate voicemail Y Y Y Y Y Y Reach the voicemail Y Y Y HK Y Y Delete messages from voicemail Y Y Y Y Y Y Agent Functions Connect Disconnect a static agent Y Y Y Y Y Y Connect a static agent Y Y Y Y Y Y Disconnect a static agent Y Y Y Y Y Y Parking Functions Parking Y Y Y Y Y Y Parking position Y Y Y Y Y Y Paging Functions Paging Y Y Y Y Y Y The 6701 and 675 expansion modules are supported DECT Infrastructure RFP35 RFP36 Provisioning N H A N N Directory XIVO N N Funckeys 0 0 Cisco ATAs Tested means the device has been tested by the XiVO development team and that the developers have access to this device These devices are marked as Not Tested because other similar models using the same firmware have been tested instead If these devices ever present any bugs they will be troubleshooted by the XiVO support team 3xiVO HA means the device is confirmed to work with XiVO HA Fkeys is the number of programmable function keys that you can configure from the XiVO web interface It is not necessarily the same as the number
319. ns in the CTI server You can register to listen these events by calling the IPBXListener method registerListener xxx For now xxx the event type can take take the values chitchat history records campaign queuestats On reception of the specified type of event BaseEngine will call the PBXListener method parseCom mand QVariantMap You should then reimplement this method to make it process the event data stored in the QVariantMap parameter The parking XLet There are two concepts here Parked calls These calls have been parked by a switchboard or an operator They are waiting to be answered by a specific person unlike a queue where calls will be answered by one of the agents of the group associated to the queue Each parked call is given a phone number so that the call can be answered by everyone Parking lots They are containers for parked calls Each parking lot has a phone number used to identify where to send the call we want to park ParkingWidget represents a parking lot and contains a table that stores all parked calls Adding new XLets When you want to add a new XLet you can use the basic XLetNull that only prints Hello World Here is a little script to accelerate the copy from XLetNull usr bin env sh newname newname Replaces xletnull NewName NewName Replaces XLetNull amp XletNull NEWNAME NEWNAME Replaces XLETNULL if d xletnull then
320. ntents XiVO doc Documentation Release 14 08 Queue Call Status Status Description full Call was not queued because queue was full happens when the number of calls is greater than the maximum number of calls allowed to wait closed Closed due to the schedule applied to the queue joinempty No agents were available in the queue to take the call follows the join empty parameter of the queue leaveempty No agents available while the call was waiting in the qeuue di Call diverted because the ratio number of agent number of calls waiting configured was vert ca ratio exceeded di Call diverted because the maximum expected waiting time configured was exceeded vert waittime answered Call was answered aban Call hangup by the caller doned timeout Call stayed longer than the maximum time allowed in queue parameter stat queue periodic Table This table is an aggregation of the queue log table This table contains counters on each queue for each given period The granularity at the time of this writing is an hour and is not configurable This table is then used to compute statistics for a given range of hours days week month or year Field Description id Generated id time time period all counters are aggregated for an hour answered Number of answered calls during the period abandoned Number of abandoned calls during the period total Total calls received during the period full Number of
321. nto M8 message when acting as a Registrar If skip cred build 1 this data will also be able to override the Credential attribute that would have otherwise been automatically generated based on network configuration This configuration option points to an external file that much contain the WPS Credential attribute s as binary data extra cred hostapd cred Credential processing 0 process received credentials internally default 1 do not process received credentials just pass them over ctrl iface to external program s 2 process received credentials internally and pass them over ctrl iface to external program s Note With wps cred processing 1 skip cred build should be set to 1 and extra cred be used to provide the Credential data for Enrollees wps cred processing 1 will disabled automatic updates of hostapd conf file both for Credential processing and for marking AP Setup Locked based on validation failures of AP PIN An external program is responsible on updating the configuration appropriately in this case 5 cred processing 0 AP Settings Attributes for M7 By default hostapd generates the AP Settings Attributes for M7 based on the current configuration It is possible to override this by providing a file with pre configured attributes This is similar to extra cred file format but the AP Settings attributes are not encapsulated in a Credential attribute ap settings hostapd ap settings
322. ntphonenumber 1000 class ipbxcommand command agentlogin commandid 733366 agentphonenumber is the physical phone set where the agent is going to log on Server Client Login successfull function updateconfig listname queuemembers tipbxid xivo timenow 1362664323 94 tid Agent 2002 blue config paused Q senalty Q membership static status I lastcall interface Agent 2002 queue name blue callstaken O class getlist function updatestatus listname agents tipbxid xivo timenow 1362664323 94 status availability_since 1362664323 94 queues phonenumber 1001 on_call false groups availability available channel null Erd 7 class getlist The phone number is already used by an other agent class ipbxcommand error string agent login exten in use timenow 1362664158 14 Logout Client gt Server class ipbxcommand command agentlogout commandid 552759274 Pause all queues Client gt Server 1 12 Developers 297 XiVO doc Documentation Release 14 08 class ipbxcommand command queuepause commandid 859140432 member agent xivo 1 Un pause On all queues Client Server class ipbxcommand command queueunpause commandid 822604987 member agent xivo Addanagentina qu
323. nts XiVO doc Documentation Release 14 08 Name t2 pabx Interface dahdi g2 Context to pabx Figure 1 51 Customized interconnection Create outgoing calls You must create two rules of outgoing calls in the menu Services gt IPBX Call management Outgoing calls page Redirect calls to the PBX Name fsc pabx Context to pabx Trunks choose the t2 pabx interconnection H RD Name fcpabx 1 Context Vers PABX to pabx x Use ENUM Internal 1 Preprocess subroutine 7 Ringing time before hangup Unlimited Trunks idefisk maq2 SIP jocelyn SIP loadtester SIP redirection local t2colt dahdi g0 test audiocodes SIP toulouse SIP te ee Figure 1 52 Outgoing call In the extensions tab exten XXXX Figure 1 53 Outgoing call 1 8 Administration 121 XiVO doc Documentation Release 14 08 2 Rename the rule default in fsc operateur Name fsc operateur Context to extern Trunks choose the t2 operateur interconnection In the extensions tab exten X Create an interconnection There are three types of interconnections Customized SIP TAX Customized interconnection Add an interconnection to the menu Services IPBX Trunk management Customized Name interconnection name Interface dahdi gO Context outgoing call t
324. number of agents currently in conversation in the queue This column is set to 0 when the queue has just been created and no members have been added Logged The number of logged agents in the queue This column is set to N A when the queue has just been created and no members have been added Available The number of available agents ready to take a call in the queue This column is set to N A when the queue has just been created and no members have been added Received The number of calls received in this queue during the configured statistical window Answered The number of calls answered in this queue during the configured statistical window Abandoned The number of calls abandoned in this queue during the configured statistical window Mean waiting time The mean wait time in the statistical time window in mm ss If no calls are received is displayed Max waiting time The longest wait time in the statistical time window mm ss If no calls are received is displayed Efficiency Answered calls over received calls during the configured statistical window unanswered calls that are still waiting are not taken into account If no calls are received is displayed QOS Percentage of calls taken within X seconds over answered calls during the configured statistical window If no calls are received is displayed Counter availability When the XiVO client is started is diplayed for counters that have
325. o Microsoft PCM 16 bit mono 8000 Hz The following command will re encode the input file with the correct parameters for asterisk and write into the output file 1 8 Administration 149 XiVO doc Documentation Release 14 08 sox input file b 16 c 1 r 8000 t wavpcm output file 1 8 27 Switchboard This page describes the configuration needed to have a switchboard on your XiVO Overview Switchboard functionality is available in the XiVO client The goal of this page is to explain how to configure your switchboard and how to use it The switchboard xlet and profile allow an operator to view incoming calls answer them put calls on hold view the calls on hold and pick up the calls on hold Limitations Note The shortcut keys of the switchboard do not work on the Mac version of the XiVO client Note The enter shortcut to answer a call will not work if the focus is currently on a widget that will consume the key press ie a text field a drop down list or a button Configuration Quick Summary In order to configure a switchboard on your XiVO you need to Create a queue for your switchboard Create a queue for your switchboard s calls on hold Create the users that will be operators Activate the switchboard option for your phone Create an agent for your user Assign the incoming calls to the switchboard queue For each operator add a function key for logging in or loggi
326. o be able to do the appropriate HTTP request from the XiVO to the device s web service The following command should work from your XiVO s bash command line wget http guest guest phone IP address gt command htm key SPEAKER If this command does not activate the phone s speaker your network configuration will have to be fixed before you can be able to use the Snom switchboard Warning When using a Snom switchboard you should not use the first function key Create an Agent for the Operator Each operator needs to have an associated agent Warning Each agent MUST ONLY be a member of the Switchboard queue To create an agent Go to Services Call center Agents Click on the group default Click on the Add button General Users Queues Advanced First name Bob Last name Number 1674 Password Context Default default 21 Language Group defaut Save Associate the user to the agent in the Users tab Assign the Agent to the Switchboard Queue and ONLY to the Switchboard queue 1 8 Administration 153 XiVO doc Documentation Release 14 08 General Users Queues Advanced 1 items selected Remove all Add all 2 Bob Abraham Maharba Alice Wonderland Charlie Chaplin Voice Mail General Users Queues Advanced Search boulangerie switchboard
327. o extern P ARV 12 Interface dahdi gO Interface suffix Context Appels sortants to extern v Description Save REM Debug Interesting Asterisk commands sip show peers sip show registry 51 set debug on Caller ID When setting up an interconnection with the public network or another PBX it is possible to set a caller ID in different places Each way to configure a caller ID has it s own use case The format for a caller ID is the following My Name 9999 If you don t set the number part of the caller ID the dialplan s number will be used instead This might not be a good option in most cases 122 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Outgoing call caller ID When you create an outgoing call it s possible to set the it to internal using the check box in the outgoing call configuration menu When this option is activated the caller s caller ID will be forwarded to the trunk This option is use full when the other side of the trunk can reach the user with it s caller ID number General Exten Call permissions Schedules Name test originate Context Outcalls to extern Use ENUM Internal Preprocess subroutine Ringing time before hangup Unlimited z Trunks 1 items selected Remove all Add all t test originate SIP trunki dahdi
328. o generate a file versions mak that contains version informations about the code being compiled It is necessary for compilation and packaging You can then launch make make Binaries are available in the bin directory The version of the executable is taken from the git describe command Debug build Add DEBUG yes on the command line make DEBUG yes Cleaning make distclean Launch You can launch the built executable with DYLD LIBRARY PATH bin bin xivoclient app Contents MacOS xivoclient Package You need to have the bin directory of Qt in your PATH To create the app bundle make pack This will result in a dmg file in the current directory The version of the package is taken from the describe command 1 12 Developers 337 XiVO doc Documentation Release 14 08 Coding the XiVO Client Project folder map baselib folder baselib contains all files necessary to build the baselib It contains the necessary code and data structures to communicate with the XiVO CTI server This library is designed to be reusable by other XiVO CTI clients If you want to build it without the rest of the XiVO Client go in its folder and type qmake amp amp make The library will be available in the new bin folder xivoclient folder xivoclient contains all other source files included in the XiVO Client src contains the source code files images contains the images i 8n contains
329. o make sure that the files can be read on SIGHUP configuration reloads wpa psk file etc hostapd wpa psk Set of accepted key management algorithms WPA PSK WPA EAP or both The ntries are separated with a space WPA PSK SHA256 and WPA EAP SHA256 can be added to enable SHA256 based stronger algorithms dotllRSNAConfigAuthenticationSuitesTable wpa key mgmt WPA PSK 1 12 Developers 325 XiVO doc Documentation Release 14 08 Set of accepted cipher suites encryption algorithms for pairwise keys unicast packets This is a space separated list of algorithms CCMP AES in Counter mode with CBC MAC RFC 3610 IEEE 802 111 7 01 TKIP Temporal Key Integrity Protocol IEEE 802 11i D7 0 Group cipher suite encryption algorithm for broadcast and multicast frames is automatically selected based on this configuration If only CCMP is allowed as the pairwise cipher group cipher will also be CCMP Otherwise TKIP will be used as the group cipher dot11RSNAConfigPairwiseCiphersTable Pairwise cipher for WPA vl default TKIP 7920 only supports TKIP wpa_pairwise TKIP Pairwise cipher for RSN WPA2 default use wpa_pairwise value rsn_pairwise CCMP Time interval for rekeying GTK broadcast multicast encryption keys in seconds dot11RSNAConfigGroupRekeyTime wpa_group_rekey 600 Rekey when any STA that possesses the current is leaving the BSS dot
330. o upgrade 1 4 8 Upgrade Notes 14 08 Consult the 14 08 Roadmap The xivo database has been merged into the asterisk database The database schema has also been altered in a way that it might make the upgrade longer than usual Please consult the following detailed updated notes for more information Databases Merge Upgrade Notes The xivo database has been merged into the asterisk database in XiVO 14 08 This has an impact on The restore procedure There s only one database to restore now Also the procedure to restore the data while keeping the system configuration has been updated The data that is replicated between the master and the slave in a high availability cluster Previously all the configuration that was under the Configuration menu of the web interface was not replicated between the master and slave This is now replicated except for HA settings All the network configuration i e everything under the Configuration Network section All the support configuration i e everything under the Configuration Support section The call center statistics have also been excluded from the replication The way the replication is done has also been updated which makes it faster Optional Upgrade Procedure When upgrading to XiVO 14 08 the database schema will be altered This will result in a longer upgrade time if you have a lots of rows in the queue log table You can see the number of rows
331. oIP The type of the old interface will automatically be changed to the data type Configuring a physical interface In this example we ll add and configure the eth network interface on our XiVO First we see there s already an unconfigured network interface named 1 on our system Configuration merce Macaddress Method Address Gateway VLANID Action gt etho 08 00 27 ea b0 75 VolP Static 192 168 32 137 192 168 32 254 sers Entities Dehi 08 00 27 29 b7 e9 Data Directories unc eC CP I Web Services Access chen deeds E NER Certificates 1 Network Enable PDdisable gt Not apply Interfaces M M Listing the network interfaces To add and configure it we click on the small plus button next to it and we get to this page Configure physical interface In our case since we want to configure this interface with static information i e not via DHCP we fill the following fields Configure physical interface Note that since our ethO network interface already has a default gateway we do not enter information in the Default gateway field for our 1 interface Once we click on Save the XiVO will put the Apply network configuration button in bold To reconfigure the given network interface with the new information you click on it 42 Ch
332. ocedure XiVO 12 13 and before When upgrading from XiVO 12 13 or earlier you must do the following before the normal upgrade apt get update apt get install debian archive keyring 1 4 5 Specific procedure XiVO 1 2 1 and before Upgrading from 1 2 0 or 1 2 1 requires a special procedure before executing xivo upgrade apt get update apt get install xivo upgrade usr bin xivo upgrade 1 4 6 Specific Procedure Upgrading a Cluster Here are the steps for upgrading a cluster 1 On the master deactivate the database replication by commenting the cron in etc cron d xivo ha master 2 On the slave deactivate the xivo check master status script cronjob by commenting the line in etc cron d xivo ha slave 3 On the slave start the upgrade xivo slave xivo upgrade 4 When the slave has finished start the upgrade on the master xivo master xivo upgrade 5 When done launch the database replication manually xivo master xivo master slave db replication slave ip 6 Reactivate the cronjobs see steps 1 and 2 14 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 1 4 7 Upgrading to from an archive version Upgrade involving archive version of XiVO Archive package names Archive packages are named as follow XiVO version Archive package name 1 2 to 1 2 12 pf fai xivo 1 2 skaro 1 2 1 12 14 to 13 24 xivo fai skaro 13 04 from 13 25 xivo fai 13 25 Upgra
333. ocumentation Is the official administrator guide documentation available publicly on the vendor web site Is it available only after registering and login to the vendor web site Having access to the administrator guide documentation of the phone is also essential Once you ve found it download it and keep the link to the URL If you can t find it it s probably not worth going further Is the latest firmware of the phone available publicly on the vendor web site Is it available only after registering and login to the vendor web site Good auto provisioning support means you need to have an easy way to download the latest firmware of the phone Ideally this mean the firmware is downloadable from an URL with no authentication whatsoever In the worst case you ll need to login on some web portal before being able to download the firmware which will be cumbersome to automatize and probably fragile If this is the case it s probably not worth going further Does the phone need other files like language files If so are these files available publicly on the vendor web site After registering Although you might not be able to answer to this question yet because you might not know if the phone needs such files to be either in English or in French the two officially supported language in XiVO you ll need to have an easy access to these files if its the case Does the phone supports auto provisioning via DHCP HTIP
334. ome Licence Welcome into the XiVO installer Components check Configuration Thanks for choosing XiVO This installer will help you to configure a fully functional XiVO Entities and contexts Validation Let yourself be guided and don t forget to note informations you will set i e root password for XiVO administration interface login You can also get online help at https wiki xivo fr Have fun Step 1 Choose your language gt gt gt Language English gt Figure 1 1 Select the language License You then have to accept the GPLv3 License under which XiVO is distributed 4 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Licence Licence Components check Configuration Entities and contexts Validation 1 accept the terms of this licence B UNE _ Figure 1 2 Accept the license o Configura ore o lt Previous Licence r Hostname CREDERE Hostname 777 eben dead hera deo an e una deeuede ee beri Validation
335. ommunity supported devices sta ble repository 1 8 Administration 135 XiVO doc Documentation Release 14 08 e http provd xivo fr plugins 1 addons testing community supported devices test ing repository The difference between the stable and testing repositories is that the latter might contain plugins that are not working properly or are still in developement The archive repository contains plugins that were once in the stable repository After setting a new URL you must refresh the list of installable plugins by clicking the update icon of the Config uration Provisioning Plugin page How to manually tell the phones to get their configuration If you have set up a DHCP server on XiVO and the phones can access it you can skip this section The according provisioning plugins must be installed Aastra the web interface of your phone go to Advanced settings Configuration server and enter the following settings Download Protocol 12 HTTP Server XiVO IP address gt HTTP Path Aastra 8667 Polycom the phone go to Menu Settings Advanced Admin Settings Network configuration Server Menu and enter the following settings Server type HTTP e Server address http XiVO address gt 8667 000000000000 cfg Then save and reboot the phone Snom the web interface of your phone go to Setup Advanced U
336. on Release 14 08 dao the private Data Access Object It knows where to get data and how to update it such as SQL queries file names URLs but has no business logic model the public class used to represent the resource It must be self contained and have almost no methods except for computed fields based on other fields in the same object notifier private it knows to whom and in which format events must be sent validator private it checks input parameters from the service module 1 12 5 Profiling Python Programs Profiling CPU Time Usage Here s an example on how to profile xivo ctid for CPU time usage 1 2 Add the debian non free repository to etc apt sources list Install the python profiler package apt get update apt get install python profiler Stop the monit daemon etc init d monit stop Stop the process you want to profile i e xivo ctid etc init d xivo ctid stop Start the service in foreground mode running with the profiler python m cProfile o test profile usr bin xivo ctid d This will create a file named test profile when the process terminates The Debugging Daemons section documents how to launch the various XiVO services in foreground debug mode Examine the result of the profiling python m pstats test profile Welcome to the profile statistics browser sort time stats 15 sort cumulative stats 15 Measuring Code Coverage
337. on forms called sheets 1 8 Administration 91 XiVO doc Documentation Release 14 08 Dial Link 5 4 Unlink Incoming DID Ji Hangup Save r Example Display a Web page when an agent answers a call The first step is to assign the URL to a dialplan variable Go in the Services IPBX Configuration files and create a new file called setsheeturl conf In this file put the following setsheeturl exten s l NoOp Starting Set Sheet URL same n Set SHEET URL CTI http documentation xivo fr same n UserEvent dialplan2cti UNIQUEID UNIQUEID CHANNEL CHANNEL VARIABLE same n Return You can replace document ation xivo fr by the URL you want The second step is to set the URL when the call is queued To do that we will use a preprocessing subroutine This is configured in the queue configuration go to Services Call center Queues and edit the queue Set the field Preprocessing subroutine to setsheeturl the same as above The third step is to configure the sheet to open the wanted URL Go to Services CTI Server Sheets Models and create a new sheet Keep the default for everything except the Action tab add a field and set it to dp mysheeturl the same as above The fourth and final step is to trigger the sheet when the agent answers the queued call Go to Services CTI Server Sheets Events an
338. on parameter use either asc or desc as a direction when lt direction gt does not exist sorting a list Example requests G Hosts Accept List all available voicemails ET 1 1 voicemails HTTP 1 1 xivoserver application json List voicemails sort by descending number G Host Accept ET 1 1 voicemails order number amp direction desc xivoserver application json List only the first 10 voicemails containing the word john G Host Accept ET 1 1 voicemails search john amp limit 10 xivoserver application json Example response HTTP 1 1 200 OK Content Type application json otalt E 2 items number Context default password null email john doeGexample com language en US timezone eu fr max messages null attach audio false delete messages false ask password false John Doe 260 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 links rel voicemails href https xivoserver 1 1 name Roger Smith number 1001 context default password null email null language en_US timezone eu fr max_messages 20 attach_audio false delete_messages false ask_password false rel voicemails href https xivoserver 1 Get Voicemai
339. on the origin of the call Warning Note that this feature has not been tested for all phones and all call flows This page describes how you can customize this file but does not intend to list all validated call flows or phones This file ring conf consists profiles of configuration some examples for different brands are already included aastra snom etc one section named number where you apply the profile to an extension or a context etc Here is the process you should follow if you want to use customize this feature 50 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 1 Create a new profile e g myprofile aastra 2 Change the phonet ype accordingly in our example myprofile aastra phonetype aastra 3 Chose the ringtone for the different type of calls note that the ringtone names are brand specific myprofile aastra phonetype aastra intern lt 11 1 gt group lt Bellcore dr2 gt 4 Apply your profile in the section number to a given list of extensions e g 1001 and 1002 1001 default myprofile aastra 1002 default myprofile aastra e or to a whole context e g default default myprofile aastra 5 Restart xivo agid service Service xivo agid restart ipbx ini Path etc xivo web interface ipbx ini Purpose This file specifies various configuration options and paths related to Asteris
340. ondition is true if 2 3 4 1 1 1 6 print condition is true Consider refactoring your statement into a function if it becomes too long or the meaning isn t clear Bad Example if price tax bonus reduction fee lt money product pay money Good Example def calculate_price price tax bonus reduction fee return price tax bonus reduction fee final_price calculate_price price tax bonus reduction fee if final_price lt money product money Naming Class names are in CamelCase File names are in lower_underscore_cas Conventions for functions prefixed by find Return None when nothing is found 1 12 Developers 281 XiVO doc Documentation Release 14 08 Return an object when a single entity is found Return the first element when multiple entities are found Example def find by username username users userl user2 user3 user search user for user in users if user username username if len user search O0 return None return user search 0 Conventions for functions prefixed by get Raise an Exception when nothing is found Return an object when a single entity is found Return the first element when multiple entities are found Example def get user userid users userl user2 user3 user search user for user in users if user userid userid if len user search raise UserNotFoundEr
341. ons sh pull utils translations sh commit utils translations sh push After these first 3 commands you can visit transifex and check that the xivo client is 10096 translated for your language Once all the translations have been checked run the 3 following commands utils translations sh pull git commit git push Warning Under Arch Linux you must have 94 installed and PATH usr lib qt4 bin PATH before each command Add a new XiVO Client locale Localizing the XiVO Client goes through four steps Creating the new translation in Transifex Generate the translation files Embedding the translation in the binaries Display the new locale to be chosen Creating the new translation in Transifex Log into Transifex and click the Create language option Generate translation files translation files will be automatically generated from the source code For the command to create files for your locale you need to ensure it is listed in the project file There are a few project files you should edit each one will translate a module of the XiVO Client baselib baselib pro xivoclient xivoclient pro xivoclient xletlib pro 344 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 e xivoclient src xlets pro In these files you should add a line like this one TRANSLATIONS ROOT DIR il8n xivoclient fr ts This line adds a translation file for french
342. ontinued from previous page 7905G 7906G 7911G 7912G 7920 7921G 7940G 7941 Disable all forwarding NT N N Y N N Y Y Enable Disable forwarding on no answer NT N N Y N N Y Y Enable Disable forwarding on busy NT N N Y N N Y Y Enable Disable forwarding unconditional NT N N Y N N X Y Voicemail Functions Enable voicemail with supervision function NT N N N N N N N Activate voicemail NT N N N N N Y Y Reach the voicemail NT N N SK N N HK HK Delete messages from voicemail NT N N Y N N Y Y Agent Functions Connect Disconnect a static agent NT N N Y N N Y Y Connect a static agent NT N N Y N N Y Y Disconnect a static agent NT N N Y N N Y Y Parking Functions Parking NT N N N N N N N Parking position NT N N N N N N N Paging Functions Paging NT N N Y N N Y Y To install firmware for xivo cisco sccp plugins you need to manually download the firmware files from the Cisco website and save them in the var lib xivo provd plugins plugin name var cache direc tory Note The directory is created by XiVO when you install the plugin i e xivo cisco sccp legacy If you create the directory manually the installation may fail For example if you have installed the xivo cisco sccp legacy plugin and you want to install the 7940 7960 fw networklocale and userlocale fr FR package you must Go to http www cisco com Click on In in the top right corner of the page and then log i
343. or TFTP The provisioning system in XiVO is based on the popular method of using a DHCP server to tell the phone where to download its configuration files and a HTTP or TFTP server to serve these configuration files Some phones support other methods of provisioning like TR 069 but that s of no use here Also if your phone is only configurable via its web interface although it s technically possible to configure it automatically by navigating its web interface it s an extremely bad idea since it s impossible to guarantee that you ll still be able to provision the phone on the next firmware release If the phone supports both HTTP and TFTP pick HTTP it usually works better with the provisioning server of XiVO What are the default usernames passwords on the phone to access administrator menus phone UI and web UI How do you do a factory reset of the phone Although this step is optional it might be handy later to have these kind of information Try to find them now and note them somewhere What are the DHCP options and their values to send to the phones to tell it where its configuration files are located Once you know that the phone supports DHCP HTTP provisioning the next question is what do you need to put in the DHCP response to tell the phone where its configuration files are located Unless the admin documentation of the phone is really poor this should not be too hard to find Once you have found this info
344. or not Blank for a phone Answered calls Number of calls answered by the member since last login for an agent or restart or configura tion reload Last call Hangup time of the last answered calls Penalty Penalty of the queue member Link XiVO Client presence to agent presence You can configure XiVO to have the following scenario The agent person leaves temporarily his office lunch break He sets his presence in the XiVO Client to the according state The agent will be automatically set in pause and his phone will not ring from queues He comes back to his office and set his presence to Available The pause will be automatically cancelled 1 9 Contact Center 175 XiVO doc Documentation Release 14 08 Agent Details Charlie Chaplin 103 default Logout X d Queues Join Grocery store green Bakery Switchboard queue early rtp superQueue q12 q13 SwitchboardHold bro Figure 1 76 Agent Details Queue Members picerie 301 default 2 agent s and 2 phone s Number Firstname Lastname Logged Paused Answered calls Last call Penalty 101 Wonderland Not paused 0 2 m em s Paul Castagnette 0 0 102 Bob Cat Logged out Not paused 0 6 176 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 You can configure the presence states of CTI profi
345. ory of the xivo manage db repository There should be an alembic ini file in this directory You can then use the following command to create a new migration script alembic revision m description This will create a file in the alembic versions directory which you ll have to edit When the migration scripts are executed they use a connection to the database with the role user asterisk This means that new objects that are created in the migration scripts will be owned by the asterisk role and it is thus not necessary nor recommended to explicitly grant access to objects to the asterisk role i e no GRANT ALL command after a CREATE TABLE command 1 12 10 Diagrams Agent states Graphs representing states and transitions between agent states Used in Agent status dashboard and agent list Download DIA 1 12 11 Provisioning This section describes the informations and tools for xivo provd Managing DHCP server configuration This page considers the configuration files of the DHCP server etc dhcp dhcpd update 1 12 Developers 307 XiVO doc Documentation Release 14 08 Who modifies the files The files are updated with the command dhcpd update which is also run when updating the provisioning plugins This commands fetches configurations files from the provd xivo fr server How to update the source files Ensure your modifications are working e XiVO edit manually the file etc dhcp dhc
346. ote that this kind of access control requires a driver that uses hostapd to take care of management frame processing and as such this can be used with driver hostap or driver n180211 but not with driver madwifi 0 accept unless in deny list 1 deny unless in accept list 2 use external RADIUS server accept deny lists are searched first macaddr_acl 0 Accept deny lists are read from separate files containing list of MAC addresses one per line Use absolute path name to make sure that the files can be read on SIGHUP configuration reloads accept_mac_file etc hostapd accept deny mac file etc hostapd deny IEEE 802 11 specifies two authentication algorithms hostapd can be configured to allow both of these or only one Open system authentication should be used with IEEE 802 1X Bit fields of allowed authentication algorithms bit 0 Open System Authentication bit 1 Shared Key Authentication requires WEP auth algs 1 Send empty SSID in beacons and ignore probe request frames that do not Specify full SSID i e require stations to know SSID default disabled 0 1 send empty length 0 SSID in beacon and ignore probe request for broadcast SSID 2 clear SSID ASCII 0 but keep the original length this may be required with some clients that do not support empty SSID and ignore probe requests for broadcast SSID ignore broadcast ssid 0 TX queue parameters EDC
347. ou want and in the right directory get the exe file for Windows the deb file for Ubuntu or Debian 1386 or amd64 depending on your computer the dmg file for Mac OS For Windows double click on the file and follow the instructions For Ubuntu Debian double click on the file or execute the following command gdebi xivoclient deb For Mac OS double click on the file and drag and drop the inner file on the Application entry of the Finder The XiVO Client should then be available in the applications menu of each platform 1 5 2 Connection to the server To connect to the server using the XiVO client you need a user name a password and the server s address Op tionally it is possible to login an agent while connecting to the server An option is available in the configuration account to show agent login info 1 5 3 Xlets Xlets are features of the CTI Client It is the contraction of XiVO applets 1 5 CTI Client 27 XiVO doc Documentation Release 14 08 XivO client dev 1331663094 f11430a XiVO Client Help Login myuser 55 Keep Password Phone 1000 Agent logged 2 Conference Overview The conference xlet allow the user to join conferences and view conference room statuses Contacts Fax History Directory Services PersonalDirectory Conference Conference room list Name v Number Pin code M
348. ox Checklist 1 12 15 Adding support for a new SCCP phone Introduction This page describes the requirements to considered that a SCCP phone is working with XiVO libsccp Checklist Basic functionnality Register on Asterisk SCCP reset restart Call history Date time display HA 1 12 Developers 345 XiVO doc Documentation Release 14 08 Telephony These test should be done with and without direct media enabled Emit a call Receive a call Receive and transfer a call Emit a call and transfer the call Hold and resume a call Features 0 and others Receive 2 calls simultaneously Emit 2 calls simultaneously DTMF on an external IVR Function keys Redial DnD Hold Resume New call End call Call forward Enable Call forward Disable Try each button in each mode on hook in progress etc Optionnal options to test and document Phone book Caller ID and other display 118 MWI Speeddial BLF 1 13 Troubleshooting The list of current bugs can be found on the official XiVO issue tracker 1 13 1 Transfers using DTMF When transfering a call using DTMF 1 you get an invalid extension error when dialing the extension The workaround to this problem is to create a preprocess subroutine and assign it to the destinations where you have the problem 346 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Under Services IPBX
349. pd_update conf Service isc dhcp server restart If errors are shown in var 10og daemon 1log check your modifications Edit the files Edit the files in the Git repo xivo provd plugins directory dhcp Push your modifications Goin dhcp e Run make upload to push your modifications to provd xivo fr There is no testing version of these files Once the files are uploaded they are available for all XiVO installations Managing Plugins Git Repository Most plugin related files are available in the xivo provd plugins repository Following examples are relative to the repository directory tree Any modifications should be preceeded by a git pull Updating a Plugin We will be using the xivo cisco spa plugins family as an example on this page There is one directory per family Here is the directory structure for xvo cisco spa plugins xivo cisco spa model name xxx model name xxx t common build py Every plugin has a folder called common which regoups common ressources for each model Every model has its own folder with its version number After modifying a plugin you must increment the version number You modifiy the file plugin info to change the version number plugins xivo cisco spa model name xxx t plugin info Important If ever you modify the folder common you must increment the version number of all the models 308 Chapter 1 Table of Contents XiVO doc Documentatio
350. pdate and enter the following settings 136 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Network Behavior Audio SIP RTP QoS Security Update Update Update Policy late automatical Setting URL Settings refresh timer PnP Config on off Apply Reset Reboot Autoprovisioning a Device Once you have installed the proper provd plugins for your devices and setup correctly your DHCP server you can then connect your devices to your network But first go to Services IPBX Devices page You will then see that no devices are currently known by your V NS 3 oO EBX MAG 9 7 Modee General settings No device found SIP Protocol ESSE SSS SS ey Protocol E r n se SCCP Protocol f Dundi Protocol V Although existing in the provisioning server a Advanced Device property configured _ Outbound MWis i 9 Device configured mode Autoprov settings Device not configured verified if the plugin is installed for this device _ Users Groups Voicemails Conference rooms N Incoming calls Outgoing calls Call permissions Ca
351. pgrade an installed plugin uninstall an installed plugin edit an installed plugin i e install uninstall optional files that are specific to each plugin like firmware or language files After installing a new plugin you are automatically redirected to its edit page You can then download and install optional files specific to the plugin You are strongly advised to install firmware and language files for the phones you ll use although it s often not a strict requirement for the phones to work correctly 134 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Q Update plugin list 1 2 Next page Desin 1 Version Size Actin null Plugin that offers no configuration service and rejects TFTP HTTP 10 105 kb xivo aastra 2 6 0 2019 Greffon pour Aastra 6730i 67311 67511 67531 6755i wont ade this 8 29 kb oJ xivo aastra 3 2 2 1136 Greffon pour Aastra 6730i 67311 67391 67531 6755i 67571 675 0 116 0 4 99 874kb 988 xivo aastra 3 2 2 6268 Greffon pour Aastra 6735i et 6737i en version 3 22 6268 istall thi s plugi n 03 75kb S9 xivo aastra switchboard Greffon pour Aastra 6731i 6755i 6757i en version 3 2 2 1136 0 1 kb 3 xivo alcatel 2 01 10 Greffon pour Alcatel IP Touch 4008 and 4018 extended edition 0 1 1 6 07 kb O xivo avaya 4 1 13 Greffon pour Avaya auparavant connu comme Nortel 1220 IP et 123 0 1 1 4 6
352. plate_id defaultconfigdevice Links og rel devices href https xivoserver 1 1 devices 412c212cff500cc158 373 00e078 7 Device list Query GET 1 1 devices Parameters order Sort devices using the specified field e g mac Allowed fields mac plugin model vendor version direction asc or desc Sort list in ascending asc or descending desc order limit total number of devices to show in the list skip number of devices to skip over before starting the list search Search devices Only devices with a field containing the search term will be listed Error Error message Description code 400 Invalid parameters limit must be a positive the limit parameter must be a number number 400 Invalid parameters skip must be a positive the skip parameter must be a number number 400 Invalid parameters ordering parameter you must use one of the fields available in a lt field gt does not exist device when sorting a list 400 Invalid parameters direction parameter use either asc or desc as a direction when direction does not exist sorting a list Example requests List all devices GET 1 1 devices HTTP 1 1 Host xivoserver Accept application json List 10 devices sorted by mac address 224 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 GET 1 1 devices limit 10 amp order mac HTTP 1 1
353. ples of custom filters e cn SOx amp cn Qx mail example org e cn SQx displayName Qx 1 8 Administration 75 XiVO doc Documentation Release 14 08 Add a LDAP filter to the Phonebook In the Services General settings Phonebook page click on the LDAP filters page and add your filter to the list of enabled filters Please refer to the Remote directory section in order to properly configure a remote directory You ll then be able to search your LDAP server directly from your phone and dial from the displayed results Use with CTI Server and Client XiVO Add a LDAP Directory Filter to the CTI Server the Services CTI Server Directories Definitions page click on the add button CTI Server directories General settings General Idap Profiles E URI Idapfiter lidapserver1 v Status Presences m Phone hints Direct match en phoneNumber email E Match reverse directories Definitions 1 Reverse directories Mapped fields N Direct directories Display fiters Fieldname Value fel Sheets lastname sn Models phone telephoneNumber Events Control mail email Restart CTI server firstname givenName fullname cn Description LDAP Directory Save Figure 1 31 Adding a directory LDAP Filter to CTI Server e Di
354. pleted calls e Round robin memory call the next member after the one who answered Random call a member at random Weight random same as random but taking the member penalty into account Ring all call all members at the same time Warning When editing a queue you can t change the ring strategy to linear This is due to an asterisk limitation Unfortunately if you want to change the ring strategy of a queue to linear you ll have to delete and create a new queue with the right strategy Timers You may control how long a call will stay in a queue using different timers Member reachabillity time out Advanced tab Maximum number of seconds a call will ring on an agent s phone If a call is not answered within this time the call will be forwareded to another agent Time before retrying a call to a member Advanced tab Used once a call has reached the Member reachability time out The call will be put on hold for the number of seconds alloted before being redirected to another agent Ringing time Application tab The total time the call will stay in the queue Timeout priority Application tab Determines which timeout to use before ending a call When set to configuration the call will use the Member reachability time out When set to dialplan the call will use the Ringing time 168 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Time before Member
355. pter 1 Table of Contents 55555 1000 55555 55555 55555 1000 1000 55555 55555 55555 55555 1001 55555 55555 1001 1001 55555 55552 XiVO doc Documentation Release 14 08 Virtual host User name guest User password guest Port 5672 Example Here s an example of a simple client in python listening for the call form result CTI events usr bin python import pika connection pika BlockingConnection pika ConnectionParameters localhost channel connection channel result channel queue declare exclusive True queue_name result method queue channel queue_bind exchange xivo cti queue queue name routing key call form result def callback ch method props body print Received body ch basic ack delivery tag method delivery tag 1 consume callback queue queue name channel start consuming If you are new to AMQP you might want to look at the RabbitMQ tutorial Notes Things to be aware when writing a client consumer The xivo service stop command stops the AMQP broker This means that the client connections to the AMQP broker will be lost on a XiVO upgrade an asterisk crash The published messages are not persistant When the AMQP broker stops the messages that are still in queues will be lost Events Events that are sent to the bus use a JSON serialization format For example
356. ption disable user user Good Example def is user available user if user available return True else return False if not is user available user disable user user Avoid throwing Exception Use one of Python s built in Exceptions or create your own custom Exception A list of exceptions is available on the Python documentation website Bad Example def get user userid user session query User get userid if not user raise Exception User not found Good Example class UserNotFoundError LookupError def init self userid message user with id not found userid LookupError init self message def get user userid user session query User get userid 284 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 if not user raise UserNotFoundError userid Never use except without specifying any exception type The reason is that it will also catch important exceptions such as KeyboardInterrupt and OutOfMemory exceptions making your program unstoppable or continuously failing instead of stopping when wanted Bad Example try get user user id except logger exception There was an error Good Example try get user user id except UserNotFoundError as e logger error e message raise Component specific information 1 12 8 CTI Server This section describes the informations and tools for CTI Server
357. queues are displayed There is a little contextual menu when right clicking on the title bar of every queue window Checking unchecking the lines of this menu shows hides the associated queue Known issues There is no profile containing this xlet The profile must be created manually There is no sorting on agents in a queue An empty queue will display an empty box with no message specifying the queue has no logged agents 178 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 bigqueue debordement Ghost 11008 v Queue 11000 Queue 11002 Queue 11001 W Queue 11004 Queue 11003 Queue 11006 Queue 11005 Queue 11007 Configuration No special configuration is necessary other than creating a CTI profile in which the Agent Status Dashboard is added 1 9 5 Skills Based Routing Introduction Skills based routing SBR or Skills based call routing is a call assignment strategy used in call cen tres to assign incoming calls to the most suitable agent instead of simply choosing the next available agent It is an enhancement to the Automatic Call Distributor ACD systems found in most call cen tres The need for skills based routing has arisen as call centres have become larger and dealt with a wider variety of call types Wikipedia In this respect skills based routing is also based on call distribution to agents through waiting queues but one or many skills
358. r Refer to MeetmeList __init__ fora callback registration example and to MeetmeList invite for the implementation of a callback from xivo cti cti commands invite confroom import InviteConfroom class MySuperClass object def init self InviteConfroom register callback self invite confroom handler def invite confroom handler self invite confroom command Do your stuff here if ok return invite confroom command get message Everything is fine else return invite confroom command get warning I don t know you go away True Note The client s connection is injected in the command instance before calling callbacks functions The client s connection is an interface cti CTI instance ppcticonf ppcticonf is a small utility used to pretty print the CTI server configuration The utility is installed by default with XiVO It comes with the xivo utils package In fact ppcticonf can be used to pretty print any URL or file that contains a JSON document How to The simplest invocation is 1 12 Developers 305 XiVO doc Documentation Release 14 08 ppcticonf agentstatus bench 0 077938079833984 certfilo xar lib xivo certificates test2 crt channelstatus contexts nva didextens aUe default directories internal display Display You can also pass a URL as an argument ppcticonf http 12
359. r agents Hours start hh mm Beginning of working hours end hh mm End of working hours Periods Number of calls answered for a time period Period 1 number of Show number of calls answered within 20 seconds in column seconds Example 20 Period n number of Show number of calls answered within 20 seconds in column seconds Example 20 Note Calls outside of working hours will not be in the cache e g if working hours are from 8 00 AM to 16 00 PM a call at 7 55 AM will not show up in the reports Note Statistics are computed on the hour e g If work hours are from 8 30 to 16 15 working hours should be set from 8 00 to 17 00 Note Period includes both bounds if the same number is used for the higher bound and the lower bound of next period some calls will be counted twice i e period 1 0 30 period 2 31 60 period 3 61 1 9 Contact Center 185 XiVO doc Documentation Release 14 08 How to generate the cache The cache must be generated before using reports By default the cache is automatically generated every six hours However you can safely generate it manually The script to generate the cache is xivo stat fill db When this script is run statistics will be regenerated for the last 8 hours starting from the previous hour e g If you run xivo stat on 2012 08 04 11 47 00 statistics will be regenerated from 2012 08 04 03 00 00 to 2012 08 04 11 47 00 Note xivo
360. r can be activated through the XiVO Web Interface Configuration Network DHCP Active 1 Pool end Extra network interfaces Save A H Figure 1 25 Configuration Network DHCP By default it will only answer to DHCP requests coming from the VoIP subnet defined in the Configuration Network Interfaces section If you need to activate DHCP server on an other interface you have to fill the Extra network interfaces field with for example et h0O After saving your modifications you need to click on Apply system configuration for them to be applied Change default gateway for DHCP By default the XiVO DHCP server gives the XiVO IP address in the router option To change this you must create a custom template 1 Create a custom template for the dhcpd subnet conf head file mkdir p etc xivo custom templates dhcp etc dhcp cd etc xivo custom templates dhcp etc dhcp cp usr share xivo config templates dhcp etc dhcp dhcpd subnet conf head 2 Edit the custom template vim dhcpd subnet conf head 3 In the file replace the string amp XIVO by the router of your VoIP network for example option routers 192 168 2 254 4 Re generate the dhcp configuration xivo update config DHCP server should have been restarted and should now give the new router option Configuring DHCP server to serve unk
361. r the number of answered calls where x is defined in the configuration Agent performance Agent performance statistics can be viewed in Services Statistics Performance agents Statistics Performance agents 000000000000 s of calls Total time Configuration Queue Answered Login Pause Wrapup Performance agents 8h 9h 11 00 00 52 16 00 00 00 00 01 50 Period details _ 9h 10h 3 00 00 25 000142 00 00 00 00 00 30 10h 11h 0 00 00 00 00 00 00 00 00 00 00 00 00 Dashboard 11 12 2 00 00 12 00 03 56 00 00 09 00 00 40 mm Total 16 00 02 44 00 57 55 00 00 09 00 03 00 rcr c E E wu ES EE Analysis Axis Day zi Day 2012 10 24 Working days TUE WED THU FRI SAT SUN Performance Note The agent performance counters do not take into account transfer between agents if agent A processes a call and transfers it to agent B only the counters of agent A will be updated Ignoring any info after the call transfer Counters e Answered Number of calls answered by the agent e Conversation Total time spent for calls answered during a given period Login Total login time of an agent Wrapup Total time spent in wrapup by an agent Pause Total pause time of an agent Warning Data generated before XiVO 12 19 might have erroneous results for the Login time counter Note The Pause time counter only
362. rch in your XiVO directory and place call directly from your phone Supported devices Tested Aastra 6700 series using the 3 2 or later firmware does not work on firmware 2 6 Snom 320 Cisco 7940G 7941G Untested Thomson Yealink Configuration For the remote directory to work on your phones the first thing to do is to go to the Services IPBX General settings Phonebook page You then have to add the range of IP addresses that will be allowed to access the directory So if you know that your phone s IP addresses are all in the 192 168 1 0 24 subnet just click on the small icon and enter 192 168 1 0 24 then save Once this is done on your phone just click on the remote directory function key and you ll be able to do a search in the XiVO directory from it Jitsi Jitsi http jitsi org is an opensource softphone previously SIP Communicator XiVO now support Jitsi sofphones provisioning Here are the steps to follow Requirements This how to needs 1 Jitsi installed 2 SIP line created Add Jitsi plugin on XiVO Open XiVO Web interface and go to Configuration tab Then chose Provisioning Plugins menu Install the Jitsi plugin you want to use e g xivo jitsi 1 You can now launch your Jitsi softphone 142 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Configuring Jitsi 1 Launch Jitsi 2 If you don t have any accounts configure
363. rder for SCCP phones to use directmedia one must enable the directn Services IPBX IPBX settings SCCP general settings Features Features Supported Receive call Yes Initiate call Yes Hangup call Yes Transfer call Yes Congestion Signal Yes Autoanswer custom dialplan Yes Call forward Yes Multi instance per line Yes Message waiting indication Yes Music on hold Yes Context per line Yes Paging Yes Direct RTP Yes Redial Yes Speed dial Yes BLF Supervision Yes Resync device configuration Yes Do not disturb DND Yes Group listen Yes Caller ID Yes Connected line ID Yes Group pickup Not yet Auto provisioning Not yet Multi line Not yet Codec selection Yes NAT traversal Not yet Type of Service TOS Manual 146 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Telephone Device type Supported Firmware version Direct media 7905 Should work Yes 77906 Should work Yes 7911 Yes 5 1 8 5 35 Yes 7912 Yes 8 0 4 080108A Yes 7920 Yes 3 0 2 Yes 7921 Yes 1 4 5 3 Yes 7940 Yes 8 1 2 0 Yes 7941 Yes SCCP41 9 0 3S Yes 7941GE Yes SCCP41 9 0 3S Yes 7942 Yes 5 42 9 0 35 7960 Yes 8 1 2 0 Yes 77961 Yes SCCP41 9 0 3S Yes 7962 Yes SCCP42 9 0 3S Yes CIPC Yes 2 1 2 Yes An unsupported device won t be able to connect to Asterisk channel sccp at all Hand written configuration The sccp conf sample file can be consulted for an example of an ha
364. re 3000 CH Alice Wonderland Listen E green 3500 102 Bob Cat Listen 3 0 Bakery 301 1 D V een FR 103 Charlie Chaplin Listen SuperQueue 3006 Clicking on a queue s name in the queue list will display the agent list in the xlet Queue Members and show waiting calls in the Calls of a Queue xlet Clicking on an agent s name in the agent list will display information on the agent in the Agent Details xlet Clicking on the icon in the Agent Details xlet will display information about the selected queue in the Calls of a Queue and Queue Members xlets Queue List General information The queue list is a dashboard displaying queue statistics and real time counters for each queue configured on the XiVO Columns 1 9 Contact Center 171 XiVO doc Documentation Release 14 08 Queues List uses cats Ew eng mia Avions 00 00 1 ji 0 0 0 5 z Bureautique 1 2 X 2 o 00 04 00 04 100 100 Casserolles 0 00 00 1 4 3 2 0 2 00 30 00 39 Charg e 00 00 0 1 1 0 0 0 Queues queue name and number if configured to be displayed Waiting calls The number of calls currently waiting for an agent in this queue The background color can change depending of the configured thresholds EWT Estimated waiting time Longest wait The longest waiting time for currently waiting calls The background color can change depending of the configured thresholds Talking The
365. rect match use to search into this field Match reverse directory use to search into this field for the reverse directory Fieldname value match to the CTI field server field LDAP server Add a LDAP Directory to the CTI Server the Services CTI Server Directories Direct directories page click on the edit button for default directory To use this directory you must then add to the list of searchable directories Warning The CTI server settings resonates in contexts This means creating a context for each CTI context of membership of your users who will examine the Directories eg CTI Context default for users in context default Restart CTI Server 1 8 2 Boss Secretary Filter The boss secretary filter allow to set a secretary or a boss role to a user Filters can then be created to filter calls directed to a boss using different strategies 76 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 CTI Server Name aea Profiles Display fiter Display Status Presences Phone hints Agents Search Directories Definitions Reverse directories H gt internal M Y Direct directories i Idap Display filters O O MELLE Sheets Modes o Events 1 Control Restart CTI server Directories
366. rectories to include to reverse lookups in the Related directories section Restart the CTI server and incoming caller IDs should be resolved using the specified directories 1 8 23 Provisioning XiVO supports the auto provisioning of a large number of telephony Devices including SIP phones SIP ATAs and even softphones 132 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Introduction The auto provisioning feature found in XiVO make it possible to provision i e configure a lots of telephony devices in an efficient and effortless way How it works Here s a simplified view of how auto provisioning is supported on a typical SIP hardphone 1 The phone is powered on 2 During its boot process the phone sends a DHCP request to obtain its network configuration 3 A DHCP server replies with the phone network configuration an HTTP URL 4 phone use the provided URL to retrieve a common configuration file a MAC specific configuration file a firmware image and some language files Building on this configuring one of the supported phone on XiVO is as simple as 1 Configuring the DHCP Server 2 Installing the required provd plugin 3 Powering on the phone 4 Dialing the user s provisioning code from the phone And voila once the phone has rebooted your user is ready to make and receive calls No manual editing of configuration files nor fiddling in the phone s web interface Limitations Devi
367. removed upon the deletion of a desin tation resource See Function Key destinations for speed dials for further details This action is for deleting function keys that cannot be removed automatically i e custom speed dials and other types of function keys Warning Not implemented yet Error Error message Description code Eitors 400 error while deleting Function Key See error message for more details lt explanation gt 404 Not found The requested function key was not found or does not exist Query DELETE 1 1 func_keys lt id gt Example request DELETE 1 1 func_keys 1 HTTP 1 1 Host xivoserver Example response HTTP 1 1 204 No Content Lines The resource lines only provides read operations Modifications can only be done on protocol specific lines see below Generic Lines Line Representation Description 238 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 provisioning extension int Field Values Description id int Read only context string The name of an internal context name string The name of the line protocol string only value sip Read only Code used to provision a device device slot int line s position on the device device id string ID of the device associated to the line links list The links to the resource SIP example iy Context default name alb2c4 protocol s
368. right of the page You ll then be shown this page You should look at the examples if you don t know which attributes to set when creating your certificates Removing certificates When removing a certificate you should remove all the files related to that certificates Warning If you remove a certificate that is used somewhere in XiVO then you need to manually reconfigure that portion of XiVO For example if you remove the certificate files used for SIP TLS then you need to manually disable SIP TLS or asterisk will look for certificate file but it won t be able to find them Examples In the following examples if a field is not specified than you should leave it at its default value 1 8 Administration 71 XiVO doc Documentation Release 14 08 General Name Certification authority Autosigned Certification authority CA password Password Cipher Key 1024 Validity end date Common name Email Unit Organization City Figure 1 27 Adding a certificate Creating certificates for SIP TLS You need to create both a CA certificate and a server certificate CA certificate Name phones CA Certification authority checkbox checked Autosigned checked Valid end date at least one month in the future Common name the FQDN Fully Qualified Domain Name of your XiVO Organization your organiza
369. rk configuration this access needs to be protected in many cases By default hostapd is configured to use gid 0 root If you want to allow non root users to use the contron interface add a new group and change this value to match with that group Add users that should have control interface access to this group 1 12 Developers 315 XiVO doc Documentation Release 14 08 This variable can be a group name or gid interface group wheel ctrl interface group 0 IE T E 802 11 related configuration SSID to used IEEE 802 11 management frames ssid example ssid Country code ISO IEC 3166 1 Used to set regulatory domain Set as needed to indicate country in which device is operating This can limit available channels and transmit power country code CA Enable IEEE 802 11d This advertises the country code and the set of allowed channels and transmit power levels based on the regulatory limits The country code setting must be configured with the correct country for IEEE 802 11d functions default 0 disabled 80211 1 Operation mode IE Default IEEE 802 11b 7920 only supports b hw mode b E 802 11a b IEEE 802 11b g IEEE 802 11g
370. rmation the easiest way to send it to the phone is to create a custom host declaration for the phone in the conf file like in this example host my phone hardware ethernet 00 11 22 33 44 55 option tftp server name http 169 254 0 1 foobar cfg What are the configuration files the phone needs filename and content what do we need to put in it for the phone to minimally be able to make and receive calls on XiVO 312 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Now that you are able to tell your phone where to look for its configuration files you need to write these files with the right content in it Again at this step you ll need to look through the documentation or examples to answer this question Note that you only want to have the most basic configuration here i e only configure 1 line with the right SIP registrar and proxy and the associated username and password 10 Do basic telephony services like transfer works correctly when using the phone buttons On most phones it s possible to do transfer both attended and direct three way conferences or put some one on hold directly from the phone Do some tests to see if it works correctly Also at this step it s a good idea to check how the phone handle non ascii characters either in the caller ID or in its configuration files 11 Does other standard features work correctly on the pho
371. ror userid return user search 0 Conventions for functions prefixed by find all Return an empty list when nothing is found Return a list of objects when multiple entites are found Example def find all users by username username users userl user2 user3 user search user for user in users if user username username return user search Magic numbers Magic numbers should be avoided Arbitrary values should be assigned to variables with a clear name Bad example class TestRanking unittest TestCase def test ranking self rank Rank 1 2 3 self assertEquals rank position 1 self assertEquals rank grade 2 self assertEquals rank session 3 Good example 282 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 class TestRanking unittest TestCase def test ranking self position 1 grade 2 session 3 rank Rank position grade session self assertEquals rank position position self assertEquals rank grade grade self assertEquals rank session session Tests Tests for a package are placed in their own folder named tests inside the package Example packagel init__ py modl py tests init__ py test modl py package2 init__ py mod9 py tests init py test mod9 py Unit tests should be short clear and concise in order to make the test easy to understand A unit test is separated into 3 sections
372. rovisioning the database This script should not be used by an administrator in normal circumstance Starting with XiVO 14 08 database migration are done with the help of alembic instead of the asterisk XXX sql and xivo XXX sql scripts alembic migration scripts can be found inside the usr share xivo manage db directory Otherwise the xivo check db and xivo update db commands have been updated to work with both the old and the new systems and are still the official way to check the database state and update the database respectively 14 07 Consult the 14 07 Roadmap Configuration for phones used for the switchboard has changed Please consult the following detailed updated notes for more information Switchboard Phone Configuration Upgrade Notes The xivo aastra switchboard and xivo snom switchboard plugins have been removed and their functionalities are now provided by the generic xivo aastra and xivo snom plugins respectively The upgrade is not done automatically so please follow the Upgrade Procedure section below Although you are strongly advised to upgrade your switchboard phone configuration backwards compatibility with the old system will be maintained Note that if you need to install a switchboard for a previous version of XiVO the old xivo aastra switchboard and xivo snom switchboard plugins can be found in the archive repository Upgrade Procedure This procedure should be executed after the upgrade to
373. rrect Proxy information is set via the etc xivo dhcpd update conf file Edit the file and look for the proxy section 48 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 xivo fetchfw This step is not needed if you don t use xivo fetchfw Proxy information is set via the etc xivo xivo fetchfw conf file Edit the file and look for the proxy section External links XiVO 1 1 and proxy server 1 6 4 Log Files Many XiVO services use the syslog s var log daemon log file to log events This log file s configuration is located at etc logrotate d rsyslog The default configuration for all services using this file is the following e File location var log daemon log Rotation frequence Weekly Number of archived files 4 agid The agid log files are sent to the system s syslog See log files above for global configuration info asterisk The Asterisk log files are managed by logrotate It s configuration files etc logrotate d asterisk and etc asterisk logger conf The message log level is enabled by default in logger conf and contains notices warnings and errors The full log entry is commented in logger conf and should only be enabled when verbose debugging is required Using this option in production would VERY large log files Default configuration e Files location var log asterisk Number of archived files 15 Rotation frequence Daily
374. rsi General Announces Members Application answer Diversions On estimated wait time overrun a Threshold estimated wait time 5 seconds v Destination Voicemail Redirect to User 1 1001 pcm dev v Play occupation message Do not play introduction message Do not play unavailable message Use n 101 method On waiting calls available agents ratio overrun 3 Threshold percent 12 Destination User v Redirect to User 3 Ring time i0 Estimated Wait Time Overrun When this scenario is used the administrator can set a destination for calls when the average waiting time is over the threshold Waiting Calls Available Agents Ratio When this scenario is used the administrator can set a destination when the call ratio is higher than the percent threshold The call ratio is calculated with the following formula call ratio number of waiting calls available agents 100 Here are a few examples Threshold 100 Waiting calls 3 Available agents 2 call ratio 3 2 100 150 Calls will be redirected Threshold 120 Waiting calls 9 Available agents 12 call ratio 9 12 100 75 Calls will not be redirected Warning With a threshold under 100 and only o
375. rule gt WT 60 technic amp 5 gt 29 amp Slang gt 39 Sos gt 39 Slang gt 19 rule gt WT lt 120 technic amp 05 gt 19 amp Slang gt 39 Sos gt 29 6 Slang gt 19 rule gt WT lt 3600 technic amp os gt 10 amp lang gt 19 rule technic e e client standard rule gt technic 0 amp sympathy gt 20 linux gt 10 amp windows gt 10 client request rule gt 120 technic 0 amp sympathy gt 60 rule gt technic 0 Apply Skill Rules Once skills skill rules are created they can attached to the call using a bit of dialplan This dialplan is stored in a configuration file you may edit using menu Services IPBX Configuration Files In the figure above 3 different languages are selected using three different subroutines Note Do not forget to issue a dialplan reload in Asterisk CLI after configuration file modification Each of this different selections of subroutines can be applied to the call qualifying object In the following example language selection is applied to incoming calls Example Configuration file for simple skill selection 182 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 File skills conf File content Figure 1 81 Use Rule Set In Dialplan Figure 1 82 Apply Rule Set to Incoming Call 1 9 Contact Center 183 XiVO doc Documentation Release 14 0
376. rward services changes are also reflected in the web interface in the services ipbx tab under IPBX settings users In the user configuration service tab Configuration The available service list is configured from the web interface in the services cti server tab under general settings profiles The right side of the service section contains services that are available to a given profile Dial Xlet Overview The Dial Xlet allows you to make calls from your computer via your phone This means that you can enter the number that you want to dial on your computer then your phone rings and when you answer it the called phone 1 5 CTI Client 37 XiVO doc Documentation Release 14 08 General Xlets Preferences Name client Display name Client A more understandable name Max GUI 1 Put 1 for no limit Presence xivo v Phonehints xivo v 2222222 5 lt lt lt 2 5 16 2 2 32264 32 2250 5 E Search Enable voicemail gt filter E E Enable DND Sa vante o anume N Transfer on busy Do EE S ELI will ring Usage You can enter the number you want to dial in the text box and then click the button or press enter to dial it If you dial an invalid extension a number is an ext
377. s ation the state of return not be returned Select the devices you want to synchronize by checking the boxes Search setings lions 00 14 7111 37 62 10 975 100 Technicolor 572030 xivo technicolor ST2030 2 74 rotocol Protocol i 00 08 5d 13 ca 05 10 97 5 102 Aastra 6738i xivo aastra 3 2 2 56 7 Voicemails Phonebook 00 0e 08 d 64 2e 10 97 5 103 5 962 xivo cisco spa legacy ET OL gencat 1 2 10 97 5 104 Technicolor 5 2030 xivo technicolor ST2030 2 74 50 IPBX settings Devices Lines Legen iaceo eee oue eee serre reseEca mcer ene aUe UE ME SEE ORE Aem Figure 1 42 Synchronize selected devices A pop up will emerge to request confirmation If synchronization mass was successfully sent to devices an information balloon green warn you of success 1 8 9 Directories This page documents how to add and configure directories from custom sources This does not include the con figuration of LDAP directories which are configured slightly differently Directories added from custom sources can be used for lookup via the CTI Client or for reverse lookup on incoming calls The directory feature of phones do not use these data sources 94 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 E
378. s After that you have to run in the XiVO Client root directory something like 1 12 Developers 341 XiVO doc Documentation Release 14 08 find name pro exec lupdate This will create or update all ts translation files registered in the pro files You can then start translating the strings in these files in the xivoclient i18n folder Code modification If you want to be able to select your new language from within the XiVO Client you have to add it in the interface For that you can add your new language in the m locale cbox QCombobox in ConfigWidget CTI debugging tool If you have a problem and you want to see what is going on between the CTI server and client you can use a specific script designed specifically for XiVO instead of using something like Wireshark to listen network communications Profiling To get profiling informations on the XiVO Client Compile the XiVO Client with debugging symbols Run the command LD LIBRARY PATH bin valgrind tool callgrind bin xivoclient Quit the client e Open the generated file callgrind out pid with KCacheGrind Automatic checking tools We use two tools to check the source code of the XiVO Client CppCheck et Valgrind CppCheck Usage cppcheck I baselib src I xivoclient src Valgrind Memcheck Usage LD LIBRARY PATH bin valgrind leak check full suppressions valgrind supp num callers 30 You need to fill a file valgri
379. s 3 1000 hangs up after a few seconds id eventtype eventtime userdeftype cid name cid num cid_ 4 4 4 8567 CHAN STAR 2012 03 28 13 58 49 004403 5555555555 5555555555 8568 APP START 2012 03 28 13 58 49 076665 25555555595 5555555555 55555 8569 CHAN STAR 2012 03 28 13 58 49 076842 Tux 1000 8570 ANSWER 2012 03 28 13 59 00 173302 Tux 1000 1000 8571 ANSWER 2012 03 28 13 59 00 173818 5555555555 5555555555 55555 8572 BRIDGE START 2012 03 28 13 59 00 173872 5555555555 5555555555 55555 8573 BRIDGE END 2012 03 28 13 59 06 386394 5555555555 5555555555 55555 8574 HANGUP 2012 03 28 13 59 06 38711 Tux 1000 1000 8575 CHAN END 2012 03 28 13 59 06 387153 Tux 1000 1000 8576 HANGUP 2012 03 28 13 59 06 387246 5555555555 5555555555 55555 8577 CHAN END 2012 03 28 13 59 06 387703 5555555555 5555555555 55555 11 rows 1 External user 555 555 5555 calls 446 2 1001 ignores the call id eventtype eventtime userdeftype cid name cid num cid an T Je le io 8620 CHAN STAR 2012 03 28 14 12 13 940952 5555555555 5555555555 8621 APP START 2012 03 28 14 12 14 028157 5555555555 5555555555 5555555 8622 CHAN STAR 2012 03 28 14 12 14 02839 1 1001 8623 2012 03 28 14 12 21 070432 1 1001 1001 8624 END 2012 03 28 14 12 21 070489 1 1001 1001 8625 ANSWER 2012 03 28 14 12 21 072653 5555555555 5555555555 5555555 8626 HANGUP 2012 03 28 14 12 26 202676 5555555555 5555555555 5555555 8627 CHAN END 2012 03 28 14 12
380. s containing the word user GET 1l 1 func keys search user amp limit 10 Host xivoserver Accept application json Example response HTTP 1 1 200 OK Content Type application json 2 items ges epe speeddial destination user destination id 12 links rel func keys href https xivoserver 1 transfer destination queue destination id 24 laxnks i rel func keys href https xivoserver 1 Get a Function Key Destination Query GET 1 1 func_keys lt id gt Example request GET 1 1 func keys 1 HTTP 1 1 Host xivoserver Accept application json Example response 1 func_keys 1 1 func_keys 2 236 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 HTTP 1 1 200 OK Content Type application json ml type speeddial destination user destination id 12 Ixnks s rel func keys href https xivoserver 1 1 func keys 2 Create a Function Key Destination Most function keys are automatically generated upon the creation of a desintation resource See Function Key destinations for speed dials for further details This action is for creating function keys that cannot be pre generated i e custom speed dials and other types of function keys Warning Not implemented yet Query POST 1 1 func keys
381. s english Skill rules english gt english gt 90 1 9 6 Statistics Overview The statistics page is used to monitor the efficiency of queues and agents Statistics are automatically generated every six hours They can also be generated manually Configuration In order to display call center statistics you must create at least one configuration profile The configuration profile is used to generate reports from the cache The cache is generated independently from the configuration so adding a new configuration does not require a new cache generation 184 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Queue p Performance agent Period details 2 configuration profile Configuration options Figure 1 83 Statistics Configuration Field Values Description name string Configuration name useful for remembering what the configuration is used for interval enum 0 999 Default time interval used when displaying statistics Examples 1 day day week show statistics for yesterday 3 weeks show statistics for the last 3 month weeks show on Display this configuration on the summary page summary page timezone Amer Your time zone ica Montreal Period Maximum and minimum dates that can be used for displaying statistics cache start YYYY MM Start date end YYYY MM End date If left to 0 use the servers current date Working Work hours fo
382. s in redundant and you will get the same result by not selecting the user Denying an incoming call coming from a specific extension from calling you Call permissions on incoming calls are semantically different from the other scenarios since the extension that you add to the permission will match the extension of the caller i e the caller number and not the extension that the caller dialed 1 the callee number Add the extension in the extensions list n the ncoming calls tab select the incoming call 1 8 4 Call Logs Call logs are pre generated from CEL entries The generation is done automatically by xivo call logd xivo call logs is also run nightly to generate call logs from CEL that were missed by xivo call logd Search Dashboard Call logs can be accessed using the menu Services IPBX Call management Call Logs page Start date 2013 08 28 End date Search Figure 1 33 Calls Records Dashboard Call logs are presented in a CSV file The CSV specifications are detailed in REST documentation Specifying no start date returns all available call logs Specifying a start date and no end date returns all call logs from start date until now REST API Call logs are also available from the REST See Call Logs 80 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Manual generation Call logs can also be generated manually To do so log
383. s user don t delete that voicema Deleting voicemail Delete voicemail is done on Services settings Voicemails 1 8 Administration 165 XiVO doc Documentation Release 14 08 Warning Deleting a voicemail is irreversible It deletes all messages associated with that voicemail f concerned user still have messages waiting for him you have to manually reboot the phone Disable password checking This option allows to skip password checking for the voicemail when it is consulted from the inside More precisely password checking will be skipped when calling the voicemail with 98 when calling the voicemail with 99 lt voicemail number But it will not be skipped when the voicemail is consulted through an incoming call For instance let s consider the following incoming call General Call permissions Schedules DID 53123 Context 1 from extern z Preprocess subroutine Description With such a configuration when calling this incoming call from the outside we will be asked for the voicemail number we want to consult the voicemail password even if the Disable password checking option is activated And then we will be granted access to the voicemail Take note that the second context field contains the context of the voicemail Voicemails of other contexts will not be accessible through this incoming call 1 9 Contact Center In
384. se 14 08 equipment the ISDN provider links could be switched to the PBX directly if the XiVO goes down XiVO does not offer natively the possibility to configure Berofos in this failover mode This section describes a workaround Logical view Provider XiVO ISDN Interconnection PBX Phones Connection Beroxfos A B O O O OO OO OO H oe omo 2 T2 XiVO PBX 4 4 ku N The following describes how to configure your XiVO and your Berofos 1 Follow the Berofos general configuration firmware IP login password described in the the Berofos Instal lation and Configuration page 2 When done apply these specific parameters to the berofos bnfos set scenario 1 h 10 105 2 26 u admin berofos bnfos set mode 1 h 10 105 2 26 u admin berofos bnfos set modedef 1 h 10 105 2 26 u admin berofos bnfos set wdog 1 h 10 105 2 26 u admin berofos bnfos set wdogdef 1 h 10 105 2 26 u admin berofos bnfos set wdogitime 60 h 10 105 2 26 u admin berofos 3 Add the following script usr local sbin berofos workaround bin bash Script workaround for berofos integration with a XiVO in front of PABX res etc init d asterisk status does_ast_run if Sdoes_ast_run eq 0 J then usr bin logger 50 Asterisk is running If asterisk is
385. se the xivo upgrade script You can start an upgrade with the command xivo upgrade Note You can t use xivo upgrade if you have not run the wizard yet Upgrading to XiVO 1 2 from a previous version i e XiVO 1 1 is not supported right now When upgrading XiVO you must also upgrade all associated XiVO Clients There is currently no retro compatibility on older XiVO Client versions This script will update XiVO and restart all daemons There are 2 options you can pass to xivo upgrade d to only download packages without installing them This will still upgrade xivo upgrade and xivo service packages e f to force upgrade without asking for user confirmation Warning If xivo upgrade fails or aborts in mid process the system might end up in a faulty condition If in doubt run the following command to check the current state of xivo s firewall rules iptables nvL If among others it displays something like the following line notice the DROP and 5060 0 0 DROP udp w 0 0 0 0 0 0 0 0 0 0 Then your XiVO will not be able to register any SIP phones In this case you must delete the DROP rules with the following command iptables D INPUT p udp dport 5060 j DROP Repeat this command until no more unwanted rules are left 1 4 1 Typical Upgrade Process Read all roadmaps starting from your current version to the current prod version Read all existing Upgrade Notes see below st
386. sequences of an outage of the XiVO with this equipment the ISDN provider links could be switched to the PBX directly if the XiVO goes down XiVO does not offer natively the possibility to configure Berofos in this failover mode The Berofos Integration with PBX section describes a workaround Installation and Configuration Master Configuration There is nothing to be done on the master node Slave Configuration First install the bntools package apt get install bntools This will make the bn os command available You can then connect your berofos to your network and power it on By default the berofos will try to get an IP address via DHCP If it is not able to get such address from a DHCP server it will take the 192 168 0 2 24 IP address Note The DHCP server on XiVO does not offer IP addresses to berofos devices by default Next step is to create the etc bnfos conf file via the following command 1 10 High Availability HA 203 XiVO doc Documentation Release 14 08 bnfos scan x If no berofos device is detected using this last command you ll have to explicitly specify the IP address of the berofos via the h option bnfos scan x h berofos ip At this stage your etc bnfos conf file should contains something like this fos1 mac 00 19 32 00 12 1D host 10 34 1 50 login lt user gt lt password gt It is advised to configure your berofos with a static IP address You first n
387. ser Password phaickbebs9 IP Address 127 0 0 1 Port 5038 The section named Listening Ports allows the administrator to specify listening addresses and ports for the CTI server s interfaces Fast AGI is the CTI server s entry point for the Asterisk dialplan This address and port have nothing to do with the listening port and address of xivo agid CTI and CTIs are for the client s connection and secure connection respectively Web Interface is for the port used to receive events from the XiVO web interface Info server a debugging console to do some introspection on the state of the CTI server Announce is used to notify the CTI server when a dialplan reload is requested Listening ports Activate IP address Port 1 5 FastAGL 127 0 01 5002 CTIE 0 0 0 0 503 CTIS 0 0 0 0 vi Certificate 5013 Private Key i Web Interface 127 0 0 1 5004 Infoserver 127 0 0 1 5005 Announce 5 127 0 0 1 5006 RATE ESI StS aes EROR owe Sas wae Sn Ste ag eg ss Sa 3 The timeout section allow the administrator to configure multiple timeouts Socket timeout is the default timeout used for network connections Login timeout is
388. ser s language description string Additional information about the user caller id string Name that appears on the phone when calling AT outgo string Caller id to use when calling through a trunk Description ing_caller_id mo string Phone number for the user s mobile device bile_phone_number username string username for connecting to the CTI password string password for connecting to the CTI music_on_hold string Name of the MOH category to use for music on hold prepro string Name of the subroutine to execute in asterisk before receiving a call cess_ subroutine userfield string A custom field which purpose is left to the client If the user has no userfield then this field is an empty string Example teang ay firstname John lastname Doe timezone America Montreal language fr FR description The most common name in America Caller id Johnny outgoing caller id default mobile phone number 5554151234 username john password supersecretpassword music on hold wasting preprocess subroutine ivr userfrelg z List Users The users are listed in ascending order on lastname then firstname Query GET 1 1 users Parameters Warning filtering on the line number is not implemented yet 4 List only users matching this filter The filter is done on the firstname lastname and firstname lastname and 18 case insensitive Example requests Listi
389. st GET lines 34 extension Host xivoserver Accept application json Example Response HTTP 1 1 200 OK Content Type application json line id 34 extension id 12 rel lines sip href https xivoserver 1 1 lines sip 34 rel extensions href https xivoserver 1 1 extensions 12 Get the Line associated to an Extension Query GET extensions lt extension_id gt line Error code Error message Description Errors 404 Extension with id lt extension_id gt does not exist 404 Extension with id lt extension_id gt does not have a line Example Request GET extensions 48 line Host xivoserver Accept application json 1 11 and SDK 245 XiVO doc Documentation Release 14 08 Example Response HTTP 1 1 200 OK Content Type application json line id 34 extension id 48 links rel lines sip href https xivoserver 1 1 lines_sip 34 rel extensions href https xivoserver 1 1 extensions 48 Associate an Extension to a Line Query POST lines lt line_id gt extension Field Required Values Description Input extension id yes int Must be an existing id Error Error message Description code 404 Line with id line id does not exist Errors 400 Nonexistent parameters extension id extension id does not exist 400 Invalid param
390. stem Accessible I e data var Accessible EEE isc dhcp server Running 1 day s 05 42 38 0 00 Xm 0 32 1 16 MiB eo ntpd Running 1 day s 05 42 32 0 00 EE 0 33 1 19 MiB eoe rabbitmq Running 1 day s 02 41 49 0 00 EE 2 17 7 95 MiB eoe xivo agent Running 1 day s 02 41 30 0 00 EET 3 87 14 18 MiB eoo xivo agid Running 1 day s 02 41 36 0 00 1 93 7 06 MiB eo xivo ami Running 1 day s 02 41 33 0 00 EE 1 27 4 65 MiB eo xivo call logd Running 1 day s 02 41 32 0 00 RR 2 82 10 33 MiB eoe xivo confgend Running 1 day s 02 41 43 0 00 Em 3 19 11 71 MiB eoo xivo ctid Running 1 day s 02 41 27 0 00 6 07 22 24 MiB eo xivo provd Running 1 day s 02 41 41 0 00 EE 2 36 8 66 MiB eo xivo restapid Unmonitored eoo xivo sysconfd Running 1 day s 02 41 45 0 00 EE 1 61 5 89 MiB eoo System Displays generic information about the operating system network adresses uptime and load average Read only Device Displays free used space on physical storage partitions Read only CPU Monitors the CPU usage Read only Network Displays network interfaces and corresponding network traffic Read only Memory Displays Physical and swap memory usage Read only 1 8 Administration 125 XiVO doc Documentation Release 14 08 Other Services Lists XiVO related processes most of which are daemons with their corresponding status
391. stination in the directory xlet Press to confirm the selection and start the call Hanging Up a Call The switchboard operator can hang up its current call by either Clicking the Hangup button Pressing the F8 key If the operator has placed a new call via the Directory or Dial xlet and that call has not yet been answered he can cancel it in the same way 158 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Distributing a call Once the call has been answered and placed in the current call frame the operator has 3 choices transfer the call to another user using the Blind transfer button or the F4 key using the Attended transfer button or the F5 key put the call on hold using the Hold button or the F7 key e end the call using the Hangup button or key Transferring a call Transfer buttons allow the operator to select towards which destination he wishes to transfer the call This is made through the Directory xlet For defails about the xlet Directory usage and configuration see Directory Once the destination name has been entered press Enter If multiple destinations are displayed you can choose by double clicking on the destination using Up Down arrows then pressing Enter pressing the transfer button again Blind transfers are straightforward once the call is transferred the operator is free to manage other calls Attended transfers are a bit more complicated
392. supports PAUSEALL and UNPAUSEALL command from cticlient Note Wrapup time events were added to XiVO in version 12 21 1 9 Contact Center 189 XiVO doc Documentation Release 14 08 Nb of calls Total time Answered Conversation Login Pause Wrapup 2 Karine Boudoix 108 87 09 59 57 30 58 51 10 53 16 00 21 30 2 Ir ne Pourtox 106 39 03 52 40 34 08 47 9 Fred Epric 100 45 01 27 52 34 59 45 05 32 45 00 07 30 102 13 00 24 23 27 42 47 97 50 42 00 02 10 9 Mensour 101 0 00 00 00 00 00 00 00 00 00 00 00 00 22 39 31 00 09 45 2 Juliette Queriau 107 78 09 03 51 34 06 24 91 23 52 00 19 30 B Agent summary Agent per day Nb of calls Total time Answered Conversation Login Pause Wrapup 9h 10h 1 00 07 31 00 28 45 00 55 13 00 00 00 10h 11h 5 00 30 50 01 00 00 00 00 00 00 01 15 11h 12h 4 00 24 15 01 00 00 00 00 20 00 01 15 12h 13h 0 00 00 00 00 33 34 00 59 07 00 00 00 13h 14h 0 00 00 00 01 00 00 00 34 20 00 00 00 14h 15h 3 01 23 38 01 00 00 00 00 00 00 00 30 15h 16h 2 00 05 24 01 00 00 00 00 00 00 00 30 16h 17h 3 00 26 21 01 00 00 00 00 00 00 01 00 17h 18h 6 00 37 50 01 00 00 00 00 00 00 01 15 Total 24 03 35 49 08 02 20 02 29 01 00 05 45 Agent per week Answered Conversation Login Pause Wrapup Monday 1 24 03 35 49 08 0
393. sword when accessing the voicemail menu Example tide Ris name John Doe number 1000 Context default password 1234 email john doe example com language en US timezone eu fr max messages 10 attach audio false delete messages false ask password true Iainks s rel voicemails href https xivoserver 1 1 voicemails 1 Voicemail list Query GET 1 1 voicemails 1 11 and SDK 259 XiVO doc Documentation Release 14 08 Parameters order Sort the list using a column e g number Columns allowed name number context email language timezone direction asc or desc Sort list in ascending asc or descending desc order limit total number of voicemails to show in the list Must be a positive integer skip number of voicemails to skip over before starting the list Must be a positive integer search Search voicemails Only voicemails with a field containing the search term will be listed Error Error message Description code 400 Invalid parameters limit must be a positive the limit parameter must be a number number 400 Invalid parameters skip must be a positive the skip parameter must be a number number 400 Invalid parameters ordering parameter you must use one of the fields available in a lt field gt does not exist device when sorting a list 400 Invalid parameters directi
394. t Numbers interval start Numbers interval end Printed name Numbers interval start Numbers interval end DID length sj Figure 1 4 Entities and Contexts your system you can change it afterwards 3 Enter the DID range and DID length for your system 4 You may change the name of your outgoing calls context Validation Finally you can validate your configuration by clicking on the Validate button Note that if you want to change one of the settings you can go backwards in the wizard by clicking on the Previous button Congratulations you now have a fully functional XiVO server You can subscribe to the xivo announce list to always stay informed on the latest upgrades for XiVO Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 1 2 3 Post installation Display called name on internal calls When you call internally another phone of the system you would like your phone to display the name of the called person instead of the dialed number only To achieve this you must change the following SIP options Services gt IPBX General settings Protocol Default Trust the Remote Party ID yes Send the Remote Party ID select Incoming caller number display The display of caller number on incoming calls depends on what is sent by your operator You can modify it via the file etc xivo asterisk xivo in callerid conf Not
395. t be written in the configuration file if BaseEngine is not aware of their existence loaded in loadSettings and saved in saveSettings getSettings Through this function you can access the lowest level of configuration storage QSettings It also contains the options stored in BaseConfig but is less easy to use This direct access is used for purely graphical settings only used to remember the appearance of the GUI until the next launch These settings don t have to be shared with other widgets and storing them directly in QSettings avoids writing code to import export to from BaseConfig 338 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 getProfileSetting setProfileSetting This pair of methods allow you to read write settings directly in QSet tings but specifically for the current configuration profile Configuration profiles When starting XiVO Client with an argument this argument is interpreted as a profile name This profile name allows you to separate different profiles with different configuration options For example configuration profile profileA will auto connect with user A and password B and profileB will not auto connect but is set to connect with user C no password remembered To invoke these profiles use xivoclient profileA xivoclient profileB The default configuration profile is default user Recognizing extracting phone numbers Of course working on XiVO
396. t mean StartTLS and port 636 should then be used Protocol version the LDAP protocol version default 3 Warning When editing an LDAP server you ll have to restart the CTI server for the changes to be taken into account 1 8 Administration 73 XiVO doc Documentation Release 14 08 Notes on SSL TLS usage If you are using SSL with an LDAP server that is using a CA certificate from an unknown certificate authority you ll have to put the certificate file as a single file ending with crt into usr local share ca certificates andrun update ca certificates You also need to make sure that the etc ldap ldap conf file contains a line TLS CACERT etc ssl certs ca certificates crt After that restart spawn fcgi with etc init d spawn fcgi restart Also make sure to use the FQDN of the server in the host field when using SSL The host field must match exactly what s in the CN attribute of the server certificate Add a LDAP Filter Next thing to do after adding a LDAP server is to create a LDAP filter via the Services IPBX configuration LDAP Filters page LDAP filters define the information that will be searched and displayed when you do a directory search You can add a LDAP filter by clicking on the add button at the top right of the page You ll then be shown this page User uid aliee ou peopk Password foobar Base DN Phone number type Customized z Description Figure 1 29 Addin
397. t possible to maintain basic telephony function whatever your main XiVO server is running or not When running a XiVO HA cluster users are guaranteed to never experience a downtime of more than 5 minutes of their basic telephony service The HA solution in XiVO is based on a 2 nodes master and slave architecture In the normal situation both the master and slave nodes are running in parallel the slave acting as an hot standby and all the telephony services are provided by the master node If the master fails or must be shutdown for maintenance then the telephony devices automatically communicate with the slave node instead of the master one Once the master is up again the telephony devices failback to the master node Both the failover and the failback operation are done automatically i e without any user intervention although an administrator might want to run some manual operations after failback as to for example make sure any voicemail messages that were left on the slave are copied back to the master 1 10 1 Prerequisites The HA in XiVO only works with telephony devices i e phones that support the notion of a primary and backup telephony server The master and the slave must be in the same subnet If firewalling the master must be allowed to join the slave on port 5432 Trunk registration timeout expiry should be less than 300 seconds 5 minutes The HA solution is guaranteed to work correctly with the following dev
398. t through the different steps that are needed to add auto provisioning support for a phone to XiVO Prerequisites Before continuing you ll need the following e a private LAN where only your phones and your test machines are connected to it i e a LAN that you fully control 310 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Configuring a test environment Although it s possible to do all the testing directly on a XiVO it s more comfortable and usually easier to do on a separate dedicated machine That said you ll still need a XiVO near since we ll be doing the call testing part on it and not on a separate asterisk So for the rest of this guide we ll suppose you are doing your tests on a Debian Wheezy with the following configuration Installed packages isc dhcp server tftpd hpa apache2 e Example content of the etc dhcp dhcpd conf file restart isc dhcp server after modifica tion ddns update style none default lease time 7200 max lease time 86400 log facility 10cal7 subnet 10 34 1 0 netmask 255 255 255 0 authoritative range 10 34 1 200 10 34 1 250 option subnet mask 255 255 255 0 option broadcast address 10 34 1 255 option routers 10 34 1 6 option ntp servers 10 34 1 6 option domain name my domain example org option domain name servers 10 34 1 6 log concat VCI option vendor class identifier Example content of the etc
399. tall Cisco firmwares uv Certificates Name Description Version High Availability LDAP Servers Interfaces General Template line Template device Plugins Apply network configuration Apply system configuration 7912 fw userlocale es ES Firmware for Cisco 79126 33106kb es ES user locale 4 11 mb userlocale de DE 7940 7960 fw networklocale userlocale fr FR de DE user locale Firmware for Cisco 7940G and 7960G Network locale fr FR user locale Figure 1 58 Editing the xivo cisco sccp legacy plugin SIP Protocol Protocol Voicemails Phonebook Advanced 10 97 5 103 00 1a a2 7a bb fe xivo cisco sccp legacy zl Existent on the provisioning server P Inexistent on the provisioning server Device properly configured Devices ne Device configured in autoprov mode Groups Device not configured check if a plugin is installed for this device Voicemails 4 4 56 5 55 55 5 2 55 22 54555 5 56 254 5555 46 352 5455 555 16 65524 225 45 51425 4 55 54 55 6 Figure 1 59 Device list 144 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 SP Protocol 00 175242 23 6d 10 975 102 Cisco 79416 xivo cisco sccp lega
400. tallation you can continue by running the configuration wizard XiVO doc Documentation Release 14 08 Installing from a minimal Debian installation XiVO can be installed directly over a 32 bit Debian Wheezy When doing so you are strongly advised to start with a clean and minimal installation of Debian Wheeze The latest installation image for Debian Wheezy can be found at http www debian org distrib Once you have your Debian Wheezy properly installed log into it and download the XiVO installation script wget http mirror xivo fr fai xivo migration xivo install current sh And run it bash xivo install current sh Note For testing purposes you can alternatively install the release candidate or developement version of XiVO Beware that there is no guarantee that these versions will work nor upgrade correctly To install the release candidate version bash xivo install current sh r To install the developement version bash xivo install current sh d Installing from a PXE You can visit the XiVO blog for more details on how to install from a PXE 1 2 2 Running the Wizard After the system installation you must go through the wizard before being able to use your XiVO Browse to your server s IP address to start the configuration wizard For example http 192 168 1 10 Language You first have to select the language you want to use for the wizard HO Lostalistion come stes Next gt Welc
401. tarted to apply changes etc init d xivo agid restart Using the advanced features The following features are only available via the etc xivo asterisk xivo fax conf configuration file They are not available from the web interface 1 8 Administration 99 XiVO doc Documentation Release 14 08 The configuration file has documentation embedded in it in the form of comments so we recommend you reading them before editing the configuration file The way it works is the following you first declare some backends i e actions to be taken when a fax is received A backend name looks like mail ftp example orgorprinter office once your backends are defined you can use them in your destination numbers For example when someone calls the DID 100 you might want the tp example org and mail backend to be run but otherwise you only want the mail backend to be run Here s an example of a valid etc xivo asterisk xivo fax conf configuration file general tiff2pdf usr bin tiff2pdf mutt usr bin mutt lp usr bin lp mail subject FAX reception to dstnum s content file etc xivo mail txt email from no replyt fax xivo fr ftp example org host example org username foo password bar directory foobar dstnum default dest mail dstnum 100 dest mail ftp example org The section named dstnum default will be used only if no DID specific actions are defined After editing e
402. tax db field name General phone book section These fields are set in the General tab of the phone book phonebook description phonebook displayname phonebook email phonebook firstname phonebook fullname this value is automatically generated as lt firstname gt lt lastname gt e g John Doe phonebook lastname phonebook society phonebook title phonebook url Phone numbers These are the different phone numbers that are available phonebooknumber fax phonebooknumber home phonebooknumber mobile phonebooknumber office phonebooknumber other Addresses Each configured address can be accessed Address uses the following syntax phonebookaddress location field e g phonebookaddress office zipcode Locations home office other 130 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Fields address1 address2 city country state Zipcode Each line is a field that will be displayed in the Remote Directory xlet Name Display Available display formats db phone db firstname db lastname db fullname db company db mail Field title Field type Default value Display format db firstname 96 1 et Num ro phone db phone Entreprise
403. tc xivo asterisk xivo_fax conf you need to restart the agid server for the changes to be applied etc init d xivo agid restart Using the FTP backend The FTP backend is used to send a PDF version of the received fax to an FTP server An FTP backend is always defined in a section beginning with the ftp prefix Here s an example for a backend named ftp example org ftp example org host example org username foo password bar directory foobar The directory option is optional and if not specified the document will be put in the user s root directory The uploaded file are named like XIVO SRCNUM EPOCH pdf Using the printer backend use the printer backend you must have the cups client package installed on your XiVO apt get install cups client 100 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 The printer backend uses the 1p command to print faxes A printer backend is always defined in a section beginning with the printer prefix Here s an example for a backend named printer office printer office name office convert to pdf 1 When a fax will be received the system command lp d office lt faxfile gt will be executed The convert to pdf option is optional and defaults to 1 If it is set to 0 the TIFF file will not be converted to PDF before being printed Warning You need a CUPS server set up somewhere on your network Using the mail backend de
404. test VALUE Salut The dp test displays Salut Sending informations during after a call After showing a sheet the XiVO Client can also send back informa tion to XiVO for post processing or archiving Here are the requirements The sheet must contain a button named save to submit information Supported widgets QCalendarWidget 1 8 Administration 89 XiVO doc Documentation Release 14 08 QCheckBox QComboBox QDateEdit QDateTime QDateTimeEdit QDoubleSpinBox QLabel QLineEdit QList QPlainTextEdit QRadioButton QSpinBox QTimeEdit Fields must have their name starting with XIVOFORM_ If you want to send information that is not visible you can make the widget invisible on the sheet change the maximumWidth or maximumHeight property to 0 e edit the ui file and add the following property to the widget lt property name visible gt lt bool gt false lt bool gt lt property gt When a CTI client submits a custom sheet a call_form_result event is published on the event bus Systray Mostly the same syntax as the sheet with less field types available title body A Systray popup will display a single title the last one added to the list of fields and zero one or more fields of type body General settings Sheet Systray Actions Field title Field type Default value Display value title xivo c
405. the exact same clock If you do this you need to use the coding wheel on the Digium cards to give them an order of recognition in DAHDI Asterisk see Digium telephony cards support daisy chain the cards with a sync cable see Digium telephony cards support load the DAHDI module with the t imingcable 1 option Create etc modprobe d xivo timingcable conf file and insert the line options module timingcable 1 Where module is the DAHDI module name of your card e g 4 for a TE205P Analog card configuration Verifications Verify that one of the wctdm wctdm24xxp module is uncommented in etc dahdi modules depend ing on the card you installed in your server If it wasn t do again the step Load the correct DAHDI modules Generate DAHDI configuration Issue the command dahdi genconf Configure With FXS modules Create file etc modprobe d xivo tdm options module fastringer 1 boostringer 1 Where module is the DAHDI module name of your card e g wctdm for a TDM400P With FXO modules Create etc modprobe d xivo tdm options module opermode FRANCE Where module is the DAHDI module name of your card e g wctdm for a TDM400P 1 Modify the etc dahdi system conf 2 Check the span numbering 3 Modify the etc asterisk dahdi channels conf file 1 8 Administration 111 XiVO doc Documentation Release 14 08 remove the unused lines l
406. the operator needs to wait for the transfer destination to answer before completing the transfer In this example the operator is currently asking Bernard Marx if he can transfer Alice Wonderland to him Charlie Chaplin Agent 103 Phone 103 103 Connected to 103 E En ligne OU appelle e Disponible eA 8 Unpaused No option Switchboard 50 Directory 8 G9 Current Call bernard G Enter m Ds 7 Name Number Location Complete T CancelT Bernard Marx 102 Alice Wunderland lt 101 gt 00 26 4 Incoming Calls Waiting Calls F9 0 calls 0 call Name Number Time Name Number Time Dial 6 x Enter Number ly e 1 Complete transfer button 2 Cancel transfer button 3 Transfer destination filtering field xlet Directory 4 Transfer destination list xlet Directory Once the destination has answered you can 1 8 Administration 159 XiVO doc Documentation Release 14 08 e cancel the transfer with F8 key complete the transfer with F5 key Note The operator can not complete an attended transfer while the transfer destination is ringing In this case the operator must cancel the attended transfer and use the Blind transfer action Putting call on hold If the user places the call on hold it will be removed from the Current call frame and displayed in the Waiting calls list The time counter shows how long the call has been waiting thus it will be reset each
407. the translation files and gtaddons contains some Qt addons used by the XiVO Client src source files are separated in three categories the XiVO Client itself the source files are directly in src the XLet library xletlib contains the code common to multiple XLets plugins like the XLet base class and mainly GUI stuff the XLets themselves xlets each one is in a xlets something subfolder Each XLet is compiled into a dynamic library but some XLets are still compiled within the xivoclient executable instead of in a separated library They are marked with a builtin subfolder name delivery This folder contains all license informations necessary for the XiVO Client to be redistributed i e the GNU GPLv3 and the additional requirements Configuration access The settings of the application are stored in BaseEngine for runtime and in files when the client is closed config XiVO on GNU Linux systems what about other platforms There are now 3 sets of functions from BaseEngine that you can use to read store settings getConfig setConfig They are proxy methods to use the BaseConfig object inside BaseEngine They use QVariantMap to store the settings values They are currently used to store retrieve options used in the ConfigWid get You can find the available keys to access data in the detailed Doxygen documentation of BaseEngine or in baseengine h Note that the settings stored in BaseConfig won
408. ti CTI clas manage connection method The interface cti uses his cti command handler member to parse and run the command The CTICommandHandler get a list of classes that handle this message from the CTICommandFactory Then the the interface cti CTI calls run commands on the handler which returns a list of all commands replies To implement a new message in the protocol you have to create a new class that inherits the CTI Command class Your new class should have a static member caller required fields which is a list of required fields for this class Your class should also have a conditions static member which is a list of tupples of conditions to detect that an incoming message matches this class The init of your class is responsible for the initialization of it s fields and should call super lt ClassName gt self init msg Your class should register itself to the CTICommandFactory from xivo cti cti cti command import CTICommand from xivo cti cti cti command factory import CTICommandFactory class InviteConfroom CTICommand required fields class invitee conditions class invite confroom def init self super InviteConfroom self init msg Self invitee msg invitee CTICommandFactory register class InviteConfroom Each CTI commands has a callback list that you can register to from anywhere Each callback function will be called when this message is received with the command as paramete
409. time the call returns in the Waiting calls list The calls are ordered from the oldest to the newest Retrieving a call on hold Once a call has been placed on hold the operator will most certainly want to retrieve that call later to distribute it to another destination To retrieve a call on hold click the desired call in the Waiting calls list with the keyboard move the focus to the Waiting calls list F9 key choose the desired call with the arrow keys press the Enter key Once a call has been retrieved from the Waiting calls list it is moved back into the Current Call frame ready to be distributed 1 8 28 Users Users Configuration Importing Users You may import your users using a csv comma separated file Users and lines are automatically created How to import users Once you have saved your file you can import your users via the Services IPBX IPBX settings Users page by clicking on the plus button avo OO ne Import a file DENEN No user found SIP Protocol u M Figure 1 67 Import Users Supported fields 160 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Field Values Description section user entityid firstname lastname language enableclient username password profileclient outcallerid agentnumber mobilephonenumber bosss
410. tion Enable WPA Setting this variable configures the AP to require WPA either WPA PSK or WPA RADIUS EAP based on other configuration For WPA PSK either wpa psk or wpa passphrase must be set and wpa key mgmt must include WPA PSK For WPA RADIUS EAP ieee8021x must be set but without dynamic WEP keys RADIUS authentication server must be configured and WPA EAP must be included in wpa key mgmt This field is a bit field that can be used to enable WPA IE 802 111 3 0 and or WPA2 full IEEE 802 11i RSN bitO WPA bitl IEEE 802 11i RSN WPA2 dot11RSNAEnabled 7920 doesn t support WPA2 1 pre shared keys for WPA PSK This b ither entered as a 256 bit Secret in hex format 64 hex digits wpa psk or as an ASCII passphrase 8 63 characters that will be converted to PSK This conversion uses SSID So the PSK changes when ASCII passphrase is used and the SSID is changed psk dotllRSNAConfigPSKValue wpa passphrase dot11RSNAConfigPSKPassPhrase psk 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef wpa passphrase example password Optionally WPA PSKs can be read from a separate text file containing list of PSK MAC address pairs This allows more than one PSK to be configured Use absolute path name t
411. tion s name or blank Email your email or organization s email Server certificate Name phones Certification authority select phones CA Valid end date at least one month in the future Common name the FQDN of your XiVO Organization your organization s name or blank Email your email or organization s email Creating certificate for CTI server Name xivo ctid Autosigned checked Valid end date at least one month in the future Common name the FQDN of your XiVO Organization your organization s name or blank Email your email or organization s email 72 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 LDAP XiVO offers the possibility to integrate LDAP servers Once configured properly you ll be able to search your LDAP servers directly from your phones if they support this feature Add a LDAP Server You can add a LDAP server by clicking on the add button at the top right corner of the Configuration Manage ment LDAP Servers page You ll then be shown this page Sebi Host 19216892194 Port 38 Protocol version 3 Figure 1 28 Adding a LDAP server Enter the following information Name the server s display name Host the hostname or IP address Port the port number default 389 Security layer select SSL if it is activated on your server and you want to use it default disabled SSL means TLS SSL doesn
412. translation It s Transifex and the web access is https www transifex net projects p xivo For the XiVO Client we have a reference file pushed regularly to Transifex This file is always by default in english and translated in Transifex New strings to be translated are uploaded to Transifex every release Translated string are downloaded from Transifex every release XiVO Prompts We have different studio for each languages and prompts The information for those languages are here French Super Sonic productions supersonicprod wanadoo fr e English Asterisk voice allison theasteriskvoice com German ATS studio Italian ATS studio If you want to add a new prompt you need to edit the xivo prompts orig csv in our git xivo sounds 278 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Asterisk Prompts If you want to add a new prompt you need to edit the asterisk prompts orig csv in our git xivo sounds XiVO Client translations are in Transifex Web Interface Translations are currently available in French and English Nothing is currently being done to translate the Web Interface in other languages 1 12 7 Style Guide Syntax License Python files start with a UTF8 encoding comment and the GPLv3 license A blank line should separate the license from the imports Example coding utf 8 x Copyright C 2013 Avencall This program is free software you can redis
413. tribute it and or modify it under the terms of the GNU General Public License as published by the Free Software Foundation either version 3 of the License or at your option any later version This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE See the GNU General Public License for more details You should have received a copy of the GNU General Public License along with this program not see lt http www gnu org licenses gt CH CH CH CHI CHR import argparse Spacing Lines should not go further than 80 to 100 characters n python indentation blocks use 4 spaces n PHP indentation blocks use tabs Imports should be ordered alphabetically e Separate module imports and f rom imports with a blank line Example 1 12 Developers 279 XiVO doc Documentation Release 14 08 import argparse import datetime import os import re import shutil import tempfile from StringIO import StringlO from urllib import urlencode PEP8 When possible use 8 to validate your code Generally the following errors are ignored E501 max 80 chars per line Example pep8 ignore E501 xivo cti When possible avoid using backslashes to separate lines Bad Example user session query User filter User firstname firstname
414. ts 0 Xivo AvailableAgents 1 Xivo EWT 6 class getqueuesstats timenow 1384512350 25 Switchboard answer This allows the switchboard operator to answer an incoming call or unhold a call on hold class answer uniqueid 12345667 89 REGCOMMANDS call form result This message is received when a call form is submitted from a client to the XiVO Client Server clase call form result commandid lt commandid gt infos buttonname saveandclose variables XIVOFORM_varnamel valuel XIVOFORM varname2 value2 history mode 0 sent calls 1 received calls 2 missed calls size Size of the list to be sent by the server 302 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Client gt Server mode gw Sage B class history xuserid lt xivoid gt lt userfeaturesid gt commandid commandid Server Client Send back a table of calls duration in seconds olass history history calldate 2013 03 29T08 44 35 273998 duration 0 148765 fullname 844201 calldate 2013 03 28716 56 48 071213 duration 58 134744 fullname 41400 1 mode 0 replyid 529422441 timenow 1364571477 33 chitchat elass ehitehat text message envoye to lt xivoid gt lt userfeaturesid gt commandid lt commandid gt featur
415. ts a device using the same MAC address has already been created 400 Nonexistent parameters plugin lt plugin gt does the selected plugin does not exist or has not not exist been installed 400 Nonexistent parameters template_id the selected device template does not exist lt template_id gt does not exist Example request POST 1 1 devices HTTP 1 1 Host xivoserver Accept application json Content Type application json Masse EE LU mac 00 00 5e 00 00 01 vendor Aastra model 67311 version 34 22 plugin xivo aastra 3 2 2 SP3 Lemplate id defaultconfigdevice Example response HTTP 1 1 201 Created Location 1 1 devices 412c212cf 500cc158 373 00e078 7 Content Type application json id 412c212cff500cc158 f373f 00e078 f7 103020 1 mac 00 00 5e 00 00 01 mull vendor Aastra model 67311 version 3 2 2 description null status configured plugin xivo aastra 3 2 2 SP3 options null Lemplate id defaultconfigdevice og rel devices href https xivoserver 1 1 devices 412c212cff500cc158 373 00e078 7 Update a Device 1 11 and SDK 227 XiVO doc Documentation Release 14 08 Query PUT 1 1 devices id The update does not need to set all the fields for the device Only the fields that need to be updated must be set Parameters id Dev
416. ty string For example if xivo origin is replaced by outcall but xivo did is not substituted the resulting URL will be http example org origin outcall e tcp x y z co r 4545 varl al amp var2 a2 connects to TCP port 4545 on x y z co fr sends the string var1 al amp var2 a2 then closes e udp x y z co r 4545 varl al amp var2 a2 connects to UDP port 4545 on x y z co fr sends the string var1 al amp var2 a2 then closes Note any string that would not be understood as an URL will be handled like and URL it is a process to launch and will be executed as it is written For and it is a requirement that the string between and 2 is empty An extension could be to define other serialization methods if needed General settings Sheet Systray Actions Display value Save Event configuration You can configure a sheet when a specific event is called For example if you want to receive a sheet when an agent answers to a call you can choose a sheet model for the Agent link event The following events are available Dial When a new call enters the queue all the members of the queue will be notified even if they are not logged Link When a user or agent answers a call Unlink When a user or agent hangup a call received from a queue Incoming DID Received a call in a DID Hangup Hangup the call The informations about a call are displayed via the XiVO Client
417. ua na No Call Waiting Serv line no _ gt Three Way Call Serv 11 line no ua na No Three Way Call Serv 1 line no _ gt Preferred Codec line no _ ua na G711a Preferred Codec 11 line no _ gt Silence Supp Enable 1 line no ua 2 na No Silence Supp Enable 11 line no _ gt Echo Canc Adapt Enable 1 line no ua 2 na No c Echo Canc Adapt Enable 1 line no gt Echo Supp Enable line no J ua na No Echo Supp Enable line no _ gt Echo Canc Enable 1 line no _ ua na No Echo Canc Enable line no _ gt Use Pref Codec Only 11 line no ua 2 na yes Use Pref Codec Only 11 line no gt DTMF Tx Mode line no ua na Normal DTMF Tx Mode 1 line no _ gt FAX Enable T38 line no _ ua na 5Yes FAX Enable T38 line no gt FAX T38 Redundancy 1 line no _ ua na gt 1 lt FAX_T38_Redundancy_ line no _ gt FAX Passthru Method line no ua na 5ReINVITE FAX Passthru Method 1 line no _ gt FAX Passthru Codec line no _ gt 6711 lt Passthru Codec 1 line no _ gt FAX Disable ECAN line no jJ ua na yes FAX Disable line no _ gt FAX Tone Detect Mode line no _ ua na gt caller or 11 lt Tone Detect Mode line Network Jitter Level line no _ ua na gt very high
418. unction to an interceptor go to Services Users edit an interceptor and go to the Func Keys tab Add a new function key of type Group Interception and save General Lines No answer Services Voicemail Groups Func Keys Key Type Destination Label Supervision 1 Filtering Boss Secretary fernando Fernando L Igiiane Lin Enabled 4 2 Group Interception ption Save 1 8 16 Server Hardware This section describes how to configure the telephony hardware on a XiVO server Note Currently XiVO support only Digium Telephony Interface cards The configration process is the following 1 Load the right DAHDI modules 2 Configure the echo canceller 3 Configure your card and the associated span in asterisk At the end of this page you will also find some general notes and DAHDI Load the correct DAHDI modules Know which card is in your server You can see which cards are detected by issuing the dahdi hardware command dahdi hardware pci 0000 05 0d 0 4 d161 b410 Digium Wildcard 410 pci 0000 05 0e 0 wet4xxpt d161 0205 Wildcard TE205P 4th Gen e Then you have to comment all the unused modules in et c dahdi modules For example if you have one 410 and one TE205P you should comment every modules in etc dahdi modules except 4 4 If this is a TE13X wcte13xp module you MUST create a configuration file
419. unt of time even if the currently used secondary server is still working radius retry primary interval 600 Interim accounting update interval If this is set larger than 0 and acct server is configured hostapd will send interim accounting updates every seconds Note if set this overrides possible Acct Interim Interval attribute in Access Accept message Thus this value should not be configured in hostapd conf if RADIUS server is used to control the interim interval This value should not be less 600 10 minutes and must not be less than 60 1 minute radius acct interim interval 600 Dynamic VLAN mode allow RADIUS authentication server to decide which VLAN is used for the stations This information is parsed from following RADIUS attributes based RFC 3580 and RFC 2868 Tunnel Type value 13 VLAN Tunnel Medium Typ value 6 IEEE 802 Tunnel Private Group ID value VLANID as a string vlan file option below must be configured if dynamic VLANs are used Optionally the local MAC ACL list accept mac file can be used to set static client MAC address to VLAN ID mapping 0 disabled default 1 option use default interface if RADIUS server does not include VLAN ID 2 required reject authentication if RADIUS server does not include VLAN ID dynamic vlan 0 VLAN interface list for dynamic VLAN mode is read from a separate text fil This list is used to map VLAN ID from
420. ve at the bottom For our example we will create a used called Alice Wonderland Afterwards click on the Lines tab 8 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 V D HH n NUN RN CNN System Wait 1 00 1 00 Error Drop 0 day s 00 03 35 1 88 MiB 1 88 MiB 0 0 Load average 0 31 0 10 0 03 SSNS 22852 0 2 ethi 0 00 byte 0 00 byte 0 0 Partition Percent Free Used Total data system ME 1850 3717 869 0 MB 4586 0 MB data var 6 30 2672 1 MB 181 9 MB 2854 0 MB Figure 1 6 System informations Services IPBX Configuration Server Call Center Monitoring Graphics Statistics Carm ea 192 168 32 169 192 168 32 169 0 day s 00 11 57 14 76 MiB Error Drop 14 76 MiB 0 0 Figure 1 7 Menu IPBX Type Enabled Disabled Total Action Agent 0 0 0 User 2 o 21 digiuni Asterisk Group 0 0 0 Software Asterisk Queue gom expo Version 1 8 11 0 pf xivo 1 2 6 20120410 200254 0785148 Conference room 0 0 o D Voicemail o o 0 SIP trunk o 0 0 IAX trunk 0 Status Total Incoming cus Active channel 0 Outgoing calls C
421. with the phone state cti server answers with a list of info relevevant to the user 288 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 Commandid lt commandid gt oelass Login id class defined what class of command use commandid a unique integer number login id Client gt Server Login commandid 1092130023 company default ident 11 1 24079 lastlogout datetime 2013 02 19T11 13 36 lastlogout stopper disconnect userlogin lt userlogin gt sersron 9999 x3voversion 1 2 Server gt Client class Login sessionid 21UaGDfst7 timenow 1361268824 64 xivoversion 1 2 Note sessionid is used to calculate the hashed password in next step login pass Client Server hashedpassword e5229ef45824333e0f8bbeed20dccfa2ddcb1c80 class passt commandid commandid Note hashed_password shal self sessionid password hexdigest Server gt Client eapalist p 2 1 class login pass replyid 1646064863 timenow 1361268824 68 If no CTI profile is defined on XiVO for this user the following message will be sent error_string capaid_undefined class logim pass replyid 1646064863 1 12 Developers 289 XiVO doc Documentation Release 14 08 time
422. won t be associated to another plugin automatically The search box at the top comes in handy when you want to find which plugin to install for your device For exam ple if you have a Cisco SPA508G enter 508 in the search box and you should see there s 1 plugin compatible with it Note If your device has a number in its model name you should use only the number as the search keyword since this is what usually gives the best results It s possible there will be more than 1 plugin compatible with a given device In these cases the difference between the two plugins is usually just the firmware version the plugins target If you are unsure about which version you should install you should look for more information on the vendor website It s good practice to only install the plugins you need and no more Alternative plugins repository default the list of plugins available for installation are the stable plugins for the officially supported devices This can be changed in the Configuration Provisioning General page by setting the URL field to one of the following value http provd xivo fr plugins 1 stable officially supported devices stable repository default http provd xivo fr plugins 1 testing officially supported devices testing reposi tory http provd xivo fr plugins 1 archive officially supported devices archive reposi tory e http provd xivo fr plugins 1 addons stable c
423. y of figuring out AP s WPS capabilities by acting as a Registrar and using M1 from the AP The config methods attribute in that message is supposed to indicate only the configuration method supported by the AP in Enrollee role i e to add an external Registrar For that case PBC shall not be used and as such the PushButton config method is removed from M1 by default If pbc in ml1 1 is included in the configuration file the PushButton config method is left in M1 if included in config methods parameter to allow Windows 7 to use PBC instead of PIN e g from a label in the AP in 1 1 Static access point PIN for initial configuration and adding Registrars If not set hostapd will not allow external WPS Registrars to control the access point The AP PIN can also be set at runtime with hostapd cli wps pin command Use of temporary enabled by user action and random AP PIN is much more secure than configuring a static AP PIN here As such use of the ap pin parameter is not recommended if the AP device has means for displaying a random PIN ap 12345670 Skip building of automatic WPS credential This can be used to allow the automatically generated Credential attribute to be replaced with pre configured Credential s Skip cred build 1 Developers 329 XiVO doc Documentation Release 14 08 Additional Credential attribute s This option can be used to add pre configured Credential attributes i
424. your sheet to be able to select it later The Focus checkbox makes the XiVO Client pop up when the sheet is displayed if the XiVO Client was hidden Sheets There are two different ways to configure the contents of the sheet creating a custom sheet from the Qt designer This gives you a total control on the layout of the information and allows you to save and process data entered during or after a call listing the different fields and their content The information will be automatically laid out in a linear fashion and will be read only Custom sheet Configuring the sheet Qt interface field is the path to the UI file created by the Qt Designer The path can either be a local file on your XiVO starting with 1 HTTP URL You must add a field with type orm and display value qtui for the form to be displayed 86 Chapter 1 Table of Contents XiVO doc Documentation Release 14 08 General settings Sheet Systray Actions Disabled Qt interface http the url to my file ui Field ttle Field type Default value Display value form zj qtui Save Create a custom sheet with Qt Designer Qt Designer is part of the Qt development kit and is also available in the Qt Creator They are available on the Ot project website Here is an example of a small form created with Qt Designer Contacts Fiches Fax Historique R pertoire Services R pertoire personnel
425. ys Service for configuring what a function key will do when pressed A function key can accom plish different actions depending on their type and destination This service does not add a function key to a device Consult the documentation on function key templates for further details Warning The function key template service has not been implemented yet Function Key Representation Field Values Description id integer Read only Description type string See Function Key Types for more details destination string See Function Key destinations for speed dials for more details destination id integer See Function Key destinations for speed dials for more details Example dd type speeddial destination user destination_id 34 Lrnks s rel func keys href https xivoserver 1 1 func keys 1 Function Key Types type determines what kind of action a function key can accomplish Here is a list of available types and what action they trigger speeddial Call another extension e g a user a queue a group etc transfer Transfer the current call to another extension dtmf Emit a dial tone as if you pressed a number on the dialpad e g 3 5 6 line Key for accessing the phone s line i e emit or answer calls by pressing on the key directory Search for a contact in the phone directory park Park the current call in a parking lot dnd Activate Do Not Disturb on t

xivo-14.08 PDF - Read the Docs

Contents

Download Pdf Manuals

Related Search

Related Contents