Technical Release Notes

Technical Release Notes

While we make a huge effort to not break things during updates, when something can't be avoided we will document it here.

McKinley 13.0

Developers, starting with v13.0...
  • Finance -

    Usage of the older "CurrencySymbol" global attribute is now deprecated starting with v13 (see v12.4 notes below).

  • Development -

    In order to load the experimental Rock.Javascript.Obsidian project in the Rock solution, you will need to add the "Node.js development" Workload to Visual Studio:

    Visual Studio Add Workload
    Visual Studio Node.js development
  • Development -

    All property and methods marked RockObsolete "1.8" and older will be removed from Rock. Those marked RockObsolete "1.9" will cause a compile error.

  • Development -

    The interface IRockMobileBlockType now implements IRockClientBlockType. This will force the classes implemeting IRockMobileBlockType to implement the method GetBlockInitialization( RockClientType clientType ). This method should return an object containing the mobile block type's configuration.

  • Development -

    Now that we have moved a number of extension methods (as well as RockDateTime) out of Rock.dll and into Rock.Common.dll, developers will need to include a project dependency/reference to Rock.Common.dll when you (re-)build plugins for Rock v13 or later.

  • Lava Engine -

    In order to achieve a rather substantial performance improvement, we're making a significant changes to the underlying Lava parser. All existing custom Lava filters will break as a result of these changes. If you've created custom Lava filters, please read the Updating Custom Lava Component instructions on what you need to do to be compatible with Rock v13. Contact the core team to discuss questions you have.
    Also Note: we are no longer going to accept any custom Lava filter plugins in the RockShop.

  • Development -

    It will no longer be possible to start from an existing database that is older than version 11 using the develop branch. Why: The EF 'migration squish' we've performed assumes your underlying database is either empty, or has everything up to version 11.0 (release-1.11.0) in it.

    If you do have a v10.x database (for example) that you wish to move to the develop branch, you should switch to the release-1.11.0 branch first (or release-1.12.0) in order to allow Entity Framework to migrate your database to that level.

  • ASP.NET 4.7.2 - We've upgraded the Rock solution to require asp.net 4.7.2.:
    • You can find our cheatsheet and notes about this conversion over at v4.7.2 Cheatsheet
    • If you are using AppVeyor, you can also find notes about what we did to get AppVeyor to continue to build on the v4.7.2 Cheatsheet
  • The following breaking changes have been introduced in pre-alpha 1.13.0.1:
    • Made the property Rock.Model.CommunicationRecipient.PersonAliasId nullable
    • Removed setter from property Rock.Model.SchedulerResource.HasSchedulingConflict. The property's value is now determined by checking the new property Rock.Model.SchedulerResource.SchedulingConflicts for any items. This new property is a List<SchedulerResourceScheduled> and holds any scheduling conflicts.
    • Removed method Rock.Reporting.DataFilter.Workflow.WorkflowAttributesFilter.workflowTypePicker_SelectItem. Selection functionality will be performed during the ValueChanged event using Rock.Reporting.DataFilter.Workflow.WorkflowAttributesFilter.workflowTypePicker_ValueChanged instead of the SelectItem event.
  • The following breaking changes have been introduced in pre-alpha 1.13.0.9:
    • Moved the following classes to Namespace Rock.Lava.RockLiquid.Blocks.
      • Rock.Lava.Blocks.Cache
      • Rock.Lava.Blocks.CalendarEvents
      • Rock.Lava.Blocks.EventScheduledInstance
      • Rock.Lava.Blocks.Execute
      • Rock.Lava.Blocks.InteractionContentChannelItemWrite
      • Rock.Lava.Blocks.Javascript
      • Rock.Lava.Blocks.JsonProperty
      • Rock.Lava.Blocks.RockEntity
      • Rock.Lava.Blocks.Search
      • Rock.Lava.Blocks.Sql
      • Rock.Lava.Blocks.Stylesheet
      • Rock.Lava.Blocks.TagList
      • Rock.Lava.Blocks.WebRequest
      • Rock.Lava.Blocks.WorkflowActivate
    • Moved class Rock.Utility.RockSerializableDictionary to Rock.Lava.

