No. Series: Ability to extend filters on finding No. Series Lines when getting new numbers #2361

PeterDurrer · 2024-11-14T08:07:01Z

Summary

Add Event for No. Series

Work Item(s)

…eplaces the backwards compatible Event

PeterDurrer · 2024-11-14T08:27:17Z

@PeterDurrer please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@microsoft-github-policy-service agree [company="{your company}"]
Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

@microsoft-github-policy-service agree company="Logico Solutions AG"

AndreasMoth · 2024-11-14T09:26:27Z

src/Business Foundation/App/NoSeries/src/Single/NoSeriesImpl.Codeunit.al

@@ -189,6 +190,7 @@ codeunit 304 "No. Series - Impl."
        if (NoSeriesLine."Line No." <> 0) and (NoSeriesLine."Series Code" = NoSeriesCode) and (NoSeriesLine."Starting Date" = NoSeriesLine2."Starting Date") then begin
            NoSeriesLine.CopyFilters(NoSeriesLine2);
            NoSeriesLine.SetRange("Line No.", NoSeriesLine."Line No.");
+            NoSeries.OnGetNoSeriesLineOnBeforeFindLast(NoSeriesLine);


This is not needed as we copy all filters from NoSeriesLine2, including the filters you would have set in the previous call.

You are right, only the first one is needed, I had included it because the RaiseObsoleteOnNoSeriesLineFilterOnBeforeFindLast was present there.

AndreasMoth · 2024-11-14T09:33:46Z

src/Business Foundation/App/NoSeries/src/Single/NoSeriesImpl.Codeunit.al

            NoSeriesManagement.RaiseObsoleteOnNoSeriesLineFilterOnBeforeFindLast(NoSeriesLine);
            LineFound := NoSeriesLine.FindLast();
        end;
 #pragma warning restore AL0432
 #else
-        if not LineFound then
+        if not LineFound then begin
+            NoSeries.OnGetNoSeriesLineOnBeforeFindLast(NoSeriesLine);


The NoSeriesLine has copied filters from NoSeriesLine2 above so this should not be needed.

You are right, only the first one is needed, I had included it because the RaiseObsoleteOnNoSeriesLineFilterOnBeforeFindLast was present there.

…eplaces the backwards compatible Event

AndreasMoth · 2024-11-14T11:48:40Z

src/Business Foundation/App/NoSeries/src/Setup/NoSeriesSetupImpl.Codeunit.al

@@ -101,6 +101,7 @@ codeunit 305 "No. Series - Setup Impl."
        NoSeriesLine.SetCurrentKey("Series Code", "Starting Date");
        NoSeriesLine.SetRange("Series Code", NoSeriesRec.Code);


I would extract these three lines into a function in the setup impl. codeunit like below. This allows anyone to set filters without potentially messing up with the record. Pure setting of filters which is what we need and they have access to what code and date we are trying to filter to.
GetNoSeriesLineFilters(var NoSeriesLine: Record "No. Series Line", code, date)
var
var NoSeriesLine2: Record "No. Series Line"
begin
NoSeriesLine2.SetRange("Starting Date", 0D, date);
NoSeriesLine2.SetRange("Series Code", code)
RaiseSetAdditionalNoSeriesLineFilters(NoSeriesLine2)
If NoSeriesLine2. <> code then
Error(CodeFieldChangedErr); // Extensions should never change the code field range, this is a bug that developers should know immediately.
NoSeriesLine.CopyFilters(NoSeriesLine2);
end;

After extracting this, I think it looks pretty good :)

I hope I understood you correctly about outsourcing the code, otherwise just let me know what the function should look like.

AndreasMoth · 2024-11-14T12:49:49Z

src/Business Foundation/App/NoSeries/src/Single/NoSeriesImpl.Codeunit.al

@@ -177,6 +177,7 @@ codeunit 304 "No. Series - Impl."
        NoSeriesLine2.SetCurrentKey("Series Code", "Starting Date");
        NoSeriesLine2.SetRange("Series Code", NoSeriesCode);
        NoSeriesLine2.SetRange("Starting Date", 0D, UsageDate);
+        NoSeries.OnGetNoSeriesLineOnBeforeFindLast(NoSeriesLine2);


This should also call into GetNoSeriesLineFilters

AndreasMoth

Looks good, just need the other event to call the new GetNoSeriesLineFilters procedure as well.

AndreasMoth · 2024-11-14T12:55:39Z

src/Business Foundation/App/NoSeries/src/Setup/NoSeriesSetupImpl.Codeunit.al

+        NoSeriesLine2.SetRange("Starting Date", 0D, StartingDate);
+        NoSeriesLine2.SetRange("Series Code", NoSeriesCode);
+        RaiseSetAdditionalNoSeriesLineFilters(NoSeriesLine2);
+        If NoSeriesLine2."Series Code" <> NoSeriesCode then


