- Fixed issue where Inactive People would be listed in Family Name on…

… the Statement Generator when Exclude Inactive Individuals is enabled (Fixes #3069)

Rock.StatementGenerator/Rest/StatementGeneratorFinancialTransactionsController.cs

@@ -424,7 +424,7 @@ public StatementGeneratorRecipientResult GetStatementGeneratorRecipientResult( i
                 var humanFriendlyEndDate = options.EndDate.HasValue ? options.EndDate.Value.AddDays( -1 ) : RockDateTime.Now.Date;
                 mergeFields.Add( "StatementEndDate", humanFriendlyEndDate );
 
-                var familyTitle = Rock.Data.RockUdfHelper.ufnCrm_GetFamilyTitle( rockContext, personId, groupId, null, false );
+                var familyTitle = Rock.Data.RockUdfHelper.ufnCrm_GetFamilyTitle( rockContext, personId, groupId, null, false, !options.ExcludeInActiveIndividuals );
 
                 mergeFields.Add( "Salutation", familyTitle );
 

Rock/Data/Udf/RockUdfHelper.cs

@@ -106,14 +106,31 @@ public enum AddressNamePart
         /// <param name="UseNickName">if set to <c>true</c> [use nick name].</param>
         /// <returns></returns>
         public static string ufnCrm_GetFamilyTitle( RockContext rockContext, int? PersonId, int? GroupId, string GroupPersonIds, bool UseNickName )
+        {
+            return ufnCrm_GetFamilyTitle( rockContext, PersonId, GroupId, GroupPersonIds, UseNickName, true );
+        }
+
+        /// <summary>
+        /// calls database TVF function ufnCrm_GetFamilyTitle.
+        /// Usage: string familyTitle = RockUdfHelper.ufnCrm_GetFamilyTitle( rockContext, personId, groupId, commaPersonIds, true, true );
+        /// </summary>
+        /// <param name="rockContext">The rock context.</param>
+        /// <param name="PersonId">The PersonId. NULL means use GroupId parameter</param>
+        /// <param name="GroupId">The GroupId of the Family. NULL means use PersonId parameter</param>
+        /// <param name="GroupPersonIds">If GroupId is specified, set this as a comma-delimited list of PersonIds that you want to limit the family members to. NULL means don't restrict.</param>
+        /// <param name="UseNickName">if set to <c>true</c> [use nick name].</param>
+        /// <param name="IncludeInactive">if set to <c>true</c> [include inactive].</param>
+        /// <returns></returns>
+        public static string ufnCrm_GetFamilyTitle( RockContext rockContext, int? PersonId, int? GroupId, string GroupPersonIds, bool UseNickName, bool IncludeInactive )
         {
             var result = rockContext.Database.SqlQuery(
                 typeof( string ),
-                "SELECT TOP 1 [PersonNames] FROM dbo.ufnCrm_GetFamilyTitle(@PersonId, @GroupId, @GroupPersonIds, @UseNickName)",
+                "SELECT TOP 1 [PersonNames] FROM dbo.ufnCrm_GetFamilyTitleIncludeInactive(@PersonId, @GroupId, @GroupPersonIds, @UseNickName, @IncludeInactive)",
                 new SqlParameter( "@PersonId", PersonId.HasValue ? (object)PersonId.Value : DBNull.Value ) { SqlDbType = SqlDbType.Int, IsNullable = true },
                 new SqlParameter( "@GroupId", GroupId.HasValue ? (object)GroupId.Value : DBNull.Value ) { SqlDbType = SqlDbType.Int, IsNullable = true },
                 new SqlParameter( "@GroupPersonIds", string.IsNullOrWhiteSpace( GroupPersonIds ) ? DBNull.Value : (object)GroupPersonIds ) { SqlDbType = SqlDbType.Text, IsNullable = true },
-                new SqlParameter( "@UseNickName", UseNickName ));
+                new SqlParameter( "@UseNickName", UseNickName ),
+                new SqlParameter( "@IncludeInactive", IncludeInactive ) );
 
             // NOTE: ufnCrm_GetFamilyTitle is a Table Valued Function, but it only returns one ROW
             return result.OfType<string>().FirstOrDefault();

Rock/Plugin/HotFixes/051_MigrationRollupsForV8_1.cs

@@ -0,0 +1,40 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Rock.Plugin.HotFixes
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <seealso cref="Rock.Plugin.Migration" />
+    [MigrationNumber( 52, "1.8.0" )]
+    public class MigrationRollupsForV8_1 : Migration
+    {
+        /// <summary>
+        /// The commands to run to migrate plugin to the specific version
+        /// </summary>
+        public override void Up()
+        {
+            // MP - Fix for Inactive People showing up in Statement Generator Address when ExcludeInactive = True
+            Sql( @"
+IF  EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[ufnCrm_GetFamilyTitleIncludeInactive]') AND type in (N'P', N'PC'))
+DROP PROCEDURE [dbo].[ufnCrm_GetFamilyTitleIncludeInactive]
+GO
+" );
+
+            Sql( HotFixMigrationResource._051_MigrationRollupsForV8_1_ufnCrm_GetFamilyTitleIncludeInactive );
+            Sql( HotFixMigrationResource._051_MigrationRollupsForV8_1_ufnCrm_GetFamilyTitle);
+        }
+
+        /// <summary>
+        /// The commands to undo a migration from a specific version
+        /// </summary>
+        public override void Down()
+        {
+
+        }
+    }
+}

Rock/Plugin/HotFixes/051_MigrationRollupsForV8_1_ufnCrm_GetFamilyTitle.sql

@@ -0,0 +1,41 @@
+/*
+<doc>
+	<summary>
+ 		This function returns either the FullName of the specified Person or a list of names of family members
+        In the case of a group (family), it will return the names of the adults of the family. If there are no adults in the family, the names of the non-adults will be listed
+        Example1 (specific person): Bob Smith 
+        Example2 (family with kids): Bill and Sally Jones
+        Example3 (different lastnames): Jim Jackson and Betty Sanders
+        Example4 (just kids): Joey, George, and Jenny Swenson
+	</summary>
+
+	<returns>
+		* Name(s)
+	</returns>
+    <param name='PersonId' datatype='int'>The Person to get a full name for. NULL means use the GroupId paramter </param>
+	<param name='@GroupId' datatype='int'>The Group (family) to get the list of names for</param>
+	<remarks>
+		[ufnCrm_GetFamilyTitle] is used by spFinance_ContributionStatementQuery as part of generating Contribution Statements
+	</remarks>
+	<code>
+		SELECT * FROM [dbo].[ufnCrm_GetFamilyTitle](2, null, default, default) -- Single Person
+        SELECT * FROM [dbo].[ufnCrm_GetFamilyTitle](null, 44, default, default) -- Family
+        SELECT * FROM [dbo].[ufnCrm_GetFamilyTitle](null, 44, '2,3', default, default) -- Family, limited to the specified PersonIds
+	</code>
+</doc>
+*/
+ALTER FUNCTION [dbo].[ufnCrm_GetFamilyTitle] (
+	@PersonId INT
+	,@GroupId INT
+	,@GroupPersonIds VARCHAR(max) = NULL
+	,@UseNickName BIT = 0
+	)
+RETURNS @PersonNamesTable TABLE (PersonNames VARCHAR(max))
+AS
+BEGIN
+	INSERT INTO @PersonNamesTable ([PersonNames])
+	SELECT *
+	FROM [ufnCrm_GetFamilyTitleIncludeInactive](@PersonId, @GroupId, @GroupPersonIds, @UseNickName, DEFAULT)
+
+	RETURN;
+END

Rock/Plugin/HotFixes/051_MigrationRollupsForV8_1_ufnCrm_GetFamilyTitleIncludeInactive.sql

@@ -0,0 +1,188 @@
+/*
+<doc>
+	<summary>
+ 		This function returns either the FullName of the specified Person or a list of names of family members
+        In the case of a group (family), it will return the names of the adults of the family. If there are no adults in the family, the names of the non-adults will be listed
+        Example1 (specific person): Bob Smith 
+        Example2 (family with kids): Bill and Sally Jones
+        Example3 (different lastnames): Jim Jackson and Betty Sanders
+        Example4 (just kids): Joey, George, and Jenny Swenson
+	</summary>
+
+	<returns>
+		* Name(s)
+	</returns>
+    <param name='PersonId' datatype='int'>The Person to get a full name for. NULL means use the GroupId paramter </param>
+	<param name='@GroupId' datatype='int'>The Group (family) to get the list of names for</param>
+	<remarks>
+		[ufnCrm_GetFamilyTitle] is used by spFinance_ContributionStatementQuery as part of generating Contribution Statements
+	</remarks>
+	<code>
+		SELECT * FROM [dbo].[ufnCrm_GetFamilyTitle](2, null, default, default, default) -- Single Person
+        SELECT * FROM [dbo].[ufnCrm_GetFamilyTitle](null, 68, default, default, default) -- Family
+        SELECT * FROM [dbo].[ufnCrm_GetFamilyTitle](null, 68, '2,3', default, default, default) -- Family, limited to the specified PersonIds
+	</code>
+</doc>
+*/
+CREATE FUNCTION [dbo].[ufnCrm_GetFamilyTitleIncludeInactive] (
+    @PersonId INT
+    ,@GroupId INT
+    ,@GroupPersonIds VARCHAR(max) = NULL
+    ,@UseNickName BIT = 0
+	,@IncludeInactive BIT = 1
+    )
+RETURNS @PersonNamesTable TABLE (PersonNames VARCHAR(max))
+AS
+BEGIN
+    DECLARE @PersonNames VARCHAR(max);
+    DECLARE @AdultLastNameCount INT;
+    DECLARE @GroupFirstOrNickNames VARCHAR(max) = '';
+    DECLARE @GroupLastName VARCHAR(max);
+    DECLARE @GroupAdultFullNames VARCHAR(max) = '';
+    DECLARE @GroupNonAdultFullNames VARCHAR(max) = '';
+    DECLARE @GroupMemberTable TABLE (
+        LastName VARCHAR(max)
+        ,FirstOrNickName VARCHAR(max)
+        ,FullName VARCHAR(max)
+        ,Gender INT
+        ,GroupRoleGuid UNIQUEIDENTIFIER
+        );
+    DECLARE @cGROUPTYPEROLE_FAMILY_MEMBER_ADULT UNIQUEIDENTIFIER = '2639F9A5-2AAE-4E48-A8C3-4FFE86681E42';
+	DECLARE @cPERSON_RECORD_STATUS_ACTIVE_ID INT = (SELECT TOP 1 ID FROM DefinedValue where [Guid] = '618F906C-C33D-4FA3-8AEF-E58CB7B63F1E');
+
+
+    IF (@PersonId IS NOT NULL)
+    BEGIN
+        -- just getting the Person Names portion of the address for an individual person
+        SELECT @PersonNames = CASE @UseNickName
+                WHEN 1
+                    THEN ISNULL([p].[NickName], '')
+                ELSE ISNULL([p].[FirstName], '')
+                END + ' ' + ISNULL([p].[LastName], '') + ' ' + ISNULL([dv].[Value], '')
+        FROM [Person] [p]
+        LEFT OUTER JOIN [DefinedValue] [dv] ON [dv].[Id] = [p].[SuffixValueId]
+        WHERE [p].[Id] = @PersonId;
+    END
+    ELSE
+    BEGIN
+        -- populate a table variable with the data we'll need for the different cases
+        -- if GroupPersonIds is set (comma-delimited) only a subset of the family members should be combined
+        INSERT INTO @GroupMemberTable
+        SELECT [p].[LastName]
+            ,CASE @UseNickName
+                WHEN 1
+                    THEN ISNULL([p].[NickName], '')
+                ELSE ISNULL([p].[FirstName], '')
+                END [FirstName]
+            ,CASE @UseNickName
+                WHEN 1
+                    THEN ISNULL([p].[NickName], '')
+                ELSE ISNULL([p].[FirstName], '')
+                END + ' ' + ISNULL([p].[LastName], '') + ' ' + ISNULL([dv].[Value], '') [FullName]
+            ,[p].Gender
+            ,[gr].[Guid]
+        FROM [GroupMember] [gm]
+        JOIN [Person] [p] ON [p].[Id] = [gm].[PersonId]
+        LEFT OUTER JOIN [DefinedValue] [dv] ON [dv].[Id] = [p].[SuffixValueId]
+        JOIN [GroupTypeRole] [gr] ON [gm].[GroupRoleId] = [gr].[Id]
+        WHERE [GroupId] = @GroupId
+			AND (@IncludeInactive = 1 OR P.RecordStatusValueId = @cPERSON_RECORD_STATUS_ACTIVE_ID)
+            AND (
+                ISNULL(@GroupPersonIds, '') = ''
+                OR (
+                    p.[Id] IN (
+                        SELECT *
+                        FROM ufnUtility_CsvToTable(@GroupPersonIds)
+                       )
+                    )
+                )
+
+        -- determine adultCount and if we can use the same lastname for all adults, and get lastname while we are at it
+        SELECT @AdultLastNameCount = count(DISTINCT [LastName])
+            ,@GroupLastName = max([LastName])
+        FROM @GroupMemberTable
+        WHERE [GroupRoleGuid] = @cGROUPTYPEROLE_FAMILY_MEMBER_ADULT;
+
+        IF @AdultLastNameCount > 0
+        BEGIN
+            -- get the FirstNames and Adult FullNames for use in the cases of families with Adults
+            SELECT @GroupFirstOrNickNames = @GroupFirstOrNickNames + [FirstOrNickName] + ' & '
+                ,@GroupAdultFullNames = @GroupAdultFullNames + [FullName] + ' & '
+            FROM @GroupMemberTable g
+            WHERE g.[GroupRoleGuid] = @cGROUPTYPEROLE_FAMILY_MEMBER_ADULT
+            ORDER BY g.Gender
+                ,g.FirstOrNickName
+
+            -- cleanup the trailing ' &'s
+            IF len(@GroupFirstOrNickNames) > 2
+            BEGIN
+                -- trim the extra ' &' off the end 
+                SET @GroupFirstOrNickNames = SUBSTRING(@GroupFirstOrNickNames, 0, len(@GroupFirstOrNickNames) - 1)
+            END
+
+            IF len(@GroupAdultFullNames) > 2
+            BEGIN
+                -- trim the extra ' &' off the end 
+                SET @GroupAdultFullNames = SUBSTRING(@GroupAdultFullNames, 0, len(@GroupAdultFullNames) - 1)
+            END
+
+            -- if all the firstnames are blanks, get rid of the '&'
+            IF (LTRIM(RTRIM(@GroupFirstOrNickNames)) = '&')
+            BEGIN
+                SET @GroupFirstOrNickNames = ''
+            END
+
+            -- if all the fullnames are blanks, get rid of the '&'
+            IF (LTRIM(RTRIM(@GroupAdultFullNames)) = '&')
+            BEGIN
+                SET @GroupAdultFullNames = ''
+            END
+        END
+
+        IF @AdultLastNameCount = 0
+        BEGIN
+            -- get the NonAdultFullNames for use in the case of families without adults 
+            SELECT @GroupNonAdultFullNames = @groupNonAdultFullNames + [FullName] + ' & '
+            FROM @GroupMemberTable
+            ORDER BY [FullName]
+
+            IF len(@GroupNonAdultFullNames) > 2
+            BEGIN
+                -- trim the extra ' &' off the end 
+                SET @GroupNonAdultFullNames = SUBSTRING(@GroupNonAdultFullNames, 0, len(@GroupNonAdultFullNames) - 1)
+            END
+
+            -- if all the fullnames are blanks, get rid of the '&'
+            IF (LTRIM(RTRIM(@GroupNonAdultFullNames)) = '&')
+            BEGIN
+                SET @GroupNonAdultFullNames = ''
+            END
+        END
+
+        IF (@AdultLastNameCount = 1)
+        BEGIN
+            -- just one lastname and at least one adult. Get the Person Names portion of the address in the format <MaleAdult> & <FemaleAdult> <LastName>
+            SET @PersonNames = @GroupFirstOrNickNames + ' ' + @GroupLastName;
+        END
+        ELSE IF (@AdultLastNameCount = 0)
+        BEGIN
+            -- no adults in family, list all members of the family in 'Fullname & FullName & ...' format
+            SET @PersonNames = @GroupNonAdultFullNames;
+        END
+        ELSE
+        BEGIN
+            -- multiple adult lastnames
+            SET @PersonNames = @GroupAdultFullNames;
+        END
+    END
+
+    WHILE (len(@PersonNames) - len(replace(@PersonNames, ' & ', '  ')) > 1)
+    BEGIN
+        SET @PersonNames = Stuff(@PersonNames, CharIndex(' & ', @PersonNames), Len(' & '), ', ')
+    END
+
+    INSERT INTO @PersonNamesTable ([PersonNames])
+    VALUES (@PersonNames);
+
+    RETURN
+END