LP 1542495: Release Notes and Sample Config Change.
[working/Evergreen.git] / docs / RELEASE_NOTES_NEXT / SIP / LP1542495-Requires-SIPServer-Upgrade.adoc
1 SIP Bugfix Requires SIPServer Upgrade
2 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3
4 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
5 crash" requires that you also upgrade SIPServer with the fix for
6 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
7 SIP client problems."  This means that if you use SIP2 with Evergreen,
8 you must also upgrade SIPServer to the latest commit in the git
9 repository.  Conversely, if you upgrade SIPServer to the latest commit
10 in git, you must also upgrade Evergreen or, at least, apply the patch
11 for Launchpad Bug 1542495.  These two patches are complementary and
12 cannot be applied independently of one another.
13
14 SIP Bugfix Changes How Encoding Is Determined in Configuration
15 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16
17 The combined fix for the above mentioned SIP bugs alters the way that
18 the output encoding is looked up in the configuration file (typically
19 oils_sip.xml).  SIPServer now looks for the encoding in the following
20 places:
21
22 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
23 2. The +encoding+ element that is a child of the +insitution+ element of the currently acctive SIP account.
24 3. The +encoding+ element that is a child of the +implementation_config+ element that is itself a child of the +insitution+ element of the currently acctive SIP account.
25 4. If none of the above exist, then ASCII encoding is used by default.
26
27 Number 3 is provided to ease the transition to the new code.  It is
28 the current location of the +encoding+ element in the sample
29 configuration file and as such, where it is likely to be found in
30 actual files.  It is recommended that you alter your configuration to
31 move this element out of the +implementation_config+ element and into
32 its parent +institution+ element.  SIPServer should *not* look into
33 the implementation config, and this check may be removed at some time
34 in the future.