wrap test at 80 characters
[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 PBX Core:
47
48 * The (very old and undocumented) ability to use BYEXTENSION for dialing
49   instead of ${EXTEN} has been removed.
50   
51 * Builtin (res_features) transfer functionality attempts to use the context
52   defined in TRANSFER_CONTEXT variable of the transferer channel first. If
53   not set, it uses the transferee variable. If not set in any channel, it will 
54   attempt to use the last non macro context. If not possible, it will default
55   to the current context.
56  
57 Command Line Interface:
58
59 * 'show channels concise', designed to be used by applications that will parse
60   its output, previously used ':' characters to separate fields. However, some
61   of those fields can easily contain that character, making the output not
62   parseable. The delimiter has been changed to '!'.
63
64 Applications:
65
66 * In previous Asterisk releases, many applications would jump to priority n+101
67   to indicate some kind of status or error condition.  This functionality was
68   marked deprecated in Asterisk 1.2.  An option to disable it was provided with
69   the default value set to 'on'.  The default value for the global priority
70   jumping option is now 'off'.
71
72 * The applications Cut, Sort, DBGet, DBPut, SetCIDNum, SetCIDName, SetRDNIS,
73   AbsoluteTimeout, DigitTimeout, ResponseTimeout, SetLanguage, GetGroupCount,
74   and GetGroupMatchCount were all deprecated in version 1.2, and therefore have
75   been removed in this version.  You should use the equivalent dialplan
76   function in places where you have previously used one of these applications.
77
78 * The application SetVar has been renamed to Set.  The syntax SetVar was marked
79   deprecated in version 1.2 and is no longer recognized in this version.
80
81 * app_read has been updated to use the newer options codes, using "skip" or
82   "noanswer" will not work.  Use s or n.  Also there is a new feature i, for
83   using indication tones, so typing in skip would give you unexpected results.
84
85 * OSPAuth is added to authenticate OSP tokens in in_bound call setup messages.
86
87 * The CONNECT event in the queue_log from app_queue now has a second field 
88   in addition to the holdtime field. It contains the unique ID of the 
89   queue member channel that is taking the call. This is useful when trying 
90   to link recording filenames back to a particular call from the queue.  
91
92 * The old/current behavior of app_queue has a serial type behavior
93   in that the queue will make all waiting callers wait in the queue
94   even if there is more than one available member ready to take
95   calls until the head caller is connected with the member they
96   were trying to get to. The next waiting caller in line then
97   becomes the head caller, and they are then connected with the
98   next available member and all available members and waiting callers
99   waits while this happens. This cycle continues until there are
100   no more available members or waiting callers, whichever comes first.
101   The new behavior, enabled by setting autofill=yes in queues.conf
102   either at the [general] level to default for all queues or 
103   to set on a per-queue level, makes sure that when the waiting 
104   callers are connecting with available members in a parallel fashion 
105   until there are no more available members or no more waiting callers,
106   whichever comes first. This is probably more along the lines of how
107   one would expect a queue should work and in most cases, you will want 
108   to enable this new behavior. If you do not specify or comment out this 
109   option, it will default to "no" to keep backward compatability with the old 
110   behavior.
111
112 * The app_queue application now has the ability to use MixMonitor to 
113   record conversations queue members are having with queue callers. Please
114   see configs/queues.conf.sample for more information on this option.
115
116 * app_meetme: The 'm' option (monitor) is renamed to 'l' (listen only), and
117   the 'm' option now provides the functionality of "initially muted". 
118   In practice, most existing dialplans using the 'm' flag should not notice
119   any difference, unless the keypad menu is enabled, allowing the user 
120   to unmute themsleves.
121
122 * ast_play_and_record would attempt to cancel the recording if a DTMF
123   '0' was received.  This behavior was not documented in most of the
124   applications that used ast_play_and_record and the return codes from
125   ast_play_and_record weren't checked for properly.
126   ast_play_and_record has been changed so that '0' no longer cancels a
127   recording.  If you want to allow DTMF digits to cancel an
128   in-progress recording use ast_play_and_record_full which allows you
129   to specify which DTMF digits can be used to accept a recording and
130   which digits can be used to cancel a recording.
131
132 * ast_app_messagecount has been renamed to ast_app_inboxcount.  There is now a
133   new ast_app_messagecount function which takes a single context/mailbox/folder
134   mailbox specification and returns the message count for that folder only.
135   This addresses the deficiency of not being able to count the number of
136   messages in folders other than INBOX and Old.
137
138 Manager:
139
140 * After executing the 'status' manager action, the "Status" manager events
141   included the header "CallerID:" which was actually only the CallerID number,
142   and not the full CallerID string.  This header has been renamed to
143   "CallerIDNum".  For compatibility purposes, the CallerID parameter will remain
144   until after the release of 1.4, when it will be removed.  Please use the time
145   during the 1.4 release to make this transition.
146
147 * The AgentConnect event now has an additional field called "BridgedChannel" 
148   which contains the unique ID of the queue member channel that is taking the 
149   call. This is useful when trying to link recording filenames back to 
150   a particular call from the queue.
151
152 * app_userevent has been modified to always send Event: UserEvent with the
153   additional header UserEvent: <userspec>.  Also, the Channel and UniqueID
154   headers are not automatically sent, unless you specify them as separate
155   arguments.  Please see the application help for the new syntax.
156
157 * app_meetme: Mute and Unmute events are now reported via the Manager API.
158   Native Manager API commands MeetMeMute and MeetMeUnmute are provided, which
159   are easier to use than "Action Command:". The MeetMeStopTalking event has
160   also been deprecated in favor of the already existing MeetmeTalking event
161   with a "Status" of "on" or "off" added.
162
163 Variables:
164
165 * The builtin variables ${CALLERID}, ${CALLERIDNAME}, ${CALLERIDNUM},
166   ${CALLERANI}, ${DNID}, ${RDNIS}, ${DATETIME}, ${TIMESTAMP}, ${ACCOUNTCODE},
167   and ${LANGUAGE} have all been deprecated in favor of their related dialplan
168   functions.  You are encouraged to move towards the associated dialplan
169   function, as these variables will be removed in a future release.
170
171 * The CDR-CSV variables uniqueid, userfield, and basing time on GMT are now 
172   adjustable from cdr.conf, instead of recompiling.
173
174 * OSP applications exports several new variables, ${OSPINHANDLE},
175   ${OSPOUTHANDLE}, ${OSPINTOKEN}, ${OSPOUTTOKEN}, ${OSPCALLING},
176   ${OSPINTIMELIMIT}, and ${OSPOUTTIMELIMIT}
177   
178 * Builtin transfer functionality sets the variable ${TRANSFERERNAME} in the new
179   created channel. This variables holds the channel name of the transferer.
180
181 Functions:
182
183 * The function ${CHECK_MD5()} has been deprecated in favor of using an
184   expression: $[${MD5(<string>)} = ${saved_md5}].
185
186 * The 'builtin' functions that used to be combined in pbx_functions.so are
187   now built as separate modules. If you are not using 'autoload=yes' in your
188   modules.conf file then you will need to explicitly load the modules that
189   contain the functions you want to use.
190
191 * The ENUMLOOKUP() function with the 'c' option (for counting the number of 
192   records), but the lookup fails to match any records, the returned value will 
193   now be "0" instead of blank.
194
195 * The REALTIME() function is now available in version 1.4 and app_realtime has
196   been deprecated in favor of the new function. app_realtime will be removed
197   completely with the version 1.6 release so please take the time between
198   releases to make any necessary changes
199
200 The IAX2 channel:
201
202 * The "mailboxdetail" option has been deprecated.  Previously, if this option
203   was not enabled, the 2 byte MSGCOUNT information element would be set to all
204   1's to indicate there there is some number of messages waiting.  With this
205   option enabled, the number of new messages were placed in one byte and the
206   number of old messages are placed in the other.  This is now the default
207   (and the only) behavior.
208
209 The SIP channel:
210
211 * The "incominglimit" setting is replaced by the "call-limit" setting in 
212   sip.conf.
213
214 * OSP support code is removed from SIP channel to OSP applications. ospauth 
215   option in sip.conf is removed to osp.conf as authpolicy. allowguest option
216   in sip.conf cannot be set as osp anymore. 
217
218 The Zap channel:
219
220 * Support for MFC/R2 has been removed, as it has not been functional for some
221   time and it has no maintainer.
222
223 Installation:
224
225 * On BSD systems, the installation directories have changed to more "FreeBSDish"
226   directories. On startup, Asterisk will look for the main configuration in 
227   /usr/local/etc/asterisk/asterisk.conf
228   If you have an old installation, you might want to remove the binaries and 
229   move the configuration files to the new locations. The following directories 
230   are now default:
231         ASTLIBDIR       /usr/local/lib/asterisk
232         ASTVARLIBDIR    /usr/local/share/asterisk
233         ASTETCDIR       /usr/local/etc/asterisk
234         ASTBINDIR       /usr/local/bin/asterisk
235         ASTSBINDIR      /usr/local/sbin/asterisk
236
237 Sounds:
238
239 * The phonetic sounds directory has been removed from the asterisk-sounds
240   package because they are now included directly in Asterisk.  However, it is
241   important to note that the phonetic sounds that existed in asterisk-sounds 
242   used a different naming convention than the sounds in Asterisk.  For example,
243   instead of alpha.gsm and bravo.gsm, Asterisk has a_p.gsm and b_p.gsm.