So, you’re already using events, right? Then you know that when you subscribe an event, the subscriber is called by the publisher every time, right? Well, sort of… There’s a property called EventSubscriberInstance<\/strong> (https:\/\/docs.microsoft.com\/en-us\/dynamics-nav\/eventsubscriberinstance-property<\/a>) that allows you to indicate if the subscribers should be bound to events automatically or manually. To bound subscribers to events manually the property must be set to Manual<\/strong>.<\/p>\n\n\n\n I’ve created a new codeunit for the purpose of replacing the report to be used, that subscribes event OnAfterSubstituteReport<\/strong> in codeunit ReportManagement<\/strong>.<\/p>\n\n\n\n Please note that the property EventSubscriberInstance<\/strong> is set to Manual<\/strong> so these subscribers won’t be called unless they’re activated. To activate the subscribers I must bind the subscription.<\/p>\n\n\n\n I’ve created two codeunits to show two different behaviors. I believe the codeunit name is self explanatory.<\/p>\n\n\n\n Codeunit -> Will Print Original Report<\/strong><\/p>\n\n\n\n Codeunit -> Print the Substitute Report<\/strong><\/p>\n\n\n\n I’ve extended the Customer List page to add two actions to test the codeunits:<\/p>\n\n\n\n Here’s the output when I run codeunit Will Print Original Report<\/strong>. “Sales – Invoice”<\/strong> report is printed.<\/p>\n\n\n\n But if I run codeunit Will Print Substituted Report<\/strong>, then “Standard Sales – Invoice”<\/strong> report is printed instead because the subscribers in codeunit are bound.<\/p>\n\n\n\n In this example I want to post a gen. journal and use the last entry no. later on.<\/p>\n\n\n\n I’ve created the following objects to demonstrate this.<\/p>\n\n\n\n Codeunit Example 2 – Aux Methods<\/strong> -> The codeunit is used to create and post a gen. journal line.<\/p>\n\n\n\n Codeunit Storage<\/strong> -> Created to subscribe the OnAfterGLFinishPosting<\/strong> event and save the Last Entry No. in variable global PostedEntryNo<\/strong>.<\/p>\n\n\n\n Please note the the EventSubscriberInstance<\/strong> property is set to Manual<\/strong>.<\/p>\n\n\n\n Codeunit Example 2 – No Bind<\/strong>. This is the codeunit that will be executed to show the first scenario. I didn’t use the BINDSUBSCRIPTION<\/strong> so the saved value in variable PostedEntryNo<\/strong>, in codeunit Storage<\/strong>, is lost and not retrieved when GetPostedEntryNo<\/strong> method is called.<\/p>\n\n\n\n Codeunit Example 2 – Bind<\/strong> -> This is the codeunit that will be executed to show the second scenario. This time I used the BINDSUBSCRIPTION<\/strong> so the saved value in variable PostedEntryNo<\/strong>, in codeunit Storage<\/strong>, is not lost and is correctly retrieved when GetPostedEntryNo<\/strong> method is called.<\/p>\n\n\n\n When BINDSUBSCRIPTION<\/strong> is used, you control the lifespan of the subscriber codeunit so the instance is stored and the content is not cleared and can be accessed until the codeunit subscription is unbound.<\/p>\n\n\n\n Once again, I’ve extended the Customer List page to add two actions to test the codeunits:<\/p>\n\n\n\n When I press the Post Gen. Jnl. Line – No Bind<\/strong> action, the codeunit Example 2 – No Bind<\/strong> is executed and the following message is retrieved because the posted G\/L Entry No. stored in variable PostedEntryNo<\/strong> was lost:<\/p>\n\n\n\n But if I press the Post Gen. Jnl. Line – Bind<\/strong> action, the codeunit Example 2 – Bind<\/strong> is executed and the entry no. is correctly retrieved from the PostedEntryNo<\/strong> variable because the codeunit was bound and the instance is stored until the codeunit is unbound.<\/p>\n\n\n\n Another scenario I’ve tried was to have a subscriber that I want to be called every time. But on some specific processes I want it to have a different behavior.<\/p>\n\n\n\n Imagine that you want to log in a new table the last entry no. inserted in the G\/L Entry, every time a post occurs. You can do that subscribing the OnAfterGLFinishPosting<\/strong> publisher event on codeunit Gen. Jnl.-Post Line<\/strong>. But on some specific scenarios you want the subscriber to have a different behavior. For example, showing a message to the user with the entry no. inserted in the Logging<\/strong> table.<\/p>\n\n\n\n First I’ve created a new table for the log that will keep the last G\/L Entry No. inserted on each post.<\/p>\n\n\n\n Next, I’ve created the codeunit that will subscribe OnAfterGLFinishPosting<\/strong> on codeunit Gen. Jnl.-Post Line<\/strong>. This subscriber will be called every time a gen. journal line is posted.<\/p>\n\n\n\n I’ll have to do some changes in this codeunit but this would be an example of the codeunit if I just wanted to save the log.<\/p>\n\n\n\n I will need an additional codeunit for the specific processes. In some specific processes I want to do the logging but I also want to show a message to the user with the logging entry no.<\/p>\n\n\n\n Please note that the EventSubscriberInstance<\/strong> property is set to Manual<\/strong>.<\/p>\n\n\n\n What’s going to happen if I bind the subscription in codeunit G\/L Logger\/Message Subscriber<\/strong>? The log will occur twice because both events will be called. To avoid it I will have to make some changes in both codeunits.<\/p>\n\n\n\n Codeunit G\/L Logger\/Message Subscriber<\/strong> will be changed to:<\/p>\n\n\n\n Codeunit G\/L Logger Subscriber<\/strong> will be changed to:<\/p>\n\n\n\n I’ve created two codeunits to simulate the behavior on both situations.<\/p>\n\n\n\n I\u2019ve extended the Customer List page to add two actions to test the codeunits:<\/p>\n\n\n\n When I press the Post Gen. Jnl. Line – No Bind<\/strong> action, the codeunit Example 3 – No Bind<\/strong> is executed and the following message is retrieved:<\/p>\n\n\n\n A new record is added to Logging<\/strong> table but that’s it.<\/p>\n\n\n\n If I press the Post Gen. Jnl. Line – Bind<\/strong> action, the codeunit Example 3 – Bind<\/strong> is executed and the following messages are retrieved:<\/p>\n\n\n\n A new record is added to the Logging<\/strong> table and a message is shown with the inserted logging entry no..<\/p>\n\n\n\n <\/p>\n\n\n\n I hope you enjoyed this article and found it useful.<\/p>\n\n\n\n Please feel free to comment on this.<\/p>\n\n\n\n Source code available in Github: https:\/\/github.com\/ricardopaiva\/NAVBC_bindsubscription_example<\/a><\/p>\n\n\n\n codeunit 50101 \"Substitute The Report\"
{
EventSubscriberInstance = Manual;
\u200b
[EventSubscriber(ObjectType::Codeunit, Codeunit::\"ReportManagement\", 'OnAfterSubstituteReport', '', true, true)]
local procedure \"ReportManagement_OnAfterSubstituteReport\"(ReportId: Integer; RunMode: Option; RequestPageXml: Text; RecordRef: RecordRef; var NewReportId: Integer)
begin
IF ReportId = REPORT::\"Sales - Invoice\" THEN
NewReportId := REPORT::\"Standard Sales - Invoice\";
end;
}<\/pre>\n\n\n\n codeunit 50102 \"Will Print Original Report\"
{
trigger OnRun()
var
SalesInvoiceHeader: Record \"Sales Invoice Header\";
begin
SalesInvoiceHeader.FindFirst();
REPORT.RunModal(REPORT::\"Sales - Invoice\", true, true, SalesInvoiceHeader);
end;
}<\/pre>\n\n\n\n codeunit 50103 \"Print the Substitute Report\"
{
trigger OnRun()
var
SalesInvoiceHeader: Record \"Sales Invoice Header\";
SubstituteTheReport: Codeunit \"Substitute The Report\";
begin
SalesInvoiceHeader.FindFirst();
BindSubscription(SubstituteTheReport);
REPORT.RunModal(REPORT::\"Sales - Invoice\", true, true, SalesInvoiceHeader);
UnbindSubscription(SubstituteTheReport); \/\/ Not necessary because when SubstituteTheReport codeunit goes out of scope, all bindings are removed.
end;
}<\/pre>\n\n\n\n pageextension 50101 \"CustomerListExt\" extends \"Customer List\"
{
actions
{
addlast(Creation)
{
group(MyActionGroup)
{
Action(MyAction1)
{
ApplicationArea = All;
Caption = 'Print Report - No Bind';
RunObject = codeunit \"Will Print Original Report\";
Promoted = true;
PromotedIsBig = true;
PromotedCategory = Process;
}
\u200b
Action(MyAction2)
{
ApplicationArea = All;
Caption = 'Print Report - Bind';
RunObject = codeunit \"Will Print Substituted Report\";
Promoted = true;
PromotedIsBig = true;
PromotedCategory = Process;
}
}
}
}
}<\/pre>\n\n\n\n![\"\"](\"https:\/\/ricardomoinhos.com\/wp-content\/uploads\/2020\/02\/BINDSUBSCRIPTION_Image_1.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/ricardomoinhos.com\/wp-content\/uploads\/2020\/02\/BINDSUBSCRIPTION_Image_2.png\")
<\/figure>\n\n\n\nExample 2 – Set global information in the subscribers codeunit<\/h3>\n\n\n\n
codeunit 50107 \"Example 2 - Aux Methods\"
{
procedure CreateAndPostGenJnlLine()
var
GenJournalLine: Record \"Gen. Journal Line\";
GenJnlPostBatch: Codeunit \"Gen. Jnl.-Post Batch\";
begin
\/\/ For demo purposes only - Values hardcoded.
\u200b
GenJournalLine.INIT;
GenJournalLine.SetHideValidation(TRUE);
GenJournalLine.VALIDATE(\"Source Code\", 'GENJNL');
GenJournalLine.VALIDATE(\"Journal Template Name\", 'GENERAL');
GenJournalLine.VALIDATE(\"Journal Batch Name\", 'DEFAULT');
GenJournalLine.VALIDATE(\"Line No.\", 10000);
GenJournalLine.VALIDATE(\"Account Type\", GenJournalLine.\"Account Type\"::\"G\/L Account\");
GenJournalLine.VALIDATE(\"Document No.\", '.');
GenJournalLine.VALIDATE(\"Account No.\", '2910');
GenJournalLine.VALIDATE(\"Document Date\", WorkDate());
GenJournalLine.VALIDATE(\"Posting Date\", WorkDate());
GenJournalLine.VALIDATE(Amount, 100);
GenJournalLine.VALIDATE(\"Bal. Account Type\", GenJournalLine.\"Bal. Account Type\"::\"G\/L Account\");
GenJournalLine.VALIDATE(\"Bal. Account No.\", '2910');
GenJournalLine.VALIDATE(\"Bal. Gen. Posting Type\", GenJournalLine.\"Bal. Gen. Posting Type\"::\" \");
GenJournalLine.VALIDATE(\"Bal. Gen. Bus. Posting Group\", '');
GenJournalLine.VALIDATE(\"Bal. Gen. Prod. Posting Group\", '');
GenJournalLine.VALIDATE(\"Bal. VAT Prod. Posting Group\", '');
GenJournalLine.VALIDATE(\"Bal. VAT Bus. Posting Group\", '');
GenJournalLine.INSERT(TRUE);
GenJnlPostBatch.Run(GenJournalLine);
end;
\u200b
}<\/pre>\n\n\n\n codeunit 50106 \"Storage\"
{
EventSubscriberInstance = Manual;
\u200b
var
PostedEntryNo: Integer;
procedure GetPostedEntryNo(): Integer
begin
exit(PostedEntryNo);
end;
[EventSubscriber(ObjectType::Codeunit, Codeunit::\"Gen. Jnl.-Post Line\", 'OnAfterGLFinishPosting', '', true, true)]
local procedure \"Gen. Jnl.-Post Line_OnAfterGLFinishPosting\"(GLEntry: Record \"G\/L Entry\"; var GenJnlLine: Record \"Gen. Journal Line\"; IsTransactionConsistent: Boolean; FirstTransactionNo: Integer; var GLRegister: Record \"G\/L Register\"; var TempGLEntryBuf: Record \"G\/L Entry\"; var NextEntryNo: Integer; var NextTransactionNo: Integer)
begin
PostedEntryNo := NextEntryNo;
end;
\u200b
}<\/pre>\n\n\n\n codeunit 50104 \"Example 2 - No Bind\"
{
var
Storage: Codeunit \"Storage\";
Aux: Codeunit \"Example 2 - Aux Methods\";
\u200b
trigger OnRun()
begin
Aux.CreateAndPostGenJnlLine();
\/\/ Do additional processing...
MESSAGE(Format(Storage.GetPostedEntryNo()));
end;
\u200b
}<\/pre>\n\n\n\n codeunit 50105 \"Example 2 - Bind\"
{
var
Storage: Codeunit \"Storage\";
Aux: Codeunit \"Example 2 - Aux Methods\";
\u200b
trigger OnRun()
begin
BindSubscription(Storage);
Aux.CreateAndPostGenJnlLine();
MESSAGE(Format(Storage.GetPostedEntryNo()));
UnbindSubscription(Storage);
end;
\u200b
}<\/pre>\n\n\n\n pageextension 50102 \"CustomerListExt\" extends \"Customer List\"
{
actions
{
addlast(Creation)
{
group(MyActionGroup)
{
Action(MyAction1)
{
ApplicationArea = All;
Caption = 'Post Gen. Jnl. Line - No Bind';
RunObject = codeunit \"Example 2 - No Bind\";
Promoted = true;
PromotedIsBig = true;
PromotedCategory = Process;
}
\u200b
Action(MyAction2)
{
ApplicationArea = All;
Caption = 'Post Gen. Jnl. Line - Bind';
RunObject = codeunit \"Example 2 - Bind\";
Promoted = true;
PromotedIsBig = true;
PromotedCategory = Process;
}
}
}
}
\u200b
}<\/pre>\n\n\n\n![\"\"](\"https:\/\/ricardomoinhos.com\/wp-content\/uploads\/2020\/02\/BINDSUBSCRIPTION_Image_3.png\")
<\/a><\/figure>\n\n\n\n![\"\"](\"https:\/\/ricardomoinhos.com\/wp-content\/uploads\/2020\/02\/BINDSUBSCRIPTION_Image_4.png\")
<\/figure>\n\n\n\nExample 3 – Reusing the subscriber but changing behavior<\/h3>\n\n\n\n
table 50100 \"Logging\"
{
DataClassification = ToBeClassified;
\u200b
fields
{
field(1; \"Entry No.\"; Integer)
{
DataClassification = ToBeClassified;
AutoIncrement = true;
}
field(2; \"G\/L Entry No.\"; Integer)
{
DataClassification = ToBeClassified;
}
}
keys
{
key(PK; \"Entry No.\")
{
Clustered = true;
}
}
}<\/pre>\n\n\n\n codeunit 50109 \"G\/L Logger Subscriber\"
{
[EventSubscriber(ObjectType::Codeunit, Codeunit::\"Gen. Jnl.-Post Line\", 'OnAfterGLFinishPosting', '', true, true)]
local procedure \"Gen. Jnl.-Post Line_OnAfterGLFinishPosting\"(GLEntry: Record \"G\/L Entry\"; var GenJnlLine: Record \"Gen. Journal Line\"; IsTransactionConsistent: Boolean; FirstTransactionNo: Integer; var GLRegister: Record \"G\/L Register\"; var TempGLEntryBuf: Record \"G\/L Entry\"; var NextEntryNo: Integer; var NextTransactionNo: Integer)
begin
AddGLEntryToLog(GLEntry.\"Entry No.\");
end;
\u200b
procedure AddGLEntryToLog(GLEntryNo: Integer): Integer
var
Logging: Record Logging;
begin
Logging.Init();
Logging.\"G\/L Entry No.\" := GLEntryNo;
Logging.Insert();
Message('New entry added to Logging');
exit(Logging.\"Entry No.\");
end;
}<\/pre>\n\n\n\n codeunit 50110 \"G\/L Logger\/Message Subscriber\"
{
EventSubscriberInstance = Manual;
\u200b
var
GLLogger: Codeunit \"G\/L Logger Subscriber\";
[EventSubscriber(ObjectType::Codeunit, Codeunit::\"Gen. Jnl.-Post Line\", 'OnAfterGLFinishPosting', '', true, true)]
local procedure \"Gen. Jnl.-Post Line_OnAfterGLFinishPosting\"(GLEntry: Record \"G\/L Entry\"; var GenJnlLine: Record \"Gen. Journal Line\"; IsTransactionConsistent: Boolean; FirstTransactionNo: Integer; var GLRegister: Record \"G\/L Register\"; var TempGLEntryBuf: Record \"G\/L Entry\"; var NextEntryNo: Integer; var NextTransactionNo: Integer)
begin
Message(Format(GLLogger.AddGLEntryToLog(GLEntry.\"Entry No.\")));
end;
}<\/pre>\n\n\n\n codeunit 50110 \"G\/L Logger\/Message Subscriber\"
{
EventSubscriberInstance = Manual;
\u200b
var
GLLogger: Codeunit \"G\/L Logger Subscriber\";
IsBound: Boolean;
procedure SetIsBound()
begin
IsBound := true;
end;
procedure GetIsBound(): Boolean
begin
exit(IsBound);
end;
[EventSubscriber(ObjectType::Codeunit, Codeunit::\"Gen. Jnl.-Post Line\", 'OnAfterGLFinishPosting', '', true, true)]
local procedure \"Gen. Jnl.-Post Line_OnAfterGLFinishPosting\"(GLEntry: Record \"G\/L Entry\"; var GenJnlLine: Record \"Gen. Journal Line\"; IsTransactionConsistent: Boolean; FirstTransactionNo: Integer; var GLRegister: Record \"G\/L Register\"; var TempGLEntryBuf: Record \"G\/L Entry\"; var NextEntryNo: Integer; var NextTransactionNo: Integer)
begin
Message(Format(GLLogger.AddGLEntryToLog(GLEntry.\"Entry No.\")));
end;
[EventSubscriber(ObjectType::Codeunit, Codeunit::\"G\/L Logger Subscriber\", 'OnCheckSubscriberIsBound', '', true, true)]
local procedure IsBound_OnCheckSubscriberIsBound_GLLoggerSubscriber(var CodeunitIsBound: Boolean);
begin
CodeunitIsBound := IsBound;
end;
}<\/pre>\n\n\n\n codeunit 50109 \"G\/L Logger Subscriber\"
{
[EventSubscriber(ObjectType::Codeunit, Codeunit::\"Gen. Jnl.-Post Line\", 'OnAfterGLFinishPosting', '', true, true)]
local procedure \"Gen. Jnl.-Post Line_OnAfterGLFinishPosting\"(GLEntry: Record \"G\/L Entry\"; var GenJnlLine: Record \"Gen. Journal Line\"; IsTransactionConsistent: Boolean; FirstTransactionNo: Integer; var GLRegister: Record \"G\/L Register\"; var TempGLEntryBuf: Record \"G\/L Entry\"; var NextEntryNo: Integer; var NextTransactionNo: Integer)
var
IsBound: Boolean;
begin
OnCheckSubscriberIsBound(IsBound);
if IsBound then
exit;
\u200b
AddGLEntryToLog(GLEntry.\"Entry No.\");
end;
procedure AddGLEntryToLog(GLEntryNo: Integer): Integer
var
Logging: Record Logging;
begin
Logging.Init();
Logging.\"G\/L Entry No.\" := GLEntryNo;
Logging.Insert();
Message('New entry added to Logging');
exit(Logging.\"Entry No.\");
end;
[IntegrationEvent(false, false)]
local procedure OnCheckSubscriberIsBound(var CodeunitIsBound: Boolean)
begin
end;
}<\/pre>\n\n\n\n codeunit 50112 \"Example 3 - No Bind\"
{
var
Aux: Codeunit \"Example 3 - Aux Methods\";
\u200b
trigger OnRun()
begin
Aux.CreateAndPostGenJnlLine();
end;
}<\/pre>\n\n\n\n codeunit 50113 \"Example 3 - Bind\"
{
var
Aux: Codeunit \"Example 3 - Aux Methods\";
LoggerMessage: Codeunit \"G\/L Logger\/Message Subscriber\";
\u200b
trigger OnRun()
begin
BindSubscription(LoggerMessage);
Aux.CreateAndPostGenJnlLine();
UnbindSubscription(LoggerMessage);
end;
}<\/pre>\n\n\n\n pageextension 50102 \"CustomerListExt\" extends \"Customer List\"
{
actions
{
addlast(Creation)
{
group(MyActionGroup)
{
Action(MyAction1)
{
ApplicationArea = All;
Caption = 'Post Gen. Jnl. Line - No Bind';
RunObject = codeunit \"Example 3 - No Bind\";
Promoted = true;
PromotedIsBig = true;
PromotedCategory = Process;
}
\u200b
Action(MyAction2)
{
ApplicationArea = All;
Caption = 'Post Gen. Jnl. Line - Bind';
RunObject = codeunit \"Example 3 - Bind\";
Promoted = true;
PromotedIsBig = true;
PromotedCategory = Process;
}
}
}
}
}<\/pre>\n\n\n\n![\"\"](\"https:\/\/ricardomoinhos.com\/wp-content\/uploads\/2020\/02\/BINDSUBSCRIPTION_Image_5.png\")
<\/figure>\n\n\n\n<\/figure>\n\n\n\n![\"\"](\"https:\/\/ricardomoinhos.com\/wp-content\/uploads\/2020\/02\/BINDSUBSCRIPTION_Image_6.png\")
<\/figure>\n\n\n\n