7a5261b94d7da4c2f4fbb45f38617b13f99e296d
[asterisk/asterisk.git] / UPGRADE.txt
1 ===========================================================
2 ===
3 === Information for upgrading between Asterisk versions
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 include 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 === UPGRADE-1.6.txt -- Upgrade info for 1.4 to 1.6
18 === UPGRADE-1.8.txt -- Upgrade info for 1.6 to 1.8
19 === UPGRADE-10.txt -- Upgrade info for 1.8 to 10
20 === UPGRADE-11.txt -- Upgrade info for 10 to 11
21 ===
22 ===========================================================
23
24 AgentMonitorOutgoing
25  - The 'c' option has been removed. It is not possible to modify the name of a
26    channel involved in a CDR.
27
28 NoCDR:
29  - This application is deprecated. Please use the CDR_PROP function instead.
30
31 ResetCDR:
32  - The 'w' and 'a' options have been removed. Dispatching CDRs to registered
33    backends occurs on an as-needed basis in order to preserve linkedid
34    propagation and other needed behavior.
35  - The 'e' option is deprecated. Please use the CDR_PROP function to enable
36    CDRs on a channel that they were previously disabled on.
37  - The ResetCDR application is no longer a part of core Asterisk, and instead
38    is now delivered as part of app_cdr.
39
40 ForkCDR:
41  - ForkCDR no longer automatically resets the forked CDR. See the 'r' option
42    for more information.
43  - Variables are no longer purged from the original CDR. See the 'v' option for
44    more information.
45  - The 'A' option has been removed. The Answer time on a CDR is never updated
46    once set.
47  - The 'd' option has been removed. The disposition on a CDR is a function of
48    the state of the channel and cannot be altered.
49  - The 'D' option has been removed. Who the Party B is on a CDR is a function
50    of the state of the respective channels, and cannot be altered.
51  - The 'r' option has been changed. Previously, ForkCDR always reset the CDR
52    such that the start time and, if applicable, the answer time was updated.
53    Now, by default, ForkCDR simply forks the CDR, maintaining any times. The
54    'r' option now triggers the Reset, setting the start time (and answer time
55    if applicable) to the current time.
56  - The 's' option has been removed. A variable can be set on the original CDR
57    if desired using the CDR function, and removed from a forked CDR using the
58    same function.
59  - The 'T' option has been removed. The concept of DONT_TOUCH and LOCKED no
60    longer applies in the CDR engine.
61  - The 'v' option now prevents the copy of the variables from the original CDR
62    to the forked CDR. Previously the variables were always copied but were
63    removed from the original. Removing variables from a CDR can have unintended
64    side effects - this option allows the user to prevent propagation of
65    variables from the original to the forked without modifying the original.
66
67 AMI:
68  - The SIP SIPqualifypeer action now sends a response indicating it will qualify
69    a peer once a peer has been found to qualify.  Once the qualify has been
70    completed it will now issue a SIPqualifypeerdone event.
71  - Version 1.4 - The details of what happens to a channel when a masquerade
72    happens (transfers, parking, etc) have changed.
73    - The Masquerade event now includes the Uniqueid's of the clone and original
74      channels.
75    - Channels no longer swap Uniqueid's as a result of the masquerade.
76    - Instead of a shell game of renames, there's now a single rename, appending
77      <ZOMBIE> to the name of the original channel.
78
79 CEL:
80  - The Uniqueid field for a channel is now a stable identifier, and will not
81    change due to transfers, parking, etc.
82
83 Core:
84  - The following channel variables have changed behavior which is described in
85    the CHANGES file: TRANSFER_CONTEXT, BRIDGEPEER, BRIDGEPVTCALLID,
86    ATTENDED_TRANSFER_COMPLETE_SOUND, DYNAMIC_FEATURENAME, and DYNAMIC_PEERNAME.
87
88 Queues:
89  - Queue logging for PAUSEALL/UNPAUSEALL now only occurs if the interface this is
90    performed on is a member of at least one queue.
91  - Queue strategy rrmemory now has a predictable order similar to strategy
92    rrordered. Members will be called in the order that they are added to the
93    queue.
94  - CDR behavior in app_queue has been modified slightly.  The CDR record will
95    now only record a disposition of BUSY if all Queue members were actually
96    busy on a call or some Queue members were busy or paused.  Previously, any
97    Queue member being paused would result in a disposition of BUSY.
98  - Removed the queues.conf check_state_unknown option.  It is no longer
99    necessary.
100  - It is now possible to play the Queue prompts to the first user waiting in a
101    call queue. Note that this may impact the ability for agents to talk with
102    users, as a prompt may still be playing when an agent connects to the user.
103    This ability is disabled by default but can be enabled on an individual
104    queue using the 'announce-to-first-user' option.
105
106 Dial:
107  - Now recognizes 'W' to pause sending DTMF for one second in addition to
108    the previously existing 'w' that paused sending DTMF for half a second.
109
110 ExternalIVR:
111  - Now recognizes 'W' to pause sending DTMF for one second in addition to
112    the previously existing 'w' that paused sending DTMF for half a second.
113
114 SendDTMF:
115  - Now recognizes 'W' to pause sending DTMF for one second in addition to
116    the previously existing 'w' that paused sending DTMF for half a second.
117
118 SetAMAFlags
119  - This application is deprecated in favor of the CHANNEL function.
120
121 chan_agent:
122  - The updatecdr option has been removed. Altering the names of channels on a
123    CDR is not supported - the name of the channel is the name of the channel,
124    and pretending otherwise helps no one.
125  - The AGENTUPDATECDR channel variable has also been removed, for the same
126    reason as the updatecdr option.
127
128 chan_dahdi:
129  - Analog port dialing and deferred DTMF dialing for PRI now distinguishes
130    between 'w' and 'W'.  The 'w' pauses dialing for half a second.  The 'W'
131    pauses dialing for one second.
132  - The default for inband_on_proceeding has changed to no.
133
134 chan_local:
135  - The /b option has been removed.
136
137 Dialplan:
138  - All channel and global variable names are evaluated in a case-sensitive manner.
139    In previous versions of Asterisk, variables created and evaluated in the
140    dialplan were evaluated case-insensitively, but built-in variables and variable
141    evaluation done internally within Asterisk was done case-sensitively.
142  - Asterisk has always had code to ignore dash '-' characters that are not
143    part of a character set in the dialplan extensions.  The code now
144    consistently ignores these characters when matching dialplan extensions.
145  - BRIDGE_FEATURES channel variable is now casesensitive for feature letter codes.
146    Uppercase variants apply them to the calling party while lowercase variants
147    apply them to the called party.
148
149 Features:
150  - The features.conf [applicationmap] <FeatureName>  ActivatedBy option is
151    no longer honored.  The feature is always activated by the channel that has
152    DYNAMIC_FEATURES defined on it when it enters the bridge.  Use predial to set
153    different values of DYNAMIC_FEATURES on the channels
154
155  - Executing a dynamic feature on the bridge peer in a multi-party bridge will
156    execute it on all peers of the activating channel.
157
158 Parking:
159  - The arguments for the Park, ParkedCall, and ParkAndAnnounce applications have
160    been modified significantly. See the application documents for specific details.
161    Also parking lot configuration is now done in res_parking.conf instead of
162    features.conf
163
164 From 10 to 11:
165
166 Voicemail:
167  - All voicemails now have a "msg_id" which uniquely identifies a message. For
168    users of filesystem and IMAP storage of voicemail, this should be transparent.
169    For users of ODBC, you will need to add a "msg_id" column to your voice mail
170    messages table. This should be a string capable of holding at least 32 characters.
171    All messages created in old Asterisk installations will have a msg_id added to
172    them when required. This operation should be transparent as well.
173
174 Parking:
175  - The comebacktoorigin setting must now be set per parking lot. The setting in
176    the general section will not be applied automatically to each parking lot.
177  - The BLINDTRANSFER channel variable is deleted from a channel when it is
178    bridged to prevent subtle bugs in the parking feature.  The channel
179    variable is used by Asterisk internally for the Park application to work
180    properly.  If you were using it for your own purposes, copy it to your
181    own channel variable before the channel is bridged.
182
183 res_ais:
184  - Users of res_ais in versions of Asterisk prior to Asterisk 11 must change
185    to use the res_corosync module, instead.  OpenAIS is deprecated, but
186    Corosync is still actively developed and maintained.  Corosync came out of
187    the OpenAIS project.
188
189 Dialplan Functions:
190  - MAILBOX_EXISTS has been deprecated. Use VM_INFO with the 'exists' parameter
191    instead.
192  - Macro has been deprecated in favor of GoSub.  For redirecting and connected
193    line purposes use the following variables instead of their macro equivalents:
194    REDIRECTING_SEND_SUB, REDIRECTING_SEND_SUB_ARGS,
195    CONNECTED_LINE_SEND_SUB, CONNECTED_LINE_SEND_SUB_ARGS.
196  - The REDIRECTING function now supports the redirecting original party id
197    and reason.
198  - The HANGUPCAUSE and HANGUPCAUSE_KEYS functions have been introduced to
199    provide a replacement for the SIP_CAUSE hash. The HangupCauseClear
200    application has also been introduced to remove this data from the channel
201    when necessary.
202
203
204 func_enum:
205  - ENUM query functions now return a count of -1 on lookup error to
206    differentiate between a failed query and a successful query with 0 results
207    matching the specified type.
208
209 CDR:
210  - cdr_adaptive_odbc now supports specifying a schema so that Asterisk can
211    connect to databases that use schemas.
212
213 Configuration Files:
214  - Files listed below have been updated to be more consistent with how Asterisk
215    parses configuration files.  This makes configuration files more consistent
216    with what is expected across modules.
217
218    - cdr.conf: [general] and [csv] sections
219    - dnsmgr.conf
220    - dsp.conf
221
222  - The 'verbose' setting in logger.conf now takes an optional argument,
223    specifying the verbosity level for each logging destination.  The default,
224    if not otherwise specified, is a verbosity of 3.
225
226 AMI:
227   - DBDelTree now correctly returns an error when 0 rows are deleted just as
228     the DBDel action does.
229   - The IAX2 PeerStatus event now sends a 'Port' header.  In Asterisk 10, this was
230     erroneously being sent as a 'Post' header.
231
232 CCSS:
233  - Macro is deprecated. Use cc_callback_sub instead of cc_callback_macro
234    in channel configurations.
235
236 app_meetme:
237   - The 'c' option (announce user count) will now work even if the 'q' (quiet)
238     option is enabled.
239
240 app_followme:
241  - Answered outgoing calls no longer get cut off when the next step is started.
242    You now have until the last step times out to decide if you want to accept
243    the call or not before being disconnected.
244
245 chan_gtalk:
246  - chan_gtalk has been deprecated in favor of the chan_motif channel driver. It is recommended
247    that users switch to using it as it is a core supported module.
248
249 chan_jingle:
250  - chan_jingle has been deprecated in favor of the chan_motif channel driver. It is recommended
251    that users switch to using it as it is a core supported module.
252
253 SIP
254 ===
255  - A new option "tonezone" for setting default tonezone for the channel driver
256    or individual devices
257  - A new manager event, "SessionTimeout" has been added and is triggered when
258    a call is terminated due to RTP stream inactivity or SIP session timer
259    expiration.
260  - SIP_CAUSE is now deprecated.  It has been modified to use the same
261    mechanism as the HANGUPCAUSE function.  Behavior should not change, but
262    performance should be vastly improved.  The HANGUPCAUSE function should now
263    be used instead of SIP_CAUSE. Because of this, the storesipcause option in
264    sip.conf is also deprecated.
265  - The sip paramater for Originating Line Information (oli, isup-oli, and
266    ss7-oli) is now parsed out of the From header and copied into the channel's
267    ANI2 information field.  This is readable from the CALLERID(ani2) dialplan
268    function.
269  - ICE support has been added and is enabled by default. Some endpoints may have
270    problems with the ICE candidates within the SDP. If this is the case ICE support
271    can be disabled globally or on a per-endpoint basis using the icesupport
272    configuration option. Symptoms of this include one way media or no media flow.
273
274 chan_unistim
275  - Due to massive update in chan_unistim phone keys functions and on-screen
276    information changed.
277
278 users.conf:
279  - A defined user with hasvoicemail=yes now finally uses a Gosub to stdexten
280    as documented in extensions.conf.sample since v1.6.0 instead of a Macro as
281    documented in v1.4.  Set the asterisk.conf stdexten=macro parameter to
282    invoke the stdexten the old way.
283
284 res_jabber
285  - This module has been deprecated in favor of the res_xmpp module. The res_xmpp
286    module is backwards compatible with the res_jabber configuration file, dialplan
287    functions, and AMI actions. The old CLI commands can also be made available using
288    the res_clialiases template for Asterisk 11.
289
290 From 1.8 to 10:
291
292 cel_pgsql:
293  - This module now expects an 'extra' column in the database for data added
294    using the CELGenUserEvent() application.
295
296 ConfBridge
297  - ConfBridge's dialplan arguments have changed and are not
298    backwards compatible.
299
300 File Interpreters
301  - The format interpreter formats/format_sln16.c for the file extension
302    '.sln16' has been removed. The '.sln16' file interpreter now exists
303    in the formats/format_sln.c module along with new support for sln12,
304    sln24, sln32, sln44, sln48, sln96, and sln192 file extensions.
305
306 HTTP:
307  - A bindaddr must be specified in order for the HTTP server
308    to run. Previous versions would default to 0.0.0.0 if no
309    bindaddr was specified.
310
311 Gtalk:
312  - The default value for 'context' and 'parkinglots' in gtalk.conf has
313    been changed to 'default', previously they were empty.
314
315 chan_dahdi:
316  - The mohinterpret=passthrough setting is deprecated in favor of
317    moh_signaling=notify.
318
319 pbx_lua:
320  - Execution no longer continues after applications that do dialplan jumps
321    (such as app.goto).  Now when an application such as app.goto() is called,
322    control is returned back to the pbx engine and the current extension
323    function stops executing.
324  - the autoservice now defaults to being on by default
325  - autoservice_start() and autoservice_start() no longer return a value.
326
327 Queue:
328  - Mark QUEUE_MEMBER_PENALTY Deprecated it never worked for realtime members
329  - QUEUE_MEMBER is now R/W supporting setting paused, ignorebusy and penalty.
330
331 Asterisk Database:
332  - The internal Asterisk database has been switched from Berkeley DB 1.86 to
333    SQLite 3. An existing Berkeley astdb file can be converted with the astdb2sqlite3
334    utility in the UTILS section of menuselect. If an existing astdb is found and no
335    astdb.sqlite3 exists, astdb2sqlite3 will be compiled automatically. Asterisk will
336    convert an existing astdb to the SQLite3 version automatically at runtime. If
337    moving back from Asterisk 10 to Asterisk 1.8, the astdb2bdb utility can be used
338    to create a Berkeley DB copy of the SQLite3 astdb that Asterisk 10 uses.
339
340 Manager:
341  - The AMI protocol version was incremented to 1.2 as a result of changing two
342    instances of the Unlink event to Bridge events. This change was documented
343    as part of the AMI 1.1 update, but two Unlink events were inadvertently left
344    unchanged.
345
346 Module Support Level
347  - All modules in the addons, apps, bridge, cdr, cel, channels, codecs,
348    formats, funcs, pbx, and res have been updated to include MODULEINFO data
349    that includes <support_level> tags with a value of core, extended, or deprecated.
350    More information is available on the Asterisk wiki at
351    https://wiki.asterisk.org/wiki/display/AST/Asterisk+Module+Support+States
352
353    Deprecated modules are now marked to not build by default and must be explicitly
354    enabled in menuselect.
355
356 chan_sip:
357  - Setting of HASH(SIP_CAUSE,<slave-channel-name>) on channels is now disabled
358    by default. It can be enabled using the 'storesipcause' option. This feature
359    has a significant performance penalty.
360  - In order to improve compliance with RFC 3261, SIP usernames are now properly
361    escaped when encoding reserved characters. Prior to this change, the use of
362    these characters in certain SIP settings affecting usernames could cause
363    injections of these characters in their raw form into SIP headers which could
364    in turn cause all sorts of nasty behaviors. All characters that are not
365    alphanumeric or are not contained in the the following lists specified by
366    RFC 3261 section 25.1 will be escaped as %XX when encoding a SIP username:
367     * mark: "-" / "_" / "." / "!" / "~" / "*" / "'" / "(" / ")"
368     * user-unreserved: "&" / "=" / "+" / "$" / "," / ";" / "?" / "/"
369
370 UDPTL:
371  - The default UDPTL port range in udptl.conf.sample differed from the defaults
372    in the source. If you didn't have a config file, you got 4500 to 4599. Now the
373    default is 4000 to 4999.
374
375 ===========================================================
376 ===========================================================