McKinley 12.4

  • The Following entity now has a PurposeKey. This new property is used in certain situations to further qualify a particular item. When attempting to find/match a following record you may want to include a null or string.Empty PurposeKey depending on your case/needs.

  • Currency - 4/15/2021

    • A new "OrganizationStandardCurrencyCode" global attribute has been implemented (and is used by the FormatAsCurrency Lava filter, as such usage of the older "CurrencySymbol" global attribute is now deprecated starting with v13.
    • Use the CurrencyBox.Value property when setting the value of a currency (not the .Text property). It will also handle formatting the currency symbol as needed.

  • Reports

    The Report Detail block has a new setting called "Add Administrate Security to Item Creator". When this is set to "Yes" then whoever created the Report will automatically have the security permission to edit and administrate it added. The default value for this setting is "No". The behavior of Rock prior to v12.4 was to automatically grant the Report creator "Administrate" and "Edit" permissions. As of v12.4 this will not happen unless the "Add Administrate Security to Item Creator" block setting is set to "Yes". This release does NOT change the security permissions for any existing Reports.

    If you would like to run a script to remove the existing "Administrate" and "Edit" permissions granted to the creaters we have some handy SQL scripts!

    This script will show all of the Persons where the Person is assigned "Edit" or "Administrate" permission and that same Person created the Report. It will NOT include permissions other than "Edit" or "Administrate", permissions assigned to a role, Disallow permissions, or permissions assigned to a Person that didn't create the Report. The permissions returned by this script are the permissions that the delete script will remove.

    -- Shows the creator permissions granted to Reports. This only for person level authorization and not security groups.
DECLARE @reportEntityTypeId int = (SELECT [Id] FROM [EntityType] WHERE [Guid] = 'F1F22D3E-FEFA-4C84-9FFA-9E8ACE60FCE7')

SELECT r.[Name] AS ReportName, p.[LastName] AS PersonLastName, p.[FirstName] AS PersonFirstName, a.*
FROM [Auth] a
JOIN [Report] r on a.[EntityId] = r.[Id]
JOIN [PersonAlias] pa on a.[PersonAliasId] = pa.[Id]
JOIN [Person] p on pa.[PersonId] = p.[Id]
WHERE a.[EntityTypeId] = @reportEntityTypeId
    AND a.[Action] IN ('Edit', 'Administrate')
    AND a.[AllowOrDeny] = 'A'
    AND r.[CreatedByPersonAliasId] = a.PersonAliasId
ORDER BY r.[Name], p.[LastName], p.[FirstName]

    Here is the DELETE script. It will remove all of the Report security settings for Persons where the Person is assigned "Edit" or "Administrate" permission and that same Person created the Report. It will NOT delete permissions other than "Edit" or "Administrate", permissions assigned to a role, Disallow permissions, or permissions assigned to a Person that didn't create the Report.

    After running this script Report edit and administration security access will be dependent on Roles and the Users explicitly assigned the permissions after creating the Report.

    -- Removes the creator permissions granted to Reports. This only affects person level authorization and not security groups.
DECLARE @reportEntityTypeId int = (SELECT [Id] FROM [EntityType] WHERE [Guid] = 'F1F22D3E-FEFA-4C84-9FFA-9E8ACE60FCE7')

DELETE FROM [Auth]
WHERE [Id] IN (
	SELECT a.[Id]
	FROM [Auth] a
	JOIN [Report] r on a.[EntityId] = r.[Id]
	WHERE a.[EntityTypeId] = @reportEntityTypeId
		AND a.[Action] IN ('Edit', 'Administrate')
		AND a.[AllowOrDeny] = 'A'
		AND r.[CreatedByPersonAliasId] = a.[PersonAliasId])

    NOTE: After running the delete script, you will need to clear the cache for the changes to effect the Rock web application.

  • DataViews

    The Data View Detail block has a new setting called "Add Administrate Security to Item Creator". When this is set to "Yes" then whoever created the Data View will automatically have the security permission to edit and administrate it added. The default value for this setting is "No". The behavior of Rock prior to v12.4 was to automatically grant the Data View creator "Administrate" and "Edit" permissions. As of v12.4 this will not happen unless the "Add Administrate Security to Item Creator" block setting is set to "Yes". This release does NOT change the security permissions for any existing Data Views.

    If you would like to run a script to remove the existing "Administrate" and "Edit" permissions granted to the creaters we have some handy SQL scripts!

    This script will show all of the Persons where the Person is assigned "Edit" or "Administrate" permission and that same Person created the Data View. It will NOT include permissions other than "Edit" or "Administrate", permissions assigned to a role, Disallow permissions, or permissions assigned to a Person that didn't create the Data View. The permissions returned by this script are the permissions that the delete script will remove.

    -- Shows the creator permissions granted to DataViews. This only for person level authorization and not security groups.
DECLARE @dataViewEntityTypeId int = (SELECT [Id] FROM [EntityType] WHERE [Guid] = '57F8FA29-DCF1-4F74-8553-87E90F234139')

SELECT dv.[Name] AS ReportName, p.[LastName] AS PersonLastName, p.[FirstName] AS PersonFirstName, a.*
FROM [Auth] a
JOIN [DataView] dv on a.[EntityId] = dv.[Id]
JOIN [PersonAlias] pa on a.[PersonAliasId] = pa.[Id]
JOIN [Person] p on pa.[PersonId] = p.[Id]
WHERE a.[EntityTypeId] = @dataViewEntityTypeId
	AND a.[Action] IN ('Edit', 'Administrate')
	AND a.[AllowOrDeny] = 'A'
	AND dv.[CreatedByPersonAliasId] = a.PersonAliasId
ORDER BY dv.[Name], p.[LastName], p.[FirstName]

    Here is the DELETE script. It will remove all of the Data View security settings for Persons where the Person is assigned "Edit" or "Administrate" permission and that same Person created the Data View. It will NOT delete permissions other than "Edit" or "Administrate", permissions assigned to a role, Disallow permissions, or permissions assigned to a Person that didn't create the Data View.

    After running this script Data View edit and administration security access will be dependent on Roles and the Users explicitly assigned the permissions after creating the Data View.

    -- Removes the creator permissions granted to DataViews. This only affects person level authorization and not security groups.
DECLARE @dataViewEntityTypeId int = (SELECT [Id] FROM [EntityType] WHERE [Guid] = '57F8FA29-DCF1-4F74-8553-87E90F234139')

DELETE FROM [Auth]
WHERE [Id] IN (
	SELECT a.[Id]
	FROM [Auth] a
	JOIN [DataView] dv on a.[EntityId] = dv.[Id]
	WHERE a.[EntityTypeId] = @dataViewEntityTypeId
		AND a.[Action] IN ('Edit', 'Administrate')
		AND a.[AllowOrDeny] = 'A'
		AND dv.[CreatedByPersonAliasId] = a.[PersonAliasId])

    NOTE: After running the delete script, you will need to clear the cache for the changes to effect the Rock web application.

McKinley 12.1

Groups

  • The GroupDetail block has new setting called "Add Administrate Security to Group Creator". When this is set to "Yes" then whoever created the group will automatically have the security permission to administrate the group added. The default value for this setting is "No". The behavior of Rock prior to v12.1 was to automatically grant the Group creator "Administrate" permission. As of v12.1 this will not happen unless the "Add Administrate Security to Group Creator" block setting is set to "Yes". This release does NOT change the security permissions for any existing Groups.

    If you would like to run a script to remove the existing "Administrate" group permissions granted to the group creater we have some handy SQL scripts!

    This script will show all of the Group/Persons where the Person is assigned "Administrate" permission and that same Person created the Group. It will NOT include permissions other than "Administrate", permissions assigned to a role, Disallow permissions, or permissions assigned to a Person that didn't create the group. The permissions returned by this script are the permissions that the delete script will remove.

    DECLARE @selectGroupEntityId int = (SELECT [Id] FROM [EntityType] WHERE [Guid] = '9BBFDA11-0D22-40D5-902F-60ADFBC88987')

SELECT g.[Name] AS GroupName, p.[LastName] AS PersonLastName, p.[FirstName] AS PersonFirstName, a.*
FROM [Auth] a
JOIN [Group] g on a.[EntityId] = g.[Id]
JOIN [PersonAlias] pa on a.[PersonAliasId] = pa.[Id]
JOIN [Person] p on pa.[PersonId] = p.[Id]
WHERE [EntityTypeId] = @selectGroupEntityId
	AND a.[Action] = 'Administrate'
	AND a.[AllowOrDeny] = 'A'
	AND g.[CreatedByPersonAliasId] = a.PersonAliasId
ORDER BY g.[Name], p.[LastName], p.[FirstName]

    Here is the DELETE script. It will remove all of the Group/Person security settings where the Person is assigned "Administrate" permission and that same Person created the Group. It will NOT delete permissions other than "Administrate", permissions assigned to a role, Disallow permissions, or permissions assigned to a Person that didn't create the group.

    After running this script Group administration security access will be dependent on Roles and the Users explicitly assigned "Administrate" permission after creating the Group.

    DECLARE @groupEntityId int = (SELECT [Id] FROM [EntityType] WHERE [Guid] = '9BBFDA11-0D22-40D5-902F-60ADFBC88987')

DELETE FROM [Auth]
WHERE [Id] IN (
	SELECT a.[Id]
	FROM [Auth] a
	JOIN [Group] g on a.[EntityId] = g.[Id]
	WHERE [EntityTypeId] = @groupEntityId
		AND a.[Action] = 'Administrate'
		AND a.[AllowOrDeny] = 'A'
		AND g.[CreatedByPersonAliasId] = a.[PersonAliasId])

    NOTE: After running the delete script, you will need to clear the cache for the changes to effect the Rock web application.

McKinley 12.0

  • The DDay.iCal library has been replaced with the ICal.Net library. Because of this, the ScheduleICalHelper class is being replaced with InetCalendarHelper and certain helper methods in the Schedule.cs class which returned either DDay.iCal.Event or IList<DDay.iCal.Occurrence> are obsoleted:
    • GetCalendarEvent() replaced with GetICalEvent()
    • GetOccurrences(...) is replaced with GetICalOccurrences(...)
  • The WorkflowLogService is being removed and the WorkflowLog model is being changed to no longer inherit from Model to reduce size and increase performance; as such it will no longer have the following properties/columns (ForeignId, ForeignGuid, ForeignKey, Guid, CreatedDateTime, ModifiedDateTime, CreatedByPersonAliasId, ModifiedByPersonAliasId).
  • If you are using a CI/CD system such as AppVeyor, you may need to add this to your build init to deal with the MSB3268 warning: 
    COPY "C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.5.2\Facades\System.IO.dll" "C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.5.2"
COPY "C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.5.2\Facades\System.Linq.Expressions.dll" "C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.5.2"
COPY "C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.5.2\Facades\System.ComponentModel.dll" "C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.5.2"
COPY "C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.5.2\Facades\System.Threading.Tasks.dll" "C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.5.2"
COPY "C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.5.2\Facades\System.Collections.Concurrent.dll" "C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.5.2"
  • To make way for better dynamic badges that can be used within the new Connections Board, custom badges should be refactored to eliminate injecting any needed script blocks in the badge that would have called Sys.Application.add_load. Instead, override the BadgeComponent's GetJavaScript() method and return your javascript there. See commits 970b0c1 and e56d506 for examples of this.
  • FYI: Several changes are needed in the web.config to support OpenId server. This is handled by the RockUpdate process, but if you're merging and building manually (or via some non-RockUpdate process), you'll need to make sure the repo's web.config changes are applied to your server's web.config.

McKinley 11.0

Starting with v11...
  • Rock will require SQL Server 2014 or higher. Read our notification.
  • Our developer solution will require Visual Studio 2019.
  • Classes, methods, and properties marked "Obsolete" as of version v7 [RockObsolete("1.7")] have been removed.
  • We have updated the Newtonsoft Json.NET library (Newtonsoft.Json.dll) from version 9.0.1 to version 11.0.2. (You can find those release notes on their github page.)
  • The SystemEmail entity (model and table) is now obsolete.
  • Updated RockWeb to use the Roslyn compiler (to enable future C# v6 and v7 features in Rock v12-- don't start using .Net v6/7 features until then)
  • The ChannelId property was renamed to InteractionChannelId on the InteractionComponent model and database table. This will affect any raw SQL you might have that references ChannelId directly and any plugins that create their own interaction components directly via SQL.
  • Changed the RelatedDataViewFilterBase abstract class to implement a new internal IRelatedChildDataView interface. This interface has a method that returns the DataView.Id that is selected to use. When data view filters are being saved, if it implements the interface, it would call that method to return the Id of the Data View that it is referencing.
  • Some small changes in Rock's stock push notification component were made to extend the usefulness of PUSH messages in Rock. 3rd party developers who are extending the PushNotification class should recompile their code to verify compatibility.
  • Updated to FontAwesome 5.13.0

McKinley 10.2

In v10.2...
  • The SystemEmail entity (model and table) is being marked obsolete. All existing data will be copied into the new SystemCommunication entity (retaining the same GUIDs). If you have a block that uses the SystemEmail entity, please swap it with SystemCommunication.

McKinley 10.0

  • Rock.SystemGuid.Block has been changed to a static class.
  • Added SameSite Cookie setting to global attributes. Default setting is Lax for better cookie handling.
  • Updated to FontAwesome 5.11.1

McKinley 9.3

  • We've removed the inherited permissions on the GetImpersonationParameter API endpoint. If you have a custom application that uses that API you may consider re-adjusting those permissions to suit your needs.

McKinley 9.0

Note
  • As of v9, any iOS device you want to run check-in on must have iOS 10 or newer. This is due to JavaScript changes that older versions of iOS cannot run.
  • If you have a check-in theme that was created before Version 7, we recommend removing <meta http-equiv="X-UA-Compatible" content="IE=10" /> from your theme to maintain compatibility for the Rock Windows Check-In App.
  • This is the last release supporting the 'Legacy' option for the Lava Support Level Global Attribute. In Rock McKinley v10 anyone using 'Legacy' will be automatically converted to 'LegacyWithWarning'. Check your ExceptionLog for any remaining legacy Lava syntax and get those cleaned up before chaning to 'NoLegacy'.
  • The old "RockOriginal" theme, which was the Rock theme for v7, has been deleted with this release. Any sites that were using RockOriginal have been changed to use the Rock theme.

Rock.Rest Project

  • Some changes were made to this project for clarification and enhancement of the endpoints and parameters. For example, this: 
    // From this:
[RouteAttribute("api/FinancialScheduledTransactions/WithPreviousTransaction")]
public HttpResponseMessage GetWithPreviousTransaction(int pageSize, int pageNumber)
// To this:
[RouteAttribute("api/FinancialScheduledTransactions/WithPreviousTransaction")]
public virtual HttpResponseMessage GetWithPreviousTransaction(int skip, int top)

// From this:
[RouteAttribute("api/FinancialScheduledTransactions/Process/{scheduledTransactionId}")]
public HttpResponseMessage ProcessPayment(int scheduledTransactionId, bool ignoreRepeatChargeProtection = False, bool ignoreScheduleAdherenceProtection = False)
// To this:
[RouteAttribute("api/FinancialScheduledTransactions/Process/{scheduledTransactionId}")]
public virtual HttpResponseMessage ProcessPayment(int scheduledTransactionId, bool enableDuplicateChecking = True, bool enableScheduleAdherenceProtection = True)

// From this:
[RouteAttribute("api/FinancialTransactions/Process")]
public HttpResponseMessage ProcessPayment(AutomatedPaymentArgs automatedPaymentArgs, bool ignoreRepeatChargeProtection = False, bool ignoreScheduleAdherenceProtection = False)
// To this:
[RouteAttribute("api/FinancialTransactions/Process")]
public virtual HttpResponseMessage ProcessPayment(AutomatedPaymentArgs automatedPaymentArgs, bool enableDuplicateChecking = True, bool enableScheduleAdherenceProtection = True)

// From this:
[RouteAttribute("api/Groups/GetChildren/{id}")]
public IQueryable GetChildren(int id, int rootGroupId = 0, bool limitToSecurityRoleGroups = False, string includedGroupTypeIds = "", string excludedGroupTypeIds = "", bool includeInactiveGroups = False, GetCountsType countsType = 0, int campusId = 0, bool includeNoCampus = False, bool limitToPublic = False)
// To this:
[RouteAttribute("api/Groups/GetChildren/{id}")]
public IQueryable GetChildren(int id, int rootGroupId = 0, bool limitToSecurityRoleGroups = False, string includedGroupTypeIds = "", string excludedGroupTypeIds = "", bool includeInactiveGroups = False, GetCountsType countsType = 0, int campusId = 0, bool includeNoCampus = False, bool limitToPublic = False, bool limitToSchedulingEnabled = False)

McKinley 8.7

We've updated the way the 'unsubscribe' functionality works. Be sure to look at the generic Unsubscribe HTML in the Email medium (under Admin Tools > Communications > Communication Mediums) and make similar changes to any custom templates you have (replacing Unsubscribe/{{ Person.UrlEncodedKey }} with Unsubscribe/{{ Person | PersonActionIdentifier:'Unsubscribe' }}). You will also need to update the Non-HTML Content for the Email Communication Medium (Located in Communications > Communication Mediums; replacing &p={{ Person.UrlEncodedKey }} with &p={{ Person | PersonActionIdentifier:'Unsubscribe' }} )

McKinley 8.0

Check-in

  • Some changes were made to support different time zones on campuses.
  • The way labels are sent to the printers when printing over the network have been changed to support extended characters.
  • Minor changes were made to the Windows check-in client to provide extended character support.
  • We added a new Check-in 'AttendanceOccurrence' table and moved the GroupId, LocationId, ScheduleId, SundayDate and DidNotOccur from 'Attendance' to 'AttendanceOccurrence'. As a result, any custom SQL queries you have that reference these fields will be effected. For example, this: 
    SELECT ...
FROM   [Attendance] AS a
INNER JOIN [Group] g ON a.GroupId = g.Id
    will need to change to something like: 
    SELECT ...
FROM   [Attendance] AS a
INNER JOIN [AttendanceOccurrence] o ON o.Id = a.OccurrenceId
INNER JOIN [Group] g ON a.GroupId = g.Id
    Also Lava such as this: {% attendance where:'GroupId == "24"' %} or this {% attendance.GroupId %} will need to change to something like this: {% attendanceoccurrence where:'GroupId == "24"' %} and this {% attendanceoccurrence.GroupId %}

Caching

  • Rock’s caching engine was completely re-written. This cleaned up a lot of inconsistencies in the API and implemented several new features (cache tags and the new cache lava block). This level of change is sure to bring up several issues (the first caching engine took 2-3 major releases to iron out all of invalidation issues).
  • Cache Tags – See documentation
  • Lava Caching Block – See https://rockrms.com/lava Version Specific Features
  • Group History – See documentation.
  • Notes – Major updates here. Please check that all the places you use notes are still functioning correctly. Then start playing with some of the new features: watches and approvals.
  • New Homepage Block – Start adding sample content the way you might use it in production.
  • Persisted Data Views
  • Signals – See documentation.
  • Please verify all plugins that you have written.

Code Updates

Below is a list of all the code changes made in Rock 8.0 that may potentially affect custom code and/or plugins.

  • Rock.Web.UI.Cache.* setters are now private on *Cache objects (NOTE: The cache is read only so setting a value into cache never really makes sense anyhow.)
  • property Rock.Model.Attendance.Group made obsolete and removed setter. Use Occurrence.Group instead.
  • property Rock.Model.Attendance.IsValid removed.
  • property Rock.Model.Attendance.Location made obsolete and removed setter. Use Occurrence.Location instead.
  • property Rock.Model.Attendance.Schedule made obsolete removed setter. Use Occurrence.Schedule instead.
  • property Rock.Model.Attendance.SundayDate made obsolete and removed setter. Use Occurrence.SundayDate instead.
  • property Rock.Model.HistoryItem.Changes removed, use PersonHistoryChangeList and GroupMemberHistoryChangeList instead.
  • property Rock.SystemGuid.DefinedType.PROTECT_MY_MINISTRY_PACKAGES changed to Rock.SystemGuid.DefinedType.BACKGROUND_CHECK_TYPES as part of adding Checkr background check support.

The following properties were removed from the Rock.Model.Group class:

  • AddUserAccountsDuringSync
  • ExitSystemEmail
  • ExitSystemEmailId
  • SyncDataView
  • SyncDataViewId
  • WelcomeSystemEmail
  • WelcomeSystemEmailId

These properties were all moved to a new Rock.Model.GroupSync class to support role-specific group syncing.

McKinley 7.0

If you are using the SendGrid Email Transport update the plugin from the RockShop immediately after upgrading to Rock v7.

Page view and email activity data has been moved in Rock v7. While we make a huge effort to not break things during updates the transition of this data to new tables may break custom SQL or code that was querying this data from the PageView and/or CommunicationRecipientActivity tables. All of the data has been transitioned to their new home in the Interactions tables so you won't miss a thing. This should impact only a very small number of organizations who have written custom code or SQL against these few tables. Note that since there could be a large amount of data to convert from the old PageView and CommunicationRecipientActivity tables, a Rock Job called 'Move Data from PageViews and Communication Activity to the new Interaction Tables' will run at 4am after v7 is installed. This job could take an hour or so depending on how much data there is.

The external giving blocks have a new 'Give as Business' option which defaults to 'on'. If you don't want your giving blocks to have the 'Give as Business' option, you'll have to change that manually.

There is a new 'Expiring Credit Card Notices' job which is enabled to run at 7:30 AM on the 1st of every month. It can be disabled manually if needed.

The ZebraPhoto lava command was changed to use the R: (DRAM) location due to long term problems with repetitive writing to the E: (Flash) location. Any labels using ZebraPhoto must also change their Recall Graphic (^XG) command to use the R: location too. https://www.rockrms.com/lava/person#zebraphoto

There is a new 'Database Maintenance' job that is enabled to run at 2:30 AM every day by default. If you SQL database already has a maintenance plan, update the 'Database Maintenance' job and/or your SQL Maintenance Plan to do what you want.

Make sure to enable the Google Static Maps API in your Google API Manager dashboard.

A change was made in how group requirement notifications are sent out. Before it would send to all Roles marked 'IsLeader' of the group, with the ability to provide a list of Role Ids to exclude. This has been changed to use the 'Receive Requirements Notifications' property on the Role. If you have setup jobs to send group requirement emails you will want to ensure that you configure the roles you want to receive these emails to have the 'Receive Requirements Notifications' checked.

Staff and Staff-Like roles will be given Edit access to the following group types if those group types do not already have specific 'Edit' roles defined. This is so that staff can add new groups of those types.

  • Serving Teams
  • Small Group Section
  • Small Group
  • General Group
  • Organization Unit

ContentChannelView has been updated to not support legacy Lava syntax for accessing global attributes. To enable this, a new "Enable Legacy Global Attribute Lava" block setting needs to be set to true (which negatively affect performance of this block).

Group Attributes now enforce security. Edit each Group Type in General Settings > Group Types, and make sure to set the security on each of the Group Attributes so they can be edited by the appropriate team.

iScroll.js is now included in the RockLibs.js bundle. If you have a custom blocks (i.e. check-in) that is loading iScroll.js, this is no longer needed.

This release fixes a bug where workflow activities marked as inactive were still being processed. If you have any activities where 'Is Active' is not checked they will no longer run even if you use the 'Activate Workflow Activity' action. This action activates an instance of an activity. The activity type however, must be active for this to occur.

Code Updates

Below is a list of all the code changes made in Rock v7 that may potentially affect custom code and/or plugins.

Classes Removed
  • Rock.Data.Context.CommunicationRecipientActivities
  • Rock.Data.Context.PageViews
  • Rock.Data.Context.PageViewSessions
  • Rock.Data.Context.PageViewUserAgents
  • Rock.Model.CommunicationRecipientActivity
  • Rock.Model.CommunicationRecipientActivityConfiguration
  • Rock.Model.CommunicationRecipientActivityExtensionMethods
  • Rock.Model.CommunicationRecipientActivityService
  • Rock.Model.PageView
  • Rock.Model.PageViewConfiguration
  • Rock.Model.PageViewExtensionMethods
  • Rock.Model.PageViewService
  • Rock.Model.PageViewSession
  • Rock.Model.PageViewSessionConfiguration
  • Rock.Model.PageViewSessionExtensionMethods
  • Rock.Model.PageViewSessionService
  • Rock.Model.PageViewUserAgent
  • Rock.Model.PageViewUserAgentConfiguration
  • Rock.Model.PageViewUserAgentExtensionMethods
  • Rock.Model.PageViewUserAgentService
  • Rock.Rest.Controllers.CommunicationRecipientActivitiesController
  • Rock.Rest.Controllers.PageViewsController
  • Rock.Rest.Controllers.PageViewSessionsController
  • Rock.Rest.Controllers.PageViewUserAgentsController
Properties Changed
  • Rock.Model.GroupRequirement.GroupId Changed from int to int? (nullable)
  • Rock.Model.PersonAlias.AliasPersonGuid Changed from Guid to Guid? (nullable)
  • Rock.Model.PersonAlias.AliasPersonId Changed from int to int? (nullable)
  • Rock.Model.Tag.EntityTypeId Changed from int to int? (nullable)
Properties Removed
  • Rock.Model.Communication.Medium
  • Rock.Model.Communication.MediumEntityType
  • Rock.Model.Communication.MediumEntityTypeId
  • Rock.Model.CommunicationRecipient.Activities
  • Rock.Model.CommunicationTemplate.Medium
  • Rock.Model.CommunicationTemplate.MediumEntityType
  • Rock.Model.CommunicationTemplate.MediumEntityTypeId
  • Rock.Model.ConnectionOpportunity.GroupMemberRole
  • Rock.Model.ConnectionOpportunity.GroupMemberRoleId
  • Rock.Model.ConnectionOpportunity.GroupMemberStatus
  • Rock.Model.ConnectionOpportunity.GroupType
  • Rock.Model.ConnectionOpportunity.UseAllGroupsOfType
  • Rock.Model.Site.PageViewRetentionPeriodDays
  • Rock.Model.SiteCache.PageViewRetentionPeriodDays
  • Rock.Web.UI.Controls.BirthdayPicker.FromGroupCssClass
  • Rock.Web.UI.Controls.BirthdayPicker.Help
  • Rock.Web.UI.Controls.BirthdayPicker.HelpBlock
  • Rock.Web.UI.Controls.BirthdayPicker.IsValid
  • Rock.Web.UI.Controls.BirthdayPicker.Label
  • Rock.Web.UI.Controls.BirthdayPicker.Required
  • Rock.Web.UI.Controls.BirthdayPicker.RequiredErrorMessage
  • Rock.Web.UI.Controls.BirthdayPicker.RequiredFieldValidator
  • Rock.Web.UI.Controls.BirthdayPicker.SelectedDate
  • Rock.Web.UI.Controls.BirthdayPicker.ValidationGroup
  • Rock.Web.UI.Controls.BirthdayPicker.Warning
  • Rock.Web.UI.Controls.BirthdayPicker.WarningBlock
  • Rock.Web.UI.Controls.Grid.IsExporting
  • Rock.Web.UI.Controls.LiquidField.ParentGrid
  • Rock.Web.UI.Controls.LiquidFieldTemplate.DataFieldInfo
  • Rock.Web.UI.Controls.RockLiteralField.ID
  • Rock.Web.UI.Controls.Communication.Email.MediumData
  • Rock.Web.UI.Controls.Communication.MediumControl.MediumData
  • Rock.Web.UI.Controls.Communication.Sms.MediumData
Methods Changed
  • Rock.Attribute.SiteFieldAttribute(string name = "Site", string description = "", bool required = True, string defaultSiteId = "", string category = "", int order = 0, string key, bool shorteningSitesOnly = False) Last parameter of constructor was added
  • Rock.Lava.RockFilters.Append(object input, object string) Second parameter was changed from string to object
  • Rock.Model.FinancialTransaction(PreSaveChanges(DbContext dbContext, DbEntityEntry entry) Last parameter was changed from "EntityState state" to "DbEntityEntry entry"
  • Rock.Model.FinancialTransactionImage(PreSaveChanges(DbContext dbContext, DbEntityEntry entry) Last parameter was changed from "EntityState state" to "DbEntityEntry entry"
  • Rock.Model.Report.GetQueryable(Type entityType, Dictionary entityFields, Dictionary attributes, Dictionary selectComponents, SortProperty sortProperty, int? databaseTimeoutSeconds, out List`1& errorMessages, out DbContext& reportDbContext) "dataViewFilterOverrides" parameter was removed, and "reportDbContext" parameter was added
  • Rock.Reporting.ReportingHelper.BindGrid.BindGrid(Report report, Grid gReport, Person currentPerson, int? databaseTimeoutSeconds, bool isCommunication, out String& errorMessage) "dataViewFilterOverrides" parameter was removed, and "isCommunication" parameter was added
  • Rock.Reporting.DataFilter.GroupMember.GroupMemberAttributesFilter.GetSelection(Type entityType, Control[] controls, FilterMode filterMode) Last "filterMode" parameter was added
  • Rock.Reporting.DataFilter.GroupMember.GroupMemberAttributesFilter.RenderControls(Type entityType, FilterField filterControl, HtmlTextWriter writer, Control[] controls, FilterMode filterMode) Last "filterMode" parameter was added
  • Rock.Rest.Controllers.CategoriesController.GetChildren(int id, int rootCategoryId = 0, bool getCategorizedItems = False, int entityTypeId = 0, string entityQualifier, string entityQualifierValue, bool showUnnamedEntityItems = True, bool showCategoriesThatHaveNoChildren = True, string includedCategoryIds, string excludedCategoryIds, string defaultIconCssClass, bool includeInactiveItems = True) Last "IncludeInactiveItems" parameter was added
  • Rock.Rest.Controllers.GroupsController.GetChildren(int id, int rootGroupId = 0, bool limitToSecurityRoleGroups = False, string includedGroupTypeIds = "", string excludedGroupTypeIds = "", bool includeInactiveGroups = False, GetCountsType countsType = 0, int campusId = 0, bool includeNoCampus = False) Last two parameters ("campusId" and "includeNoCampus") were added
  • Rock.Rest.Controllers.LavaController.RenderTemplate(string template, string additionalMergeObjects) Last "additionalMergeObjects" parameter was added
  • Rock.Rest.Controllers.TaggedItemsController. Delete(int entityTypeId, int ownerId, Guid entityGuid, string name, string entityQualifier, string entityQualifierValue, Nullable categoryGuid, bool? includeInactive) Last four parameters ("entityQualifier", "entityQualifierValue", "categoryGuid", and "includeInactive") were added
  • Rock.Rest.Controllers.TaggedItemsController. Post(int entityTypeId, int ownerId, Guid entityGuid, string name, string entityQualifier, string entityQualifierValue, Nullable categoryGuid, bool? includeInactive) Last four parameters ("entityQualifier", "entityQualifierValue", "categoryGuid", and "includeInactive") were added
Methods Removed
  • Rock.Communication.Medium.Email.ProcessHtmlBody(Communication communication, GlobalAttributesCache globalAttributes, Dictionary mergeObjects, Person currentPersonOverride)
  • Rock.Communication.Medium.Email.ProcessTextBody(Communication communication, GlobalAttributesCache globalAttributes, Dictionary mergeObjects, Person currentPersonOverride)
  • Rock.Communication.Medium.Email.Send(Communication communication)
  • Rock.Communication.Medium.SMS.Send(Communication communication)
  • Rock.Field.Types.MarkdownFieldType.FormatValueAsHtml(Control parentControl, string value, Dictionary configurationValues, bool condensed = False)
  • Rock.Field.Types.MemoFieldType.FormatValueAsHtml(Control parentControl, string value, Dictionary configurationValues, bool condensed = False)
  • Rock.Field.Types.RangeSliderFieldType.FormatValueAsHtml(Control parentControl, string value, Dictionary configurationValues, bool condensed = False)
  • Rock.Web.UI.Controls.BirthdayPicker.RenderBaseControl(HtmlTextWriter writer)
  • Rock.Web.UI.Controls.BirthdayPicker.RenderControl(HtmlTextWriter writer)
  • Rock.Web.UI.Controls.LiquidField.Intitialize(bool sortingEnabled, Control control)
  • Rock.Web.UI.Controls.LiquidFieldTemplate.InstantiateIn(Control container)
  • Rock.Web.UI.Controls.MarkdownEditor.OnInit(EventArgs e)
  • Rock.Web.UI.Controls.MarkdownEditor.RenderBaseControl(HtmlTextWriter writer)
  • Rock.Rest.Controllers.TaggedItemsController.AddRoutes(RouteCollection routes)
  • Rock.Rest.Controllers.TaggedItemsController.Delete(int entityTypeId, int ownerId, Guid entityGuid, string name, string entityQualifier)
  • Rock.Rest.Controllers.TaggedItemsController.Delete(int entityTypeId, int ownerId, Guid entityGuid, string name, string entityQualifier, string entityQualifierValue)
  • Rock.Rest.Controllers.TaggedItemsController.Post(int entityTypeId, int ownerId, Guid entityGuid, string name, string entityQualifier)
  • Rock.Rest.Controllers.TaggedItemsController.Post(int entityTypeId, int ownerId, Guid entityGuid, string name, string entityQualifier, string entityQualifierValue)

McKinley 6.0

This release fixes a bug where workflow activities marked as inactive were still being processed. If you have any activities where 'Is Active' is not checked they will no longer run even if you use the 'Activate Workflow Activity' action. This action activates an instance of an activity. The activity type however, must be active for this to occur.
  • Rock now requires Microsoft .NET Framework 4.5.2 or greater on the hosting server. This framework version was released by Microsoft on May 5th, 2014. You will need to upgrade hosting server in order to proceed with the next update.
  • The Rock project now requires Visual Studio 2015 due to some C# 6.0 dependencies.

McKinley 5.0

  • Rock now requires ASP.Net 4.5.2
  • Check-in
    • The Rock.CheckIn.CheckInBlock now has a CurrentCheckinType/CurrentCheckinTypeId and the Rock.CheckIn.CheckInState class has a CheckinType/CheckinTypeId that is used (required) by various Workflow actions.
  • Person
    • Several Rock.Model.Person.GetPhotoUrl(...) methods were deprecated. Use GetPersonPhotoUrl(...) instead.
  • Web Sites
    • Rock will now auto compile your custom theme's .less files into .css files. Add a .nocompile to the theme's 'Styles' folder to disable auto-compile for a theme.

McKinley 4.0

People without birth date will no longer be able to check-in to groups that have an age range requirement. This behavior can be changed by editing the 'Unattended Check-in' workflow, selecting the 'Person Search' activity, then the 'Filter Groups By Age' action, and un-checking the new 'Age Required' option.

Only members of the 'RSR - Data Integrity Worker' will be able to complete person merges. Everyone else will only be able to request merges (new functionality). This can be modified by adding other security roles to have edit access to the merge block.

Security was adjusted on the Website Ads and Bulletin Content Channels to give the 'RSR - Staff Worker' and 'RSR - Staff Like Worker' View/Edit rights.

  • Requires SQL 2012 (or Azure SQL V12) or greater
  • a Change to GatewayComponent effecting custom finance gateways
  • Rock.Model.Person.IsDeceased - Property will no longer be nullable. Any code that references .HasValue (or expects the property to be nullable) will need to change.
  • Financial Gateway
    • Rock.Financial.GatewayComponent.AddScheduledPayment()- Added additional FinancialGateway parameter
    • Rock.Financial.GatewayComponent.Authorize() - added additional FinancialGateway parameter
    • Rock.Financial.GatewayComponent.BatchTimeOffset - Removed property ( Is now a property of new FinancialGateway model )
    • Rock.Financial.GatewayComponent.Charge() - added additional FinancialGateway parameter
    • Rock.Financial.GatewayComponent.GetPayments() - added additional FinancialGateway parameter
    • Rock.Financial.TestGateway.AddScheduledPayment()- Added additional FinancialGateway parameter
    • Rock.Financial.TestGateway.Charge() - added additional FinancialGateway parameter
    • Rock.Financial.TestGateway.GetPayments() - added additional FinancialGateway parameter
    • Rock.Model.FinancialPersonSavedAccount.GatewayEntityType - Removed property ( use FinancialGateway property instead )
    • Rock.Model.FinancialPersonSavedAccount.GatewayEntityTypeId - Removed property ( use FinancialGatewayId property instead )
    • Rock.Model.FinancialScheduledTransaction.GatewayEntityType - Removed property ( use FinancialGateway property instead )
    • Rock.Model.FinancialScheduledTransaction.GatewayEntityTypeId - Removed property ( use FinancialGatewayId property instead )
    • Rock.Model.FinancialScheduledTransactionService.ProcessPayments() - Added additional FinancialGateway parameter
    • Rock.Model.FinancialTransaction.GatewayEntityType - Removed property ( use FinancialGateway property instead )
    • Rock.Model.FinancialTransaction.GatewayEntityTypeId - Removed property ( use FinancialGatewayId property instead )
  • Rock.Model.AttendanceSummaryData (Removed)
  • Rock.Model.BinaryFileType.PreferredColorDepth - Property returns new 'ColorDepth' enumeration instead of removed 'PreferredColorDepth' enumeration
  • Rock.Model.BinaryFileType.PreferredFormat - Property returns new 'Format' enumeration instead of removed 'PreferredFormat' enumeration
  • Rock.Model.BinaryFileType.PreferredResolution - Property returns new 'Resolution' enumeration instead of removed 'PreferredResolution' enumeration
  • Rock.Model.GroupService.GetNavigationChildren() - Added additional IncludeInactiveGroups parameter
  • Rock.Model.PreferredColorDepth - Removed ( use ColorDepth instead )
  • Rock.Model.PreferredFormat - Removed ( use Format instead )
  • Rock.Model.PreferredResolution - Removed ( use Resolution instead )
  • Rock.Model.ScheduleService.GetGroupOccurrences() - Added FromDateTime, ToDateTime, LocationId, and ScheduleId paramters
  • Rock.Reporting.EntityField - Parameterless constructor removed, added FieldType paramter to second constructor
  • Rock.SystemGuid.Page.PLUGIN_MANAGER - removed
  • Rock.SystemGuid.Page.PLUGIN_SETTINGS - removed
  • Rock.Web.UI.Controls.Grid.MergePageRoute - removed ( MergeTemplatePageRoute property added )
  • Rock.Web.UI.Controls.GridActions.MergeClick - removed ( MergeTemplateClick handler added )

McKinley 3.0

Heads Up! We've added several new features to groups to support the attendance and group finder features. The update will modify some of the settings to the 'Small Group' group type. If you've modified or are using this group type you'll want to read through these changes below. The update will do the following...
  1. Update the Small Group type to make it use the new 'simple' schedule option (day of week + meeting time).
  2. Add a new group attribute of Topic that links to a defined type.
  3. Take all the existing text topics and create defined values out of them, then match them to the groups (basically wire up all the current text based topics as defined values)
  4. Delete the existing text topic group attribute.
  5. If you do NOT have any small groups in the database we will delete the meeting time attribute from the small group type (otherwise we'll leave it for you to delete since you'll probably need it to set the new meeting time value).
  • Rock.Workflow.Action.SetAttributeToEntity was renamed to Rock.Workflow.Action.SetAttributeFromEntity
  • Person.BirthDate property became readonly - this was due to change to allow people to enter partial birthdates (month and day with no year). Use SetBirthDate to set the full birthdate and use Person.BirthMonth, Person.BirthDay if partial.
  • Storage Provider changes
    • a storage provider will now provide the path to the resource via the GetPath() method and GetUrl() will provide a URL to the resource. GenerateUrl() is no longer used.
    • BinaryContentStream ?
    • GetContentStream() method is responsible to obtain a stream of the item resource.
  • Binary Files Methods/Objects changes:
    • BinaryFile.Data became BinaryFile.DatabaseData.
    • BinaryFile.ContentStream now uses the StorageProvider's GetContentStream() to get the stream of the content.
    • BinaryFileData.ContentStream (virtual) was removed and the BinaryFile.ContentStream should now be used to get a stream to the resource.
  • The "Unknown" value was removed from the Marital Status DefinedType and records with that ID were given a NULL MaritalStatusValueId.

Latest pre-alpha-release (experimental)

  • 1.14.0.4 (TBD) - TBD
  • 1.14.0.3 (01/18/2022) -

    The following properties where changed from public to private:

    • Rock.Model.ConnectionRequest.HistoryChangeList
    • Rock.Model.ConnectionRequest.PersonHistoryChangeList
  • 1.14.0.2 (01/04/2022) -

Release Notes

The regular release notes detail changes that are important to admins and users. There is also a pre-alpha release notes which covers stuff in the latest pre-alpha-release branch.

Mobile Release Notes

Rock Mobile Release Notes

Rock Versions