issue #5887
[asterisk/asterisk.git] / UPGRADE.txt
1 Information for Upgrading From Previous Asterisk Releases
2 =========================================================
3
4 Compiling:
5
6 * The Asterisk 1.2 source code now uses C language features
7   supported only by 'modern' C compilers.  Generally, this means GCC
8   version 3.0 or higher, although some GCC 2.96 releases will also
9   work.  Some non-GCC compilers that support C99 and the common GCC
10   extensions (including anonymous structures and unions) will also
11   work.  All releases of GCC 2.95 do _not_ have the requisite feature
12   support; systems using that compiler will need to be upgraded to
13   a more recent compiler release.
14
15 Dialplan Expressions:
16
17 * The dialplan expression parser (which handles $[ ... ] constructs)
18   has gone through a major upgrade, but has one incompatible change:
19   spaces are no longer required around expression operators, including
20   string comparisons. However, you can now use quoting to keep strings
21   together for comparison. For more details, please read the
22   doc/README.variables file, and check over your dialplan for possible
23   problems.
24
25 Agents:
26
27 * The default for ackcall has been changed to "no" instead of "yes" 
28   because of a bug which caused the "yes" behavior to generally act like
29   "no".  You may need to adjust the value if your agents behave 
30   differently than you expect with respect to acknowledgement.
31
32 * The AgentCallBackLogin application now requires a second '|' before
33   specifying an extension@context.  This is to distinguish the options
34   string from the extension, so that they do not conflict.  See
35   'show application AgentCallbackLogin' for more details.
36
37 Parking:
38
39 * Parking behavior has changed slightly; when a parked call times out,
40   Asterisk will attempt to deliver the call back to the extension that
41   parked it, rather than the 's' extension. If that extension is busy
42   or unavailable, the parked call will be lost.
43
44 Dialing:
45
46 * The Caller*ID of the outbound leg is now the extension that was 
47   called, rather than the Caller*ID of the inbound leg of the call.  The 
48   "o" flag for Dial can be used to restore the original behavior if 
49   desired.  Note that if you are looking for the originating callerid
50   from the manager event, there is a new manager event "Dial" which 
51   provides the source and destination channels and callerid.
52
53 IAX: 
54
55 * The naming convention for IAX channels has changed in two ways: 
56    1. The call number follows a "-" rather than a "/" character.
57    2. The name of the channel has been simplified to IAX2/peer-callno,
58    rather than IAX2/peer@peer-callno or even IAX2/peer@peer/callno.
59
60 SIP:
61
62 * The global option "port" in 1.0.X that is used to set which port to
63   bind to has been changed to "bindport" to be more consistent with
64   the other channel drivers and to avoid confusion with the "port"
65   option for users/peers.
66
67 * The "Registry" event now uses "Username" rather than "User" for 
68   consistency with IAX.
69
70 Applications:
71
72 * With the addition of dialplan functions (which operate similarly
73   to variables), the SetVar application has been renamed to Set.
74
75 * The CallerPres application has been removed.  Use SetCallerPres 
76   instead.  It accepts both numeric and symbolic names.
77
78 * The applications GetGroupCount, GetGroupMatchCount, SetGroup, and
79   CheckGroup have been deprecated in favor of functions.  Here is a
80   table of their replacements:
81
82   GetGroupCount([groupname][@category]         GROUP_COUNT([groupname][@category])      Set(GROUPCOUNT=${GROUP_COUNT()})
83   GroupMatchCount(groupmatch[@category])       GROUP_MATCH_COUNT(groupmatch[@category]) Set(GROUPCOUNT=${GROUP_MATCH_COUNT(SIP/.*)})
84   SetGroup(groupname[@category])               GROUP([category])=groupname              Set(GROUP()=test)
85   CheckGroup(max[@category])                   N/A                                      GotoIf($[ ${GROUP_COUNT()} > 5 ]?103)
86
87   Note that CheckGroup does not have a direct replacement.  There is
88   also a new function called GROUP_LIST() which will return a space
89   separated list of all of the groups set on a channel.  The GROUP()
90   function can also return the name of the group set on a channel when
91   used in a read environment.
92
93 * The applications DBGet and DBPut have been deprecated in favor of
94   functions.  Here is a table of their replacements:
95
96   DBGet(foo=family/key)        Set(foo=${DB(family/key)})
97   DBPut(family/key=${foo})     Set(DB(family/key)=${foo})
98
99 * The application SetLanguage has been deprecated in favor of the
100   function LANGUAGE().
101
102   SetLanguage(fr)               Set(LANGUAGE()=fr)
103
104   The LANGUAGE function can also return the currently set language:
105
106   Set(MYLANG=${LANGUAGE()})
107
108 * The applications AbsoluteTimeout, DigitTimeout, and ResponseTimeout
109   have been deprecated in favor of the function TIMEOUT(timeouttype):
110
111   AbsoluteTimeout(300)          Set(TIMEOUT(absolute)=300)
112   DigitTimeout(15)              Set(TIMEOUT(digit)=15)
113   ResponseTimeout(15)           Set(TIMEOUT(response)=15)
114
115   The TIMEOUT() function can also return the currently set timeouts:
116
117   Set(DTIMEOUT=${TIMEOUT(digit)})
118
119 * The applications SetCIDName, SetCIDNum, and SetRDNIS have been
120   deprecated in favor of the CALLERID(datatype) function:
121
122   SetCIDName(Joe Cool)          Set(CALLERID(name)=Joe Cool)
123   SetCIDNum(2025551212)         Set(CALLERID(number)=2025551212)
124   SetRDNIS(2024561414)          Set(CALLERID(RDNIS)=2024561414)
125
126 * The application Record now uses the period to separate the filename
127   from the format, rather than the colon.
128
129 * The application VoiceMail now supports a 'temporary' greeting for each
130   mailbox. This greeting can be recorded by using option 4 in the
131   'mailbox options' menu, and 'change your password' option has been
132   moved to option 5.
133
134 * The application VoiceMailMain now only matches the 'default' context if
135   none is specified in the arguments.  (This was the previously 
136   documented behavior, however, we didn't follow that behavior.)
137
138 Queues:
139
140 * A queue is now considered empty not only if there are no members but if
141   none of the members are available (e.g. agents not logged on).  To
142   restore the original behavior, use "leavewhenempty=strict" or 
143   "joinwhenempty=strict" instead of "=yes" for those options.
144
145 * It is now possible to use multi-digit extensions in the exit context
146   for a queue (although you should not have overlapping extensions,
147   as there is no digit timeout). This means that the EXITWITHKEY event
148   in queue_log can now contain a key field with more than a single
149   character in it.
150
151 Extensions:
152
153 * By default, there is a new option called "autofallthrough" in
154   extensions.conf that is set to yes.  Asterisk 1.0 (and earlier) 
155   behavior was to wait for an extension to be dialed after there were no 
156   more extensions to execute.  "autofallthrough" changes this behavior
157   so that the call will immediately be terminated with BUSY,
158   CONGESTION, or HANGUP based on Asterisk's best guess.  If you are
159   writing an extension for IVR, you must use the WaitExten application
160   if "autofallthrough" is set to yes.
161
162 AGI:
163
164 * AGI scripts did not always get SIGHUP at the end, previously.  That 
165   behavior has been fixed.  If you do not want your script to terminate 
166   at the end of AGI being called (e.g. on a hangup) then set SIGHUP to 
167   be ignored within your application.
168
169 * CallerID is reported with agi_callerid and agi_calleridname instead
170   of a single parameter holding both.
171
172 Music On Hold:
173
174 * The preferred format for musiconhold.conf has changed; please see the
175   sample configuration file for the new format. The existing format
176   is still supported but will generate warnings when the module is loaded.
177
178 chan_modem:
179
180 * All the chan_modem channel drivers (aopen, bestdata and i4l) are deprecated
181   in this release, and will be removed in the next major Asterisk release.
182   Please migrate to chan_misdn for ISDN interfaces; there is no upgrade
183   path for aopen and bestdata modem users.
184
185 MeetMe:
186
187 * The conference application now allows users to increase/decrease their
188   speaking volume and listening volume (independently of each other and 
189   other users); the 'admin' and 'user' menus have changed, and new sound 
190   files are included with this release. However, if a user calling in 
191   over a Zaptel channel that does NOT have hardware DTMF detection 
192   increases their speaking volume, it is likely they will no longer be 
193   able to enter/exit the menu or make any further adjustments, as the  
194   software DTMF detector will not be able to recognize the DTMF coming 
195   from their device.
196
197 GetVar Manager Action:
198
199 * Previously, the behavior of the GetVar manager action reported the value
200   of a variable in the following manner:
201    > name: value
202   This has been changed to a manner similar to the SetVar action and is now
203    > Variable: name
204    > Value: value