release-notes/5.7.0.md

   1 # CiviCRM 5.7.0
   2
   3 Released November 7, 2018
   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?     |   no    |
  21 | Introduce features?                                             | **yes** |
  22 | Fix bugs?                                                       | **yes** |
  23
  24 ## <a name="features"></a>Features
  25
  26 ### Core CiviCRM
  27
  28 - **Add icons to top-level navigation menu
  29   ([12878](https://github.com/civicrm/civicrm-core/pull/12878) and
  30   [13015](https://github.com/civicrm/civicrm-core/pull/13015))**
  31
  32   Each item in the top (horizontal) level of the navigation menu is now
  33   accompanied by an icon.
  34
  35 - **Fix api profile.submit to work with tag & note fields
  36   ([12825](https://github.com/civicrm/civicrm-core/pull/12825))**
  37
  38   This change improves the Profile API so that in the `submit` action one can
  39   add and remove tags and add a note field.
  40
  41 - **Better title for note field
  42   ([12827](https://github.com/civicrm/civicrm-core/pull/12827))**
  43
  44   Updates the title of the note field from "note(s)" to "note" because you can
  45   only import one note at a time.
  46
  47 - **(DX) Civi::contactSettings - Add a facade for working with the logged-in
  48   user's settings
  49   ([12879](https://github.com/civicrm/civicrm-core/pull/12879))**
  50
  51   This adds a helper method for accessing the SettingsBag of the contact
  52   corresponding to the logged-in user.
  53
  54 - **Improve display of relationships tab
  55   ([12800](https://github.com/civicrm/civicrm-core/pull/12800))**
  56
  57   The relationships tab on a contact is now more consistent with the rest of
  58   CiviCRM, displaying correctly in standard output and in the Shoreditch theme.
  59
  60 - **Cleanup contact summary tabs code
  61   ([12941](https://github.com/civicrm/civicrm-core/pull/12941))**
  62
  63   A largely non-functional change, this makes it possible for extensions to
  64   modify the order of tabs on a contact record.
  65
  66 ### CiviContribute
  67
  68 - **Use cached function for financialAccount retrieval.
  69   ([12773](https://github.com/civicrm/civicrm-core/pull/12773))**
  70
  71   This is a performance improvement which reduces repetitive queries when
  72   creating contributions.
  73
  74 - **Allow descriptions for payment fields
  75   ([12721](https://github.com/civicrm/civicrm-core/pull/12721))**
  76
  77   This change makes it so a payment processor extension can add a description to
  78   a payment field.
  79
  80 ### CiviEvent
  81
  82 - **Allow to specify template_id on URL when creating a new event
  83   ([12781](https://github.com/civicrm/civicrm-core/pull/12781))**
  84
  85   Adding the `template_id` URL parameter with the ID of an event template will
  86   now load the New Event form using that template.
  87
  88 ### CiviMember
  89
  90 - **Convert membership date fields to datepicker & form to entity form
  91   ([12690](https://github.com/civicrm/civicrm-core/pull/12690))**
  92
  93   Updates the membership date fields to datepicker rather than jCalendar.  This
  94   also uses the new entityFormTrait methods to add the fields in a more
  95   systematic way.
  96
  97 ## <a name="bugs"></a>Bugs resolved
  98
  99 ### Core CiviCRM
 100
 101 - **[dev/core#396](https://lab.civicrm.org/dev/core/issues/396) date ranges are
 102   lost when creating smart groups
 103   ([12909](https://github.com/civicrm/civicrm-core/pull/12909))**
 104
 105   This change fixes a regression where smart groups created using a manually
 106   entered date range (the user sets a start and end date as opposed to a preset
 107   range like "this year") would ignore the dates.
 108
 109 - **[dev/core#376](https://lab.civicrm.org/dev/core/issues/376) Contact Detail
 110   report breaks when adding clause using selectWhereClause()
 111   ([12772](https://github.com/civicrm/civicrm-core/pull/12772))**
 112
 113   Extensions using `hook_civicrm_selectWhereClause` to modify the Contact Detail
 114   report would cause a database error.
 115
 116 - **[dev/report#6](https://lab.civicrm.org/dev/report/issues/6)
 117   getAddressColumns defined `street_name` twice
 118   ([12808](https://github.com/civicrm/civicrm-core/pull/12808))**
 119
 120   This change fixes a bug where for reports that use the common function to get
 121   address fields one could not sort by the "street name" field.
 122
 123 - **Fix invalid markup on extension page - remove dots from ids & classes
 124   ([12882](https://github.com/civicrm/civicrm-core/pull/12882))**
 125
 126 - **Don't mess up fragment links in nav menu
 127   ([12876](https://github.com/civicrm/civicrm-core/pull/12876))**
 128
 129   Fixes a bug where where fragment links (for example, javascript-oriented links
 130   like `<a href="#summary">`) were not rendering properly in the navigation menu.
 131
 132 - **[dev/core#362](https://lab.civicrm.org/dev/core/issues/362) Contact
 133   Reference Fields don't allow search and select On Behalf Profiles
 134   ([12790](https://github.com/civicrm/civicrm-core/pull/12790))**
 135
 136   Contact reference fields that were added to the on-behalf profile on a
 137   contribution page would not have the expected Select2 widget: they would
 138   simply appear as text fields.  The fields now appear as expected.
 139
 140 - **Freeze custom data elements when viewing an entity
 141   ([12867](https://github.com/civicrm/civicrm-core/pull/12867))**
 142
 143   When viewing an entity with custom data, the custom data would appear as a
 144   form, though no changes would be saved.  Custom fields now appear frozen in
 145   view mode, just like the rest of the entity's fields.
 146
 147 - **[dev/core#393](https://lab.civicrm.org/dev/core/issues/393) OptionGroup
 148   check doesn't like option values of zero in a group of integers
 149   ([12817](https://github.com/civicrm/civicrm-core/pull/12817))**
 150
 151   The system check for invalid option values no longer displays a notice if a
 152   value of `0` is part of an integer option group.
 153
 154 - **Fixed spacing between & table structure issues
 155   ([12811](https://github.com/civicrm/civicrm-core/pull/12811))**
 156
 157   This change cleans up the layout (spacing and table structure) on events &
 158   membership pages.
 159
 160 - **Fixed pages dropdown design issues
 161   ([12812](https://github.com/civicrm/civicrm-core/pull/12812))**
 162
 163   This change cleans up and standardizes the markup on the CiviCampaign GOTV
 164   display.
 165
 166 - **[dev/core#379](https://lab.civicrm.org/dev/core/issues/379) View Activity:
 167    extraneous newlines by nl2br on HTML content
 168   ([12778](https://github.com/civicrm/civicrm-core/pull/12778))**
 169
 170   This change fixes extra spacing added in the details field on an activity.
 171
 172 - **Display tables correctly on import wizard/membership dashboard when using
 173   drupal bootstrap based theme
 174   ([12799](https://github.com/civicrm/civicrm-core/pull/12799))**
 175
 176   This change fixes the display of tables on the import wizard and the
 177   membership dashboard for Drupal sites that use a Bootstrap based theme.
 178
 179 - **[dev/core#382](https://lab.civicrm.org/dev/core/issues/382) DB Error
 180   generated when updating a group with an organisation record attached where the
 181   id in the civicrm_group_organisation does not match the id in civicrm_group
 182   ([12785](https://github.com/civicrm/civicrm-core/pull/12785))**
 183
 184 - **Fix capitalisation for 'Republic of' countries (Iran, Macedonia)
 185   ([12802](https://github.com/civicrm/civicrm-core/pull/12802))**
 186
 187   This change fixes "Republic of" countries (like Iran and Macedonia) so that
 188   the "of" is not capitalized.
 189
 190 - **[dev/core#428](https://lab.civicrm.org/dev/core/issues/428) Fatal error in
 191   Activity Details report when Sorting uses Section Header
 192   ([12915](https://github.com/civicrm/civicrm-core/pull/12915))**
 193
 194 - **Fix regression on activity detail report add to group
 195   ([12963](https://github.com/civicrm/civicrm-core/pull/12963))**
 196
 197   This resolves a database error that would appear when adding contacts to a
 198   group from the Activity Detail report.
 199
 200 - **Contact summary report with location type selected: fixed fatal error for
 201   function not found
 202   ([12967](https://github.com/civicrm/civicrm-core/pull/12967))**
 203
 204 - **Remove contact tags when none selected on edit screen
 205   ([12958](https://github.com/civicrm/civicrm-core/pull/12958))**
 206
 207   From the contact edit form, unselecting all of a contact's tags would not
 208   result in any changes.
 209
 210 - **[dev/core#462](https://lab.civicrm.org/dev/core/issues/462) Export temporary
 211   tables cause Advanced Logging warning of missing log tables
 212   ([12984](https://github.com/civicrm/civicrm-core/pull/12984))**
 213
 214 ### CiviCase
 215
 216 - **[dev/core#370](https://lab.civicrm.org/dev/core/issues/370) No new tasks and
 217   documents get added to workflow if all built-in ones are deleted
 218   ([12748](https://github.com/civicrm/civicrm-core/pull/12748))**
 219
 220   This change makes it so one can delete all built in tasks associated with the
 221   standard workflow of a case type and then add new ones. Before this change if
 222   you deleted all existing tasks associated with a case type you could not add
 223   new ones.
 224
 225 - **Remove Stray Extra Div in Case Dashboard TPL
 226 ([12848](https://github.com/civicrm/civicrm-core/pull/12848))**
 227
 228   This change removes an extra div tag on the case dashboard that was messing up
 229   the layout of the page for some WordPress users.
 230
 231 ### CiviContribute
 232
 233 - **Add span to amount label in Confirm.tpl
 234   ([12847](https://github.com/civicrm/civicrm-core/pull/12847))**
 235
 236   This change adds a HTML `<span>` tag to the amount label on the Contribution
 237   Confirm page to make it so one can more easily hide labels as needed.
 238
 239 - **When submitting a standalone credit card contribution the contact email
 240   address should not be deleted
 241   ([12854](https://github.com/civicrm/civicrm-core/pull/12854))**
 242
 243 - **Remove duplicate payment processor select on Membership Renewal form
 244   ([12734](https://github.com/civicrm/civicrm-core/pull/12734))**
 245
 246   This removes an extraneous second Payment Processor field from the backend
 247   credit card membership renewal form.
 248
 249 - **[dev/core#386](https://lab.civicrm.org/dev/core/issues/386) Contribution
 250   Detail Report shows no amount if set to Soft Credit Only.
 251   ([12860](https://github.com/civicrm/civicrm-core/pull/12860))**
 252
 253   This change fixes a bug on the Contribution Detail Report where, if the report
 254   was configured to show only Soft Credit amounts, the Amount column would
 255   display as empty.
 256
 257 - **fixing batch search by payment method
 258   ([12707](https://github.com/civicrm/civicrm-core/pull/12707))**
 259
 260   The Payment Method field was ignored when searching for transactions to add to
 261   an accounting batch.  It now filters transactions correctly if the field is
 262   set.
 263
 264 ### CiviEvent
 265
 266 - **Don't show 'Register Participant' on the manage events page if the logged in
 267   user does not have 'Edit Event Participants' permission
 268   ([12768](https://github.com/civicrm/civicrm-core/pull/12768))**
 269
 270 - **Fix default for repetition_start_date
 271   ([12997](https://github.com/civicrm/civicrm-core/pull/12997))**
 272
 273   The start date for repeating events now defaults to the current event's start
 274   date.
 275
 276 ### CiviMail
 277
 278 - **[dev/core#448](https://lab.civicrm.org/dev/core/issues/448) When creating a
 279   CiviCRM Mailing including a Smart Group, All contacts met by the criteria of
 280   the smart group are added. There is no check performed to make sure that
 281   contacts removed from the smart group aren't included**
 282
 283 - **[dev/core#281](https://lab.civicrm.org/dev/core/issues/281) Fix invoice
 284   number in message template
 285   ([12856](https://github.com/civicrm/civicrm-core/pull/12856))**
 286
 287   This change fixes a bug where when printing or emailing an invoice the
 288   Invoice Number field would show the invoice ID instead of the human-readable
 289   invoice number.
 290
 291 - **[dev/core#421](https://lab.civicrm.org/dev/core/issues/421) Creating a new
 292   message template from within CiviMail interface requires both edit user
 293   workflow templates and edit system workflow templates as well as edit message
 294   templates ([12896](https://github.com/civicrm/civicrm-core/pull/12896))**
 295
 296   A past version added separate permissions for editing system workflow message
 297   templates and editing user-driven message templates.  These are meant to be
 298   more granular alternatives to the permission to edit message templates.  A bug
 299   in the CiviMail workflow required all three permissions to create a new
 300   message template.  Now, you can create a template if you have either the
 301   legacy general permission to edit message templates or the relevant new
 302   specific permission.
 303
 304 - **Renamed Mailing Component entity
 305   ([12728](https://github.com/civicrm/civicrm-core/pull/12728) and
 306   [12877](https://github.com/civicrm/civicrm-core/pull/12877))**
 307
 308   This change renames the Mailing Component entity from
 309   CRM/Core/DAO/Component.php to CRM/Core/DAO/MailingComponent.php to fix some
 310   extension compatibility issues.
 311
 312 - **[dev/core#410](https://lab.civicrm.org/dev/core/issues/410) Validation
 313   Problems on Scheduled Reminders Form With SMS
 314   ([12874](https://github.com/civicrm/civicrm-core/pull/12874))**
 315
 316   This change cleans up the SMS reminder form to properly denote which fields
 317   are required and which are optional.
 318
 319 ### Joomla Integration
 320
 321 - **Fixed Joomla menu z-index regression
 322   [12952](https://github.com/civicrm/civicrm-core/pull/12952)**
 323
 324   This resolves a bug where the Joomla menus would open beneath the CiviCRM
 325   menu.  It also moves the CiviCRM menu directly below the Joomla menu.
 326
 327 ## <a name="misc"></a>Miscellany
 328
 329 - **Rename variable in MembershipRenewal form to make a merge with Membership
 330   form in future easier
 331   ([12798](https://github.com/civicrm/civicrm-core/pull/12798))**
 332
 333 - **Report Template test for SelectWhere - add test
 334   ([12809](https://github.com/civicrm/civicrm-core/pull/12809))**
 335
 336 - **Alter Test to ensure that order of city is output doesn't mater in th…
 337   ([12815](https://github.com/civicrm/civicrm-core/pull/12815))**
 338
 339 - **Just a test. ([12794](https://github.com/civicrm/civicrm-core/pull/12794))**
 340
 341 - **NFC: Rename variable in RecurringEntityPreview
 342   ([12770](https://github.com/civicrm/civicrm-core/pull/12770))**
 343
 344 - **NFC: fix grammar/punctuation in help
 345   ([12838](https://github.com/civicrm/civicrm-core/pull/12838))**
 346
 347 - **[NFC] Add unit test to cover component ACLs.
 348   ([12846](https://github.com/civicrm/civicrm-core/pull/12846))**
 349
 350 - **NFC Fix overindenting in caseDashboard template
 351   ([12853](https://github.com/civicrm/civicrm-core/pull/12853))**
 352
 353 - **(NFC) Fix indenting of Case DashBoard.tpl
 354   ([12849](https://github.com/civicrm/civicrm-core/pull/12849))**
 355
 356 - **Fix typo ([12858](https://github.com/civicrm/civicrm-core/pull/12858))**
 357
 358 - **[CRM-21677](https://issues.civicrm.org/jira/browse/CRM-21677) Report
 359   improvements ([12885](https://github.com/civicrm/civicrm-core/pull/12885))
 360   (follow-up)**
 361
 362   This cleans up code related to a prior change.
 363
 364 - **Export code improvement
 365   ([12672](https://github.com/civicrm/civicrm-core/pull/12672))**
 366
 367 - **Cleanup pledge form to use datepicker
 368   ([12774](https://github.com/civicrm/civicrm-core/pull/12774))**
 369
 370 - **Fixed wrapper
 371   ([12820](https://github.com/civicrm/civicrm-core/pull/12820))**
 372
 373 - **Add new paymentprocessor supportsX methods to replace remaining isSupported
 374   methods ([12762](https://github.com/civicrm/civicrm-core/pull/12762))**
 375
 376 - **Convert "Info and Settings" tab on ManageEvent to use datepicker
 377   ([12776](https://github.com/civicrm/civicrm-core/pull/12776))**
 378
 379 - **Switch grant form to use crmDatepicker instead of jCalendar
 380   ([12771](https://github.com/civicrm/civicrm-core/pull/12771))**
 381
 382 - **Convert RecurringEntity form to datepicker
 383   ([12746](https://github.com/civicrm/civicrm-core/pull/12746))**
 384
 385 - **(NFC) Make the test concurrency test not run on PR testing but on matrix
 386   alone until we can sort out the issue
 387   ([12961](https://github.com/civicrm/civicrm-core/pull/12961))**
 388
 389 ## <a name="credits"></a>Credits
 390
 391 This release was developed by the following code authors:
 392
 393 AGH Strategies - Alice Frumin, Andie Hunt; Australian Greens - Seamus Lee;
 394 CiviCRM - Coleman Watts, Tim Otten; CiviDesk - Yashodha Chaku; CompuCorp -
 395 Mukesh Ram; Coop SymbioTIC - Mathieu Lutfy; JMA Consulting - Joe Murray;
 396 Lemniscus - Noah Miller; Megaphone Technology Consulting - Jon Goldberg; MJW
 397 Consulting - Matthew Wire; mmyriam; Pradeep Nayak; Progressive Technology
 398 Project - Jamie McClelland; Samson Alajede; Tadpole Collective - Kevin
 399 Cristiano; Tanya Bouman; Team Expansion - Greg Harris; Wikimedia Foundation -
 400 Eileen McNaughton
 401
 402 Most authors also reviewed code for this release; in addition, the following
 403 reviewers contributed their comments:
 404
 405 Circle Interactive - Dave Jenkins; Digitalcourage - Detlev Sieber; JMA
 406 Consulting - Monish Deb; Joinery - Allen Shaw
 407
 408 ## <a name="feedback"></a>Feedback
 409
 410 These release notes are edited by Alice Frumin and Andie Hunt.  If you'd like
 411 to provide feedback on them, please log in to https://chat.civicrm.org/civicrm
 412 and contact `@agh1`.