incorporates r159808 from branches/1.4:
[asterisk/asterisk.git] / UPGRADE-1.6.txt
1 =========================================================
2 ===
3 === Information for upgrading from Asterisk 1.4 to 1.6
4 ===
5 === These files document all the changes that MUST be taken
6 === into account when upgrading between the Asterisk
7 === versions listed below. These changes may require that
8 === you modify your configuration files, dialplan or (in
9 === some cases) source code if you have your own Asterisk
10 === modules or patches. These files also includes advance
11 === notice of any functionality that has been marked as
12 === 'deprecated' and may be removed in a future release,
13 === along with the suggested replacement functionality.
14 ===
15 === UPGRADE-1.2.txt -- Upgrade info for 1.0 to 1.2
16 === UPGRADE-1.4.txt -- Upgrade info for 1.2 to 1.4
17 ===
18 =========================================================
19
20 AEL:
21
22 * Macros are now implemented underneath with the Gosub() application.
23   Heaven Help You if you wrote code depending on any aspect of this!
24   Previous to 1.6, macros were implemented with the Macro() app, which
25   provided a nice feature of auto-returning. The compiler will do its
26   best to insert a Return() app call at the end of your macro if you did
27   not include it, but really, you should make sure that all execution
28   paths within your macros end in "return;".
29
30 * The conf2ael program is 'introduced' in this release; it is in a rather
31   crude state, but deemed useful for making a first pass at converting
32   extensions.conf code into AEL. More intelligence will come with time.
33
34 Core:
35
36 * The 'languageprefix' option in asterisk.conf is now deprecated, and
37   the default sound file layout for non-English sounds is the 'new
38   style' layout introduced in Asterisk 1.4 (and used by the automatic
39   sound file installer in the Makefile).
40
41 * The ast_expr2 stuff has been modified to handle floating-point numbers.
42   Numbers of the format D.D are now acceptable input for the expr parser, 
43   Where D is a string of base-10 digits. All math is now done in "long double",
44   if it is available on your compiler/architecture. This was half-way between
45   a bug-fix (because the MATH func returns fp by default), and an enhancement.
46   Also, for those counting on, or needing, integer operations, a series of
47   'functions' were also added to the expr language, to allow several styles
48   of rounding/truncation, along with a set of common floating point operations,
49   like sin, cos, tan, log, pow, etc. The ability to call external functions
50   like CDR(), etc. was also added, without having to use the ${...} notation.
51  
52 * The delimiter passed to applications has been changed to the comma (','), as
53   that is what people are used to using within extensions.conf.  If you are
54   using realtime extensions, you will need to translate your existing dialplan
55   to use this separator.  To use a literal comma, you need merely to escape it
56   with a backslash ('\').  Another possible side effect is that you may need to
57   remove the obscene level of backslashing that was necessary for the dialplan
58   to work correctly in 1.4 and previous versions.  This should make writing
59   dialplans less painful in the future, albeit with the pain of a one-time
60   conversion.  If you would like to avoid this conversion immediately, set
61   pbx_realtime=1.4 in the [compat] section of asterisk.conf.  After
62   transitioning, set pbx_realtime=1.6 in the same section.
63
64 * For the same purpose as above, you may set res_agi=1.4 in the [compat]
65   section of asterisk.conf to continue to use the '|' delimiter in the EXEC
66   arguments of AGI applications.  After converting to use the ',' delimiter,
67   change this option to res_agi=1.6.
68
69 * The logger.conf option 'rotatetimestamp' has been deprecated in favor of
70   'rotatestrategy'.  This new option supports a 'rotate' strategy that more
71   closely mimics the system logger in terms of file rotation.
72
73 * The concise versions of various CLI commands are now deprecated. We recommend
74   using the manager interface (AMI) for application integration with Asterisk.
75
76 Voicemail:
77
78 * The voicemail configuration values 'maxmessage' and 'minmessage' have
79   been changed to 'maxsecs' and 'minsecs' to clarify their purpose and
80   to make them more distinguishable from 'maxmsgs', which sets folder
81   size.  The old variables will continue to work in this version, albeit
82   with a deprecation warning.
83
84 * If you use any interface for modifying voicemail aside from the built in
85   dialplan applications, then the option "pollmailboxes" *must* be set in
86   voicemail.conf for message waiting indication (MWI) to work properly.  This
87   is because Voicemail notification is now event based instead of polling
88   based.  The channel drivers are no longer responsible for constantly manually
89   checking mailboxes for changes so that they can send MWI information to users.
90   Examples of situations that would require this option are web interfaces to
91   voicemail or an email client in the case of using IMAP storage.
92
93 Applications:
94
95
96 * ChanIsAvail() now has a 't' option, which allows the specified device
97   to be queried for state without consulting the channel drivers. This
98   performs mostly a 'ChanExists' sort of function.
99
100 * ChannelRedirect() will not terminate the channel that fails to do a
101   channelredirect as it has done previously. Instead CHANNELREDIRECT_STATUS
102   will reflect if the attempt was successful of not.
103
104 * SetCallerPres() has been replaced with the CALLERPRES() dialplan function
105   and is now deprecated.
106
107 * DISA()'s fifth argument is now an options argument.  If you have previously
108   used 'NOANSWER' in this argument, you'll need to convert that to the new
109   option 'n'.
110
111 * Macro() is now deprecated.  If you need subroutines, you should use the
112   Gosub()/Return() applications.  To replace MacroExclusive(), we have
113   introduced dialplan functions LOCK(), TRYLOCK(), and UNLOCK().  You may use
114   these functions in any location where you desire to ensure that only one
115   channel is executing that path at any one time.  The Macro() applications
116   are deprecated for performance reasons.  However, since Macro() has been
117   around for a long time and so many dialplans depend heavily on it, for the
118   sake of backwards compatibility it will not be removed .  It is also worth
119   noting that using both Macro() and GoSub() at the same time is _heavily_
120   discouraged.
121
122 * Read() now sets a READSTATUS variable on exit.  It does NOT automatically
123   return -1 (and hangup) anymore on error.  If you want to hangup on error,
124   you need to do so explicitly in your dialplan.
125
126 * Privacy() no longer uses privacy.conf, so any options must be specified
127   directly in the application arguments.
128
129 * MusicOnHold application now has duration parameter which allows specifying
130   timeout in seconds.
131
132 * WaitMusicOnHold application is now deprecated in favor of extended MusicOnHold.
133
134 * SetMusicOnHold is now deprecated. You should use Set(CHANNEL(musicclass)=...)
135   instead.
136
137 * The arguments in ExecIf changed a bit, to be more like other applications.
138   The syntax is now ExecIf(<cond>?appiftrue(args):appiffalse(args)).
139
140 * The behavior of the Set application now depends upon a compatibility option,
141   set in asterisk.conf.  To use the old 1.4 behavior, which allowed Set to take
142   multiple key/value pairs, set app_set=1.4 in [compat] in asterisk.conf.  To
143   use the new behavior, which permits variables to be set with embedded commas,
144   set app_set=1.6 in [compat] in asterisk.conf.  Note that you can have both
145   behaviors at the same time, if you switch to using MSet if you want the old
146   behavior.
147
148 Dialplan Functions:
149
150 * QUEUE_MEMBER_COUNT() has been deprecated in favor of the QUEUE_MEMBER() function. For
151   more information, issue a "show function QUEUE_MEMBER" from the CLI.
152
153 CDR:
154
155 * The cdr_sqlite module has been marked as deprecated in favor of
156   cdr_sqlite3_custom.  It will potentially be removed from the tree
157   after Asterisk 1.6 is released.
158
159 * The cdr_odbc module now uses res_odbc to manage its connections.  The
160   username and password parameters in cdr_odbc.conf, therefore, are no
161   longer used.  The dsn parameter now points to an entry in res_odbc.conf.
162
163 * The uniqueid field in the core Asterisk structure has been changed from a
164   maximum 31 character field to a 149 character field, to account for all
165   possible values the systemname prefix could be.  In the past, if the
166   systemname was too long, the uniqueid would have been truncated.
167
168 * The cdr_tds module now supports all versions of FreeTDS that contain
169   the db-lib frontend.  It will also now log the userfield variable if
170   the target database table contains a column for it.
171
172 Formats:
173
174 * format_wav: The GAIN preprocessor definition and source code that used it
175   is removed.  This change was made in response to user complaints of
176   choppiness or the clipping of loud signal peaks.  To increase the volume
177   of voicemail messages, use the 'volgain' option in voicemail.conf
178
179 Channel Drivers:
180
181 * SIP: a small upgrade to support the "Record" button on the SNOM360,
182   which sends a sip INFO message with a "Record: on" or "Record: off" 
183   header. If Asterisk is set up (via features.conf) to accept "One Touch Monitor"
184   requests (by default, via '*1'), then the user-configured dialpad sequence
185   is generated, and recording can be started and stopped via this button. The
186   file names and formats are all controlled via the normal mechanisms. If the
187   user has not configured the automon feature, the normal "415 Unsupported media type"
188   is returned, and nothing is done.
189
190 * SIP: The "call-limit" option is marked as deprecated. It still works in this version of
191   Asterisk, but will be removed in the following version. Please use the groupcount functions
192   in the dialplan to enforce call limits. The "limitonpeer" configuration option is
193   now renamed to "counteronpeer".
194
195 * SIP: The "username" option is now renamed to "defaultuser" to match "defaultip".
196   These are used only before registration to call a peer with the uri 
197         sip:defaultuser@defaultip
198   The "username" setting still work, but is deprecated and will not work in 
199   the next version of Asterisk.
200
201 * chan_local.c: the comma delimiter inside the channel name has been changed to a
202   semicolon, in order to make the Local channel driver compatible with the comma
203   delimiter change in applications.
204
205 * H323: The "tos" setting has changed name to "tos_audio" and "cos" to "cos_audio"
206   to be compatible with settings in sip.conf. The "tos" and "cos" configuration
207   is deprecated and will stop working in the next release of Asterisk.
208
209 * Console: A new console channel driver, chan_console, has been added to Asterisk.
210   This new module can not be loaded at the same time as chan_alsa or chan_oss.  The
211   default modules.conf only loads one of them (chan_oss by default).  So, unless you
212   have modified your modules.conf to not use the autoload option, then you will need
213   to modify modules.conf to add another "noload" line to ensure that only one of
214   these three modules gets loaded.
215
216 * DAHDI: The chan_zap module that supported PSTN interfaces using
217   Zaptel has been renamed to chan_dahdi, and only supports the DAHDI
218   telephony driver package for PSTN interfaces. See the
219   Zaptel-to-DAHDI.txt file for more details on this transition.
220
221 * DAHDI: The "msdstrip" option has been deprecated, as it provides no value over
222   the method of stripping digits in the dialplan using variable substring syntax.
223
224 Configuration:
225
226 * pbx_dundi.c: tos parameter changed to use new values. Old values like lowdelay,
227   lowcost and other is not acceptable now. Look into qos.tex for description of 
228   this parameter.
229
230 * queues.conf: the queue-lessthan sound file option is no longer available, and the
231   queue-round-seconds option no longer takes '1' as a valid parameter.
232
233 Manager:
234
235 * Manager has been upgraded to version 1.1 with a lot of changes. 
236   Please check doc/manager_1_1.txt for information
237
238 * The IAXpeers command output has been changed to more closely resemble the
239   output of the SIPpeers command.
240
241 * cdr_manager now reports at the "cdr" level, not at "call"  You may need to
242    change your manager.conf to add the level to existing AMI users, if they
243    want to see the CDR events generated.
244
245 * The Originate command now requires the Originate write permission.  For
246    Originate with the Application parameter, you need the additional System
247    privilege if you want to do anything that calls out to a subshell.
248
249 iLBC Codec:
250
251 * Previously, the Asterisk source code distribution included the iLBC
252   encoder/decoder source code, from Global IP Solutions
253   (http://www.gipscorp.com). This code is not licensed for
254   distribution, and thus has been removed from the Asterisk source
255   code distribution. If you wish to use codec_ilbc to support iLBC
256   channels in Asterisk, you can run the contrib/scripts/get_ilbc_source.sh
257   script to download the source and put it in the proper place in
258   the Asterisk build tree. Once that is done you can follow your normal
259   steps of building Asterisk. You will need to run 'menuselect' and enable
260   the iLBC codec in the 'Codec  Translators' category.