"if NoSeriesLine2.GetFilter("Series Code") <> NoSeriesCode then" - that's what I meant. Do verify this is what GetFilter actually returns, I didn't test this completely :)

AndreasMoth · 2024-11-14T13:05:20Z

src/Business Foundation/App/NoSeries/src/Setup/NoSeriesSetupImpl.Codeunit.al

@@ -88,7 +88,7 @@ codeunit 305 "No. Series - Setup Impl."
        NoSeries.MarkedOnly(true);
    end;

-    local procedure SetNoSeriesCurrentLineFilters(var NoSeriesRec: Record "No. Series"; var NoSeriesLine: Record "No. Series Line"; ResetForDrillDown: Boolean)
+    procedure SetNoSeriesCurrentLineFilters(var NoSeriesRec: Record "No. Series"; var NoSeriesLine: Record "No. Series Line"; ResetForDrillDown: Boolean)


This no longer needs to be public

grobyns · 2024-11-14T14:51:32Z

src/Business Foundation/App/NoSeries/src/Setup/NoSeriesSetupImpl.Codeunit.al

@@ -137,6 +135,23 @@ codeunit 305 "No. Series - Setup Impl."
        exit(NoSeriesSingle.MayProduceGaps());
    end;

+    local procedure GetNoSeriesLineFilters(var NoSeriesLine: Record "No. Series Line"; NoSeriesCode: Code[20]; StartingDate: Date)


Suggested change

local procedure GetNoSeriesLineFilters(var NoSeriesLine: Record "No. Series Line"; NoSeriesCode: Code[20]; StartingDate: Date)

procedure SetNoSeriesLineFilters(var NoSeriesLine: Record "No. Series Line"; NoSeriesCode: Code[20]; StartingDate: Date)

grobyns · 2024-11-14T14:55:01Z

src/Business Foundation/App/NoSeries/src/Setup/NoSeriesSetupImpl.Codeunit.al

+    var
+        NoSeries: Codeunit "No. Series";
+        NoSeriesLine2: Record "No. Series Line";
+        CodeFieldChangedErr: Label 'Change of Series Code Field is on this Record not allowed.';


We add labels as global variables.

Suggested change

CodeFieldChangedErr: Label 'Change of Series Code Field is on this Record not allowed.';

CodeFieldChangedErr: Label 'The filter on Series Code was altered by an event subscriber. This is a programming error. Please contact your partner to resolve the issue.\Original Series Code: %1\Modified Filter: %2';

grobyns · 2024-11-14T14:57:36Z

src/Business Foundation/App/NoSeries/src/Setup/NoSeriesSetupImpl.Codeunit.al

+        NoSeriesLine2.SetCurrentKey("Series Code", "Starting Date");
+        NoSeriesLine2.SetRange("Starting Date", 0D, StartingDate);
+        NoSeriesLine2.SetRange("Series Code", NoSeriesCode);
+        RaiseSetAdditionalNoSeriesLineFilters(NoSeriesLine2);


Suggested change

RaiseSetAdditionalNoSeriesLineFilters(NoSeriesLine2);

OnSetNoSeriesLineFilters(NoSeriesLine2);

grobyns · 2024-11-14T14:58:36Z

src/Business Foundation/App/NoSeries/src/Setup/NoSeriesSetupImpl.Codeunit.al

+        NoSeriesLine2.SetRange("Series Code", NoSeriesCode);
+        RaiseSetAdditionalNoSeriesLineFilters(NoSeriesLine2);
+        If NoSeriesLine2."Series Code" <> NoSeriesCode then
+            Error(CodeFieldChangedErr); // Extensions should never change the code field range, this is a bug that developers should know immediately.


Suggested change

Error(CodeFieldChangedErr); // Extensions should never change the code field range, this is a bug that developers should know immediately.

