res_config_odbc: Fix for nullable integer columns and keyfield existence check in...
[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 === UPGRADE-12.txt  -- Upgrade info for 11 to 12
22 ===========================================================
23 From 12.1.0 to 12.2.0:
24 PJSIP:
25  - The PJSIP registrar now stores the contents of the User-Agent header of incoming
26    REGISTER requests for each contact that is registered. If using realtime for
27    PJSIP contacts, this means that the schema has been updated to add a user_agent
28    column. An alembic revision has been added to facilitate this update.
29  
30  - PJSIP endpoints now have a "message_context" option that can be used to determine
31    where to route incoming MESSAGE requests from the endpoint.
32
33 IAX2:
34  - When communicating with a peer on an Asterisk 1.4 or earlier system, the
35    chan_iax2 parameter 'connectedline' must be set to "no" in iax.conf. This
36    prevents an incompatible connected line frame from an Astersik 1.8 or later
37    system from causing a hangup in an Asterisk 1.4 or earlier system. Note that
38    this particular incompatibility has always existed between 1.4 and 1.8 and
39    later versions; this upgrade note is simply informing users of its existance.
40
41 Realtime Configuration:
42  - PJSIP endpoint columns 'tos_audio' and 'tos_video' have been changed from yes/no
43    enumerators to string values. 'cos_audio' and 'cos_video' have been changed from
44    yes/no enumerators to integer values. PJSIP transport column 'tos' has been
45    changed from a yes/no enumerator to a string value. 'cos' has been changed from
46    a yes/no enumerator to an integer value.
47
48 From 12.0.0 to 12.1.0:
49 * The sound_place_into_conference sound used in Confbridge is now deprecated
50   and is no longer functional since it has been broken since its inception
51   and the fix involved using a different method to achieve the same goal. The
52   new method to achieve this functionality is by using sound_begin to play
53   a sound to the conference when waitmarked users are moved into the conference.
54
55 From 12 to 13:
56
57 - The per console verbose level feature as previously implemented caused a
58   large performance penalty.  The fix required some minor incompatibilities
59   if the new rasterisk is used to connect to an earlier version.  If the new
60   rasterisk connects to an older Asterisk version then the root console verbose
61   level is always affected by the "core set verbose" command of the remote
62   console even though it may appear to only affect the current console.  If
63   an older version of rasterisk connects to the new version then the
64   "core set verbose" command will have no effect.
65
66 ARI:
67  - The ARI version has been changed from 1.0.0 to 1.1.0. This is to reflect
68    the backwards compatible changes listed below.
69
70  - Added a new ARI resource 'mailboxes' which allows the creation and
71    modification of mailboxes managed by external MWI. Modules res_mwi_external
72    and res_stasis_mailbox must be enabled to use this resource.
73
74  - Added new events for externally initiated transfers. The event
75    BridgeBlindTransfer is now raised when a channel initiates a blind transfer
76    of a bridge in the ARI controlled application to the dialplan; the
77    BridgeAttendedTransfer event is raised when a channel initiates an
78    attended transfer of a bridge in the ARI controlled application to the
79    dialplan.
80
81  - Channel variables may now be specified as a body parameter to the
82    POST /channels operation. The 'variables' key in the JSON is interpreted
83    as a sequence of key/value pairs that will be added to the created channel
84    as channel variables. Other parameters in the JSON body are treated as
85    query parameters of the same name.
86
87 AMI:
88  - The AMI version has been changed from 2.0.0 to 2.1.0. This is to reflect
89    the backwards compatible changes listed below.
90
91  - The DialStatus field in the DialEnd event can now have additional values.
92    This includes ABORT, CONTINUE, and GOTO.
93
94  - The res_mwi_external_ami module can, if loaded, provide additional AMI
95    actions and events that convey MWI state within Asterisk. This includes
96    the MWIGet, MWIUpdate, and MWIDelete actions, as well as the MWIGet and
97    MWIGetComplete events that occur in response to an MWIGet action.
98
99  - AMI now contains a new class authorization, 'security'. This is used with
100    the following new events: FailedACL, InvalidAccountID, SessionLimit,
101    MemoryLimit, LoadAverageLimit, RequestNotAllowed, AuthMethodNotAllowed,
102    RequestBadFormat, SuccessfulAuth, UnexpectedAddress, ChallengeResponseFailed,
103    InvalidPassword, ChallengeSent, and InvalidTransport.
104
105  - Bridge related events now have two additional fields: BridgeName and
106    BridgeCreator. BridgeName is a descriptive name for the bridge;
107    BridgeCreator is the name of the entity that created the bridge. This
108    affects the following events: ConfbridgeStart, ConfbridgeEnd,
109    ConfbridgeJoin, ConfbridgeLeave, ConfbridgeRecord, ConfbridgeStopRecord,
110    ConfbridgeMute, ConfbridgeUnmute, ConfbridgeTalking, BlindTransfer,
111    AttendedTransfer, BridgeCreate, BridgeDestroy, BridgeEnter, BridgeLeave
112
113 CDRs:
114  - The "endbeforehexten" setting now defaults to "yes", instead of "no".
115    When set to "no", yhis setting will cause a new CDR to be generated when a
116    channel enters into hangup logic (either the 'h' extension or a hangup
117    handler subroutine). In general, this is not the preferred default: this
118    causes extra CDRs to be generated for a channel in many common dialplans.
119
120 CLI commands:
121  - "core show settings" now lists the current console verbosity in addition
122    to the root console verbosity.
123
124  - "core set verbose" has not been able to support the by module verbose
125    logging levels since verbose logging levels were made per console.  That
126    syntax is now removed and a silence option added in its place.
127
128 Configuration Files:
129  - The 'verbose' setting in logger.conf still takes an optional argument,
130    specifying the verbosity level for each logging destination.  However,
131    the default is now to once again follow the current root console level.
132    As a result, using the AMI Command action with "core set verbose" could
133    again set the root console verbose level and affect the verbose level
134    logged.
135
136  - The manager.conf 'eventfilter' now takes an "extended" regular expression
137    instead of a "basic" one.
138
139 ODBC:
140 - The compatibility setting, allow_empty_string_in_nontext, has been removed.
141   Empty column values will be stored as empty strings during realtime updates.
142
143 Realtime Configuration:
144  - WARNING: The database migration script that adds the 'extensions' table for
145    realtime had to be modified due to an error when installing for MySQL.  The
146    'extensions' table's 'id' column was changed to be a primary key.  This could
147    potentially cause a migration problem.  If so, it may be necessary to
148    manually alter the affected table/column to bring it back in line with the
149    migration scripts.
150
151  - New columns have been added to realtime tables for 'support_path' on
152    ps_registrations and ps_aors and for 'path' on ps_contacts for the new
153    SIP Path support in chan_pjsip.
154
155  - The following new tables have been added for pjsip realtime: 'ps_systems',
156    'ps_globals', 'ps_tranports', 'ps_registrations'.
157
158  - The following columns were added to the 'ps_aors' realtime table:
159    'maximum_expiration', 'outbound_proxy', and 'support_path'.
160
161  - The following columns were added to the 'ps_contacts' realtime table:
162    'outbound_proxy' and 'path'.
163
164  - New columns have been added to the ps_endpoints realtime table for the
165    'media_address', 'redirect_method' and 'set_var' options.  Also the
166    'mwi_fromuser' column was renamed to 'mwi_from_user'.
167
168  - A new column was added to the 'ps_globals' realtime table for the 'debug'
169    option.
170
171
172 ===========================================================
173 ===========================================================