e65cedc215369db0f61fa64ab52a7148aa329845
[asterisk/asterisk.git] / UPGRADE-12.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 There are many significant architectural changes in Asterisk 12. It is
25 recommended that you not only read through this document for important
26 changes that affect an upgrade, but that you also read through the CHANGES
27 document in depth to better understand the new options available to you.
28
29 Additional information on the architectural changes made in Asterisk can be
30 found on the Asterisk wiki (https://wiki.asterisk.org)
31
32 Of particular note, the following systems in Asterisk underwent significant
33 changes. Documentation for the changes and a specification for their
34 behavior in Asterisk 12 is also available on the Asterisk wiki.
35  - AMI: Many events were changed, and the semantics of channels and bridges
36         were defined. In particular, how channels and bridges behave under
37         transfer scenarios and situations involving multiple parties has
38         changed significantly. See https://wiki.asterisk.org/wiki/x/dAFRAQ
39         for more information.
40  - CDR: CDR logic was extracted from the many locations it existed in across
41         Asterisk and implemented as a consumer of Stasis message bus events.
42         As a result, consistency of records has improved significantly and the
43         behavior of CDRs in transfer scenarios has been defined in the CDR
44         specification. However, significant behavioral changes in CDRs resulted
45         from the transition. The most significant change is the addition of
46         CDR entries when a channel who is the Party A in a CDR leaves a bridge.
47         See https://wiki.asterisk.org/wiki/x/pwpRAQ for more information.
48  - CEL: Much like CDRs, CEL was removed from the many locations it existed in
49         across Asterisk and implemented as a consumer of Stasis message bus
50         events. It now closely follows the Bridging API model of channels and
51         bridges, and has a much closer consistency of conveyed events as AMI.
52         For the changes in events, see https://wiki.asterisk.org/wiki/x/4ICLAQ.
53
54 Build System:
55  - Removed the CHANNEL_TRACE development mode build option. Certain aspects of
56    the CHANNEL_TRACE build option were incompatible with the new bridging
57    architecture.
58
59  - Asterisk now depends on libjansson, libuuid and optionally (but recommended)
60    libxslt and uriparser.
61
62  - The new SIP stack and channel driver uses a particular version of PJSIP.
63    Please see https://wiki.asterisk.org/wiki/x/J4GLAQ for more information on
64    configuring and installing PJSIP for use with Asterisk.
65
66 AgentLogin and chan_agent:
67  - Along with AgentRequest, this application has been modified to be a
68    replacement for chan_agent. The chan_agent module and the Agent channel
69    driver have been removed from Asterisk, as the concept of a channel driver
70    proxying in front of another channel driver was incompatible with the new
71    architecture (and has had numerous problems through past versions of
72    Asterisk). The act of a channel calling the AgentLogin application places the
73    channel into a pool of agents that can be requested by the AgentRequest
74    application. Note that this application, as well as all other agent related
75    functionality, is now provided by the app_agent_pool module.
76
77  - This application no longer performs agent authentication. If authentication
78    is desired, the dialplan needs to perform this function using the
79    Authenticate or VMAuthenticate application or through an AGI script before
80    running AgentLogin.
81
82  - The agents.conf schema has changed. Rather than specifying agents on a
83    single line in comma delineated fashion, each agent is defined in a separate
84    context. This allows agents to use the power of context templates in their
85    definition.
86
87  - A number of parameters from agents.conf have been removed. This includes
88    maxloginretries, autologoffunavail, updatecdr, goodbye, group, recordformat,
89    urlprefix, and savecallsin. These options were obsoleted by the move from
90    a channel driver model to the bridging/application model provided by
91    app_agent_pool.
92
93  - The AGENTUPDATECDR channel variable has also been removed, for the same
94    reason as the updatecdr option.
95
96  - The endcall and enddtmf configuration options are removed.  Use the
97    dialplan function CHANNEL(dtmf-features) to set DTMF features on the agent
98    channel before calling AgentLogin.
99
100 AgentMonitorOutgoing
101  - This application has been removed. It was a holdover from when
102    AgentCallbackLogin was removed.
103
104 Answer
105  - It is no longer possible to bypass updating the CDR when answering a
106    channel. CDRs are based on the channel state and will be updated when
107    the channel is Answered.
108
109 ControlPlayback
110  - The channel variable CPLAYBACKSTATUS may now return the value
111    'REMOTESTOPPED' when playback is stopped by an external entity.
112
113 DISA
114  - This application now has a dependency on the app_cdr module. It uses this
115    module to hide the CDR created prior to execution of the DISA application.
116
117 DumpChan:
118  - The output of DumpChan no longer includes the DirectBridge or IndirectBridge
119    fields. Instead, if a channel is in a bridge, it includes a BridgeID field
120    containing the unique ID of the bridge that the channel happens to be in.
121
122 ForkCDR:
123  - Nearly every parameter in ForkCDR has been updated and changed to reflect
124    the changes in CDRs. Please see the documentation for the ForkCDR
125    application, as well as the CDR specification on the Asterisk wiki.
126
127 NoCDR:
128  - The NoCDR application has been deprecated. Please use the CDR_PROP function
129    to disable CDRs on a channel.
130
131 ParkAndAnnounce:
132  - The app_parkandannounce module has been removed. The application
133    ParkAndAnnounce is now provided by the res_parking module. See the
134    Parking changes for more information.
135
136 ResetCDR:
137  - The 'w' and 'a' options have been removed. Dispatching CDRs to registered
138    backends occurs on an as-needed basis in order to preserve linkedid
139    propagation and other needed behavior.
140  - The 'e' option is deprecated. Please use the CDR_PROP function to enable
141    CDRs on a channel that they were previously disabled on.
142  - The ResetCDR application is no longer a part of core Asterisk, and instead
143    is now delivered as part of app_cdr.
144
145 Queues:
146  - Queue strategy rrmemory now has a predictable order similar to strategy
147    rrordered. Members will be called in the order that they are added to the
148    queue.
149
150  - Removed the queues.conf check_state_unknown option.  It is no longer
151    necessary.
152
153  - It is now possible to play the Queue prompts to the first user waiting in a
154    call queue. Note that this may impact the ability for agents to talk with
155    users, as a prompt may still be playing when an agent connects to the user.
156    This ability is disabled by default but can be enabled on an individual
157    queue using the 'announce-to-first-user' option.
158
159  - The configuration options eventwhencalled and eventmemberstatus have been
160    removed.  As a result, the AMI events QueueMemberStatus, AgentCalled,
161    AgentConnect, AgentComplete, AgentDump, and AgentRingNoAnswer will always be
162    sent.  The "Variable" fields will also no longer exist on the Agent* events.
163    These events can be filtered out from a connected AMI client using the
164    eventfilter setting in manager.conf.
165
166  - The queue log now differentiates between blind and attended transfers. A
167    blind transfer will result in a BLINDTRANSFER message with the destination
168    context and extension. An attended transfer will result in an
169    ATTENDEDTRANSFER message. This message will indicate the method by which
170    the attended transfer was completed: "BRIDGE" for a bridge merge, "APP"
171    for running an application on a bridge or channel, or "LINK" for linking
172    two bridges together with local channels. The queue log will also now detect
173    externally initiated blind and attended transfers and record the transfer
174    status accordingly.
175
176  - When performing queue pause/unpause on an interface without specifying an
177    individual queue, the PAUSEALL/UNPAUSEALL event will only be logged if at
178    least one member of any queue exists for that interface.
179
180 SetAMAFlags
181  - This application is deprecated in favor of CHANNEL(amaflags).
182
183 VoiceMail:
184  - The voicemail.conf configuration file now has an 'alias' configuration
185    parameter for use with the Directory application. The voicemail realtime
186    database table schema has also been updated with an 'alias' column. Systems
187    using voicemail with realtime should update their schemas accordingly.
188
189 Channel Drivers:
190  - When a channel driver is configured to enable jiterbuffers, they are now
191    applied unconditionally when a channel joins a bridge. If a jitterbuffer
192    is already set for that channel when it enters, such as by the JITTERBUFFER
193    function, then the existing jitterbuffer will be used and the one set by
194    the channel driver will not be applied.
195
196 chan_bridge
197  - chan_bridge is removed and its functionality is incorporated into ConfBridge
198    itself.
199
200 chan_dahdi:
201  - Analog port dialing and deferred DTMF dialing for PRI now distinguishes
202    between 'w' and 'W'.  The 'w' pauses dialing for half a second.  The 'W'
203    pauses dialing for one second.
204
205  - The default for inband_on_proceeding has changed to no.
206
207  - The CLI command 'dahdi destroy channel' is now 'dahdi destroy channels'.
208    A range of channels can be specified to be destroyed. Note that this command
209    should only be used if you understand the risks it entails.
210
211 chan_local:
212  - The /b option has been removed.
213
214  - chan_local moved into the system core and is no longer a loadable module.
215
216 chan_sip:
217  - The 'callevents' parameter has been removed. Hold AMI events are now raised
218    in the core, and can be filtered out using the 'eventfilter' parameter
219    in manager.conf.
220
221  - Dynamic realtime tables for SIP Users can now include a 'path' field. This
222    will store the path information for that peer when it registers. Realtime
223    tables can also use the 'supportpath' field to enable Path header support.
224
225  - LDAP realtime configurations for SIP Users now have the AstAccountPathSupport
226    objectIdentifier. This maps to the supportpath option in sip.conf.
227
228 Core:
229  - Masquerades as an operation inside Asterisk have been effectively hidden
230    by the migration to the Bridging API. As such, many 'quirks' of Asterisk
231    no longer occur. This includes renaming of channels, "<ZOMBIE>" channels,
232    dropping of frame/audio hooks, and other internal implementation details
233    that users had to deal with. This fundamental change has large implications
234    throughout the changes documented for this version. For more information
235    about the new core architecture of Asterisk, please see the Asterisk wiki.
236
237  - The following channel variables have changed behavior which is described in
238    the CHANGES file: TRANSFER_CONTEXT, BRIDGEPEER, BRIDGEPVTCALLID,
239    ATTENDED_TRANSFER_COMPLETE_SOUND, DYNAMIC_FEATURENAME, and DYNAMIC_PEERNAME.
240
241 AMI (Asterisk Manager Interface):
242  - Version 1.4 - The details of what happens to a channel when a masquerade
243    happens (transfers, parking, etc) have changed.
244    - The Masquerade event now includes the Uniqueid's of the clone and original
245      channels.
246    - Channels no longer swap Uniqueid's as a result of the masquerade.
247    - Instead of a shell game of renames, there's now a single rename, appending
248      <ZOMBIE> to the name of the original channel.
249
250  - *Major* changes were made to both the syntax as well as the semantics of the
251    AMI protocol. In particular, AMI events have been substantially modified
252    and improved in this version of Asterisk. The major event changes are listed
253    below.
254    - NewPeerAccount has been removed. NewAccountCode is raised instead.
255    - Reload events have been consolidated and standardized.
256    - ModuleLoadReport has been removed.
257    - FaxSent is now SendFAX; FaxReceived is now ReceiveFAX. This standardizes
258      app_fax and res_fax events.
259    - MusicOnHold has been replaced with MusicOnHoldStart and MusicOnHoldStop.
260    - JabberEvent has been removed.
261    - Hold is now in the core and will now raise Hold and Unhold events.
262    - Join is now QueueCallerJoin.
263    - Leave is now QueueCallerLeave.
264    - Agentlogin/Agentlogoff is now AgentLogin/AgentLogoff, respectively.
265    - ChannelUpdate has been removed.
266    - Local channel optimization is now conveyed via LocalOptimizationBegin and
267      LocalOptimizationEnd.
268    - BridgeAction and BridgeExec have been removed.
269    - BlindTransfer and AttendedTransfer events were added.
270    - Dial is now DialBegin and DialEnd.
271    - DTMF is now DTMFBegin and DTMFEnd.
272    - Bridge has been replaced with BridgeCreate, BridgeEnter, BridgeLeave, and
273      BridgeDestroy
274    - MusicOnHold has been replaced with MusicOnHoldStart and MusicOnHoldStop
275    - AGIExec is now AGIExecStart and AGIExecEnd
276    - AsyncAGI is now AsyncAGIStart, AsyncAGIExec, and AsyncAGIEnd
277
278  - The 'MCID' AMI event now publishes a channel snapshot when available and
279    its non-channel-snapshot parameters now use either the "MCallerID" or
280    'MConnectedID' prefixes with Subaddr*, Name*, and Num* suffixes instead
281    of 'CallerID' and 'ConnectedID' to avoid confusion with similarly named
282    parameters in the channel snapshot.
283
284  - The 'Channel' key used in the 'AlarmClear', 'Alarm', and 'DNDState' has been
285    renamed "DAHDIChannel" since it does not convey an Asterisk channel name.
286
287  - All AMI events now contain a 'SystemName' field, if available.
288
289  - Local channel information in events is now prefixed with 'LocalOne' and
290    'LocalTwo'. This replaces the suffix of '1' and '2' for the two halves of
291    the Local channel. This affects the 'LocalBridge', 'LocalOptimizationBegin',
292    and 'LocalOptimizationEnd' events.
293
294  - The 'RTCPSent'/'RTCPReceived' events have been significantly modified from
295    previous versions. They now report all SR/RR packets sent/received, and
296    have been restructured to better reflect the data sent in a SR/RR. In
297    particular, the event structure now supports multiple report blocks.
298
299  - The deprecated use of | (pipe) as a separator in the channelvars setting in
300    manager.conf has been removed.
301
302  - The SIP SIPqualifypeer action now sends a response indicating it will qualify
303    a peer once a peer has been found to qualify.  Once the qualify has been
304    completed it will now issue a SIPqualifypeerdone event.
305
306  - The AMI event 'Newexten' field 'Extension' is deprecated, and may be removed
307    in a future release. Please use the common 'Exten' field instead.
308
309  - The AMI events 'ParkedCall', 'ParkedCallTimeOut', 'ParkedCallGiveUp', and
310    'UnParkedCall' have changed significantly in the new res_parking module.
311    - The 'Channel' and 'From' headers are gone. For the channel that was parked
312      or is coming out of parking, a 'Parkee' channel snapshot is issued and it
313      has a number of fields associated with it. The old 'Channel' header relayed
314      the same data as the new 'ParkeeChannel' header.
315    - The 'From' field was ambiguous and changed meaning depending on the event.
316      for most of these, it was the name of the channel that parked the call
317      (the 'Parker'). There is no longer a header that provides this channel name,
318      however the 'ParkerDialString' will contain a dialstring to redial the
319      device that parked the call.
320    - On UnParkedCall events, the 'From' header would instead represent the
321      channel responsible for retrieving the parkee. It receives a channel
322      snapshot labeled 'Retriever'. The 'from' field is is replaced with
323      'RetrieverChannel'.
324    - Lastly, the 'Exten' field has been replaced with 'ParkingSpace'.
325
326  - The AMI event 'Parkinglot' (response to 'Parkinglots' command) in a similar
327    fashion has changed the field names 'StartExten' and 'StopExten' to
328    'StartSpace' and 'StopSpace' respectively.
329
330  - The AMI 'Status' response event to the AMI Status action replaces the
331    'BridgedChannel' and 'BridgedUniqueid' headers with the 'BridgeID' header to
332    indicate what bridge the channel is currently in.
333
334 CDR (Call Detail Records)
335  - Significant changes have been made to the behavior of CDRs. The CDR engine
336    was effectively rewritten and built on the Stasis message bus. For a full
337    definition of CDR behavior in Asterisk 12, please read the specification
338    on the Asterisk wiki (wiki.asterisk.org).
339
340  - CDRs will now be created between all participants in a bridge. For each
341    pair of channels in a bridge, a CDR is created to represent the path of
342    communication between those two endpoints. This lets an end user choose who
343    to bill for what during bridge operations with multiple parties.
344
345  - The duration, billsec, start, answer, and end times now reflect the times
346    associated with the current CDR for the channel, as opposed to a cumulative
347    measurement of all CDRs for that channel.
348
349 CEL:
350  - The Uniqueid field for a channel is now a stable identifier, and will not
351    change due to transfers, parking, etc.
352
353  - CEL has undergone significant rework in Asterisk 12, and is now built on the
354    Stasis message bus. Please see the specification for CEL on the Asterisk
355    wiki at https://wiki.asterisk.org/wiki/x/4ICLAQ for more detailed
356    information. A summary of the affected events is below:
357    - BRIDGE_START, BRIDGE_END, BRIDGE_UPDATE, 3WAY_START, 3WAY_END, CONF_ENTER,
358      CONF_EXIT, CONF_START, and CONF_END events have all been removed. These
359      events have been replaced by BRIDGE_ENTER/BRIDGE_EXIT.
360    - BLINDTRANSFER/ATTENDEDTRANSFER events now report the peer as NULL and
361      additional information in the extra string field.
362
363 Dialplan Functions:
364
365  - Certain dialplan functions have been marked as 'dangerous', and may only be
366    executed from the dialplan. Execution from extenal sources (AMI's GetVar and
367    SetVar actions; etc.) may be inhibited by setting live_dangerously in the
368    [options] section of asterisk.conf to no. SHELL(), channel locking, and
369    direct file read/write functions are marked as dangerous. DB_DELETE() and
370    REALTIME_DESTROY() are marked as dangerous for reads, but can now safely
371    accept writes (which ignore the provided value).
372
373 Dialplan:
374  - All channel and global variable names are evaluated in a case-sensitive
375    manner. In previous versions of Asterisk, variables created and evaluated in
376    the dialplan were evaluated case-insensitively, but built-in variables and
377    variable evaluation done internally within Asterisk was done
378    case-sensitively.
379
380  - Asterisk has always had code to ignore dash '-' characters that are not
381    part of a character set in the dialplan extensions.  The code now
382    consistently ignores these characters when matching dialplan extensions.
383
384  - BRIDGE_FEATURES channel variable is now casesensitive for feature letter
385    codes. Uppercase variants apply them to the calling party while lowercase
386    variants apply them to the called party.
387
388 Features:
389  - The features.conf [applicationmap] <FeatureName>  ActivatedBy option is
390    no longer honored.  The feature is always activated by the channel that has
391    DYNAMIC_FEATURES defined on it when it enters the bridge. Use predial to set
392    different values of DYNAMIC_FEATURES on the channels
393
394  - Executing a dynamic feature on the bridge peer in a multi-party bridge will
395    execute it on all peers of the activating channel.
396
397  - There is no longer an explicit 'features reload' CLI command. Features can
398    still be reloaded using 'module reload features'.
399
400  - It is no longer necessary (or possible) to define the ATXFER_NULL_TECH in
401    features.c for atxferdropcall=no to work properly. This option now just
402    works.
403
404 Parking:
405  - Parking has been extracted from the Asterisk core as a loadable module,
406    res_parking.
407
408  - Configuration is found in res_parking.conf. It is no longer supported in
409    features.conf
410
411  - The arguments for the Park, ParkedCall, and ParkAndAnnounce applications 
412    have been modified significantly. See the application documents for 
413    specific details.
414
415  - Numerous changes to Parking related applications, AMI and CLI commands and
416    internal inter-workings  have been made. Please read the CHANGES file for 
417    the detailed list.
418
419 Security Events Framework:
420  - Security Event timestamps now use ISO 8601 formatted date/time instead of
421    the "seconds-microseconds" format that it was using previously.
422
423 AGENT:
424  - The password option has been disabled, as the AgentLogin application no
425    longer provides authentication.
426
427 AUDIOHOOK_INHERIT:
428  - Due to changes in the Asterisk core, this function is no longer needed to
429    preserve a MixMonitor on a channel during transfer operations and dialplan
430    execution. It is effectively obsolete.
431
432 CDR: (function)
433  - The 'amaflags' and 'accountcode' attributes for the CDR function are
434    deprecated. Use the CHANNEL function instead to access these attributes.
435
436  - The 'l' option has been removed. When reading a CDR attribute, the most
437    recent record is always used. When writing a CDR attribute, all non-finalized
438    CDRs are updated.
439
440  - The 'r' option has been removed, for the same reason as the 'l' option.
441
442  - The 's' option has been removed, as LOCKED semantics no longer exist in the
443    CDR engine.
444
445 res_rtp_asterisk:
446  - ICE/STUN/TURN support in res_rtp_asterisk has been made optional. To enable
447    them, an Asterisk-specific version of PJSIP needs to be installed.
448    Tarballs are available from https://github.com/asterisk/pjproject/tags/.
449
450
451 ===========================================================
452 ===========================================================