release-notes/5.10.0.md

   1 # CiviCRM 5.10.0
   2
   3 Released February 6, 2019
   4
   5 - **[Synopsis](#synopsis)**
   6 - **[Features](#features)**
   7 - **[Bugs resolved](#bugs)**
   8 - **[Miscellany](#misc)**
   9 - **[Credits](#credits)**
  10 - **[Feedback](#feedback)**
  11
  12 ## <a name="synopsis"></a>Synopsis
  13
  14 | *Does this version...?*                                         |         |
  15 |:--------------------------------------------------------------- |:-------:|
  16 | Fix security vulnerabilities?                                   |   no    |
  17 | Change the database schema?                                     |   no    |
  18 | **Alter the API?**                                              | **yes** |
  19 | Require attention to configuration options?                     |   no    |
  20 | **Fix problems installing or upgrading to a previous version?** | **yes** |
  21 | **Introduce features?**                                         | **yes** |
  22 | **Fix bugs?**                                                   | **yes** |
  23
  24 ## <a name="features"></a>Features
  25
  26 ### Core CiviCRM
  27
  28 - **Support customdata subtype on entityform (for activity/relationship types)
  29   ([13311](https://github.com/civicrm/civicrm-core/pull/13311))**
  30
  31   This change makes it so that users can see and edit custom data for entity
  32   sub-types (like activity types and relationship types).
  33
  34 - **[dev/translation#13](https://lab.civicrm.org/dev/translation/issues/13)
  35   Language switcher for all
  36   ([13240](https://github.com/civicrm/civicrm-core/pull/13240))**
  37
  38   This change introduces a new setting to the settings page for Localization "UI
  39   Languages" for users in monolingual mode (not using multilingual). Configuring
  40   this setting results in the Language Switcher block being shown (same as in
  41   multilingual mode).
  42
  43 - **[dev/core#561](https://lab.civicrm.org/dev/core/issues/561) Replace
  44   jcalendar instances with datepicker
  45   ([13241](https://github.com/civicrm/civicrm-core/pull/13241) and
  46   [13299](https://github.com/civicrm/civicrm-core/pull/13299)) -- CONTINUED
  47   WORK**
  48
  49   These changes update the Scheduled Reminders Form and the Activity date and
  50   case start date fields to use the new datepicker widget.
  51
  52 - **Improved support for case variability in UF API calls.
  53   ([13343](https://github.com/civicrm/civicrm-core/pull/13343))**
  54
  55   This change makes it so that the API will accept "UFgroup" and "ufgroup" as
  56   the entity.
  57
  58 - **optimize CRM_Utils_String::ellipsify() method
  59   ([13347](https://github.com/civicrm/civicrm-core/pull/13347))**
  60
  61   This change improves performance for the function that truncates a string and
  62   adds an ellipsis on the end.
  63
  64 ### CiviCase
  65
  66 - **[dev-core#564](https://lab.civicrm.org/dev/core/issues/564) Differentiate
  67   case relationships in Contact Summary page
  68   ([13189](https://github.com/civicrm/civicrm-core/pull/13189))**
  69
  70   On the Relationship tab of a contact, this change adds a case icon for each
  71   case relationship to denote that the relationship is related to a case. This
  72   icon is linked to the case so one can easily access the case from the
  73   relationship.
  74
  75 - **Cache case count when getting list of cases so query is executed once
  76   instead of three times
  77   ([13368](https://github.com/civicrm/civicrm-core/pull/13368))**
  78
  79   This change improves performance on the Case Dashboard when listing cases.
  80
  81 ### CiviContribute
  82
  83 - **Add default of TRUE for is_active on PaymentProcessor.create api.
  84   ([13291](https://github.com/civicrm/civicrm-core/pull/13291))**
  85
  86   This change makes it so that when using the API with the entity Payment
  87   Processor and the action create, the parameter "is_active" defaults to TRUE
  88   like the UFGroup, CustomGroup, ComtributionPage entities do.
  89
  90 ## <a name="bugs"></a>Bugs resolved
  91
  92 ### Core CiviCRM
  93
  94 - **[dev/core#695](https://lab.civicrm.org/dev/core/issues/695) Custom Search
  95   results selection failure and
  96   [dev/core#679](https://lab.civicrm.org/dev/core/issues/679) Groups and Tags
  97   affect search results when using Search Builder
  98   ([13533](https://github.com/civicrm/civicrm-core/pull/13533))**
  99
 100   This resolves some search regressions introduced in 5.9.0 relating to caching
 101   and custom searches.
 102
 103 - **[dev/core#192](https://lab.civicrm.org/dev/core/issues/192) - Search builder
 104   fails for != smart group filter
 105   ([12344](https://github.com/civicrm/civicrm-core/pull/12344))**
 106
 107   This change makes it so that when using the Search Builder with a filter
 108   "Contacts -> Group -> !- -> Smart group" the != operator is respected.
 109
 110 - **[dev/core#485](https://lab.civicrm.org/dev/core/issues/485) New
 111   Organization's profile: From time to time data in the field "Website" is
 112   deleted if nothing choose in the drop-down "Website Type"
 113   ([13170](https://github.com/civicrm/civicrm-core/pull/13170))**
 114
 115   This change fixes a bug when editing a contact where if a user enters a
 116   Website but no Website Type, the Website was not saved, so that the website is
 117   saved.
 118
 119 - **[dev/core#491](https://lab.civicrm.org/dev/core/issues/491) Report results
 120   don't show inactive campaigns
 121   ([13380](https://github.com/civicrm/civicrm-core/pull/13380),
 122   [13321](https://github.com/civicrm/civicrm-core/pull/13321),
 123   [13341](https://github.com/civicrm/civicrm-core/pull/13341),
 124   [13281](https://github.com/civicrm/civicrm-core/pull/13281),
 125   [13231](https://github.com/civicrm/civicrm-core/pull/13231),
 126   [13243](https://github.com/civicrm/civicrm-core/pull/13243),
 127   [13358](https://github.com/civicrm/civicrm-core/pull/13358),
 128   [13379](https://github.com/civicrm/civicrm-core/pull/13379),
 129   [13376](https://github.com/civicrm/civicrm-core/pull/13376),
 130   [13356](https://github.com/civicrm/civicrm-core/pull/13356),
 131   [13348](https://github.com/civicrm/civicrm-core/pull/13348) and
 132   [13351](https://github.com/civicrm/civicrm-core/pull/13351))**
 133
 134   This change updates the following reports: Member Summary, Pledged but not
 135   Paid, SYBUNT, Member Detail, Participant Listing, Pledge Detail, Contribution
 136   (org), Household Summary, and Soft Credit to include a filter for active vs
 137   disabled campaigns and generally simplifies the campaign related code on these
 138   reports.
 139
 140 - **[dev/core#592](https://lab.civicrm.org/dev/core/issues/592)
 141   ArgumentCountError: Too few arguments to function CiviCRM_API3_Exception...
 142   ([13263](https://github.com/civicrm/civicrm-core/pull/13263))**
 143
 144   This change fixes a bug where an "ArgumntCountError" was being thrown whenever
 145   an error was thrown so that only the error is thrown.
 146
 147 - **[dev/core#610](https://lab.civicrm.org/dev/core/issues/610) Page title
 148   displays twice if the activity type is set in Activity form
 149   ([13339](https://github.com/civicrm/civicrm-core/pull/13339))**
 150
 151   This change ensures that on the new or edit activity form the title is only
 152   shown once. Before this change if the Activity Type was set the title would
 153   show up twice.
 154
 155 - **[dev/core#622](https://lab.civicrm.org/dev/core/issues/622) User Dashboard
 156   doesn't show Edit Contact Information link
 157   ([13375](https://github.com/civicrm/civicrm-core/pull/13375))**
 158
 159   This change makes it so that the Edit Contact information link displays on the
 160   User Dashboard.
 161
 162 - **[dev/core#660](https://lab.civicrm.org/dev/core/issues/660) Fatal DB Error:
 163   already exists on event registration/contribution pages when profile has user
 164   creation ([13451](https://github.com/civicrm/civicrm-core/pull/13451))**
 165
 166   This change fixes a bug where if Anonymous users have ACLs to see a contact
 167   they cannot register for an event so that Anonymous users with ACLs to se a
 168   contact can register for events.
 169
 170 - **Fix php 7.2 countable warning
 171   ([13414](https://github.com/civicrm/civicrm-core/pull/13414))**
 172
 173 - **Bump Minimum Required PHP to be 5.6
 174   ([13309](https://github.com/civicrm/civicrm-core/pull/13309))**
 175
 176 - **Fix PHP 7 strict warnings CRM_Core_DAO::getContactIDsFromComponent passed by
 177   reference ([13295](https://github.com/civicrm/civicrm-core/pull/13295))**
 178
 179 - **Generalise the UsersTableName Setting name to support Backdrop
 180   ([13292](https://github.com/civicrm/civicrm-core/pull/13292))**
 181
 182 - **Fix duplicate merge to not disregard zero values.
 183   ([12669](https://github.com/civicrm/civicrm-core/pull/12669))**
 184
 185 - **Search Builder fails with an error when searching for State if the location
 186   type differs from the display name.
 187   ([13313](https://github.com/civicrm/civicrm-core/pull/13313))**
 188
 189 - **installer: PHP 7.2 compatibility fixes
 190   ([13326](https://github.com/civicrm/civicrm-core/pull/13326))**
 191
 192   This change fixes some php countable warnings thrown for users installing
 193   using PHP 7.2.
 194
 195 - **Export merge to household - fix DB error relating to fields too long for
 196   table. ([13338](https://github.com/civicrm/civicrm-core/pull/13338))**
 197
 198   This change fixes a fatal error when trying to combine/merge households and
 199   'primary fields' on some mysql configs
 200
 201 - **Fix notice on first loading activity search form
 202   ([13378](https://github.com/civicrm/civicrm-core/pull/13378))**
 203
 204 - **fix verbiage for Edit Contact Information title
 205   ([13352](https://github.com/civicrm/civicrm-core/pull/13352))**
 206
 207   On the User Dashboard this changes updates the link to edit a users contact
 208   from "Edit Relationship" to "Edit Contact Information".
 209
 210 - **fix verbiage for Dashboard title
 211   ([13349](https://github.com/civicrm/civicrm-core/pull/13349))**
 212
 213   This change updates the "User Dashboard" "Relationships" section Dashboard
 214   links to use the title "Dashboard" instead of "Edit Relationship".
 215
 216 ### CiviCase
 217
 218 - **[dev/core#454](https://lab.civicrm.org/dev/core/issues/454) CiviCase access
 219   to activities permission discrepancy
 220   ([12995](https://github.com/civicrm/civicrm-core/pull/12995))**
 221
 222   This change standardizes the permissioning of CiviCase so that users with the
 223   permission "access my cases and activities" or "access all cases and
 224   activities" can view appropriate case activities. Before this change the
 225   permissions needed to view case activities were inconsistent.
 226
 227 - **[dev/core#603](https://lab.civicrm.org/dev/core/issues/603) DB error on Case
 228   Summary report ([13296](https://github.com/civicrm/civicrm-core/pull/13296))**
 229
 230   This fixes a bug where running the Case Summary Report with no changes to the
 231   default settigns would result in a warning message so that the default
 232   settings for the Case Summary Report result in the report running as expected.
 233
 234 - **[dev/core#625](https://lab.civicrm.org/dev/core/issues/625) DB error on Case
 235   Summary report ([13359](https://github.com/civicrm/civicrm-core/pull/13359))**
 236
 237   This change fixes a bug in the Case Summary Report where running the report
 238   without the Columns "Staff Member" and "Relationship" but with a filter on
 239   "Active Relationships?" resulted in a DB Error so that one can run this report
 240   with this configuration.
 241
 242 - **Fix broken case activity date filter
 243   ([13449](https://github.com/civicrm/civicrm-core/pull/13449))**
 244
 245   This change fixes a bug on the Case Summary Screen where searching activities
 246   using the Activity Date filters (From or To) would result in a database error.
 247
 248 - **Standardize letter case
 249   ([13245](https://github.com/civicrm/civicrm-core/pull/13245))**
 250
 251   This change updates the text for the Case Task "Print/merge Document" to
 252   "Print/merge document".
 253
 254 - **Revert to showing overdue activities on a case first
 255   ([13360](https://github.com/civicrm/civicrm-core/pull/13360))**
 256
 257 - **Don't crash with missing class if action is not defined when opening new
 258   case ([13336](https://github.com/civicrm/civicrm-core/pull/13336))**
 259
 260 ### CiviContribute
 261
 262 - **[dev/core#680](https://lab.civicrm.org/dev/core/issues/680) "Date Received"
 263   for contributions no longer mandatory, also breaks financial transactions
 264   ([13537](https://github.com/civicrm/civicrm-core/pull/13537))**
 265
 266 - **[dev/core#651](https://lab.civicrm.org/dev/core/issues/651) Error exporting
 267   contributions with soft credits
 268   ([13536](https://github.com/civicrm/civicrm-core/pull/13536))**
 269
 270 - **[dev/core#620](https://lab.civicrm.org/dev/core/issues/620) Unable to show
 271   custom fields on Repeat Contributions Report
 272   ([13350](https://github.com/civicrm/civicrm-core/pull/13350))**
 273
 274   This change fixes a bug where selecting a custom field column on a Repeat
 275   Contributions report would result in an error so that one can use a custom
 276   field as a column in a Repeat Contributions report.
 277
 278 - **[dev/core#621](https://lab.civicrm.org/dev/core/issues/621) Price field
 279   option 9 Decimal Places in GUI
 280   ([13355](https://github.com/civicrm/civicrm-core/pull/13355))**
 281
 282   This change makes it so that the "Option Amount" field on the "Edit Price
 283   Option" form shows only two decimal places, before this change it showed 9
 284   decimal places.
 285
 286 - **Unable to mark price set field as inactive
 287   ([13257](https://github.com/civicrm/civicrm-core/pull/13257))**
 288
 289   This change ensures that when on the "Edit Price Field" form one can save
 290   changes to the "Active?" field.
 291
 292 - **Display self-service links in email receipts based on payment processor
 293   capabilities ([13215](https://github.com/civicrm/civicrm-core/pull/13215))**
 294
 295 - **On the Contribution Detail Report link the Amount field to the contribution
 296   ([13316](https://github.com/civicrm/civicrm-core/pull/13316))**
 297
 298 - **Declare 'amount' as required on ContributionRecur api
 299   ([13290](https://github.com/civicrm/civicrm-core/pull/13290))**
 300
 301 ### CiviEvent
 302
 303 - **[dev/core#653](https://lab.civicrm.org/dev/core/issues/653) New Events
 304   defaulting to event template after first page
 305   ([13478](https://github.com/civicrm/civicrm-core/pull/13478))**
 306
 307   This resolves a regression introduced in 5.9.0 where creating a new event would
 308   instead create a new event template.
 309
 310 ### CiviMail
 311
 312 - **[dev/report#5](CANNOT FIND THIS GITLAB ISSUE) - Fix mailing report unique
 313   count issue ([13322](https://github.com/civicrm/civicrm-core/pull/13322))**
 314
 315   This fixes the count when viewing the report of Unique Opens for a Mailing.
 316
 317 - **[dev/mail#35](https://lab.civicrm.org/dev/mail/issues/35) Public View link
 318   does not show from Scheduled and Sent screen
 319   ([13354](https://github.com/civicrm/civicrm-core/pull/13354))**
 320
 321   This change makes it so that one can click the Public View url on the
 322   Scheduled and Sent mailing screen.
 323
 324 - **[dev/core#623](https://lab.civicrm.org/dev/core/issues/623)
 325   civicrm_mailing_bounce_type.threshold = 30 for 'Away' is that correct?
 326   ([13366](https://github.com/civicrm/civicrm-core/pull/13366) and
 327   [13362](https://github.com/civicrm/civicrm-core/pull/13362))**
 328
 329   This change ensures that the CiviMail mailing bounce threshold for bounces of
 330   the type "Away" is set to be 30, prior to this change some instances had the
 331   threshold set to 3.
 332
 333 ### Joomla Integration
 334
 335 - **[dev/joomla#3](https://lab.civicrm.org/dev/joomla/issues/3) Recipients are
 336   not shown when creating / editing mailings
 337   ([13294](https://github.com/civicrm/civicrm-core/pull/13294))**
 338
 339 ### Wordpress Integration
 340
 341 - **[dev/wordpress#16](https://lab.civicrm.org/dev/wordpress/issues/16) Fatal
 342   error with some versions of PHP
 343   ([143](https://github.com/civicrm/civicrm-wordpress/pull/143))**
 344
 345   This fixes a bug where installing the CiviCRM plugin on a Wordpress
 346   site using PHP 7.2.12 would result in a fatal error.
 347
 348 ## <a name="misc"></a>Miscellany
 349
 350 - **(NFC) Fix PHP7.2 Count error on test testImportParserWtihEmployeeOfRelation…
 351   ([13247](https://github.com/civicrm/civicrm-core/pull/13247))**
 352
 353 - **(NFC) Update Copyright in FiveTen upgrade file to be 2019
 354   ([13268](https://github.com/civicrm/civicrm-core/pull/13268))**
 355
 356 - **(NFC) Just some additional package metadata
 357   ([13293](https://github.com/civicrm/civicrm-core/pull/13293))**
 358
 359 - **NFC: Improved documentation of crmPageTitle directive.
 360   ([13337](https://github.com/civicrm/civicrm-core/pull/13337))**
 361
 362 - **NFC Minor tweaks to docblocks on opencase form
 363   ([13335](https://github.com/civicrm/civicrm-core/pull/13335))**
 364
 365 - **Unit test for PR#12699
 366   ([13323](https://github.com/civicrm/civicrm-core/pull/13323))**
 367
 368 - **Add in unit test to support changes in UF API in PR 13343
 369   ([13344](https://github.com/civicrm/civicrm-core/pull/13344))**
 370
 371 - **NFC tidy up comments, remove unused variables in customfield classes
 372   ([13367](https://github.com/civicrm/civicrm-core/pull/13367))**
 373
 374 - **Simplify handling for case checking.
 375   ([13372](https://github.com/civicrm/civicrm-core/pull/13372))**
 376
 377 - **[REF] extract internals of Payment.create into function on BAO class.
 378   ([13370](https://github.com/civicrm/civicrm-core/pull/13370))**
 379
 380 - **[REF] simplify CRM_Activity_BAO_Activity function by using early returns
 381   ([13371](https://github.com/civicrm/civicrm-core/pull/13371))**
 382
 383 - **[REF] genericise function to add pseudoconstant data to fields to process
 384   ([13328](https://github.com/civicrm/civicrm-core/pull/13328))**
 385
 386 - **[REF] Add caching to function to determine if activity type is permitted.
 387   ([13329](https://github.com/civicrm/civicrm-core/pull/13329))**
 388
 389 - **[REF] Export add test for phone details, fix phone_type_id
 390   ([13275](https://github.com/civicrm/civicrm-core/pull/13275))**
 391
 392 - **[REF] Minor Test clean up
 393   ([13269](https://github.com/civicrm/civicrm-core/pull/13269))**
 394
 395 - **[REF] Export cleanup - filter at point of query on postal exports
 396   ([13216](https://github.com/civicrm/civicrm-core/pull/13216))**
 397
 398 - **[REF] Build single array of information about output specifications when
 399   exporting ([13213](https://github.com/civicrm/civicrm-core/pull/13213))**
 400
 401 ## <a name="credits"></a>Credits
 402
 403 This release was developed by the following code authors:
 404
 405 AGH Strategies - Alice Frumin, Andrew Hunt, Eli Lisseck; Andrew Thompson;
 406 Australian Greens - Seamus Lee; Christian Wach; CiviCoop - Klaas Eikelboom;
 407 CiviCRM - Coleman Watts, Tim Otten; CiviDesk - Sunil Pawar, Yashodha Chaku;
 408 CompuCorp - Davi Alexandre, Vinu Varshith Sekar; Coop SymbioTIC - Mathieu Lutfy;
 409 Electronic Frontier Foundation - Mark Burdett; Francesc Bassas i Bullich; Fuzion
 410 - Jitendra Purohit; Ginkgo Street Labs - Frank Gómez; iXiam - Luciano Spiegel;
 411 JMA Consulting - Monish Deb; MillerTech - Chamil Wijesooriya; MJW Consulting -
 412 Matthew Wire; Ray Wright; Squiffle Consulting - Aidan Saunders; Tadpole
 413 Collective - Kevin Cristiano; Veda Consulting - Mathavan Veeramuthu; Wikimedia
 414 Foundation - Eileen McNaughton
 415
 416 Most authors also reviewed code for this release; in addition, the following
 417 reviewers contributed their comments:
 418
 419 Blackfly Solutions - Alan Dixon; Circle Interactive - Dave Jenkins; Fuzion -
 420 Peter Davis; JMA Consulting - Joe Murray; John Kingsnorth; Joinery - Allen Shaw;
 421 Lighthouse Design and Consulting - Brian Shaughnessy; Megaphone Technology
 422 Consulting - Jon Goldberg; Nicol Wistreich; Richard van Oosterhout; Skvare -
 423 Mark Hanna; Systopia - Björn Endres
 424
 425 ## <a name="feedback"></a>Feedback
 426
 427 These release notes are edited by Alice Frumin and Andrew Hunt.  If you'd like
 428 to provide feedback on them, please log in to https://chat.civicrm.org/civicrm
 429 and contact `@agh1`.