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