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