Remove unnecessary (long time ago commented out) code
[asterisk/asterisk.git] / UPGRADE.txt
1 Information for Upgrading From Previous Asterisk Releases
2 =========================================================
3
4 Build Process (configure script):
5
6 Asterisk now uses an autoconf-generated configuration script to learn how it
7 should build itself for your system. As it is a standard script, running:
8
9 $ ./configure --help
10
11 will show you all the options available. This script can be used to tell the
12 build process what libraries you have on your system (if it cannot find them
13 automatically), which libraries you wish to have ignored even though they may
14 be present, etc.
15
16 You must run the configure script before Asterisk will build, although it will
17 attempt to automatically run it for you with no options specified; for most
18 users, that will result in a similar build to what they would have had before
19 the configure script was added to the build process (except for having to run
20 'make' again after the configure script is run). Note that the configure script
21 does NOT need to be re-run just to rebuild Asterisk; you only need to re-run it
22 when your system configuration changes or you wish to build Asterisk with 
23 different options.
24
25 Build Process (module selection):
26
27 The Asterisk source tree now includes a basic module selection and build option
28 selection tool called 'menuselect'. Run 'make menuselect' to make your choices.
29 In this tool, you can disable building of modules that you don't care about,
30 turn on/off global options for the build and see which modules will not 
31 (and cannot) be built because your system does not have the required external
32 dependencies installed.
33
34 The resulting file from menuselect is called 'menuselect.makeopts'. Note that
35 the resulting menuselect.makeopts file generally contains which modules *not*
36 to build. The modules listed in this file indicate which modules have unmet
37 dependencies, a present conflict, or have been disabled by the user in the
38 menuselect interface. Compiler Flags can also be set in the menuselect
39 interface.  In this case, the resulting file contains which CFLAGS are in use,
40 not which ones are not in use.
41
42 If you would like to save your choices and have them applied against all
43 builds, the file can be copied to '~/.asterisk.makeopts' or 
44 '/etc/asterisk.makeopts'.
45
46 Build Process (Makefile targets):
47
48 The 'valgrind' and 'dont-optimize' targets have been removed; their functionality
49 is available by enabling the DONT_OPTIMIZE setting in the 'Compiler Flags' menu
50 in the menuselect tool.
51
52 It is now possible to run most make targets against a single subdirectory; from
53 the top level directory, for example, 'make channels' will run 'make all' in the
54 'channels' subdirectory. This also is true for 'clean', 'distclean' and 'depend'.
55
56 Sound (prompt) and Music On Hold files:
57
58 Beginning with Asterisk 1.4, the sound files and music on hold files supplied for
59 use with Asterisk have been replaced with new versions produced from high quality
60 master recordings, and are available in three languages (English, French and
61 Spanish) and in five formats (WAV (uncompressed), mu-Law, a-Law, GSM and G.729).
62 In addition, the music on hold files provided by FreePlay Music are now available
63 in the same five formats, but no longer available in MP3 format.
64
65 The Asterisk 1.4 tarball packages will only include English prompts in GSM format,
66 (as were supplied with previous releases) and the FreePlay MOH files in WAV format.
67 All of the other variations can be installed by running 'make menuselect' and
68 selecting the packages you wish to install; when you run 'make install', those
69 packages will be downloaded and installed along with the standard files included
70 in the tarball.
71
72 If for some reason you expect to not have Internet access at the time you will be
73 running 'make install', you can make your package selections using menuselect and
74 then run 'make sounds' to download (only) the sound packages; this will leave the
75 sound packages in the 'sounds' subdirectory to be used later during installation.
76
77 WARNING: Asterisk 1.4 supports a new layout for sound files in multiple languages;
78 instead of the alternate-language files being stored in subdirectories underneath
79 the existing files (for French, that would be digits/fr, letters/fr, phonetic/fr,
80 etc.) the new layout creates one directory under /var/lib/asterisk/sounds for the
81 language itself, then places all the sound files for that language under that
82 directory and its subdirectories. This is the layout that will be created if you
83 select non-English languages to be installed via menuselect, HOWEVER Asterisk does
84 not default to this layout and will not find the files in the places it expects them
85 to be. If you wish to use this layout, make sure you put 'languageprefix=yes' in your
86 /etc/asterisk/asterisk.conf file, so that Asterisk will know how the files were
87 installed.
88
89 PBX Core:
90
91 * The (very old and undocumented) ability to use BYEXTENSION for dialing
92   instead of ${EXTEN} has been removed.
93   
94 * Builtin (res_features) transfer functionality attempts to use the context
95   defined in TRANSFER_CONTEXT variable of the transferer channel first. If
96   not set, it uses the transferee variable. If not set in any channel, it will 
97   attempt to use the last non macro context. If not possible, it will default
98   to the current context.
99
100 * The autofallthrough setting introduced in Asterisk 1.2 now defaults to 'yes';
101   if your dialplan relies on the ability to 'run off the end' of an extension
102   and wait for a new extension without using WaitExten() to accomplish that,
103   you will need set autofallthrough to 'no' in your extensions.conf file.
104  
105 Command Line Interface:
106
107 * 'show channels concise', designed to be used by applications that will parse
108   its output, previously used ':' characters to separate fields. However, some
109   of those fields can easily contain that character, making the output not
110   parseable. The delimiter has been changed to '!'.
111
112 Applications:
113
114 * In previous Asterisk releases, many applications would jump to priority n+101
115   to indicate some kind of status or error condition.  This functionality was
116   marked deprecated in Asterisk 1.2.  An option to disable it was provided with
117   the default value set to 'on'.  The default value for the global priority
118   jumping option is now 'off'.
119
120 * The applications Cut, Sort, DBGet, DBPut, SetCIDNum, SetCIDName, SetRDNIS,
121   AbsoluteTimeout, DigitTimeout, ResponseTimeout, SetLanguage, GetGroupCount,
122   and GetGroupMatchCount were all deprecated in version 1.2, and therefore have
123   been removed in this version.  You should use the equivalent dialplan
124   function in places where you have previously used one of these applications.
125
126 * The application SetGlobalVar has been deprecated.  You should replace uses
127   of this application with the following combination of Set and GLOBAL():
128   Set(GLOBAL(name)=value).  You may also access global variables exclusively by
129   using the GLOBAL() dialplan function, instead of relying on variable
130   interpolation falling back to globals when no channel variable is set.
131
132 * The application SetVar has been renamed to Set.  The syntax SetVar was marked
133   deprecated in version 1.2 and is no longer recognized in this version.
134
135 * app_read has been updated to use the newer options codes, using "skip" or
136   "noanswer" will not work.  Use s or n.  Also there is a new feature i, for
137   using indication tones, so typing in skip would give you unexpected results.
138
139 * OSPAuth is added to authenticate OSP tokens in in_bound call setup messages.
140
141 * The CONNECT event in the queue_log from app_queue now has a second field 
142   in addition to the holdtime field. It contains the unique ID of the 
143   queue member channel that is taking the call. This is useful when trying 
144   to link recording filenames back to a particular call from the queue.  
145
146 * The old/current behavior of app_queue has a serial type behavior
147   in that the queue will make all waiting callers wait in the queue
148   even if there is more than one available member ready to take
149   calls until the head caller is connected with the member they
150   were trying to get to. The next waiting caller in line then
151   becomes the head caller, and they are then connected with the
152   next available member and all available members and waiting callers
153   waits while this happens. This cycle continues until there are
154   no more available members or waiting callers, whichever comes first.
155   The new behavior, enabled by setting autofill=yes in queues.conf
156   either at the [general] level to default for all queues or 
157   to set on a per-queue level, makes sure that when the waiting 
158   callers are connecting with available members in a parallel fashion 
159   until there are no more available members or no more waiting callers,
160   whichever comes first. This is probably more along the lines of how
161   one would expect a queue should work and in most cases, you will want 
162   to enable this new behavior. If you do not specify or comment out this 
163   option, it will default to "no" to keep backward compatability with the old 
164   behavior.
165
166 * The app_queue application now has the ability to use MixMonitor to 
167   record conversations queue members are having with queue callers. Please
168   see configs/queues.conf.sample for more information on this option.
169
170 * The app_queue application strategy called 'roundrobin' has been deprecated
171   for this release. Users are encouraged to use 'rrmemory' instead, since it
172   provides more 'true' round-robin call delivery. For the Asterisk 1.6 release,
173   'rrmemory' will be renamed 'roundrobin'.
174
175 * app_meetme: The 'm' option (monitor) is renamed to 'l' (listen only), and
176   the 'm' option now provides the functionality of "initially muted". 
177   In practice, most existing dialplans using the 'm' flag should not notice
178   any difference, unless the keypad menu is enabled, allowing the user 
179   to unmute themsleves.
180
181 * ast_play_and_record would attempt to cancel the recording if a DTMF
182   '0' was received.  This behavior was not documented in most of the
183   applications that used ast_play_and_record and the return codes from
184   ast_play_and_record weren't checked for properly.
185   ast_play_and_record has been changed so that '0' no longer cancels a
186   recording.  If you want to allow DTMF digits to cancel an
187   in-progress recording use ast_play_and_record_full which allows you
188   to specify which DTMF digits can be used to accept a recording and
189   which digits can be used to cancel a recording.
190
191 * ast_app_messagecount has been renamed to ast_app_inboxcount.  There is now a
192   new ast_app_messagecount function which takes a single context/mailbox/folder
193   mailbox specification and returns the message count for that folder only.
194   This addresses the deficiency of not being able to count the number of
195   messages in folders other than INBOX and Old.
196
197 * The exit behavior of the AGI applications has changed. Previously, when
198   a connection to an AGI server failed, the application would cause the channel
199   to immediately stop dialplan execution and hangup. Now, the only time that
200   the AGI applications will cause the channel to stop dialplan execution is
201   when the channel itself requests hangup. The AGI applications now set an
202   AGISTATUS variable which will allow you to find out whether running the AGI
203   was successful or not.
204
205   Previously, there was no way to handle the case where Asterisk was unable to
206   locally execute an AGI script for some reason. In this case, dialplan
207   execution will continue as it did before, but the AGISTATUS variable will be
208   set to "FAILURE".
209
210   A locally executed AGI script can now exit with a non-zero exit code and this
211   failure will be detected by Asterisk. If an AGI script exits with a non-zero
212   exit code, the AGISTATUS variable will be set to "FAILURE" as opposed to
213   "SUCCESS".
214
215 * app_voicemail: The ODBC_STORAGE capability now requires the extended table format
216   previously used only by EXTENDED_ODBC_STORAGE. This means that you will need to update
217   your table format using the schema provided in doc/odbcstorage.txt
218
219 * app_waitforsilence: Fixes have been made to this application which changes the 
220   default behavior with how quickly it returns. You can maintain "old-style" behavior
221   with the addition/use of a third "timeout" parameter.
222   Please consult the application documentation and make changes to your dialplan 
223   if appropriate.
224
225 Manager:
226
227 * After executing the 'status' manager action, the "Status" manager events
228   included the header "CallerID:" which was actually only the CallerID number,
229   and not the full CallerID string.  This header has been renamed to
230   "CallerIDNum".  For compatibility purposes, the CallerID parameter will remain
231   until after the release of 1.4, when it will be removed.  Please use the time
232   during the 1.4 release to make this transition.
233
234 * The AgentConnect event now has an additional field called "BridgedChannel" 
235   which contains the unique ID of the queue member channel that is taking the 
236   call. This is useful when trying to link recording filenames back to 
237   a particular call from the queue.
238
239 * app_userevent has been modified to always send Event: UserEvent with the
240   additional header UserEvent: <userspec>.  Also, the Channel and UniqueID
241   headers are not automatically sent, unless you specify them as separate
242   arguments.  Please see the application help for the new syntax.
243
244 * app_meetme: Mute and Unmute events are now reported via the Manager API.
245   Native Manager API commands MeetMeMute and MeetMeUnmute are provided, which
246   are easier to use than "Action Command:". The MeetMeStopTalking event has
247   also been deprecated in favor of the already existing MeetmeTalking event
248   with a "Status" of "on" or "off" added.
249
250 Variables:
251
252 * The builtin variables ${CALLERID}, ${CALLERIDNAME}, ${CALLERIDNUM},
253   ${CALLERANI}, ${DNID}, ${RDNIS}, ${DATETIME}, ${TIMESTAMP}, ${ACCOUNTCODE},
254   and ${LANGUAGE} have all been deprecated in favor of their related dialplan
255   functions.  You are encouraged to move towards the associated dialplan
256   function, as these variables will be removed in a future release.
257
258 * The CDR-CSV variables uniqueid, userfield, and basing time on GMT are now 
259   adjustable from cdr.conf, instead of recompiling.
260
261 * OSP applications exports several new variables, ${OSPINHANDLE},
262   ${OSPOUTHANDLE}, ${OSPINTOKEN}, ${OSPOUTTOKEN}, ${OSPCALLING},
263   ${OSPINTIMELIMIT}, and ${OSPOUTTIMELIMIT}
264   
265 * Builtin transfer functionality sets the variable ${TRANSFERERNAME} in the new
266   created channel. This variables holds the channel name of the transferer.
267
268 * The dial plan variable PRI_CAUSE will be removed from future versions 
269   of Asterisk.
270   It is replaced by adding a cause value to the hangup() application.
271
272 Functions:
273
274 * The function ${CHECK_MD5()} has been deprecated in favor of using an
275   expression: $[${MD5(<string>)} = ${saved_md5}].
276
277 * The 'builtin' functions that used to be combined in pbx_functions.so are
278   now built as separate modules. If you are not using 'autoload=yes' in your
279   modules.conf file then you will need to explicitly load the modules that
280   contain the functions you want to use.
281
282 * The ENUMLOOKUP() function with the 'c' option (for counting the number of 
283   records), but the lookup fails to match any records, the returned value will 
284   now be "0" instead of blank.
285
286 * The REALTIME() function is now available in version 1.4 and app_realtime has
287   been deprecated in favor of the new function. app_realtime will be removed
288   completely with the version 1.6 release so please take the time between
289   releases to make any necessary changes
290
291 * The QUEUEAGENTCOUNT() function has been deprecated in favor of
292   QUEUE_MEMBER_COUNT().
293
294 The IAX2 channel:
295
296 * The "mailboxdetail" option has been deprecated.  Previously, if this option
297   was not enabled, the 2 byte MSGCOUNT information element would be set to all
298   1's to indicate there there is some number of messages waiting.  With this
299   option enabled, the number of new messages were placed in one byte and the
300   number of old messages are placed in the other.  This is now the default
301   (and the only) behavior.
302
303 The SIP channel:
304
305 * The "incominglimit" setting is replaced by the "call-limit" setting in 
306   sip.conf.
307
308 * OSP support code is removed from SIP channel to OSP applications. ospauth 
309   option in sip.conf is removed to osp.conf as authpolicy. allowguest option
310   in sip.conf cannot be set as osp anymore. 
311
312 * The Asterisk RTP stack has been changed in regards to RFC2833 reception
313   and transmission. Packets will now be sent with proper duration instead of all
314   at once. If you are receiving calls from a pre-1.4 Asterisk installation you
315   will want to turn on the rfc2833compensate option. Without this option your
316   DTMF reception may act poorly.
317
318 * The $SIPUSERAGENT dialplan variable is deprecated and will be removed
319   in coming versions of Asterisk. Please use the dialplan function
320   SIPCHANINFO(useragent) instead.
321
322 * The ALERT_INFO dialplan variable is deprecated and will be removed
323   in coming versions of Asterisk. Please use the dialplan application
324   sipaddheader() to add the "Alert-Info" header to the outbound invite.
325
326 The Zap channel:
327
328 * Support for MFC/R2 has been removed, as it has not been functional for some
329   time and it has no maintainer.
330
331 The Agent channel:
332
333 * Callback mode (AgentCallbackLogin) is now deprecated, since the entire function
334   it provided can be done using dialplan logic, without requiring additional
335   channel and module locks (which frequently caused deadlocks). An example of
336   how to do this using AEL dialplan is in doc/queues-with-callback-members.txt.
337
338 The G726-32 codec:
339
340 * It has been determined that previous versions of Asterisk used the wrong codeword
341   packing order for G726-32 data. This version supports both available packing orders,
342   and can transcode between them. It also now selects the proper order when
343   negotiating with a SIP peer based on the codec name supplied in the SDP. However,
344   there are existing devices that improperly request one order and then use another;
345   Sipura and Grandstream ATAs are known to do this, and there may be others. To
346   be able to continue to use these devices with this version of Asterisk and the
347   G726-32 codec, a configuration parameter called 'g726nonstandard' has been added
348   to sip.conf, so that Asterisk can use the packing order expected by the device (even
349   though it requested a different order). In addition, the internal format number for
350   G726-32 has been changed, and the old number is now assigned to AAL2-G726-32. The
351   result of this is that this version of Asterisk will be able to interoperate over
352   IAX2 with older versions of Asterisk, as long as this version is told to allow
353   'g726aal2' instead of 'g726' as the codec for the call.
354
355 Installation:
356
357 * On BSD systems, the installation directories have changed to more "FreeBSDish"
358   directories. On startup, Asterisk will look for the main configuration in 
359   /usr/local/etc/asterisk/asterisk.conf
360   If you have an old installation, you might want to remove the binaries and 
361   move the configuration files to the new locations. The following directories 
362   are now default:
363         ASTLIBDIR       /usr/local/lib/asterisk
364         ASTVARLIBDIR    /usr/local/share/asterisk
365         ASTETCDIR       /usr/local/etc/asterisk
366         ASTBINDIR       /usr/local/bin/asterisk
367         ASTSBINDIR      /usr/local/sbin/asterisk
368
369 Music on Hold:
370
371 * The music on hold handling has been changed in some significant ways in hopes
372   to make it work in a way that is much less confusing to users. Behavior will
373   not change if the same configuration is used from older versions of Asterisk.
374   However, there are some new configuration options that will make things work
375   in a way that makes more sense.
376
377   Previously, many of the channel drivers had an option called "musicclass" or
378   something similar. This option set what music on hold class this channel
379   would *hear* when put on hold. Some people expected (with good reason) that
380   this option was to configure what music on hold class to play when putting
381   the bridged channel on hold. This option has now been deprecated.
382
383   Two new music on hold related configuration options for channel drivers have
384   been introduced. Some channel drivers support both options, some just one,
385   and some support neither of them. Check the sample configuration files to see
386   which options apply to which channel driver.
387
388   The "mohsuggest" option specifies which music on hold class to suggest to the
389   bridged channel when putting them on hold. The only way that this class can
390   be overridden is if the bridged channel has a specific music class set that
391   was done in the dialplan using Set(CHANNEL(musicclass)=something).
392
393   The "mohinterpret" option is similar to the old "musicclass" option. It
394   specifies which music on hold class this channel would like to listen to when
395   put on hold. This music class is only effective if this channel has no music
396   class set on it from the dialplan and the bridged channel putting this one on
397   hold had no "mohsuggest" setting.
398
399   The IAX2 and Zap channel drivers have an additional feature for the
400   "mohinterpret" option. If this option is set to "passthrough", then these
401   channel drivers will pass through the HOLD message in signalling instead of
402   starting music on hold on the channel. An example for how this would be
403   useful is in an enterprise network of Asterisk servers. When one phone on one
404   server puts a phone on a different server on hold, the remote server will be
405   responsible for playing the hold music to its local phone that was put on
406   hold instead of the far end server across the network playing the music.
407
408 CDR Records:
409
410 * The behavior of the "clid" field of the CDR has always been that it will
411   contain the callerid ANI if it is set, or the callerid number if ANI was not
412   set.  When using the "callerid" option for various channel drivers, some
413   would set ANI and some would not.  This has been cleared up so that all
414   channel drivers set ANI.  If you would like to change the callerid number
415   on the channel from the dialplan and have that change also show up in the 
416   CDR, then you *must* set CALLERID(ANI) as well as CALLERID(num).