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