Error(CodeFieldChangedErr, NoSeriesCode, NoSeriesLine2.GetFilter("Series Code"); // Extensions should never change the code field range, this is a bug that developers should know immediately.

grobyns · 2024-11-14T15:00:32Z

src/Business Foundation/App/NoSeries/src/Setup/NoSeriesSetupImpl.Codeunit.al

@@ -389,4 +404,9 @@ codeunit 305 "No. Series - Setup Impl."
            if NumberSequence.Exists(Rec."Sequence Name") then
                NumberSequence.Delete(Rec."Sequence Name");
    end;
+
+    [IntegrationEvent(false, false)]
+    internal procedure RaiseSetAdditionalNoSeriesLineFilters(var NoSeriesLine: Record "No. Series Line");


The event publisher should be added in NoSeries.Codeunit.al, not here

grobyns · 2024-11-14T15:01:16Z

src/Business Foundation/App/NoSeries/src/Setup/NoSeriesSetupImpl.Codeunit.al

+        NoSeriesLine2.SetCurrentKey("Series Code", "Starting Date");
+        NoSeriesLine2.SetRange("Starting Date", 0D, StartingDate);
+        NoSeriesLine2.SetRange("Series Code", NoSeriesCode);
+        RaiseSetAdditionalNoSeriesLineFilters(NoSeriesLine2);


Suggested change

RaiseSetAdditionalNoSeriesLineFilters(NoSeriesLine2);

NoSeries.OnSetNoSeriesLineFilters(NoSeriesLine2);

grobyns · 2024-11-14T15:01:35Z

src/Business Foundation/App/NoSeries/src/Single/NoSeries.Codeunit.al

+    /// </summary>
+    /// <param name="NoSeriesLine">The No. Series Line to set filters on.</param>
+    [IntegrationEvent(false, false)]
+    internal procedure OnGetNoSeriesLineOnBeforeFindLast(var NoSeriesLine: Record "No. Series Line");


Suggested change

internal procedure OnGetNoSeriesLineOnBeforeFindLast(var NoSeriesLine: Record "No. Series Line");

internal procedure OnSetNoSeriesLineFilters(var NoSeriesLine: Record "No. Series Line");

grobyns · 2024-11-14T15:03:02Z

src/Business Foundation/App/NoSeries/src/Single/NoSeries.Codeunit.al

+    /// <summary>
+    /// Use this event to change the filters set on the No. Series Line record. These filters are used when searching the No. Series.
+    /// </summary>
+    /// <param name="NoSeriesLine">The No. Series Line to set filters on.</param>


Suggested change

/// <param name="NoSeriesLine">The No. Series Line to set filters on.</param>

/// <remarks>Changing the filter on the "Series Code" field is not allowed and will result in an error.</remarks>

/// <param name="NoSeriesLine">The No. Series Line to set filters on.</param>

grobyns · 2024-11-14T15:03:35Z

src/Business Foundation/App/NoSeries/src/Single/NoSeries.Codeunit.al

@@ -362,4 +362,13 @@ codeunit 310 "No. Series"
    internal procedure OnAfterSetNoSeriesCurrentLineFilters(NoSeries: Record "No. Series"; var NoSeriesLine: Record "No. Series Line"; IsDrillDown: Boolean);
    begin
    end;
+
+    /// <summary>
+    /// Use this event to change the filters set on the No. Series Line record. These filters are used when searching the No. Series.


Suggested change

/// Use this event to change the filters set on the No. Series Line record. These filters are used when searching the No. Series.

/// Use this event to set additional filters on the No. Series Line record. These filters are used when searching the No. Series.

grobyns · 2024-11-14T15:06:50Z

src/Business Foundation/App/NoSeries/src/Single/NoSeriesImpl.Codeunit.al

@@ -177,6 +177,7 @@ codeunit 304 "No. Series - Impl."
        NoSeriesLine2.SetCurrentKey("Series Code", "Starting Date");
        NoSeriesLine2.SetRange("Series Code", NoSeriesCode);
        NoSeriesLine2.SetRange("Starting Date", 0D, UsageDate);
+        NoSeries.OnGetNoSeriesLineOnBeforeFindLast(NoSeriesLine2);


Suggested change

NoSeries.OnGetNoSeriesLineOnBeforeFindLast(NoSeriesLine2);

NoSeriesSetupImpl.SetNoSeriesLineFilters(NoSeriesLine2, NoSeriesCode, UsageDate);

PeterDurrer added 3 commits November 13, 2024 12:02

New Event OnGetNoSeriesLineOnBeforeFindLast for Filter NoSeriesLine R…

013977d

…eplaces the backwards compatible Event

public SetNoSeriesCurrentLineFilters

3a10813

New Event OnGetNoSeriesLineOnBeforeFindLast for Filter NoSeriesLine R…

0cdace8

…eplaces the backwards compatible Event

PeterDurrer requested a review from a team as a code owner November 14, 2024 08:07

PeterDurrer closed this Nov 14, 2024

github-actions bot added AL: Business Foundation From Fork Pull request is coming from a fork labels Nov 14, 2024

PeterDurrer changed the title ~~https://github.com/microsoft/BCApps/issues/1362#issue-2360774022~~ No. Series: Ability to extend filters on finding No. Series Lines when getting new numbers Nov 14, 2024

PeterDurrer reopened this Nov 14, 2024

grobyns assigned grobyns and AndreasMoth Nov 14, 2024

grobyns requested review from AndreasMoth and grobyns November 14, 2024 08:42

AndreasMoth reviewed Nov 14, 2024

View reviewed changes

PeterDurrer added 2 commits November 14, 2024 10:42

New Event OnGetNoSeriesLineOnBeforeFindLast for Filter NoSeriesLine R…

0d6fcdf

…eplaces the backwards compatible Event

Merge remote-tracking branch 'upstream/main'

8fc5fb4

AndreasMoth reviewed Nov 14, 2024

View reviewed changes

public SetNoSeriesCurrentLineFilters

1c346ae

AndreasMoth reviewed Nov 14, 2024

View reviewed changes

AndreasMoth approved these changes Nov 14, 2024

View reviewed changes

AndreasMoth reviewed Nov 14, 2024

View reviewed changes

grobyns requested changes Nov 14, 2024

View reviewed changes

JesperSchulz added the Integration GitHub request for Integration area label Nov 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

No. Series: Ability to extend filters on finding No. Series Lines when getting new numbers #2361

No. Series: Ability to extend filters on finding No. Series Lines when getting new numbers #2361

PeterDurrer commented Nov 14, 2024 •

edited by github-actions bot

Loading

PeterDurrer commented Nov 14, 2024 •

edited

Loading

AndreasMoth Nov 14, 2024

PeterDurrer Nov 14, 2024

AndreasMoth Nov 14, 2024

PeterDurrer Nov 14, 2024

AndreasMoth Nov 14, 2024

AndreasMoth Nov 14, 2024

PeterDurrer Nov 14, 2024

AndreasMoth Nov 14, 2024

AndreasMoth left a comment

AndreasMoth Nov 14, 2024

AndreasMoth Nov 14, 2024

grobyns Nov 14, 2024

grobyns Nov 14, 2024

grobyns Nov 14, 2024

grobyns Nov 14, 2024

grobyns Nov 14, 2024

grobyns Nov 14, 2024

grobyns Nov 14, 2024

grobyns Nov 14, 2024

grobyns Nov 14, 2024

grobyns Nov 14, 2024

		@@ -101,6 +101,7 @@ codeunit 305 "No. Series - Setup Impl."
		NoSeriesLine.SetCurrentKey("Series Code", "Starting Date");
		NoSeriesLine.SetRange("Series Code", NoSeriesRec.Code);

	local procedure GetNoSeriesLineFilters(var NoSeriesLine: Record "No. Series Line"; NoSeriesCode: Code[20]; StartingDate: Date)
	procedure SetNoSeriesLineFilters(var NoSeriesLine: Record "No. Series Line"; NoSeriesCode: Code[20]; StartingDate: Date)

	CodeFieldChangedErr: Label 'Change of Series Code Field is on this Record not allowed.';
	CodeFieldChangedErr: Label 'The filter on Series Code was altered by an event subscriber. This is a programming error. Please contact your partner to resolve the issue.\Original Series Code: %1\Modified Filter: %2';

	RaiseSetAdditionalNoSeriesLineFilters(NoSeriesLine2);
	OnSetNoSeriesLineFilters(NoSeriesLine2);

	Error(CodeFieldChangedErr); // Extensions should never change the code field range, this is a bug that developers should know immediately.
	Error(CodeFieldChangedErr, NoSeriesCode, NoSeriesLine2.GetFilter("Series Code"); // Extensions should never change the code field range, this is a bug that developers should know immediately.

	RaiseSetAdditionalNoSeriesLineFilters(NoSeriesLine2);
	NoSeries.OnSetNoSeriesLineFilters(NoSeriesLine2);

	internal procedure OnGetNoSeriesLineOnBeforeFindLast(var NoSeriesLine: Record "No. Series Line");
	internal procedure OnSetNoSeriesLineFilters(var NoSeriesLine: Record "No. Series Line");

	/// <param name="NoSeriesLine">The No. Series Line to set filters on.</param>
	/// <remarks>Changing the filter on the "Series Code" field is not allowed and will result in an error.</remarks>
	/// <param name="NoSeriesLine">The No. Series Line to set filters on.</param>

	/// Use this event to change the filters set on the No. Series Line record. These filters are used when searching the No. Series.
	/// Use this event to set additional filters on the No. Series Line record. These filters are used when searching the No. Series.

	NoSeries.OnGetNoSeriesLineOnBeforeFindLast(NoSeriesLine2);
	NoSeriesSetupImpl.SetNoSeriesLineFilters(NoSeriesLine2, NoSeriesCode, UsageDate);

No. Series: Ability to extend filters on finding No. Series Lines when getting new numbers #2361

Are you sure you want to change the base?

No. Series: Ability to extend filters on finding No. Series Lines when getting new numbers #2361

Conversation

PeterDurrer commented Nov 14, 2024 • edited by github-actions bot Loading

Summary

Work Item(s)

PeterDurrer commented Nov 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AndreasMoth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PeterDurrer commented Nov 14, 2024 •

edited by github-actions bot

Loading

PeterDurrer commented Nov 14, 2024 •

edited

Loading