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