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