UPGRADE.txt

   1 Information for Upgrading From Previous Asterisk Releases
   2 =========================================================
   3
   4 Build Process (configure script):
   5
   6 Asterisk now uses an autoconf-generated configuration script to learn how it
   7 should build itself for your system. As it is a standard script, running:
   8
   9 $ ./configure --help
  10
  11 will show you all the options available. This script can be used to tell the
  12 build process what libraries you have on your system (if it cannot find them
  13 automatically), which libraries you wish to have ignored even though they may
  14 be present, etc.
  15
  16 You must run the configure script before Asterisk will build, although it will
  17 attempt to automatically run it for you with no options specified; for most users,
  18 that will result in a similar build to what they would have had before the
  19 configure script was added to the build process (except for having to run 'make'
  20 again after the configure script is run). Note that the configure script does NOT
  21 need to be re-run just to rebuild Asterisk; you only need to re-run it when your
  22 system configuration changes or you wish to build Asterisk with different options.
  23
  24 Build Process (module selection):
  25
  26 The Asterisk source tree now includes a basic module selection and build option
  27 selection tool called 'menuselect'. Run 'make menuselect' to make your choices.
  28 In this tool, you can disable building of modules that you don't care about,
  29 turn on/off global options for the build and see which modules will not (and cannot)
  30 be built because your system does not have the required external dependencies
  31 installed.
  32
  33 (TODO: document where 'global' and 'per-user' menuselect input files should go
  34 and what they need to contain)
  35
  36 PBX Core:
  37
  38 * The (very old and undocumented) ability to use BYEXTENSION for dialing
  39   instead of ${EXTEN} has been removed.
  40
  41 Command Line Interface:
  42
  43 * 'show channels concise', designed to be used by applications that will parse
  44   its output, previously used ':' characters to separate fields. However, some
  45   of those fields can easily contain that character, making the output not
  46   parseable. The delimiter has been changed to '!'.
  47
  48 Applications:
  49
  50 * In previous Asterisk releases, many applications would jump to priority n+101
  51   to indicate some kind of status or error condition.  This functionality was
  52   marked deprecated in Asterisk 1.2.  An option to disable it was provided with
  53   the default value set to 'on'.  The default value for the global priority
  54   jumping option is now 'off'.
  55
  56 * The applications Cut, Sort, DBGet, DBPut, SetCIDNum, SetCIDName, SetRDNIS,
  57   AbsoluteTimeout, DigitTimeout, ResponseTimeout, SetLanguage, GetGroupCount,
  58   and GetGroupMatchCount were all deprecated in version 1.2, and therefore have
  59   been removed in this version.  You should use the equivalent dialplan
  60   function in places where you have previously used one of these applications.
  61
  62 * The application SetVar has been renamed to Set.  The syntax SetVar was marked
  63   deprecated in version 1.2 and is no longer recognized in this version.
  64
  65 * app_read has been updated to use the newer options codes, using "skip" or
  66   "noanswer" will not work.  Use s or n.  Also there is a new feature i, for
  67   using indication tones, so typing in skip would give you unexpected results.
  68
  69 * OSPAuth is added to authenticate OSP tokens in in_bound call setup messages.
  70
  71 * The CONNECT event in the queue_log from app_queue now has a second field
  72   in addition to the holdtime field. It contains the unique ID of the
  73   queue member channel that is taking the call. This is useful when trying
  74   to link recording filenames back to a particular call from the queue.
  75
  76 * The old/current behavior of app_queue has a serial type behavior
  77   in that the queue will make all waiting callers wait in the queue
  78   even if there is more than one available member ready to take
  79   calls until the head caller is connected with the member they
  80   were trying to get to. The next waiting caller in line then
  81   becomes the head caller, and they are then connected with the
  82   next available member and all available members and waiting callers
  83   waits while this happens. This cycle continues until there are
  84   no more available members or waiting callers, whichever comes first.
  85   The new behavior, enabled by setting autofill=yes in queues.conf
  86   either at the [general] level to default for all queues or
  87   to set on a per-queue level, makes sure that when the waiting
  88   callers are connecting with available members in a parallel fashion
  89   until there are no more available members or no more waiting callers,
  90   whichever comes first. This is probably more along the lines of how
  91   one would expect a queue should work and in most cases, you will want
  92   to enable this new behavior. If you do not specify or comment out this
  93   option, it will default to "no" to keep backward compatability with the old
  94   behavior.
  95
  96 * The app_queue application now has the ability to use MixMonitor to
  97   record conversations queue members are having with queue callers. Please
  98   see configs/queues.conf.sample for more information on this option.
  99
 100 * app_meetme: The 'm' option (monitor) is renamed to 'l' (listen only), and
 101   the 'm' option now provides the functionality of "initially muted".
 102   In practice, most existing dialplans using the 'm' flag should not notice
 103   any difference, unless the keypad menu is enabled, allowing the user
 104   to unmute themsleves.
 105
 106 * ast_play_and_record would attempt to cancel the recording if a DTMF
 107   '0' was received.  This behavior was not documented in most of the
 108   applications that used ast_play_and_record and the return codes from
 109   ast_play_and_record weren't checked for properly.
 110   ast_play_and_record has been changed so that '0' no longer cancels a
 111   recording.  If you want to allow DTMF digits to cancel an
 112   in-progress recording use ast_play_and_record_full which allows you
 113   to specify which DTMF digits can be used to accept a recording and
 114   which digits can be used to cancel a recording.
 115
 116 * ast_app_messagecount has been renamed to ast_app_inboxcount.  There is now a
 117   new ast_app_messagecount function which takes a single context/mailbox/folder
 118   mailbox specification and returns the message count for that folder only.
 119   This addresses the deficiency of not being able to count the number of
 120   messages in folders other than INBOX and Old.
 121
 122 Manager:
 123
 124 * After executing the 'status' manager action, the "Status" manager events
 125   included the header "CallerID:" which was actually only the CallerID number,
 126   and not the full CallerID string.  This header has been renamed to
 127   "CallerIDNum".  For compatibility purposes, the CallerID parameter will remain
 128   until after the release of 1.4, when it will be removed.  Please use the time
 129   during the 1.4 release to make this transition.
 130
 131 * The AgentConnect event now has an additional field called "BridgedChannel"
 132   which contains the unique ID of the queue member channel that is taking the
 133   call. This is useful when trying to link recording filenames back to
 134   a particular call from the queue.
 135
 136 * app_userevent has been modified to always send Event: UserEvent with the
 137   additional header UserEvent: <userspec>.  Also, the Channel and UniqueID
 138   headers are not automatically sent, unless you specify them as separate
 139   arguments.  Please see the application help for the new syntax.
 140
 141 * app_meetme: Mute and Unmute events are now reported via the Manager API.
 142   Native Manager API commands MeetMeMute and MeetMeUnmute are provided, which
 143   are easier to use than "Action Command:". The MeetMeStopTalking event has
 144   also been deprecated in favor of the already existing MeetmeTalking event
 145   with a "Status" of "on" or "off" added.
 146
 147 Variables:
 148
 149 * The builtin variables ${CALLERID}, ${CALLERIDNAME}, ${CALLERIDNUM},
 150   ${CALLERANI}, ${DNID}, ${RDNIS}, ${DATETIME}, ${TIMESTAMP}, ${ACCOUNTCODE},
 151   and ${LANGUAGE} have all been deprecated in favor of their related dialplan
 152   functions.  You are encouraged to move towards the associated dialplan
 153   function, as these variables will be removed in a future release.
 154
 155 * The CDR-CSV variables uniqueid, userfield, and basing time on GMT are now
 156   adjustable from cdr.conf, instead of recompiling.
 157
 158 * OSP applications exports several new variables, ${OSPINHANDLE},
 159   ${OSPOUTHANDLE}, ${OSPINTOKEN}, ${OSPOUTTOKEN}, ${OSPCALLING},
 160   ${OSPINTIMELIMIT}, and ${OSPOUTTIMELIMIT}
 161
 162 Functions:
 163
 164 * The function ${CHECK_MD5()} has been deprecated in favor of using an
 165   expression: $[${MD5(<string>)} = ${saved_md5}].
 166
 167 * The 'builtin' functions that used to be combined in pbx_functions.so are
 168   now built as separate modules. If you are not using 'autoload=yes' in your
 169   modules.conf file then you will need to explicitly load the modules that
 170   contain the functions you want to use.
 171
 172 * The ENUMLOOKUP() function with the 'c' option (for counting the number of records),
 173   but the lookup fails to match any records, the returned value will now be "0" instead of blank.
 174
 175 * The REALTIME() function is now available in version 1.4 and app_realtime has
 176   been deprecated in favor of the new function. app_realtime will be removed
 177   completely with the version 1.6 release so please take the time between
 178   releases to make any necessary changes
 179
 180 The IAX2 channel:
 181
 182 * The "mailboxdetail" option has been deprecated.  Previously, if this option
 183   was not enabled, the 2 byte MSGCOUNT information element would be set to all
 184   1's to indicate there there is some number of messages waiting.  With this
 185   option enabled, the number of new messages were placed in one byte and the
 186   number of old messages are placed in the other.  This is now the default
 187   (and the only) behavior.
 188
 189 The SIP channel:
 190
 191 * The "incominglimit" setting is replaced by the "call-limit" setting in sip.conf.
 192
 193 * OSP support code is removed from SIP channel to OSP applications. ospauth
 194   option in sip.conf is removed to osp.conf as authpolicy. allowguest option
 195   in sip.conf cannot be set as osp anymore.
 196
 197 The Zap channel:
 198
 199 * Support for MFC/R2 has been removed, as it has not been functional for some time
 200   and it has no maintainer.
 201
 202 Installation:
 203
 204 * On BSD systems, the installation directories have changed to more "FreeBSDish" directories. On startup, Asterisk will look for the main configuration in /usr/local/etc/asterisk/asterisk.conf
 205 If you have an old installation, you might want to remove the binaries and move the configuration files to the new locations. The following directories are now default:
 206         ASTLIBDIR       /usr/local/lib/asterisk
 207         ASTVARLIBDIR    /usr/local/share/asterisk
 208         ASTETCDIR       /usr/local/etc/asterisk
 209         ASTBINDIR       /usr/local/bin/asterisk
 210         ASTSBINDIR      /usr/local/sbin/asterisk
 211
 212 Sounds:
 213
 214 * The phonetic sounds directory has been removed from the asterisk-sounds package
 215   because they are now included directly in Asterisk.  However, it is important to
 216   note that the phonetic sounds that existed in asterisk-sounds used a different
 217   naming convention than the sounds in Asterisk.  For example, instead of alpha.gsm
 218   and bravo.gsm, Asterisk has a_p.gsm and b_p.gsm.