4212 lines
No EOL
729 KiB
XML
4212 lines
No EOL
729 KiB
XML
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>alguidelines.dev - Business Central Design Patterns – 1. Patterns</title><link>https://alguidelines.dev/docs/navpatterns/patterns/</link><description>Recent content in 1. Patterns on alguidelines.dev - Business Central Design Patterns</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://alguidelines.dev/docs/navpatterns/patterns/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: Activity Logs</title><link>https://alguidelines.dev/docs/navpatterns/patterns/activity-log/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/activity-log/</guid><description>
|
||
<p><em>Originally by Ciprian Iordache at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="activity-log">Activity Log</h2>
|
||
<p><strong>Abstract</strong></p>
|
||
<p>The Activity Log pattern tracks execution of activities. This is a Dynamics NAV specific implementation of the <a href="http://martinfowler.com/eaaDev/AuditLog.html">Audit Log</a> pattern.</p>
|
||
<p><a href="Activity-Log.jpg"><img src="Activity-Log.jpg" alt=" "></a></p>
|
||
<p><strong>Problem</strong></p>
|
||
<p>In general, integrating with external systems can be very challenging, due to the complexity of the situation &ndash; connectivity issues, asynchronous operations, user errors, etc. These challenges require sometimes re-trying several times, polling the external system, re-send/re-get data as all these activities can succeed but can very well fail.</p>
|
||
<p>Similar challenges exist in situations where a lengthy, complex task, composed of different steps is to be executed by various people in various timeframes. In case of errors (but sometimes also in case of success) there will be a need to track these activities to see what happened and the actual person which did a specific step.</p>
|
||
<p>In all these cases, we need to be able to troubleshoot.</p>
|
||
<p>A tracking/logging functionality could be implemented for each activity/step separately, but this would lead to code duplication and problems in maintaining the code in future.</p>
|
||
<p>In NAV there is already the Change Log functionality which can record all the data changes that have been done to specific tables, specific fields. However, this functionality is not available for activities. Also, there are few places where separate logging/tracking implementations were done but the current pattern proposes an unified, central way of data recording and enables the user to track all/most of the activities.</p>
|
||
<p><strong>Solution</strong></p>
|
||
<p>The Activity Log pattern tracks specific outcome of the activities, in order to be able to assess what went wrong/fine or who performed a specific activity.</p>
|
||
<p>Activity Log pattern</p>
|
||
<ul>
|
||
<li>records the activity and its outcome (error or success messages)</li>
|
||
<li>assembles all messages in one central view and presents them to the user filtered for the specific activity and ordered in reverse chronological order.</li>
|
||
</ul>
|
||
<p>Figure below illustrates the how the Activity Log manifests in the UI. The figure shows a part of an activity log for a posted document that was sent to the document exchange service and illustrates both successful and failed activities.</p>
|
||
<p><a href="Activity-Log-NAV.jpg"><img src="Activity-Log-NAV.jpg" alt=" "></a></p>
|
||
<p>This functionality is implemented in the following way - Activity Log table (TAB710) contains a simple function that allows you to log the result of a task or activity:</p>
|
||
<p>ActivityLog.LogActivity(ContextRecordID,ActivityLog.Status::Failed,ContextDescription,ActivityDescription,ActivityMessage);</p>
|
||
<p>Similar to TAB700 for Error Messaging, the Activity Log table contains a RECORDID that is a link to the parent/context entity. That permits the Activity Log to be used in a generic way, for any kind of entities (tables) and it also permits filtering the data to a specific related entity only before being presenting to the user.</p>
|
||
<p>The following parameters should be provided to the function:</p>
|
||
<ul>
|
||
<li>RecordID: The record/context for which the activity is logged</li>
|
||
<li>Status: The task/activity outcome</li>
|
||
<li>Descriptions/Messages: fields that will clearly describe the state and outcome of the task</li>
|
||
</ul>
|
||
<p>To show the log, add a page action, with the caption including the name &ldquo;&lt;prefix&gt; Log&rdquo; and link it to the image named &ldquo;Log&rdquo;:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-AL" data-lang="AL">{<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">;</span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">Action</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Name=ActivityLog<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CaptionML=ENU=<span style="color:#4e9a06">&#39;Activity Log&#39;</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ToolTipML=ENU=<span style="color:#4e9a06">&#39;View the status and any errors if the document was sent as an electronic document or OCR file through the document exchange service.&#39;</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ApplicationArea=#Basic<span style="color:#000;font-weight:bold">,</span>#Suite<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Image=Log<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnAction=<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ActivityLog@<span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">710</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ActivityLog<span style="color:#ce5c00;font-weight:bold">.</span>ShowEntries<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">RECORDID</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>}<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p><strong>NAV usages</strong></p>
|
||
<p>In Dynamics NAV 2016, there is a new feature for sending documents in electronic format to a document exchange service. In this case, sending documents requires multiple steps as it is an asynchronous activity and as such, in order to keep track of what&rsquo;s happening and when the Activity Log functionality was used. That offers later the possibility to see who sent and when a document was sent, when it was dispatched, if any dispatch errors and how many tries have been made until the document was finally dispatched or rejected.</p>
|
||
<p>So as usages in NAV 2016, we have the document exchange and OCR features plus the related posted documents involved in the document exchange feature.</p>
|
||
<ul>
|
||
<li>COD1294.TXT</li>
|
||
<li>COD1410.TXT</li>
|
||
<li>PAG1270.TXT</li>
|
||
<li>PAG1275.TXT</li>
|
||
<li>PAG143.TXT</li>
|
||
<li>PAG144.TXT</li>
|
||
<li>PAG189.TXT</li>
|
||
<li>TAB112.TXT</li>
|
||
<li>TAB114.TXT</li>
|
||
<li>TAB130.TXT</li>
|
||
</ul>
|
||
<p><strong>Ideas for improvement</strong></p>
|
||
<p>Replace the scattered similar functionality (as mentioned above, we have several places having close functionality or similar requirements) with this new pattern.</p>
|
||
<p><strong>Consequences</strong></p>
|
||
<ul>
|
||
<li>Use with caution, similar to the Change Log functionality, as if the pattern will be used extensively in all the activities/operations within NAV, the table might become large containing many records and might cause some performance issues when presenting the data to the client (filtering on the specific activity).</li>
|
||
<li>Do not log private or confidential information (passwords, amounts, salaries, sensitive data), unless you are ok with this data to be showed to all users (even to users which normally would not have access to this data), thus overriding the permission sets.</li>
|
||
<li>Log only essential information (quality over quantity). Can the logged data be used to analyze the problem, or is it just junk data?</li>
|
||
</ul>
|
||
<p><strong>NAV Versions</strong></p>
|
||
<p>Supported from NAV 2016</p>
|
||
<p><strong>Related Topics</strong></p>
|
||
<p>Error Message Processing &ndash; provides a similar view and uses similar concepts: has a generic implementation (uses as link the same RECORDID feature) and uses same filtering functionality when displaying the data to the user.</p>
|
||
<p>Audit Log &ndash; as mentioned in the beginning, this pattern is a NAV specific implementation of the audit log pattern.</p></description></item><item><title>Docs: Argument Table</title><link>https://alguidelines.dev/docs/navpatterns/patterns/argument-table/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/argument-table/</guid><description>
|
||
<p><em>Originally By Nikola Kukrika and waldo</em></p>
|
||
<h3 id="abstract">Abstract</h3>
|
||
<p>The Argument Table pattern is used to provide an extension point for adding new arguments without changing the signature. By grouping multiple arguments into a table the code becomes more readable (function signature and the usage of the function).</p>
|
||
<p><a href="0218.Argument-Table-image.png"><img src="0218.Argument-Table-image.png" alt=" "></a></p>
|
||
<h3 id="problem">Problem</h3>
|
||
<p>In CAL overloading function signature is not supported. It is also not possible to provide default values for the function arguments.</p>
|
||
<p>When an argument needs to be added to the function, the existing function needs to be extracted to a new method with an additional argument and the original function will call new method. This will cause an upgrade problem in the future, since the entire body of the method is replaced.</p>
|
||
<p>Second commonly occurring problem is option duplication. In order to pass options often they are duplicated in the signature.</p>
|
||
<p>The last problem that can be solved is high number of arguments. Functions with a high number of arguments are hard to understand. Having arguments grouped within the table with a meaningful name will improve readability and make code easier to understanding.</p>
|
||
<p>Few examples of the bad implementations are as illustrated here:</p>
|
||
<h4 id="bad-example-1">Bad example 1</h4>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-AL" data-lang="AL"><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FillInVATReturnData@<span style="color:#0000cf;font-weight:bold">1200001</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DeclarationID@<span style="color:#0000cf;font-weight:bold">1200000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Code</span><span style="color:#f8f8f8;text-decoration:underline"> </span>[<span style="color:#0000cf;font-weight:bold">20</span>]<span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>LineID@<span style="color:#0000cf;font-weight:bold">1200001</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Code</span><span style="color:#f8f8f8;text-decoration:underline"> </span>[<span style="color:#0000cf;font-weight:bold">20</span>]<span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>PeerID@<span style="color:#0000cf;font-weight:bold">1200002</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Code</span><span style="color:#f8f8f8;text-decoration:underline"> </span>[<span style="color:#0000cf;font-weight:bold">20</span>]<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DocumentNo@<span style="color:#0000cf;font-weight:bold">1200003</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Code</span>[<span style="color:#0000cf;font-weight:bold">20</span>]<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>NumberOfCopies@<span style="color:#0000cf;font-weight:bold">1200007</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Uploaded@<span style="color:#0000cf;font-weight:bold">1200004</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Correction@<span style="color:#0000cf;font-weight:bold">1200005</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>HasValidationErr@<span style="color:#0000cf;font-weight:bold">1200006</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p><strong>Call</strong></p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-AL" data-lang="AL">FillInVATReturnData<span style="color:#ce5c00;font-weight:bold">(</span>NoSeries<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>NextLineID<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CustomerID<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DocumentNo<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SingleCopy<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>???<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>??<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">....</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">...)
|
||
</span></code></pre></div><p>In this example the code is hard to read and understand. Adding an additional argument will require refactoring of the existing function. Each time a new argument is added a new function will be created.</p>
|
||
<h4 id="bad-example-2">Bad example 2</h4>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-AL" data-lang="AL"><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GetTableSyncSetupW1@<span style="color:#0000cf;font-weight:bold">3</span><span style="color:#ce5c00;font-weight:bold">(</span>OldTableId@<span style="color:#0000cf;font-weight:bold">1002</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>UpgradeTableId@<span style="color:#0000cf;font-weight:bold">1001</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TableUpgradeMode@<span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;Check, Copy, Move, Force&#39;</span><span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">CASE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OldTableId<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">OF</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DATABASE</span><span style="color:#000;font-weight:bold">::</span>&#34;Sales Header&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SetTableSyncSetup<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span>TableUpgradeMode<span style="color:#000;font-weight:bold">::</span>Check<span style="color:#000;font-weight:bold">,</span>UpgradeTableId<span style="color:#000;font-weight:bold">,</span>TableUpgradeMode<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DATABASE</span><span style="color:#000;font-weight:bold">::</span>&#34;Posting Exch. Column Def&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SetTableSyncSetup<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">104025</span><span style="color:#000;font-weight:bold">,</span>TableUpgradeMode<span style="color:#000;font-weight:bold">::</span>Copy<span style="color:#000;font-weight:bold">,</span>UpgradeTableId<span style="color:#000;font-weight:bold">,</span>TableUpgradeMode<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DATABASE</span><span style="color:#000;font-weight:bold">::</span>&#34;Payment Export Data&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SetTableSyncSetup<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span>TableUpgradeMode<span style="color:#000;font-weight:bold">::</span>Force<span style="color:#000;font-weight:bold">,</span>UpgradeTableId<span style="color:#000;font-weight:bold">,</span>TableUpgradeMode<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ELSE</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span>FALSE<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span>TRUE<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>In this example each time a new argument is added all function calls will have to be updated. Option is duplicated in the signature, which will cause issues if a new option is defined or the existing options are renamed.</p>
|
||
<h3 id="solution">Solution</h3>
|
||
<p>By grouping the arguments within the table it is possible to add additional argument and reuse it where it is needed without changing the signature.</p>
|
||
<p>Multiple parameters are grouped within the single object with a meaningful name so the code becomes more readable.</p>
|
||
<p>It is possible to assign default values and to have the code validation.</p>
|
||
<p>Argument table should preferably be a temporary table since the implementation is simpler.</p>
|
||
<p>The examples of usages addressing problems shown above are:</p>
|
||
<h4 id="good-example-1">Good example 1</h4>
|
||
<p>New table</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-AL" data-lang="AL">TAB<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">50003</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VAT<span style="color:#f8f8f8;text-decoration:underline"> </span>Return<span style="color:#f8f8f8;text-decoration:underline"> </span>Data<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FillInVATReturnData@<span style="color:#0000cf;font-weight:bold">1200001</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VATReturnData@<span style="color:#0000cf;font-weight:bold">1200000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">50003</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>VATReturnData<span style="color:#ce5c00;font-weight:bold">.</span>INIT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>VATReturnData<span style="color:#ce5c00;font-weight:bold">.</span>NumberOfCopies<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GetDefaultNumberOfCopies<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>VATReturnData<span style="color:#ce5c00;font-weight:bold">.</span>Uploaded<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FALSE<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>FillInVATReturnData<span style="color:#ce5c00;font-weight:bold">(</span>VATReturnData<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>By introducing an argument table, code is much more readable since there is a single argument for a function. It is easy to see which arguments are passed in and which are modified in a function.</p>
|
||
<h4 id="good-example-2">Good example 2</h4>
|
||
<p>Good example</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-AL" data-lang="AL"><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GetTableSyncSetupW1@<span style="color:#0000cf;font-weight:bold">3</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TableSynchSetup@<span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">2000000135</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SetTableSyncSetup<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">DATABASE</span><span style="color:#000;font-weight:bold">::</span>&#34;Sales Header&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span>TableSynchSetup<span style="color:#ce5c00;font-weight:bold">.</span>Mode<span style="color:#000;font-weight:bold">::</span>Check<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SetTableSyncSetup<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">DATABASE</span><span style="color:#000;font-weight:bold">::</span>&#34;Posting Exch. Column Def&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#0000cf;font-weight:bold">104025</span><span style="color:#000;font-weight:bold">,</span>TableSynchSetup<span style="color:#ce5c00;font-weight:bold">.</span>Mode<span style="color:#000;font-weight:bold">::</span>Copy<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SetTableSyncSetup<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">DATABASE</span><span style="color:#000;font-weight:bold">::</span>&#34;Payment Export Data&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span>TableSynchSetup<span style="color:#ce5c00;font-weight:bold">.</span>Mode<span style="color:#000;font-weight:bold">::</span>Force<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>Option definition is not encapsulated within the table. Arguments are grouped and we can add additional arguments without the need to change the signature.</p>
|
||
<h3 id="downsides">Downsides</h3>
|
||
<p>You need to create one more table</p>
|
||
<p>Complex types can&rsquo;t be embedded as fields in tables (cannot have a record field type etc).</p>
|
||
<h3 id="nav-usages">NAV Usages</h3>
|
||
<p>Upgrade Codeunits</p>
|
||
<h3 id="related-patterns">Related Patterns</h3>
|
||
<p>Posting Routine, Select behavior: Setting fields on existing records in order not to change the signatures.</p></description></item><item><title>Docs: Blocked Entity</title><link>https://alguidelines.dev/docs/navpatterns/patterns/blocked-entity/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/blocked-entity/</guid><description>
|
||
<p><em>Originally by Abhishek Ghosh at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>The Blocked Entity is used when it is required to stop transactions for an entity (mostly master data), temporarily or permanently.</p>
|
||
<p><a href="2260.BlockedEntityPattern.png"><img src="2260.BlockedEntityPattern.png" alt=" "></a></p>
|
||
<h2 id="description">Description</h2>
|
||
<p>To block entities through metadata, read this pattern. To do the same thing through data, read <a href="https://alguidelines.dev/navpatterns/1-patterns/blocked-entity/data-driven-blocked-entity/">Data Driven Blocked Entity pattern</a>.</p>
|
||
<p>The business entity holds a state that controls if a given transaction is allowed. The state is used by the logic controlling transactions. The change of state could either be temporary or permanent.</p>
|
||
<p>An example of a temporary halt is when a retail chain selling items has received lot of complaints about an item, and the company wants to stop all transactions, both purchase and sale, with that item until the dealer has clarified the issue with his supplier and possibly received a replacement for the defective stock. Another common example is during counting the physical inventory using cycle counting where the counting is done in one section of a warehouse at a time, so that the regular operations can continue in the other parts of the warehouse. In these situations, it is necessary to block all transactions, such as picks and put-aways, for a bin while warehouse counting is in progress for that bin.</p>
|
||
<p>In contrast, a permanent halt to transactions could be required when an item has become obsolete (or is about to become obsolete), and the company wants to stop further purchase or sale of the item. However, the company wants to maintain the transaction history of the item and, therefore, does not want to delete the item record.</p>
|
||
<p>A simple design implementation of such requirements in Microsoft Dynamics NAV is to add a Blocked field in the entity table (and on the associated page). The implementation takes this state into the logic and checks for the value of this field in related transactions. For most simple scenarios, it is sufficient to have two states on the Blocked field, specifying whether it is allowed to perform transactions for the entity or not.</p>
|
||
<p>In certain situations, however, there could be different levels of blocking. For example, the company could block all sales to a customer that has overdue payments, and the company does not want to allow transactions with this customer until the payments are received. In other situations, the customer may have raised objections about an invoice, and the company has decided not to generate new invoices for the customer until the issue has been resolved. However, the company does want to continue shipping goods to the customer so as not to impact the customer&rsquo;s operations. In these scenarios, it may be necessary to have multiple states on the Blocked field depending on the level of restriction that is needed.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>As mentioned in the previous section, there are two implementations depending on business requirements: The 2-state Boolean field for simple implementations and the multi-state option field for more complex requirements. The implementation flow is similar for both patterns, except how the validation is implemented. The following discusses the two scenarios one by one.</p>
|
||
<h3 id="boolean-implementation">Boolean Implementation</h3>
|
||
<p>Add a Boolean field named Blocked in the table.</p>
|
||
<p>In the relevant logic, add a condition to check the status of the Blocked flag. The cheapest way is to use a TESTFIELD:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-AL" data-lang="AL">&lt;rec<span style="color:#f8f8f8;text-decoration:underline"> </span>variable\&gt;<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">TESTFIELD</span><span style="color:#ce5c00;font-weight:bold">(</span>Blocked<span style="color:#000;font-weight:bold">,</span>FALSE<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>Alternatively, you can throw a custom error message. However, you should only do that if the default error message thrown by TESTFIELD is not sufficient.</p>
|
||
<h3 id="option-field-implementation">Option-Field Implementation</h3>
|
||
<p>Add an option field named Blocked in the table. The option values will reflect the different blocked states required by the company.</p>
|
||
<p>Add this field on the card page (or on the List page if the entity does not have a card). As with the Boolean implementation, the convention is to add this field in the right-hand column in the General FastTab of the card page.</p>
|
||
<p>Implement a function in the table that takes the transaction context as input and evaluates the Blocked field to decide whether the transaction should be allowed or not. Optionally, the function can be responsible for notifying the user and bubble up an error message straight away.</p>
|
||
<p>Note: the option field assumes that only one of the multiple options can be active at a time. In other words, the options should be mutually exclusive.</p>
|
||
<p>How not to use the option field in this case: if we want to block an item from sale and/or purchase, the 4 combined options would be <strong>Block none</strong> | <strong>Block Sales</strong> | <strong>Block Purchases</strong> | <strong>Block Sales and Purchases</strong>. This doesn&rsquo;t scale, because if now we need to block another transaction, the number of option would grow too fast. In this situations, it is better to use two Boolean fields: <strong>Blocked Sale</strong>: <strong>true|false</strong> and <strong>Blocked Purchase: true|false</strong>.</p>
|
||
<p>A good example of usage would be for varying the behavior depending on the chosen option, for example by displaying a different error message depending on the reason an Item is blocked. In this case we can have the item <strong>Not Blocked</strong> | <strong>Blocked due to defect</strong> | <strong>Blocked waiting for approval</strong>, etc.</p>
|
||
<h2 id="nav-specific-example">NAV Specific Example</h2>
|
||
<h3 id="boolean-implementation-1">Boolean Implementation</h3>
|
||
<p><a href="8637.BlockedEntityPattern_5F00_5F00_5F00_Boolean.png"><img src="8637.BlockedEntityPattern_5F00_5F00_5F00_Boolean.png" alt=" "></a></p>
|
||
<p>An example of the Boolean implementation on the Item card.</p>
|
||
<p>In codeunit 22 &ndash; Item Jnl.-Post Line, the following lines of code have implemented a check based on the value of the Blocked field:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-AL" data-lang="AL"><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">NOT</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CalledFromAdjustment<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Item<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">TESTFIELD</span><span style="color:#ce5c00;font-weight:bold">(</span>Blocked<span style="color:#000;font-weight:bold">,</span>FALSE<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h3 id="option-field-implementation-1">Option-Field Implementation</h3>
|
||
<p><a href="3056.BlockedEntityPattern_5F00_5F00_5F00_Option.png"><img src="3056.BlockedEntityPattern_5F00_5F00_5F00_Option.png" alt=" "></a></p>
|
||
<p>An example of the option field implementation on the Customer card.</p>
|
||
<p>The CheckBlockedCustOnDocs and CheckBlockedCustOnJnls functions in the Customer table are responsible for validating the Blocked state with respect to the input document type. These functions are invoked in several areas, such as posting routines, where a status check on the Blocked field is required. This is a good practice where the Blocked implementation gets more complex, as this encourages reuse and ensures uniformity of implementation.</p>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>Entities where the Blocked Entity has been implemented include:</p>
|
||
<ul>
|
||
<li>Item</li>
|
||
<li>G/L Account</li>
|
||
<li>Customer</li>
|
||
<li>Vendor</li>
|
||
<li>Bin</li>
|
||
</ul>
|
||
<h2 id="related-topics">Related Topics</h2>
|
||
<p>The <a href="https://alguidelines.dev/navpatterns/1-patterns/released-entity/">Released Entity</a>.</p>
|
||
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;">
|
||
<iframe src="https://www.youtube.com/embed/O2R-fTSup1o" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" allowfullscreen title="YouTube Video"></iframe>
|
||
</div></description></item><item><title>Docs: Cached Web Server Calls</title><link>https://alguidelines.dev/docs/navpatterns/patterns/cached-web-service-calls/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/cached-web-service-calls/</guid><description>
|
||
<p><em>Originally by Mostafa Balat, Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>In a service-oriented deployment, web services are used to extend NAV&rsquo;s functionality and reach. Depending on how volatile this data is and the corresponding usage scheme, it is expected to be up-to-date within a pre-defined period of time (e.g. once a day).</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>When NAV is integrated with external services, then the user scenarios become dependent on the data and functions offered by such services. Eventually, there are different approaches through which the external data can be retrieved, stored and used.</p>
|
||
<ul>
|
||
<li>Dynamic: either exposed by the external service itself or by a separate catalog that NAV can query.
|
||
<ul>
|
||
<li>Advantage: data is always up-to-date</li>
|
||
<li>Disadvantage: it requires constant connection to the data source.</li>
|
||
</ul>
|
||
</li>
|
||
<li>Static: hard-coded in the database for the user to benefit from.
|
||
<ul>
|
||
<li>Advantage: data is promptly available when needed.</li>
|
||
<li>Disadvantage: if data changes at some point, it will require a maintenance effort, which exposes the business process to a risk of failure.</li>
|
||
</ul>
|
||
</li>
|
||
<li>Cached: offered through an external service and gets pulled according to a pre-defined refresh rate or manually.
|
||
<ul>
|
||
<li>Advantage: data is &lsquo;up-to-date&rsquo; within the rules acceptable by the business process, without extra load on the network resources or the external service.</li>
|
||
<li>Disadvantage: if data changes while the auto-refresh did not happen yet, the user may not have access to the latest data; however, the user can manually force a refresh of the data, if asked to do so.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id="when-to-use-it">When to Use It</h3>
|
||
<p>Offer data in lookups that were cached from an external service.</p>
|
||
<h3 id="diagram">Diagram</h3>
|
||
<p><a href="Cached_5F00_Web_5F00_Service_5F00_Calls_5F00_Diagram.png"><img src="Cached_5F00_Web_5F00_Service_5F00_Calls_5F00_Diagram.png" alt=" "></a></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>Set up an NAV feature to consume the data from an external service. Refresh the data on a pre-defined refresh rate (e.g. once a day) or when enforced by a power user or an admin. Cache the data in a table and offer it in lookups, as applicable.</p>
|
||
<h2 id="nav-specific-example">NAV Specific Example</h2>
|
||
<h3 id="overview">Overview</h3>
|
||
<p><strong>PAG1259 Bank Name - Data Conv. List</strong> offers the required functionality to refresh and display the list of bank names needed to specify which file format to convert to. The page can be accessed from <strong>PAG1260 Bank Data Conv. Service Setup</strong> to display all available bank names. It is also used as a lookup on <strong>PAG370 Bank Account Card</strong>, where it offers a filtered view of the cached bank names based on the Country/Region Code field.</p>
|
||
<p>If <strong>PAG1259 Bank Name - Data Conv. List</strong> is being open and the cached data is &lsquo;old&rsquo;, it refreshes the cache. The cached data is stored in <strong>TAB1259 Bank Data Conv. Bank</strong>. Meanwhile, the user has the chance to refresh the data using</p>
|
||
<h3 id="code-sample">Code Sample</h3>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-AL" data-lang="AL">OnInit=<span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ShortTimeout<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">5000</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>LongTimeout<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">30000</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>OnOpenPage=<span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BankDataConvBank@<span style="color:#0000cf;font-weight:bold">1002</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1259</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ImpBankListExtDataHndl@<span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1289</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CountryRegionCode@<span style="color:#0000cf;font-weight:bold">1004</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>HideErrors@<span style="color:#0000cf;font-weight:bold">1003</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CountryRegionCode<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>IdentifyCountryRegionCode<span style="color:#ce5c00;font-weight:bold">(</span>Rec<span style="color:#000;font-weight:bold">,</span>GETFILTER<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Country/Region Code&#34;<span style="color:#ce5c00;font-weight:bold">))</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BankDataConvBank<span style="color:#ce5c00;font-weight:bold">.</span>ISEMPTY<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ImpBankListExtDataHndl<span style="color:#ce5c00;font-weight:bold">.</span>GetBankListFromConversionService<span style="color:#ce5c00;font-weight:bold">(</span>HideErrors<span style="color:#000;font-weight:bold">,</span>CountryRegionCode<span style="color:#000;font-weight:bold">,</span>ShortTimeout<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>RefreshBankNamesOlderThanToday<span style="color:#ce5c00;font-weight:bold">(</span>CountryRegionCode<span style="color:#000;font-weight:bold">,</span>HideErrors<span style="color:#000;font-weight:bold">,</span>ShortTimeout<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>OnAction=<span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ImpBankListExtDataHndl@<span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1289</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FilterNotUsed@<span style="color:#0000cf;font-weight:bold">1001</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ShowErrors@<span style="color:#0000cf;font-weight:bold">1003</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ShowErrors<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TRUE<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ImpBankListExtDataHndl<span style="color:#ce5c00;font-weight:bold">.</span>GetBankListFromConversionService<span style="color:#ce5c00;font-weight:bold">(</span>ShowErrors<span style="color:#000;font-weight:bold">,</span>FilterNotUsed<span style="color:#000;font-weight:bold">,</span>LongTimeout<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>IdentifyCountryRegionCode@<span style="color:#0000cf;font-weight:bold">1</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BankDataConvBank@<span style="color:#0000cf;font-weight:bold">1002</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1259</span><span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">Filter</span>@<span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CompanyInformation@<span style="color:#0000cf;font-weight:bold">1001</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">79</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BlankFilter@<span style="color:#0000cf;font-weight:bold">1003</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BlankFilter<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;&#39;&#39;&#39;&#39;</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Filter</span><span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span>BlankFilter<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CompanyInformation<span style="color:#ce5c00;font-weight:bold">.</span>GET<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BankDataConvBank<span style="color:#ce5c00;font-weight:bold">.</span>SETFILTER<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Country/Region Code&#34;<span style="color:#000;font-weight:bold">,</span>CompanyInformation<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Country/Region Code&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span>BankDataConvBank<span style="color:#ce5c00;font-weight:bold">.</span>GETFILTER<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Country/Region Code&#34;<span style="color:#ce5c00;font-weight:bold">))</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">Filter</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>RefreshBankNamesOlderThanToday@<span style="color:#0000cf;font-weight:bold">5</span><span style="color:#ce5c00;font-weight:bold">(</span>CountryRegionCode@<span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#000;font-weight:bold">;</span>ShowErrors@<span style="color:#0000cf;font-weight:bold">1002</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#000;font-weight:bold">;</span>Timeout@<span style="color:#0000cf;font-weight:bold">1004</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BankDataConvBank@<span style="color:#0000cf;font-weight:bold">1001</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1259</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ImpBankListExtDataHndl@<span style="color:#0000cf;font-weight:bold">1003</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1289</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CountryRegionCode<span style="color:#f8f8f8;text-decoration:underline"> </span>&lt;&gt;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BankDataConvBank<span style="color:#ce5c00;font-weight:bold">.</span>SETFILTER<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Country/Region Code&#34;<span style="color:#000;font-weight:bold">,</span>CountryRegionCode<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BankDataConvBank<span style="color:#ce5c00;font-weight:bold">.</span>SETFILTER<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Last Update Date&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;&lt;%1&#39;</span><span style="color:#000;font-weight:bold">,</span>TODAY<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BankDataConvBank<span style="color:#ce5c00;font-weight:bold">.</span>FINDFIRST<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ImpBankListExtDataHndl<span style="color:#ce5c00;font-weight:bold">.</span>GetBankListFromConversionService<span style="color:#ce5c00;font-weight:bold">(</span>ShowErrors<span style="color:#000;font-weight:bold">,</span>CountryRegionCode<span style="color:#000;font-weight:bold">,</span>Timeout<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h2 id="nav-usages">NAV Usages</h2>
|
||
<p>Bank name lookup on the Bank Account card for dynamically identifying the format to use to generate a bank-specific payment file.</p>
|
||
<h2 id="ideas-for-improvement">Ideas for Improvement</h2>
|
||
<p>Expose the refresh rate through a setup table to make it easily configurable without changing the code.</p></description></item><item><title>Docs: Conditional Cascading Update</title><link>https://alguidelines.dev/docs/navpatterns/patterns/conditional-cascading-update/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/conditional-cascading-update/</guid><description>
|
||
<p><em>Originally by Jan Hoek at IDYN</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>The Conditional Cascading Update pattern is used to intelligently populate fields whose values depend on other field values. In this pattern description, the field triggering the update will be called &ldquo;source field&rdquo;, and the depending field will be called &ldquo;target field&rdquo;.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>The value of one table field sometimes depends on the value of another field, typically following an application-defined transformation (note that we&rsquo;re talking about transformations of field values here. This has nothing to do with e.g. form transformation), such as conversion to uppercase, removal of certain characters etc.</p>
|
||
<p>If the target field is non-editable, said transformation is usually the only way for the target field to receive new values, so no irreproducible information can be lost. However, if the target field is editable, the user may have cared enough to override the default (transformed) value, in which case revalidating the source field should not blindly replace the target field&rsquo;s value.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>In the OnValidate trigger of the source field, test if the target field value is either blank, or equal to the transformed value of the source field&rsquo;s previous contents. If it is, populate the target field&rsquo;s value with the transformed source field value. If it is not, do nothing (effectively preserving the value set by the user).</p>
|
||
<h2 id="nav-specific-example">NAV Specific Example</h2>
|
||
<p>In the base application, this pattern can be found in Search Name/Search Description fields, which are updated with the uppercase value from the corresponding Name/Description field when the latter is validated, only if the Search Name/Description in question is currently blank, or equal to the (uppercase equivalent) of the previous contents of the Name/Description field.</p>
|
||
<p><a href="3124.T18_5F00_Name_5F00_OnValidate.png"><img src="3124.T18_5F00_Name_5F00_OnValidate.png" alt=" "></a></p>
|
||
<p>In this particular case, the transformation between source and target fields is implicit and due to the different data types of the fields (text vs. code). Note how the field triggers of the Search Name field itself do not contain any logic linked to this pattern.</p>
|
||
<h2 id="consequences">Consequences</h2>
|
||
<p>There is a case when this pattern should not be used. If the target field is non-editable, this pattern will not add any value, since there won&rsquo;t be any user-overridden values to protect.</p></description></item><item><title>Docs: Copy Document</title><link>https://alguidelines.dev/docs/navpatterns/patterns/copy-document/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/copy-document/</guid><description>
|
||
<p><em>By Bogdan Sturzoiu at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>The goal of the Copy Document pattern is to create a replica of an existing open or closed document (posted or not posted), by moving the lines and, optionally, the header information from the source document to a destination document.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>Documents are widely used by most of our customers. Many times, a significant portion of these documents are similar to each other, either by sharing the same customer, vendor, type, or line structure. Being able to re-use a document as a base for creating a new one is therefore an important means of saving time.</p>
|
||
<p>Other business scenarios require that a newly created document is applied to an existing document. For example, in returns management, a return order can be the reversal of an existing order and can therefore be copied from the original order. Other times, there is even a legal requirement to match the document to its source. For example, credit memos need to be applied to the originating Invoice.</p>
|
||
<p>For these reasons, NAV supports the copying of documents as a method to re-use or link documents.</p>
|
||
<p>The Copy Document functionality is used in the following situations:</p>
|
||
<ul>
|
||
<li>The user wants to create a new open sales document (Quote, Order, Blanket Order, Invoice, Return Order, Credit Memo) based on an existing posted or non-posted sales document (Quote, Blanket Order, Order, Invoice, Return Order, Credit Memo, Posted Shipment, Posted Invoice, Posted Return Receipt, Posted Credit Memo).</li>
|
||
<li>The user wants to create a new open purchase document (Quote, Order, Blanket Order, Invoice, Return Order, Credit Memo) based on an existing posted or non-posted purchase document (Quote, Blanket Order, Order, Invoice, Return Order, Credit Memo, Posted Shipment, Posted Invoice, Posted Return Receipt, Posted Credit Memo).</li>
|
||
<li>The user wants to create a new production order (Simulated, Planned, Firm Planned or Released) based on an existing production order (Simulated, Planned, Firm Planned, Released or Finished).</li>
|
||
<li>The user wants to create a new assembly order based on an existing assembly document (Quote, Blanket Order, Order and Posted Order).</li>
|
||
<li>The user wants to create a new service contract or quote based on an existing service contract or quote.</li>
|
||
<li>The user wants to create all relevant return-related documents. For example, from a sales return order, the user can recreate the involved supply chain documentation, by copying the information upwards to a purchase return order (if the items need to be returned to the vendor), purchase order (if the items need to be reordered), and sales order (if the items need to be re-sent to the customer).</li>
|
||
</ul>
|
||
<p><strong>Note</strong></p>
|
||
<ul>
|
||
<li>Not all to and from combinations are allowed. For example, you can only copy to open document types, since the posted documents are not editable.</li>
|
||
<li>The destination document needs to have the header fully created. For example, a Sales Order will need to have the Sell-To Customer No. populated.</li>
|
||
</ul>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>The Dynamics NAV application developer can take into account using the Copy Document design pattern when they have requirements such as:</p>
|
||
<ul>
|
||
<li>To provide a quick and efficient way of moving content from a document to another.</li>
|
||
<li>To allow reusing the document history as a template for new documents.</li>
|
||
<li>To allow linking of documents that need to be applied to each other.</li>
|
||
</ul>
|
||
<p>The Copy Document pattern involves the following entities:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Source document tables for document header and line. For example,Sales Header/Line.</p>
|
||
</li>
|
||
<li>
|
||
<p>Destination document tables for document header and line.<br>
|
||
<strong>Note:</strong> The source document header/line and destination document header/line tables do not need to be the same. For example, you can copy a Sales Shipment Header/Lines into a Sales Header/Lines.</p>
|
||
</li>
|
||
<li>
|
||
<p>Copy Document engine: COD6620, Copy Document Mgt.</p>
|
||
</li>
|
||
<li>
|
||
<p>Copy Document report for a specific document type. The report requires the following parameters:</p>
|
||
</li>
|
||
</ol>
|
||
<ul>
|
||
<li>Source Document Type</li>
|
||
<li>Source Document No.</li>
|
||
<li>Include Header (optional)</li>
|
||
<li>Recalculate Lines (optional)</li>
|
||
</ul>
|
||
<p>Example: REP901, Copy Assembly Document</p>
|
||
<p><a href="clip_image002.gif-750x0.png"><img src="clip_image002.gif-750x0.png" alt=" "></a></p>
|
||
<h2 id="usage-sequence">Usage Sequence</h2>
|
||
<p><strong>Precondition</strong>: The user creates a new destination document Header, filling up the required information.</p>
|
||
<p><strong>Step 1</strong>: The user runs the Copy Document report (element no. 4), filling up the parameters:</p>
|
||
<ul>
|
||
<li>Source Document Type</li>
|
||
<li>Source Document No.</li>
|
||
<li>Include Header and/or Recalculate Lines (not all Copy Document reports have these).</li>
|
||
</ul>
|
||
<p><strong>Step 2</strong>: The report copies the information in the source tables (Header and Line) into the destination tables (Header and Line).</p>
|
||
<p><strong>Post processing</strong>: The user performs additional editing of the destination document.</p>
|
||
<p>The sequence flow of the pattern is described in the following diagram.</p>
|
||
<p><a href="clip_image004.gif-750x0.png"><img src="clip_image004.gif-750x0.png" alt=" "></a></p>
|
||
<p>Example: Copy Sales Document for Credit Memos.</p>
|
||
<p>In the standard version of Microsoft Dynamics NAV, the Copy Document functionality is implemented in the Sales Credit Memo window as shown in the following section.</p>
|
||
<hr>
|
||
<p><strong>Precondition</strong>: The user enters data in PAGE44, Sales Credit Memo.</p>
|
||
<p><a href="clip_5F00_image006.jpg"><img src="clip_5F00_image006.jpg" alt=" "></a></p>
|
||
<p><strong>Step 1</strong>: The user runs REP292, Copy Sales Document from the Sales Credit Memo window, populating the required parameters. The Include Header and Recalculate Lines fields are selected.</p>
|
||
<p><a href="clip_5F00_image008.jpg"><img src="clip_5F00_image008.jpg" alt=" "></a></p>
|
||
<p><strong>Step 2</strong>: The Sales Credit Memo window is populated with information from the source sales document.</p>
|
||
<p><a href="clip_5F00_image010.jpg"><img src="clip_5F00_image010.jpg" alt=" "></a></p>
|
||
<p><strong>Post processing</strong>: The user can now do additional editing of the sales credit memo.</p>
|
||
<h1 id="nav-implementations">NAV Implementations</h1>
|
||
<ol>
|
||
<li>Copy Sales Document (REP292)</li>
|
||
<li>Copy Purchase Document (REP492)</li>
|
||
<li>Copy Service Document (REP5979)</li>
|
||
<li>Copy Assembly Document (REP901)</li>
|
||
</ol>
|
||
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;">
|
||
<iframe src="https://www.youtube.com/embed/aTiwroXwW0" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" allowfullscreen title="YouTube Video"></iframe>
|
||
</div></description></item><item><title>Docs: Create Data from Templates</title><link>https://alguidelines.dev/docs/navpatterns/patterns/create-data-from-templates/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/create-data-from-templates/</guid><description>
|
||
<p><em>Originally by Nikola Kukrika at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>For many records, such as Items, Customers, and Vendors, users have to enter the same sets of data again and again. This is tedious, error-prone (users forget to enter a field or they choose the wrong group), and difficult to learn for some users.</p>
|
||
<p>We can group sets of data as templates to speed up and simplify the process of entering data in Microsoft Dynamics NAV. For example, the process of creating a new customer could be simplified so that users only have to enter information that is specific for every individual customer, e.g. Name and Address/Contact.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>This pattern solves the problem of creating new records based on their type. You should use it whenever there is a large set of data that could be grouped in a meaningful way.</p>
|
||
<p>In Microsoft Dynamics NAV 2013 R2, we have extended the Configuration Templates feature so that templates can be used in different languages than the language they were created in. We have also added the ability to set related templates so that related records can be inserted, such as dimensions for customers, items, and vendors.</p>
|
||
<p>The pattern consists of two parts:</p>
|
||
<p>1. Using templates to create new records or applying templates to existing records</p>
|
||
<p>2. Defining and updating existing templates</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p><a href="4118.Picture1.png"><img src="4118.Picture1.png" alt=" "></a></p>
|
||
<p>Using the patterns involves three steps.</p>
|
||
<ol>
|
||
<li>
|
||
<p>As a first step, we must insert a record. This can be done either through C/AL code or by letting the user create a record using the <strong>New</strong> action.</p>
|
||
</li>
|
||
<li>
|
||
<p>After the record is created, we must apply the template. This is done by using the <strong>UpdateRecord</strong> function in the <strong>Config. Template Management</strong> codeunit (8612).</p>
|
||
</li>
|
||
</ol>
|
||
<p><strong>Config. Template Lines</strong> records reference one <strong>Config. Template Header</strong> record (lines pattern). The lines can be of type:</p>
|
||
<ul>
|
||
<li><strong>Field</strong> - Stores a field value that will be applied to the record</li>
|
||
<li><strong>Related</strong> Template &ndash; References a Config. Template Header record for a related template.</li>
|
||
</ul>
|
||
<p>The <strong>UpdateRecord</strong> function applies values to the record one line at the time. One of the requirements was to be possible to use configuration templates in different language/regional settings than the template was created in.</p>
|
||
<p>To support this scenario, when applying the <strong>Config. Template Line</strong> record, <strong>GLOBALLANGUAGE</strong> is set to the language ID of the field. This is important because the default value is stored as text, so we need to use the same formatting that NAV was running on when the template was created. Otherwise, data types, such as Boolean, Date, etc., will raise validation errors.</p>
|
||
<p>Any updates to a <strong>Config. Template Line</strong> record will automatically update the language ID to the current one. Since lines are applied one by one, it is supported to have lines with different language IDs belonging to the same template.</p>
|
||
<ol start="3">
|
||
<li>After we have applied the template to the record, we can insert related templates. For example, when you insert an item, you may want to insert dimensions as well. You must implement the logic to apply or then modify the related templates, since this depends on the logic and the relationship between the records. Lines with <strong>Type = Related Template</strong> are used to reference related templates.</li>
|
||
</ol>
|
||
<p>Code example (Insert a record, apply a template, and insert the related templates):</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#8f5902;font-style:italic">// First insert a record Customer.INSERT(TRUE);
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#8f5902;font-style:italic">// Apply a template RecRef.GETTABLE(Customer);
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>ConfigTemplateMgt<span style="color:#ce5c00;font-weight:bold">.</span>UpdateRecord<span style="color:#ce5c00;font-weight:bold">(</span>ConfigTemplateHeader<span style="color:#000;font-weight:bold">,</span>RecRef<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>RecRef<span style="color:#ce5c00;font-weight:bold">.</span>SETTABLE<span style="color:#ce5c00;font-weight:bold">(</span>Customer<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#8f5902;font-style:italic">// Insert Dimensions -- related templates
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>MiniDimensionsTemplate<span style="color:#ce5c00;font-weight:bold">.</span>InsertDimensionsFromTemplates<span style="color:#ce5c00;font-weight:bold">(</span>ConfigTemplateHeader<span style="color:#000;font-weight:bold">,</span>Customer<span style="color:#ce5c00;font-weight:bold">.</span>&#34;No.&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#204a87;font-weight:bold">DATABASE</span><span style="color:#000;font-weight:bold">::</span>Customer<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>Code to insert related templates (dimensions):</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">FUNCTION</span><span style="color:#f8f8f8;text-decoration:underline"> </span>InsertDimensionsFromTemplates<span style="color:#ce5c00;font-weight:bold">(</span>ConfigTemplateHeader<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Config. Template Header&#34;<span style="color:#000;font-weight:bold">;</span>MasterRecordNo<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Code</span>[<span style="color:#0000cf;font-weight:bold">20</span>]<span style="color:#000;font-weight:bold">;</span>TableID<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span><span style="color:#8f5902;font-style:italic">// There are multiple records (multiple dimensions per master record)
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// We have to set filter
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span>ConfigTemplateLine<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">Type</span><span style="color:#000;font-weight:bold">,</span>ConfigTemplateLine<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">Type</span><span style="color:#000;font-weight:bold">::</span>&#34;Related Template&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ConfigTemplateLine<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Data Template Code&#34;<span style="color:#000;font-weight:bold">,</span>ConfigTemplateHeader<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">Code</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ConfigTemplateLine<span style="color:#ce5c00;font-weight:bold">.</span>FINDSET<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">REPEAT</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ConfigTemplateHeader<span style="color:#ce5c00;font-weight:bold">.</span>GET<span style="color:#ce5c00;font-weight:bold">(</span>ConfigTemplateLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Template Code&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// Ensure that the table where the template belongs to is Dimensions
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// We could have other related templates
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ConfigTemplateHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Table ID&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DATABASE</span><span style="color:#000;font-weight:bold">::</span>&#34;Default Dimension&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>InsertDimensionFromTemplate<span style="color:#ce5c00;font-weight:bold">(</span>ConfigTemplateHeader<span style="color:#000;font-weight:bold">,</span>MasterRecordNo<span style="color:#000;font-weight:bold">,</span>TableID<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">UNTIL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ConfigTemplateLine<span style="color:#ce5c00;font-weight:bold">.</span>NEXT<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#8f5902;font-style:italic">// Create a new Dimensions Record and link it to the Master Record
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#204a87;font-weight:bold">FUNCTION</span><span style="color:#f8f8f8;text-decoration:underline"> </span>InsertDimensionFromTemplate<span style="color:#ce5c00;font-weight:bold">(</span>ConfigTemplateHeader<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Config. Template Header&#34;<span style="color:#000;font-weight:bold">;</span>MasterRecordNo<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Code</span>[<span style="color:#0000cf;font-weight:bold">20</span>]<span style="color:#000;font-weight:bold">;</span>TableID<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span>DefaultDimension<span style="color:#ce5c00;font-weight:bold">.</span>INIT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DefaultDimension<span style="color:#ce5c00;font-weight:bold">.</span>&#34;No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MasterRecordNo<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DefaultDimension<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Table ID&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TableID<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DefaultDimension<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Dimension Code&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GetDefaultDimensionCode<span style="color:#ce5c00;font-weight:bold">(</span>ConfigTemplateHeader<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DefaultDimension<span style="color:#ce5c00;font-weight:bold">.</span>INSERT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>RecRef<span style="color:#ce5c00;font-weight:bold">.</span>GETTABLE<span style="color:#ce5c00;font-weight:bold">(</span>DefaultDimension<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ConfigTemplateMgt<span style="color:#ce5c00;font-weight:bold">.</span>UpdateRecord<span style="color:#ce5c00;font-weight:bold">(</span>ConfigTemplateHeader<span style="color:#000;font-weight:bold">,</span>RecRef<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>RecRef<span style="color:#ce5c00;font-weight:bold">.</span>SETTABLE<span style="color:#ce5c00;font-weight:bold">(</span>DefaultDimension<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p><strong>To surface the action in the product, you have three options:</strong></p>
|
||
<ol>
|
||
<li><strong>Recommended</strong> - Implement a separate action called <strong>New from Template</strong>.</li>
|
||
<li><strong>Optional</strong> - Implement the apply template function on the document itself. This is especially good in scenarios where users are allowed to change the template.</li>
|
||
<li><strong>Alternative</strong> - Remove the new action by configuration or set Insert Allowed to FALSE on the list (this will block the creation of new records from the lookup). Implement an application action named <strong>New</strong> and tie it to your code.</li>
|
||
</ol>
|
||
<p><strong>Note:</strong> In Microsoft Dynamics C5 2014, we chose to remove the <strong>New</strong> action with configuration since we wanted to promote the functionality and avoid the confusion in having too many options. However this might be difficult to maintain with a larger set of pages.</p>
|
||
<p><strong>To view or edit templates, you have two options:</strong></p>
|
||
<ol>
|
||
<li>Use the <strong>Config. Template List</strong> table (8620) and the <strong>Config. Template Header Card</strong> table (8618).</li>
|
||
</ol>
|
||
<p>This is a generic solution that is not very usable and is error-prone (no lookups, checks for length, table relation checks, etc.) The default value is a text field of 250 characters, which might be much more than the field length, and may lead to validation errors when used. Users will most likely not be able to use this page.</p>
|
||
<p><a href="2816.Picture3.png"><img src="2816.Picture3.png" alt=" "></a></p>
|
||
<p>2. Implement custom pages resembling the document.</p>
|
||
<p>This is optional if you want to enable the users to create and modify templates. In C5 2014, we created temporary tables with the same fields as the main record. Based on this temporary record, we built a page that resembles a document.</p>
|
||
<p>Example of the <strong>Customer Template</strong> page:</p>
|
||
<p><a href="7271.Picture4.png"><img src="7271.Picture4.png" alt=" "></a></p>
|
||
<p>The goals of this solution were:</p>
|
||
<ul>
|
||
<li>To make the setup page resemble a document page so that it is easy to use with basic validation and lookups.</li>
|
||
<li>To have only one place to store templates and maintain only one business logic for applying them, namely in the <strong>Configuration Template Header</strong> table.</li>
|
||
<li>To avoid any lateral effects of doing validation on the temporary master record. Doing validation on fields, even though the record itself is temporary, could permanently modify other data in the database. For example, if you insert a new record in the <strong>Customer</strong> table, even in a temporary table, a Contact record is created, which will not be temporary.</li>
|
||
<li>Testability: It is easy to test through RecordRef that the template table matches the main table. We can compare field lengths, data types, table relations, etc. The test is able to detect that they are out of sync, so it is easy to prevent errors.</li>
|
||
</ul>
|
||
<p>One example in the product is the <strong>Mini Customer Template</strong> table (1300).</p>
|
||
<p>The table itself contains very little code. OnModify, OnInsert, and OnDelete triggers update the <strong>Configuration Header</strong> and <strong>Configuration Lines</strong> tables. The following functions in the <strong>Config. Template Management</strong> codeunit (8612), are used for this:</p>
|
||
<ul>
|
||
<li>ConfigTemplateManagement.CreateConfigTemplateAndLines</li>
|
||
<li>ConfigTemplateManagement.UpdateConfigTemplateAndLines</li>
|
||
<li>ConfigTemplateManagement.DeleteRelatedTemplates</li>
|
||
</ul>
|
||
<p>The CreateFieldRefArray function is used as an interface function on all the temporary template tables. It builds data to be read/written to the configuration templates.</p>
|
||
<p>To further enhance the usability, we have provided the following additional functionality:</p>
|
||
<ul>
|
||
<li>Create a template from the existing record: The user opens an existing record and creates a template from that record. All the fields that are defined in the CreateFieldRefArray function are used to create the new template.</li>
|
||
<li>Templates list: This page is used by users to select templates or create new ones. Depending on which templates they are working on, we show different template cards.</li>
|
||
</ul>
|
||
<h2 id="nav-specific-example">NAV Specific Example</h2>
|
||
<p>In C5 2014, this is the workflow:</p>
|
||
<p>The user opens the <strong>Customers List</strong> window and selects <strong>New</strong></p>
|
||
<p><a href="4341.Picture4.png"><img src="4341.Picture4.png" alt=" "></a></p>
|
||
<p>From this page, the user can view the template, edit it, or create a new one. Selecting a template will populate the customer card and open a new record. From the existing record, the user has options to save as a template or opening a list of templates to maintain available templates. Selecting a template will populate the customer card and open a new record. From the existing record, the user has options to save as a template or opening a list of templates to maintain available templates.</p>
|
||
<p><a href="3482.Picture-5.png"><img src="3482.Picture-5.png" alt=" "></a></p>
|
||
<p>From the <strong>Customer Card Template</strong> window, we can invoke the <strong>Dimensions</strong> action, through which we can define the dimensions that will be inserted together with the template:</p>
|
||
<p><a href="2134.Picture6.png"><img src="2134.Picture6.png" alt=" "></a></p>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>This pattern is used in Microsoft Dynamics C5 2014 in the following objects:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Temporary template tables:</p>
|
||
<ul>
|
||
<li><strong>Mini Customer Template</strong> table (1300)</li>
|
||
<li><strong>Mini Item Template</strong> table (1301)</li>
|
||
<li><strong>Mini Dimensions Template</strong> table(1302)</li>
|
||
<li><strong>Mini Vendor Template</strong> table (1303)</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Pages to define templates:</p>
|
||
<ul>
|
||
<li><strong>Mini Customer Template Card</strong> page (1341)</li>
|
||
<li><strong>Mini Item Template Card</strong> page (,1342)</li>
|
||
<li><strong>Mini Dimensions Template List</strong> page (1343)</li>
|
||
<li><strong>Mini Vendor Template Card</strong> page (1344)</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Pages that use the templates:</p>
|
||
<ul>
|
||
<li><strong>Mini Customer List</strong> page (1301)</li>
|
||
<li><strong>Mini Item List</strong> page ( 1303)</li>
|
||
<li><strong>Mini Vendor List</strong> page (1331)</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p>In the standard version of Microsoft Dynamics NAV, we use the <strong>Apply Template</strong> action on the following pages:</p>
|
||
<ul>
|
||
<li><strong>Customer Card</strong> page (21)</li>
|
||
<li><strong>Vendor Card</strong> page (26)</li>
|
||
<li><strong>Item Card</strong> page (30)</li>
|
||
<li><strong>Resource Card</strong> page (, 76)</li>
|
||
<li>Other similar cards.</li>
|
||
</ul>
|
||
<h2 id="ideas-for-improvement">Ideas for improvement</h2>
|
||
<p>Implement the solution in the standard version of Microsoft Dynamics NAV and extend the Apply Template functionality to insert dimensions.</p>
|
||
<p>It is possible that users end up with a large number of templates if they need many different data combinations. An improvement could be to split templates into smaller groups, grouping only part of the fields that are related, and then apply only these.</p>
|
||
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;">
|
||
<iframe src="https://www.youtube.com/embed/F0CTvoyKSmI" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" allowfullscreen title="YouTube Video"></iframe>
|
||
</div></description></item><item><title>Docs: Create URLs to NAV Clients</title><link>https://alguidelines.dev/docs/navpatterns/patterns/create-urls-to-nav-clients/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/create-urls-to-nav-clients/</guid><description>
|
||
<p><em>By Mike Borg Cardona and Bogdana Botez at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>This article illustrates NAV platform functionality to be used by C/AL developers.</p>
|
||
<p>The URL builder function, GETURL, is released in Microsoft Dynamics NAV 2013 R2 to reduce coding time for developers who need to create various URL strings to run application objects in either the win client, the web client, or on web services. In addition, the GETURL function makes multitenancy features more transparent to C/AL developers.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>Ever had to construct win client URLs like the one below?</p>
|
||
<p>dynamicsnav://myserver:7046/myInstance/myCompany/runpage?page=26</p>
|
||
<p>Today, Microsoft Dynamics NAV also provides a web client. This means that you must update your code to construct web client URLs too. What about multitenancy? The URL Builder should know if it is running in a multitenant setup and it should know how to choose the right tenant. What about maintaining this code?</p>
|
||
<p>The good news is that GETURL has been introduced to handle all URL building for you.</p>
|
||
<p>GETURL automatically handles:</p>
|
||
<ul>
|
||
<li>Multitenancy</li>
|
||
<li>Correct URL format for each client</li>
|
||
<li>Publicly accessible hostnames.</li>
|
||
</ul>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>The format is:</p>
|
||
<p>[String :=] GETURL(ClientType[, Company][, Object Type][, Object Id][, Record])</p>
|
||
<p>Where:</p>
|
||
<ul>
|
||
<li><strong>Client Type</strong> can be: Current, Default, Windows, Web, SOAP, or OData. This enables a range of scenarios for the C/AL developer, such as moving to the web client without changing code to decide where the URL should point to. This is done either by setting Client Type to Current, and just ensuring that web is used to invoke the link creation, or by setting Client Type to Default and changing its value to Web when it is ready to move to the web platform.</li>
|
||
<li><strong>Object Type</strong> and <strong>Object ID</strong> define the type of the application object to run (Table, Page, Report, Codeunit, Query, or XMLport) and its ID.</li>
|
||
<li><strong>Record</strong> specifies the actual data to run the URL on, such as:</li>
|
||
</ul>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">Vendor<span style="color:#ce5c00;font-weight:bold">.</span>GET<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Account No.&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>GETURL<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">CLIENTTYPE</span><span style="color:#000;font-weight:bold">:</span>WEB<span style="color:#000;font-weight:bold">,</span>COMPANYNAME<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">OBJECTTYPE</span><span style="color:#000;font-weight:bold">::</span><span style="color:#204a87;font-weight:bold">Page</span><span style="color:#000;font-weight:bold">,</span><span style="color:#0000cf;font-weight:bold">27</span><span style="color:#000;font-weight:bold">,</span>Vendor<span style="color:#ce5c00;font-weight:bold">)
|
||
</span></code></pre></div><p><strong>Note</strong>: It is currently not possible to set filters on the record that you sent as a last parameter to the GETURL function. However, it is possible to write your own code to compute and append the filter string to the URL that is created by the GETURL function.</p>
|
||
<p>The server name and instance are extracted automatically by GETURL and do not need to be specified by the C/AL developer. Furthermore, the multitenancy setup is transparent to the C/AL developer. No multitenancy parameters are specified when you call GETURL, because the function knows from the server setup if it is running in a multitenant environment and if so, it will add a string like &ldquo;&amp;tenant=MyTenant&rdquo; to the URL.</p>
|
||
<h2 id="when-to-use">When to Use</h2>
|
||
<p>The GETURL function can generally be used every time a URL must be created. The following are some scenarios where the function is particularly useful.</p>
|
||
<ul>
|
||
<li>Document approvals. For more information, see the &ldquo;NAV Usage Example&rdquo; section.</li>
|
||
<li>Reports containing drill-down links. (Beware of the resource cost of adding a new URL element to the Report dataset.)</li>
|
||
<li>When planning to write code for, or migrate to, various display targets (Microsoft Dynamics NAV Windows client, Microsoft Dynamics NAV web client, Microsoft Dynamics NAV web services) without having to explicitly specify which client to use.</li>
|
||
</ul>
|
||
<h2 id="examples-of-usage">Examples of Usage</h2>
|
||
<p>The following are examples of calls to GETURL and their corresponding return value:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Command</th>
|
||
<th>URL</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Win)</td>
|
||
<td>dynamicsnav://MyServer:7046/DynamicsNAV71//</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Web)</td>
|
||
<td>https://navwebsrvr:443/DynamicsNAV71_Instance1/Webclient</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::OData)</td>
|
||
<td>http://MyServer:7048/DynamicsNAV71/OData</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::SOAP)</td>
|
||
<td>http://MyServer:7047/DynamicsNAV71/WS/Services</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Current) ie. When running this code on a Win client session</td>
|
||
<td>dynamicsnav://MyServer:7046/DynamicsNAV71//</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Default) ie. When the Server config key DefaultClient is set to Windows</td>
|
||
<td>dynamicsnav://MyServer:7046/DynamicsNAV71//</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Windows,COMPANYNAME)</td>
|
||
<td>dynamicsnav://MyServer:7046/DynamicsNAV71/CRONUS/</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Windows,'')</td>
|
||
<td>dynamicsnav://MyServer:7046/DynamicsNAV71//</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Windows,&lsquo;NONEXISTING Corp&rsquo;)</td>
|
||
<td>dynamicsnav://MyServer:7046/DynamicsNAV71/NONEXISTING Corp/</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Web,COMPANYNAME)</td>
|
||
<td>https://navwebsrvr:443/DynamicsNAV71_Instance1/Webclient?company=CRONUS</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Web,'')</td>
|
||
<td>https://navwebsrvr:443/DynamicsNAV71_Instance1/Webclient</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Web,&lsquo;NONEXISTING Corp&rsquo;)</td>
|
||
<td>https://navwebsrvr:443/DynamicsNAV71_Instance1/Webclient?company=NONEXISTING Corp</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::OData,COMPANYNAME)</td>
|
||
<td>http://MyServer:7048/DynamicsNAV71/OData/Company(&lsquo;CRONUS&rsquo;)</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::OData,'')</td>
|
||
<td>http://MyServer:7048/DynamicsNAV71/OData</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::OData,&lsquo;NONEXISTING Corp&rsquo;)</td>
|
||
<td>http://MyServer:7048/DynamicsNAV71/OData/Company(&lsquo;NONEXISTING Corp&rsquo;)</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::SOAP,COMPANYNAME)</td>
|
||
<td>http://MyServer:7047/DynamicsNAV71/WS/CRONUS/Services</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::SOAP,'')</td>
|
||
<td>http://MyServer:7047/DynamicsNAV71/WS/Services</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::SOAP,&lsquo;NONEXISTING Corp&rsquo;)</td>
|
||
<td>http://MyServer:7047/DynamicsNAV71/WS/NONEXISTING Corp/Services</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Windows,COMPANYNAME,OBJECTTYPE::Table,27)</td>
|
||
<td>dynamicsnav://MyServer:7046/DynamicsNAV71/CRONUS/runtable?table=27</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Windows,COMPANYNAME,OBJECTTYPE::Page,27)</td>
|
||
<td>dynamicsnav://MyServer:7046/DynamicsNAV71/CRONUS/runpage?page=27</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Windows,COMPANYNAME,OBJECTTYPE::Report,6)</td>
|
||
<td>dynamicsnav://MyServer:7046/DynamicsNAV71/CRONUS/runreport?report=6</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Windows,COMPANYNAME,OBJECTTYPE::Codeunit,5065)</td>
|
||
<td>dynamicsnav://MyServer:7046/DynamicsNAV71/CRONUS/runcodeunit?codeunit=5065</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Windows,COMPANYNAME,OBJECTTYPE::Query,9150)</td>
|
||
<td>dynamicsnav://MyServer:7046/DynamicsNAV71/CRONUS/runquery?query=9150</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Windows,COMPANYNAME,OBJECTTYPE::XmlPort,5150)</td>
|
||
<td>dynamicsnav://MyServer:7046/DynamicsNAV71/CRONUS/runxmlport?xmlport=5150</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::OData,COMPANYNAME,OBJECTTYPE::Page,27) ie. When the Web Service is published</td>
|
||
<td>http://MyServer:7048/DynamicsNAV71/OData/Company(&lsquo;CRONUS&rsquo;)/PAG27Vendors</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::OData,COMPANYNAME,OBJECTTYPE::Query,9150) ie. When the Web Service is published</td>
|
||
<td>http://MyServer:7048/DynamicsNAV71/OData/Company(&lsquo;CRONUS&rsquo;)/QUE9150MyCustomers</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::SOAP,COMPANYNAME,OBJECTTYPE::Page,27)Â ie. When the Web Service is published</td>
|
||
<td>http://MyServer:7047/DynamicsNAV71/WS/CRONUS/Page/PAG27Vendors</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::SOAP,COMPANYNAME,OBJECTTYPE::Codeunit,5065) ie. When the Web Service is published</td>
|
||
<td>http://MyServer:7047/DynamicsNAV71/WS/CRONUS/Codeunit/COD5065EmailLogging</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Windows,COMPANYNAME,OBJECTTYPE::Page,27,record) List Page</td>
|
||
<td>dynamicsnav://MyServer:7046/DynamicsNAV71/CRONUS/runpage?page=27&amp;bookmark=23;FwAAAAJ7/0kAQwAxADAAMwAw</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Windows,COMPANYNAME,OBJECTTYPE::Page,26,record) Card Page</td>
|
||
<td>dynamicsnav://MyServer:7046/DynamicsNAV71/CRONUS/runpage?page=26&amp;bookmark=23;FwAAAAJ7/0kAQwAxADAAMwAw</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Web,COMPANYNAME,OBJECTTYPE::Page,27,record) List Page</td>
|
||
<td>https://navwebsrvr:443/DynamicsNAV71_Instance1/Webclient?company=CRONUS&amp;page=27&amp;bookmark=23;FwAAAAJ7/0kAQwAxADAAMwAw</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Web,COMPANYNAME,OBJECTTYPE::Page,26,record) Card Page</td>
|
||
<td>https://navwebsrvr:443/DynamicsNAV71_Instance1/Webclient?company=CRONUS&amp;page=26&amp;bookmark=23;FwAAAAJ7/0kAQwAxADAAMwAw</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::OData,COMPANYNAME,OBJECTTYPE::Page,27,record)</td>
|
||
<td>http://MyServer:7048/DynamicsNAV71/OData/Company(&lsquo;CRONUS&rsquo;)/PAG27Vendors(&lsquo;IC1030&rsquo;)</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Web,COMPANYNAME,OBJECTTYPE::Page,27)</td>
|
||
<td>https://navwebsrvr:443/DynamicsNAV71_Instance1/Webclient?company=CRONUS&amp;page=27</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Web,COMPANYNAME,OBJECTTYPE::Report,6)</td>
|
||
<td>https://navwebsrvr:443/DynamicsNAV71_Instance1/Webclient?company=CRONUS&amp;report=6</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>If the GETURL function is called with invalid parameters, it will return an empty string. In that case, you can find the related error text by calling the GETLASTERRORTEXT function.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Function Call</th>
|
||
<th>Error Message</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Web,COMPANYNAME,OBJECTTYPE::Table,27)</td>
|
||
<td>The specified object type parameter for the GetUrl function is not valid.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Web,COMPANYNAME,OBJECTTYPE::Codeunit,5065)</td>
|
||
<td>The specified object type parameter for the GetUrl function is not valid.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Web,COMPANYNAME,OBJECTTYPE::Query,9150)</td>
|
||
<td>The specified object type parameter for the GetUrl function is not valid.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::Web,COMPANYNAME,OBJECTTYPE::XmlPort,5150)</td>
|
||
<td>The specified object type parameter for the GetUrl function is not valid.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::OData,COMPANYNAME,OBJECTTYPE::Table,27)</td>
|
||
<td>The specified object type parameter for the GetUrl function is not valid.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::OData,COMPANYNAME,OBJECTTYPE::Page,27)</td>
|
||
<td>The Page object, 27, that is specified for the GetUrl function has not been published in the Web Services table.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::OData,COMPANYNAME,OBJECTTYPE::Report,6)</td>
|
||
<td>The specified object type parameter for the GetUrl function is not valid.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::OData,COMPANYNAME,OBJECTTYPE::Codeunit,5065)</td>
|
||
<td>The specified object type parameter for the GetUrl function is not valid.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::OData,COMPANYNAME,OBJECTTYPE::Query,9150)</td>
|
||
<td>The Query object, 9150, that is specified for the GetUrl function has not been published in the Web Services table.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::OData,COMPANYNAME,OBJECTTYPE::XmlPort,5150)</td>
|
||
<td>The specified object type parameter for the GetUrl function is not valid.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::SOAP,COMPANYNAME,OBJECTTYPE::Table,27)</td>
|
||
<td>The specified object type parameter for the GetUrl function is not valid.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::SOAP,COMPANYNAME,OBJECTTYPE::Page,27)</td>
|
||
<td>The Page object, 27, that is specified for the GetUrl function has not been published in the Web Services table.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::SOAP,COMPANYNAME,OBJECTTYPE::Report,6)</td>
|
||
<td>The specified object type parameter for the GetUrl function is not valid.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::SOAP,COMPANYNAME,OBJECTTYPE::Codeunit,5065)</td>
|
||
<td>The Codeunit object, 5065, that is specified for the GetUrl function has not been published in the Web Services table.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::SOAP,COMPANYNAME,OBJECTTYPE::Query,9150)</td>
|
||
<td>The specified object type parameter for the GetUrl function is not valid.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::SOAP,COMPANYNAME,OBJECTTYPE::XmlPort,5150)</td>
|
||
<td>The specified object type parameter for the GetUrl function is not valid.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GETURL(CLIENTTYPE::SOAP,COMPANYNAME,OBJECTTYPE::Page,27,record)</td>
|
||
<td>You cannot specify a record parameter for the GetUrl function when the object type is SOAP</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="nav-specific-example">NAV Specific Example</h2>
|
||
<p>The following example shows how to use the GETURL function in codeunit 440 to ensure that the notification mail in Document Approvals can link to both the Microsoft Dynamics NAV Windows client and the Microsoft Dynamics NAV web client:</p>
|
||
<p><a href="1778.url1.jpg"><img src="1778.url1.jpg" alt=" "></a></p>
|
||
<p>This resulting UI looks as follows.</p>
|
||
<p><a href="7802.url2.jpg"><img src="7802.url2.jpg" alt=" "></a></p>
|
||
<p>The first link opens the approval document in the Microsoft Dynamics NAV Windows client. The second link (Web view) opens the same document in the Microsoft Dynamics NAV web client.</p></description></item><item><title>Docs: Creating Custom Charts</title><link>https://alguidelines.dev/docs/navpatterns/patterns/creating-custom-charts/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/creating-custom-charts/</guid><description>
|
||
<p><em>Originally by Nikola Kukrika at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>The goal of this solution is to enable you to:</p>
|
||
<ol>
|
||
<li>Use charts in the web client.</li>
|
||
<li>Create charts with custom functionality.</li>
|
||
</ol>
|
||
<h2 id="description">Description</h2>
|
||
<p>This pattern enables you to implement a business chart (Specific Chart type) in a way that is maintainable and reusable on other pages. This also enables you to provide specific functionality that is not possible with the Generic Chart type and it enables you to show charts in the web client.</p>
|
||
<p>The Business Chart add-in is a special because it is a combination of .NET and Javascript add-ins depending on the display target. In the web client, it renders a JavaScript control, while in the win client, it renders a .Net control. Because of this behavior, you can expect minor differences in how the chart is presented in the win client versus in the web client. Note that this implementation is specific to NAV platform code, because it is not possible to create add-ins that combines .NET and JavaScript by using a framework API.</p>
|
||
<p><a href="5153.Picture1.png"><img src="5153.Picture1.png" alt=" "></a></p>
|
||
<p>Example of the same chart in the win client:</p>
|
||
<p><a href="1411.Picture2.png"><img src="1411.Picture2.png" alt=" "></a></p>
|
||
<p>The most obvious differences in chart rendering in the two clients are: Slightly different line heights, slightly different chart height, legends in web-client charts can be used as toggle filters to show/hide groups (this is not possible in the win client).</p>
|
||
<h3 id="implementation-overview">Implementation Overview</h3>
|
||
<p><a href="1781.Picture5.png"><img src="1781.Picture5.png" alt=" "></a></p>
|
||
<h3 id="add-in-buffer-table">Add-in Buffer Table</h3>
|
||
<p>This table is used to encapsulate the logic of the Business Chart Add-in. The table handles the following logic:</p>
|
||
<ul>
|
||
<li>Storing chart values and conversion from .NET to C/AL and vice versa</li>
|
||
<li>Handling of captions: We must use C/AL to provide multilanguage text in add-ins. In addition, the multilanguage text must be encapsulated in a single place, because we pass/read the same dataset from/to the add-in.</li>
|
||
<li>DrillDown logic</li>
|
||
<li>Other helper data related functions, for displaying date, periods, etc.[Bogdana1] [NK2] [NK3]</li>
|
||
</ul>
|
||
<p><strong>Note:</strong> It is recommended that you reuse the <strong>Business Chart Buffer table</strong> (485) as a buffer table or extend. It is a generic table which should cover most of the use cases. Implement a new buffer table only if this table does not meet your needs.</p>
|
||
<h3 id="cardpart-page">CardPart page</h3>
|
||
<p>The CardPart page hosts the Business Chart add-in and must use the add-in buffer table as a source table.</p>
|
||
<p>On the page, you must implement the following triggers:</p>
|
||
<ul>
|
||
<li><strong>AddInReady</strong> &ndash; Executed when the page is done rendering. Used to initialize the add-in.</li>
|
||
<li><strong>DataPointClicked</strong> &ndash; Single-click on an element on the chart.</li>
|
||
<li><strong>DataPointDoubleClicked</strong> &ndash; Double-click on an element on the chart</li>
|
||
</ul>
|
||
<p>The CardPart usually contains a StatusText variable to provide more information about the chart or dataset and a set of actions to control the chart.</p>
|
||
<p>The most commonly used actions are:</p>
|
||
<ul>
|
||
<li><strong>Select Chart</strong>, <strong>Previous Chart</strong>, <strong>Next Chart</strong></li>
|
||
<li><strong>Set Period</strong>, <strong>Work Date</strong></li>
|
||
<li>Actions to filter the data set</li>
|
||
<li><strong>Refresh</strong></li>
|
||
<li><strong>Chart Information</strong> &ndash; a tooltip with a description of the chart and how data is calculated.</li>
|
||
</ul>
|
||
<h3 id="optional-preserving-user-personalization">Optional: Preserving User Personalization</h3>
|
||
<p>One of the most common functionalities is personalization. If the chart can be customized by the user, you should store the settings that the user has entered and apply them the next time the chart is loaded.</p>
|
||
<p>To do this, you need the following:</p>
|
||
<ul>
|
||
<li>A setup record to store the data. You can use the <strong>Business Chart User Setup</strong> table (487) or create a new setup table if you need to store more information.</li>
|
||
<li>A management codeunit to write/apply the settings to the chart and to encapsulate other logic. Since we should not write code on pages, the code for the actions and other logic that does not apply to the setup record should go in this codeunit.</li>
|
||
<li>Setup pages where users can customize how the chart is shown and set different settings.</li>
|
||
</ul>
|
||
<p>The relation between the components is visualized in the following diagram:</p>
|
||
<p><a href="0246.Picture6.png"><img src="0246.Picture6.png" alt=" "></a></p>
|
||
<h3 id="optional-show-multiple-charts-within-a-single-cardpart">Optional: Show Multiple Charts within a Single CardPart</h3>
|
||
<p>This option is useful on a Role Center where you want to show multiple charts using different datasets within a single part. In that case, you need a record to store the last chart selection, the setup records, and code units for separate charts.</p>
|
||
<p>See, for example, the implementation of the <strong>Mini Generic Chart</strong> page (1390), which uses <strong>MiniChartManagment</strong> CodeUnit to manage separate management codeunits for charts and their setup records. The last selected chart is stored in a separate table, <strong>Mini Chart Definition</strong> (1310).</p>
|
||
<p><a href="1803.Picture7.png"><img src="1803.Picture7.png" alt=" "></a></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>To implement the pattern, create a new ChartPart and set the source table to <strong>Business Chart Buffer</strong>.</p>
|
||
<p>Add a field named <strong>BusinessChart</strong> and set the ControlAddIn property to Microsoft.Dynamics.Nav.Client.BusinessChart.</p>
|
||
<p>Then implement the AddInReady event. This event is executed when the page is done rendering. Code within this method must call the Update method from the <strong>Business Chart Buffer</strong> table, Update(CurrPage.BusinessChart) to initialize the chart and assign initial values.</p>
|
||
<p>If you need a setup record and codeunit, then it is a good idea to encapsulate this logic within a method.</p>
|
||
<h3 id="nav-specific-example-1">NAV Specific Example 1</h3>
|
||
<p>Implementation of the <strong>Finance Performance Chart</strong> page (762)</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">BusinessChart<span style="color:#000;font-weight:bold">::</span>AddInReady<span style="color:#ce5c00;font-weight:bold">()
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span>UpdateChart<span style="color:#ce5c00;font-weight:bold">(</span>Period<span style="color:#000;font-weight:bold">::</span>&#34; &#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>UpdateChart<span style="color:#ce5c00;font-weight:bold">(</span>Period<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;,Next,Previous&#39;</span><span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span>MoveAndUpdateChart<span style="color:#ce5c00;font-weight:bold">(</span>Period<span style="color:#000;font-weight:bold">,</span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MoveAndUpdateChart<span style="color:#ce5c00;font-weight:bold">(</span>Period<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;,Next,Previous&#39;</span><span style="color:#000;font-weight:bold">;</span>Move<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span>AccSchedChartManagement<span style="color:#ce5c00;font-weight:bold">.</span>GetSetupRecordset<span style="color:#ce5c00;font-weight:bold">(</span>AccountSchedulesChartSetup<span style="color:#000;font-weight:bold">,</span>AccountSchedulesChartSetup<span style="color:#ce5c00;font-weight:bold">.</span>Name<span style="color:#000;font-weight:bold">,</span>Move<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>AccSchedChartManagement<span style="color:#ce5c00;font-weight:bold">.</span>UpdateData<span style="color:#ce5c00;font-weight:bold">(</span>Rec<span style="color:#000;font-weight:bold">,</span>Period<span style="color:#000;font-weight:bold">,</span>AccountSchedulesChartSetup<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>Update<span style="color:#ce5c00;font-weight:bold">(</span>CurrPage<span style="color:#ce5c00;font-weight:bold">.</span>BusinessChart<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>StatusText<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GetCurrentSelectionText<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Period Filter Start Date&#34;<span style="color:#000;font-weight:bold">,</span>&#34;Period Filter End Date&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>In the MoveAndUpdateChart method, the AccSchedChartManagement codeunit gets a setup record and updates it if necessary. Then, it initializes the chart with setup data and sets the StatusText to show the period for which data is displayed. The same method is used by the actions to move and update the chart so that there is no code duplication.</p>
|
||
<p>The following code is used to implement <strong>DataPointClicked</strong></p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">BusinessChart<span style="color:#000;font-weight:bold">::</span>DataPointClicked<span style="color:#ce5c00;font-weight:bold">(</span>point<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DotNet</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Microsoft.Dynamics.Nav.Client.BusinessChart.BusinessChartDataPoint&#34;<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span>SetDrillDownIndexes<span style="color:#ce5c00;font-weight:bold">(</span>point<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>AccSchedChartManagement<span style="color:#ce5c00;font-weight:bold">.</span>DrillDown<span style="color:#ce5c00;font-weight:bold">(</span>Rec<span style="color:#000;font-weight:bold">,</span>AccountSchedulesChartSetup<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>SetDrillDownindexes is a method from the <strong>Business Chart Buffer</strong> table that maps the DotNet point variable to C/AL data, so it must be used. The next method that you must implement is the action to be performed on Drilldown.</p>
|
||
<p>The <strong>DataPointDoubleClicked</strong> trigger has the same implementation logic as the DataPointClicked trigger.</p>
|
||
<h3 id="nav-specific-example-2">NAV Specific Example 2</h3>
|
||
<p>Implementation of chart part 1390 on the <strong>Small Business Role Center</strong> page (9022)</p>
|
||
<p><a href="1541.Picture7.png"><img src="1541.Picture7.png" alt=" "></a></p>
|
||
<p>This chart part contains data from multiple charts within a single part. The <strong>Status Text</strong> field shows the name of the chart and the current period. Users can browse through the charts with <strong>Next Chart</strong> and <strong>Previous Chart</strong> or use <strong>Select Chart</strong> to choose from a list of available charts.</p>
|
||
<p><a href="2553.Picture8.png"><img src="2553.Picture8.png" alt=" "></a></p>
|
||
<p>On this dialog, users can choose if a chart should be enabled or disabled. If the chart is not enabled, it will be skipped on the <strong>Previous Chart</strong> and <strong>Next Chart</strong> actions. Charts used by this part use different codeunits and setup records. If the user changes the selected chart, this option will be saved and applied next time role center is opened.</p>
|
||
<p>Users can also change the period length.</p>
|
||
<p><a href="5545.Picture9.png"><img src="5545.Picture9.png" alt=" "></a></p>
|
||
<p>Choosing the <strong>Chart Information</strong> button opens a short description of the chart.</p>
|
||
<p><a href="5582.Picture10.png"><img src="5582.Picture10.png" alt=" "></a></p>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>Implementation of multiple charts within a single part:</p>
|
||
<ul>
|
||
<li>Page 1390, <strong>Mini Generic Chart</strong></li>
|
||
</ul>
|
||
<p>Charts that use a setup record and select the chart with <strong>Customize Chart Setup</strong> pages:</p>
|
||
<ul>
|
||
<li>Page 772, <strong>Inventory Performance</strong></li>
|
||
<li>Page 771, <strong>Purchase Performance</strong></li>
|
||
<li>Page 770, <strong>Sales Performance</strong></li>
|
||
<li>Page 762, <strong>Finance Performance</strong></li>
|
||
</ul>
|
||
<p>Chart that uses the <strong>Business Chart User Setup</strong> table:</p>
|
||
<ul>
|
||
<li>Page 768, <strong>Aged Acc. Receivable Chart</strong></li>
|
||
</ul>
|
||
<p>Other implementations:</p>
|
||
<ul>
|
||
<li>Page 972, <strong>Time Sheet Chart</strong></li>
|
||
<li>Page 869, <strong>Cash Flow Chart</strong></li>
|
||
<li>Page 760, <strong>Trailing Sales Orders Chart</strong></li>
|
||
</ul>
|
||
<h2 id="ideas-for-improvement">Ideas for improvement</h2>
|
||
<p>We should consider making a generic table for the last chart that the user has used.</p>
|
||
<p>We should investigate if we could make generic code for selecting periods and other common functionality by using RecordRefs.</p>
|
||
<p>Add-In improvements &ndash; Different ways to visualize the data and to pick colors for categories.</p>
|
||
<p>As a nice-to-have feature, we could implement functionality to cycle through the charts with a timer.</p></description></item><item><title>Docs: Cross Session Events</title><link>https://alguidelines.dev/docs/navpatterns/patterns/cross-session-events/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/cross-session-events/</guid><description>
|
||
<p><em>By Nikolai L&rsquo;Estrange, from TVision Technology Ltd. in the UK</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>Track things that happen in other NAV Sessions.</p>
|
||
<p><a href="PubSub.png"><img src="PubSub.png" alt=" "></a></p>
|
||
<h2 id="problem">Problem</h2>
|
||
<p>In Microsoft Dynamics NAV you can fire a function whenever something changes within your session (and from NAV 2016 this is even easier with the new Event model), however there is not an easy way to know what is happening in other sessions. Sometimes you would like to know what has happened since your last read, without reading everything again, e.g. when you need to pass a large dataset to a Control Add-in.</p>
|
||
<p>A common way of handling this with Ledger Tables is to make note of the last record you read, and continuously poll to see if there are any new records. However this is restricted to strictly sequentially entered tables.</p>
|
||
<h2 id="solution">Solution</h2>
|
||
<p>There is a common pattern in many other languages called <a href="https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern">Publish-Subscribe</a> (or PubSub) that solves the same issue. We can implement the same pattern in NAV using a Table as a message queue platform and polling this table. We have named this pattern &ldquo;Cross Session Events&rdquo; in order to avoid confusion with the standard NAV Events which use the terms Publisher and Subscriber, and to try and describe more accurately when you would need this pattern.</p>
|
||
<p>The pattern has four components:</p>
|
||
<ul>
|
||
<li><strong>Publisher(s)</strong>: These push messages to the Message Broker.</li>
|
||
<li><strong>Subscriber Records</strong>: Identifies the Subscriber and store filters to say what messages the Subscriber and interested in receiving.</li>
|
||
<li><strong>Message Broker</strong>: This distributes all messages sent in to all Subscribers that have expressed an interest (i.e. the message is within their filters).</li>
|
||
<li><strong>Message Queue</strong>: To hold the messages for each Subscriber. Generally once these messages are read, they are deleted.</li>
|
||
</ul>
|
||
<h2 id="example">Example</h2>
|
||
<p>An example of this would be when we have multiple users looking at the same set of data and we want their screens to update in &ldquo;real time&rdquo; whenever one of them makes a change, without doing a full refresh. We will use the <a href="https://alguidelines.dev/navpatterns/1-patterns/observer/">Observer pattern</a> to capture the change (act as the Publisher) and then create a Table to hold Subscribers and Filters (Change Observer), a Table to be the Message Queue (Change Notification), and a Codeunit to be the Message Broker and help with the polling (ObserverMgt).</p>
|
||
<p>Below are the table definitions:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th><strong>Change Observer:</strong></th>
|
||
<th></th>
|
||
<th></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>&ldquo;Table ID&rdquo;</td>
|
||
<td>Integer</td>
|
||
<td>&ldquo;Observable Table&rdquo;</td>
|
||
</tr>
|
||
<tr>
|
||
<td>&ldquo;Server ID&rdquo;</td>
|
||
<td>Integer</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>&ldquo;Session ID&rdquo;</td>
|
||
<td>Integer</td>
|
||
<td></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th><strong>Change Notification:</strong></th>
|
||
<th></th>
|
||
<th></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>&ldquo;Table ID&rdquo;</td>
|
||
<td>Integer</td>
|
||
<td>&ldquo;Observable Table&rdquo;</td>
|
||
</tr>
|
||
<tr>
|
||
<td>&ldquo;Server ID&rdquo;</td>
|
||
<td>Integer</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>&ldquo;Session ID&rdquo;</td>
|
||
<td>Integer</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>&ldquo;Entry No.&rdquo;</td>
|
||
<td>Integer</td>
|
||
<td>AutoIncrement</td>
|
||
</tr>
|
||
<tr>
|
||
<td>&ldquo;Type of Change&rdquo;</td>
|
||
<td>Option</td>
|
||
<td>Insert,Modify,Delete,Rename</td>
|
||
</tr>
|
||
<tr>
|
||
<td>&ldquo;Record ID&rdquo;</td>
|
||
<td>RecordID</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>&hellip; (other fields to indicate what has changed)</td>
|
||
<td></td>
|
||
<td></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>The Change Observer table identifies the Subscriber using Server ID and Session ID, and then in this example there is only one filter, which is the Table ID we want to listen to any changes. In this case all three fields are in the Primary Key.</p>
|
||
<p>The Change Notification table then has the same three fields plus an Entry No. as its Primary Key, and in this example borrows heavily from the Change Log code to fill in the rest of the message.</p>
|
||
<p><em><strong>Note:</strong></em> Other examples of the pattern could have very different fields to identify the Subscriber, Filters and then whatever fields needed for content of the Message.</p>
|
||
<p>Our Message Broker Codeunit will also serve as a central place to create Subscribers (Listen and StopListening functions) and a place to Poll for Messages. Note that the Poll function deletes the Messages as it reads them.</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">Listen<span style="color:#ce5c00;font-weight:bold">(</span>TableID<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">WITH</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observer<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DO</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Table ID&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TableID<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Server ID&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SERVICEINSTANCEID<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Session ID&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SESSIONID<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>INSERT<span style="color:#ce5c00;font-weight:bold">(</span>TRUE<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>COMMIT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>StopListening<span style="color:#ce5c00;font-weight:bold">(</span>TableID<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">WITH</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observer<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DO</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>RESET<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Server ID&#34;<span style="color:#000;font-weight:bold">,</span>SERVICEINSTANCEID<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Session ID&#34;<span style="color:#000;font-weight:bold">,</span>SESSIONID<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Table ID&#34;<span style="color:#000;font-weight:bold">,</span>TableID<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DELETEALL<span style="color:#ce5c00;font-weight:bold">(</span>TRUE<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>COMMIT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>NotifyAll<span style="color:#ce5c00;font-weight:bold">(</span>ChangeNotification<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Change Notification&#34;<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">WITH</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observer<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DO</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>RESET<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Table ID&#34;<span style="color:#000;font-weight:bold">,</span>ChangeNotification<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Table ID&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FINDSET<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">REPEAT</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Notify<span style="color:#ce5c00;font-weight:bold">(</span>Observer<span style="color:#000;font-weight:bold">,</span>ChangeNotification<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">UNTIL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>NEXT<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>Notify<span style="color:#ce5c00;font-weight:bold">(</span>Observer<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Change Observer&#34;<span style="color:#000;font-weight:bold">;</span>ChangeNotification<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Change Notification&#34;<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">WITH</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ChangeNotification<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DO</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Server ID&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observer<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Server ID&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Session ID&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observer<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Session ID&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Entry No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>INSERT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>Poll<span style="color:#ce5c00;font-weight:bold">(</span>TableID<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempChangeNotification<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">TEMPORARY</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Change Notification&#34;<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">WITH</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ChangeNotification<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DO</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempChangeNotification<span style="color:#ce5c00;font-weight:bold">.</span>RESET<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempChangeNotification<span style="color:#ce5c00;font-weight:bold">.</span>DELETEALL<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>RESET<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Table ID&#34;<span style="color:#000;font-weight:bold">,</span>TableID<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Server ID&#34;<span style="color:#000;font-weight:bold">,</span>SERVICEINSTANCEID<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Session ID&#34;<span style="color:#000;font-weight:bold">,</span>SESSIONID<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FINDSET<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">REPEAT</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempChangeNotification<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ChangeNotification<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempChangeNotification<span style="color:#ce5c00;font-weight:bold">.</span>INSERT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MARK<span style="color:#ce5c00;font-weight:bold">(</span>TRUE<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">UNTIL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>NEXT<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MARKEDONLY<span style="color:#ce5c00;font-weight:bold">(</span>TRUE<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DELETEALL<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>The final part of this example is an object that calls the functions above. In this example we will use a Page with a PingPong Timer Control to do the polling in (almost) real time. These are the functions on the page:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">OnQueryClosePage<span style="color:#ce5c00;font-weight:bold">(</span>CloseAction<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Action</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">None</span><span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>ObserverMgt<span style="color:#ce5c00;font-weight:bold">.</span>StopListening<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">DATABASE</span><span style="color:#000;font-weight:bold">::</span>&#34;NAV Whiteboard Booking&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>Timer<span style="color:#000;font-weight:bold">::</span>AddInReady<span style="color:#ce5c00;font-weight:bold">()
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ObserverMgt<span style="color:#ce5c00;font-weight:bold">.</span>Listen<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">DATABASE</span><span style="color:#000;font-weight:bold">::</span>&#34;NAV Whiteboard Booking&#34;<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>CurrPage<span style="color:#ce5c00;font-weight:bold">.</span>Timer<span style="color:#ce5c00;font-weight:bold">.</span>Ping<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>Timer<span style="color:#000;font-weight:bold">::</span>Pong<span style="color:#ce5c00;font-weight:bold">()
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span>CallUpdate<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>CurrPage<span style="color:#ce5c00;font-weight:bold">.</span>Timer<span style="color:#ce5c00;font-weight:bold">.</span>Ping<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CallUpdate<span style="color:#ce5c00;font-weight:bold">()
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span>ObserverMgt<span style="color:#ce5c00;font-weight:bold">.</span>Poll<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">DATABASE</span><span style="color:#000;font-weight:bold">::</span>&#34;NAV Whiteboard Booking&#34;<span style="color:#000;font-weight:bold">,</span>TempChangeNotification<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">WITH</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempChangeNotification<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DO</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FINDSET<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">REPEAT</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Type of Change&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Type of Change&#34;<span style="color:#000;font-weight:bold">::</span>Delete<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">...
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ELSE</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>RecRef<span style="color:#ce5c00;font-weight:bold">.</span>GET<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Record ID&#34;<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">...
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">UNTIL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>NEXT<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h2 id="consequences">Consequences</h2>
|
||
<p>The PingPong control is only available on the Windows Client, so if you want to use another client you will need to use another solution to Poll for Messages. Therefore this pattern is not always going to be &ldquo;real time&rdquo;.</p>
|
||
<h2 id="related-topics">Related Topics</h2>
|
||
<p>This pattern was originally described in the following blog:</p>
|
||
<p><a href="https://geeknikolai.wordpress.com/2015/10/30/pubsub-pattern-in-dynamics-nav-2016/">https://geeknikolai.wordpress.com/2015/10/30/pubsub-pattern-in-dynamics-nav-2016/</a></p>
|
||
<p>Below is the Wikipedia link to the PubSub pattern</p>
|
||
<p><a href="https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern">https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern</a></p></description></item><item><title>Docs: Currently Active Record</title><link>https://alguidelines.dev/docs/navpatterns/patterns/currently-active-record/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/currently-active-record/</guid><description>
|
||
<p><em>Authors: Henrik Langbak and Kim Ginnerup, Bording Data</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>Date controlled data is expensive to find in the database. This pattern describes how using a view with a sub-select and a linked table object will minimize the returned dataset.<br>
|
||
A side effect is reduced and simplified code, increased performance and a more scalable solution that is almost independent of the amount of records in the table.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>There is no way in NAV to get a set of records from the database, which all have the newest starting date, that is less than or equal to today&rsquo;s date. Having an ending date on the record will help, but it introduces some other problems. In Dynamics NAV this is normally done by reading too many records, either at the SQL Server level or in the middle tier and throw away the ones you do not need. That is a waste of resources:</p>
|
||
<ul>
|
||
<li>
|
||
<p>The SQL Server is reading too many records</p>
|
||
</li>
|
||
<li>
|
||
<p>There would be too much data sent over the network.<br>
|
||
(If the SQL Server and the NAV Service tier are on different machines.)</p>
|
||
</li>
|
||
<li>
|
||
<p>The NAV Service Tier receives and throws away data.</p>
|
||
</li>
|
||
</ul>
|
||
<h2 id="ending-date-problem">Ending Date Problem</h2>
|
||
<p>Ending Date may introduce some problems of its own.</p>
|
||
<p>If your design requires to have one and only one active record per key in a dataset, then Ending Date introduces the possibility for overlapping or holes in the timeline.<br>
|
||
Ending Date creates a dependency between two records. Changing a Starting Date, requires you to update the previous record. Changing the Ending Date requires you to update the next record.<br>
|
||
If you add a record in between you will have to update both the before and the after record.</p>
|
||
<p>The pattern we describe here will work whether there is an Ending Date or Not.</p>
|
||
<p>The pattern is also relevant for other types than date. The pattern is usable whenever you have dependencies between rows in a table.</p>
|
||
<p>Use the pattern whenever you read a set of data containing a Starting Date and you need to implement a loop to throw away unwanted records. An example could be Codeunit 7000 &ldquo;Sales Price Calc. Mgt.&rdquo;. In this codeunit there are many loop constructs to find prices and discounts.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>In the following example, we have a fictive table containing: Code, Starting Date and Price. The Primary Key consist of Code, Starting Date. The Database is the Demo Database, and the Company is Cronus.</p>
|
||
<p><a href="6545.Table.png"><img src="6545.Table.png" alt=" "></a></p>
|
||
<h3 id="1-create-the-view">1. Create the view</h3>
|
||
<p>You will need to create the view before you define the Table Object.<br>
|
||
You will need to create a view for every company in the database.</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sql" data-lang="sql"><span style="color:#204a87;font-weight:bold">CREATE</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">VIEW</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">[</span><span style="color:#000">dbo</span><span style="color:#000;font-weight:bold">].[</span><span style="color:#000">CRONUS$PriceView</span><span style="color:#000;font-weight:bold">]</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">AS</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">SELECT</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">[</span><span style="color:#000">Code</span><span style="color:#000;font-weight:bold">],</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">[</span><span style="color:#000">Starting</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87">Date</span><span style="color:#000;font-weight:bold">],</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">[</span><span style="color:#000">Price</span><span style="color:#000;font-weight:bold">]</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">FROM</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">dbo</span><span style="color:#000;font-weight:bold">.[</span><span style="color:#000">CRONUS$Price</span><span style="color:#000;font-weight:bold">]</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">AS</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">A</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">WHERE</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">[</span><span style="color:#000">Starting</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87">Date</span><span style="color:#000;font-weight:bold">]</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#000;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">SELECT</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">MAX</span><span style="color:#000;font-weight:bold">([</span><span style="color:#000">Starting</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87">Date</span><span style="color:#000;font-weight:bold">])</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">FROM</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">dbo</span><span style="color:#000;font-weight:bold">.[</span><span style="color:#000">CRONUS$Price</span><span style="color:#000;font-weight:bold">]</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">AS</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">B</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">WHERE</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">B</span><span style="color:#000;font-weight:bold">.[</span><span style="color:#000">Code</span><span style="color:#000;font-weight:bold">]</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">A</span><span style="color:#000;font-weight:bold">.[</span><span style="color:#000">Code</span><span style="color:#000;font-weight:bold">]</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">AND</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#000">B</span><span style="color:#000;font-weight:bold">.[</span><span style="color:#000">Starting</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87">Date</span><span style="color:#000;font-weight:bold">]</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">&lt;=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">GETDATE</span><span style="color:#000;font-weight:bold">())</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>Test the view to ensure that you get the correct result. It is much easier to test now than later.</p>
|
||
<h3 id="2-create-the-table-object">2. Create the Table object</h3>
|
||
<p>Remember to set the link table property before you save it.</p>
|
||
<h3 id="3-implement-the-code">3. Implement the code</h3>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>PriceView<span style="color:#ce5c00;font-weight:bold">.</span>FINDSET<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// You have them
|
||
</span></code></pre></div><h3 id="4-create-a-deployment-codeunit">4. Create a deployment codeunit</h3>
|
||
<p>Create a SQL Deployment codeunit to manage your views.<br>
|
||
The codeunit needs to Create or Alter the views for all companies.<br>
|
||
To see an example of how to talk to SQL Server using .NET see waldo&rsquo;s blog here:<br>
|
||
<a href="http://dynamicsuser.net/blogs/waldo/archive/2011/07/19/net-interop-calling-stored-procedures-on-sql-server-example-1.aspx">http://dynamicsuser.net/blogs/waldo/archive/2011/07/19/net-interop-calling-stored-procedures-on-sql-server-example-1.aspx</a></p>
|
||
<h3 id="5-deployment">5. Deployment</h3>
|
||
<p>You need to deploy in three steps:</p>
|
||
<ol>
|
||
<li>Delete the table objects referencing the views</li>
|
||
<li>Deploy and run the deployment codeunit</li>
|
||
<li>Deploy the new table objects that reference the views</li>
|
||
</ol>
|
||
<h3 id="general-precaution">General precaution</h3>
|
||
<p>If you later want to change the view, you need to follow these rules:</p>
|
||
<ul>
|
||
<li>If you add columns, you need to add them to the view first and then add them to the Table Object.</li>
|
||
<li>If you want to remove columns from the view, you need to delete the Table Object, then change the view and last recreate the Table Object without the new columns.</li>
|
||
</ul>
|
||
<h3 id="code-example-that-accomplish-the-same-but-without-using-the-pattern">Code example that accomplish the same but without using the pattern</h3>
|
||
<p>This following example will give you the same result but the performance will deteriorate as time goes by and you get more and more old data.</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">Price<span style="color:#ce5c00;font-weight:bold">.</span>SETCURRENTKEY<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">Code</span><span style="color:#000;font-weight:bold">,</span>&#34;Starting Date&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>Price<span style="color:#ce5c00;font-weight:bold">.</span>SETFILTER<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Starting Date&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;..%1&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TODAY<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Price<span style="color:#ce5c00;font-weight:bold">.</span>FINDSET<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">REPEAT</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Price<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">Code</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Price<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">Code</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Price<span style="color:#ce5c00;font-weight:bold">.</span>FINDLAST<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Price<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">Code</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>PriceTemp<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Price<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>PriceTemp<span style="color:#ce5c00;font-weight:bold">.</span>INSERT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">UNTIL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Price<span style="color:#ce5c00;font-weight:bold">.</span>NEXT<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#8f5902;font-style:italic">// PriceTemp will contain the Prices
|
||
</span></code></pre></div><h3 id="comparison">Comparison</h3>
|
||
<p>The above NAV example is for a very simple date controlled solution and is provided to give an idea of what the pattern changes seen from a NAV development point of view. But consider the following:</p>
|
||
<ul>
|
||
<li>The table has a more complex key.<br>
|
||
This will require setting and clearing more filters</li>
|
||
<li>You need to read from more than one table.<br>
|
||
Say you need to apply discount from a separate table.<br>
|
||
This may give several lines in PriceTemp.</li>
|
||
<li>If the Code field is controlled by a Type field.<br>
|
||
The Code field reference keys in different tables</li>
|
||
</ul>
|
||
<p>All three examples above can be implemented directly in the view. By using the pattern, it will still only require a single line of NAV code.</p>
|
||
<p>Using the pattern will only issue one SQL call and thereby one trip to the server.<br>
|
||
The NAV Example will require an unknown number of SQL calls and thereby an unknown number of trips to the server. The number of SQL calls is dependent on the number of distinct Code values.<br>
|
||
The NAV example will require SQL Server to read all data older than or equal to TODAY, but only return one row per Code. Over time, as old data piles up in the system, the NAV code will perform slower because the SQL statements will be slower.<br>
|
||
The Pattern makes a scalable solution with a predictable performance. The performance will not deteriorate at the same rate as the NAV code example.</p>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>The pattern does not exist in NAV (yet J). We have used it several times in our code for an Add-On.</p>
|
||
<h2 id="ideas-for-improvement">Ideas for improvement</h2>
|
||
<p>Query Object should be able to handle sub-selects and Unions. A simple solution could be to allow the NAV developer to specify the actual Select statement inside the query Object in clear text. Opening up for writing your own queries and map the projection to the Query-defined fields will make the query Object very versatile and remove the pressure from Microsoft trying to create all the different permutations that a select statement can have. Microsoft and others have all tried to create wizards that can create SQL select statement. They all end up having a clear text option.</p>
|
||
<p>An alternative would be better support for linked table objects, specifically views. The current implementation is very fragile.</p>
|
||
<p>The pattern only supports fetching data for a given date (normally today). This is because you cannot control the where-clause of the sub-select.</p>
|
||
<h2 id="related-topics">Related Topics</h2>
|
||
<p>The idea of having a linked table object pointing to a view could be a pattern of its own.</p></description></item><item><title>Docs: Data Migration Façade</title><link>https://alguidelines.dev/docs/navpatterns/patterns/data-migration-facade/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/data-migration-facade/</guid><description>
|
||
<p><em>By David Bastide and Soumya Dutta at Microsoft Development Center Copenhagen</em></p>
|
||
<p><a href="8308.logo.png"><img src="8308.logo.png" alt=" "></a></p>
|
||
<h2 id="context">Context:</h2>
|
||
<p>This pattern is describing how you can migrate data using the Data Migration Façade.</p>
|
||
<h2 id="problem">Problem:</h2>
|
||
<p>Writing migration code from an external source, such as a product from a competitor, can be time consuming, as you need to tackle the problems of what to migrate, in which order, exception handling&hellip; and can result in code that is fragile due to deep dependencies on the NAV data model (high coupling). Any change to the NAV data model can easily break this code.</p>
|
||
<h2 id="solution">Solution:</h2>
|
||
<p>The idea of the Data Migration Façade is to provide an API that creates and updates master data and related entities (including transactions) without referencing NAV tables.</p>
|
||
<p>Additionally, the framework around the Data Migration Façade provides tools for error handling, and a way to integrate the migration in the Data Migration Overview page (page 1799).</p>
|
||
<p>The façade framework has the following components:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Two management codeunits:</p>
|
||
<ul>
|
||
<li><strong>Data Migration Façade</strong> (codeunit 6100): Integrates the extension to the Data Migration Wizard. Starts a migration, or restarts a migration that failed for some records.</li>
|
||
<li><strong>Data Migration Status Facade</strong> (codeunit 6101): Initializes and updates the status of the migration. The status displays in the <strong>Data Migration Overview</strong> page (page 1799).</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Several master data migration façade codeunits that create and update entities. Each codeunit also contains events that help ensure that data is created in the correct order:</p>
|
||
<ul>
|
||
<li><strong>GL Acc. Data Migration Façade</strong> (codeunit 6110)</li>
|
||
<li><strong>Vendor Data Migration Façade</strong> (codeunit 6111)</li>
|
||
<li><strong>Customer Data Migration Façade</strong> (codeunit 6112)</li>
|
||
<li><strong>Item Data Migration Façade</strong> (codeunit 6113)</li>
|
||
<li>If you want to migrate other entities, it is possible to define your own codeunit that will contain your custom code (see &lsquo;Usage&rsquo; below).</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>A page where you can view the status and progress of the migration. It shows one line for each master data entity (item, customer, vendor, general ledger account) that was chosen for migration. You can also stop a migration by choosing the <strong>Stop Migration</strong> action.</p>
|
||
<ul>
|
||
<li><strong>Data Migration Overview</strong> (page 1799)</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id="usage">Usage:</h2>
|
||
<p>There are the following use cases:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Migration with staging tables, where data from another product is exported to a file or set of files, and the exported data is then imported to buffer tables, before running the migration logic. In this case, the migration is implemented in your extension codeunits, and it is called through events, one record at a time.</p>
|
||
</li>
|
||
<li>
|
||
<p>Migration without staging tables, for example, when you migrate data by importing it from an external tool such as external APIs and webservices. In this case, the migration is also implemented in your extension codeunits but it will be called through the OnRun procedure. You will be responsible for looping on the records to migrate, and you must migrate all records in this unique OnRun call for a given entity.</p>
|
||
</li>
|
||
</ul>
|
||
<p>To initialize and start the data migration, you must call the following procedures:</p>
|
||
<ul>
|
||
<li><strong>&ldquo;Data Migration Status Façade&rdquo;.InitStatusLine(&lsquo;My Migration Type&rsquo;,Database::Item,42000,0,Codeunit::&ldquo;My extension Item migration codeunit&rdquo;)</strong><br>
|
||
This deletes existing status lines for migrating Items for &lsquo;My Migration Type&rsquo;, and initializes a new status line with 0 records migrated out of 42000.</li>
|
||
</ul>
|
||
<p><strong>&ldquo;Data Migration Façade&rdquo;.StartMigration(&lsquo;My Migration Type&rsquo;,false)</strong><br>
|
||
This starts the migration. False means this is not a retry. A re-try is when you migrate one or more records from the <strong>Show Errors</strong> page, which is described later in this document. Retry = true is only used by the <strong>Show Errors</strong> page and should not be used from extensions.</p>
|
||
<h3 id="usage-without-staging-tables">Usage without staging tables:</h3>
|
||
<p>The overall workflow is:</p>
|
||
<ol>
|
||
<li>Integrate your extension in the <strong>Data Migration Wizard</strong> by subscribing to the events exposed by the <strong>Data Migration Façade</strong>.</li>
|
||
<li>From there, initialize the status of the migration so it can be displayed in the Data Migration Overview. When initializing the status lines, you provide the codeunit ID that will be called for each entity: <strong>&ldquo;Data Migration Status Façade&rdquo;.InitStatusLine(&lsquo;My Migration Type&rsquo;,Database::Item,42000,0,Codeunit::&ldquo;My extension Item migration codeunit&rdquo;)</strong>.</li>
|
||
<li>Launch the migration: <strong>&ldquo;Data Migration Façade&rdquo;.StartMigration(&lsquo;My Migration Type&rsquo;,false).</strong></li>
|
||
<li>Your migration codeunits are called one at a time (<strong>OnRun</strong>) in the following order:</li>
|
||
<li>G/L accounts (first, because customer/vendor posting groups refer to G/L accounts)</li>
|
||
<li>Customers</li>
|
||
<li>Vendors</li>
|
||
<li>Items (because discounts may refer to customer groups)</li>
|
||
<li>Others</li>
|
||
<li>Loop on all of the records to migrate. You can update the increment of the amount of records migrated: <strong>&ldquo;Data Migration Status Facade&rdquo;.IncrementStatusLine(&lsquo;My Migration Type&rsquo;,Database::Item,42).</strong></li>
|
||
</ol>
|
||
<p><a href="NoStagingTableNew2.png"><img src="NoStagingTableNew2.png" alt=" "></a></p>
|
||
<p><em>Figure 1: sequence diagram of the data migration without staging tables</em></p>
|
||
<p>The following example shows how to migrate items without staging tables:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">trigger</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnRun<span style="color:#ce5c00;font-weight:bold">()</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">var</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemDataMigrationFacade<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Item Data Migration Facade&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemNumber<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemJson<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">begin</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// loop on items retrieved through a web service for example
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">for</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemNumber<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">to</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ExternalWebService<span style="color:#ce5c00;font-weight:bold">.</span>GetItemCount<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">do</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">begin</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ExternalWebService<span style="color:#ce5c00;font-weight:bold">.</span>GetItem<span style="color:#ce5c00;font-weight:bold">(</span>ItemNumber<span style="color:#000;font-weight:bold">,</span>ItemJson<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// create item using the facade
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">if</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">not</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemDataMigrationFacade<span style="color:#ce5c00;font-weight:bold">.</span>CreateItemIfNeeded<span style="color:#ce5c00;font-weight:bold">(</span>ItemJson<span style="color:#ce5c00;font-weight:bold">.</span>ItemNumber<span style="color:#000;font-weight:bold">,</span>ItemJson<span style="color:#ce5c00;font-weight:bold">.</span>ItemName1<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemJson<span style="color:#ce5c00;font-weight:bold">.</span>ItemName2<span style="color:#000;font-weight:bold">,</span>ConvertItemType<span style="color:#ce5c00;font-weight:bold">(</span>ItemJson<span style="color:#ce5c00;font-weight:bold">.</span>ItemType<span style="color:#ce5c00;font-weight:bold">)) </span><span style="color:#204a87;font-weight:bold">then</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">exit</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// item already exists
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// set some fields using the facade
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemDataMigrationFacade<span style="color:#ce5c00;font-weight:bold">.</span>SetVendorItemNo<span style="color:#ce5c00;font-weight:bold">(</span>ItemJson<span style="color:#ce5c00;font-weight:bold">.</span>VendItemNumber<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemDataMigrationFacade<span style="color:#ce5c00;font-weight:bold">.</span>SetUnitVolume<span style="color:#ce5c00;font-weight:bold">(</span>ItemJson<span style="color:#ce5c00;font-weight:bold">.</span>Volume<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemDataMigrationFacade<span style="color:#ce5c00;font-weight:bold">.</span>SetAlternativeItemNo<span style="color:#ce5c00;font-weight:bold">(</span>ItemJson<span style="color:#ce5c00;font-weight:bold">.</span>AltItemNumber<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">if</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemJson<span style="color:#ce5c00;font-weight:bold">.</span>PrimaryVendor<span style="color:#f8f8f8;text-decoration:underline"> </span>&lt;&gt;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">then</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemDataMigrationFacade<span style="color:#ce5c00;font-weight:bold">.</span>SetVendorNo<span style="color:#ce5c00;font-weight:bold">(</span>ItemJson<span style="color:#ce5c00;font-weight:bold">.</span>PrimaryVendor<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// migrate dependencies
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span>MigrateItemUnitOfMeasure<span style="color:#ce5c00;font-weight:bold">(</span>ItemDataMigrationFacade<span style="color:#000;font-weight:bold">,</span>ItemJson<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// modify the item (+run trigger) to save the changes made by setters
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemDataMigrationFacade<span style="color:#ce5c00;font-weight:bold">.</span>ModifyItem<span style="color:#ce5c00;font-weight:bold">(</span>true<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// update the status in the migration dashboard
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span>DataMigrationStatusFacade<span style="color:#ce5c00;font-weight:bold">.</span>IncrementMigratedRecordCount<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#39;My Migration Type&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#204a87;font-weight:bold">Database</span><span style="color:#000;font-weight:bold">::</span>Item<span style="color:#000;font-weight:bold">,</span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">end</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">end</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">procedure</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MigrateItemUnitOfMeasure<span style="color:#ce5c00;font-weight:bold">(</span>ItemDataMigrationFacade<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Item Data Migration Facade&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemJson<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">var</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MyUnitCodeStagingTable<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;My Unit Code Staging Table&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DataMigrationStatusFacade<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Data Migration Status Facade&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DescriptionToSet<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span>[<span style="color:#0000cf;font-weight:bold">10</span>]<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>UnitCodeJson<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">begin</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">if</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemJson<span style="color:#ce5c00;font-weight:bold">.</span>UnitCode<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">then</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// log an error using the Data migration façade
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span>DataMigrationStatusFacade<span style="color:#ce5c00;font-weight:bold">.</span>RegisterErrorNoStagingTablesCase<span style="color:#ce5c00;font-weight:bold">(
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span><span style="color:#4e9a06">&#39;My Migration Type&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#204a87;font-weight:bold">Database</span><span style="color:#000;font-weight:bold">::</span>Item<span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;Unit of measure is empty.&#39;</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">if</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ExternalWebService<span style="color:#ce5c00;font-weight:bold">.</span>GetUnitCode<span style="color:#ce5c00;font-weight:bold">(</span>ItemJson<span style="color:#ce5c00;font-weight:bold">.</span>UnitCode<span style="color:#000;font-weight:bold">,</span>UnitCodeJson<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">then</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DescriptionToSet<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>UnitCodeJson<span style="color:#ce5c00;font-weight:bold">.</span>Description<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemDataMigrationFacade<span style="color:#ce5c00;font-weight:bold">.</span>CreateUnitOfMeasureIfNeeded<span style="color:#ce5c00;font-weight:bold">(</span>ItemJson<span style="color:#ce5c00;font-weight:bold">.</span>UnitCode<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DescriptionToSet<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// set the unit of measure on the item
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span>ItemDataMigrationFacade<span style="color:#ce5c00;font-weight:bold">.</span>SetBaseUnitOfMeasure<span style="color:#ce5c00;font-weight:bold">(</span>ItemJson<span style="color:#ce5c00;font-weight:bold">.</span>UnitCode<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">end</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p><em>Figure 2: Example of Item and Item Unit of Measure migration without staging tables</em></p>
|
||
<h3 id="usage-with-staging-tables">Usage with staging tables:</h3>
|
||
<p>The overall workflow is:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Integrate your extension in the Data Migration Wizard by subscribing to the events exposed by the <strong>Data Migration Façade</strong>.</p>
|
||
</li>
|
||
<li>
|
||
<p>From there, initialize the status of the migration so it can be displayed in the <strong>Data Migration Overview: &ldquo;Data Migration Status Façade&rdquo;.InitStatusLine(&lsquo;My Migration Type&rsquo;,Database::Item,42000,Database::&ldquo;My extension Staging table for items&rdquo;,0)</strong>.</p>
|
||
</li>
|
||
<li>
|
||
<p>You can either fill the staging tables from the wizard events, or in a subscriber to the event dedicated to filling staging tables (<strong>&lsquo;OnFillStagingTables&rsquo;</strong> in codeunit 6100): in this case, the import of data from the files to the staging tables will be done in the background.</p>
|
||
</li>
|
||
<li>
|
||
<p>Launch the migration: <strong>&ldquo;Data Migration Façade&rdquo;.StartMigration(&lsquo;My Migration Type&rsquo;,false)</strong>.</p>
|
||
</li>
|
||
<li>
|
||
<p>Subscribe to the events to migrate entities and their dependencies.</p>
|
||
</li>
|
||
<li>
|
||
<p>From the event subscribers, call the façade procedures to create entities and set their field values:</p>
|
||
<ul>
|
||
<li><strong>&ldquo;Item Data Migration Façade&rdquo;.CreateItemIfNeeded(&lsquo;ITEM042&rsquo;,&lsquo;My Item Description&rsquo;;&lsquo;My Item Description 2&rsquo;;ItemTypeToSet::Inventory)</strong></li>
|
||
<li><strong>&ldquo;Item Data Migration Façade&rdquo;.SetBaseUnitOfMeasure(&lsquo;BOX&rsquo;)</strong></li>
|
||
<li><strong>&ldquo;Item Data Migration Façade&rdquo;.ModifyItem(true)</strong></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p><a href="StagingTableNew2.png"><img src="StagingTableNew2.png" alt=" "></a></p>
|
||
<p><em>Figure 3: Simplified sequence diagram of the data migration with staging tables</em></p>
|
||
<p>Below is a simplified example showing how to create an item:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">[EventSubscriber<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">ObjectType</span><span style="color:#000;font-weight:bold">::</span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#000;font-weight:bold">::</span>&#34;Item Data Migration Facade&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;OnMigrateItem&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>true<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>true<span style="color:#ce5c00;font-weight:bold">)</span>]<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">procedure</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnMigrateItem<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Sender<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Item Data Migration Facade&#34;<span style="color:#000;font-weight:bold">;</span>RecordIdToMigrate<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">RecordId</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">var</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MyItemStagingTable<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;My Item Staging Table&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">begin</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// handle the event if it targets this extension&#39;s staging table
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">if</span><span style="color:#f8f8f8;text-decoration:underline"> </span>RecordIdToMigrate<span style="color:#ce5c00;font-weight:bold">.</span>TableNo<span style="color:#f8f8f8;text-decoration:underline"> </span>&lt;&gt;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Database</span><span style="color:#000;font-weight:bold">::</span>&#34;My Item Staging Table&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">then</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">exit</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>Get<span style="color:#ce5c00;font-weight:bold">(</span>RecordIdToMigrate<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// create item using the facade
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">if</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">not</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Sender<span style="color:#ce5c00;font-weight:bold">.</span>CreateItemIfNeeded<span style="color:#ce5c00;font-weight:bold">(</span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>ItemNumber<span style="color:#000;font-weight:bold">,</span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>ItemName1<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>ItemName2<span style="color:#000;font-weight:bold">,</span>ConvertItemType<span style="color:#ce5c00;font-weight:bold">(</span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>ItemType<span style="color:#ce5c00;font-weight:bold">)) </span><span style="color:#204a87;font-weight:bold">then</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">exit</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// item already exists
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// set some fields using the facade
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span>Sender<span style="color:#ce5c00;font-weight:bold">.</span>SetVendorItemNo<span style="color:#ce5c00;font-weight:bold">(</span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>VendItemNumber<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Sender<span style="color:#ce5c00;font-weight:bold">.</span>SetUnitVolume<span style="color:#ce5c00;font-weight:bold">(</span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>Volume<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Sender<span style="color:#ce5c00;font-weight:bold">.</span>SetAlternativeItemNo<span style="color:#ce5c00;font-weight:bold">(</span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>AltItemNumber<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">if</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>PrimaryVendor<span style="color:#f8f8f8;text-decoration:underline"> </span>&lt;&gt;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">then</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Sender<span style="color:#ce5c00;font-weight:bold">.</span>SetVendorNo<span style="color:#ce5c00;font-weight:bold">(</span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>PrimaryVendor<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// modify the item (+run trigger) to save the changes made by setters
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span>Sender<span style="color:#ce5c00;font-weight:bold">.</span>ModifyItem<span style="color:#ce5c00;font-weight:bold">(</span>true<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">end</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p><em>Figure 4: Example of event subscriber for Item migration</em></p>
|
||
<p>Below is another example showing how to use additional events to set fields that reference other tables, here the unit of measure:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">[EventSubscriber<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">ObjectType</span><span style="color:#000;font-weight:bold">::</span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#000;font-weight:bold">::</span>&#34;Item Data Migration Facade&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;OnMigrateItemUnitOfMeasure&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>true<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>true<span style="color:#ce5c00;font-weight:bold">)</span>]<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">procedure</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnMigrateItemUnitOfMeasure<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Sender<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Item Data Migration Facade&#34;<span style="color:#000;font-weight:bold">;</span>RecordIdToMigrate<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">RecordId</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">var</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MyItemStagingTable<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;My Item Staging Table&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MyUnitCodeStagingTable<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;My Unit Code Staging Table&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DescriptionToSet<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span>[<span style="color:#0000cf;font-weight:bold">10</span>]<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">begin</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// handle the event if it targets this extension&#39;s staging table
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">if</span><span style="color:#f8f8f8;text-decoration:underline"> </span>RecordIdToMigrate<span style="color:#ce5c00;font-weight:bold">.</span>TableNo<span style="color:#f8f8f8;text-decoration:underline"> </span>&lt;&gt;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Database</span><span style="color:#000;font-weight:bold">::</span>&#34;My Item Staging Table&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">then</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">exit</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>Get<span style="color:#ce5c00;font-weight:bold">(</span>RecordIdToMigrate<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">if</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>UnitCode<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">then</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>error<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#39;Unit of measure is empty.&#39;</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MyUnitCodeStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>SetRange<span style="color:#ce5c00;font-weight:bold">(</span>UnitCode<span style="color:#000;font-weight:bold">,</span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>UnitCode<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">if</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MyUnitCodeStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>FindFirst<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">then</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DescriptionToSet<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MyUnitCodeStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>Description<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// create the unit of measure through the facade
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span>Sender<span style="color:#ce5c00;font-weight:bold">.</span>CreateUnitOfMeasureIfNeeded<span style="color:#ce5c00;font-weight:bold">(</span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>UnitCode<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DescriptionToSet<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// set the unit of measure on the item
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span>Sender<span style="color:#ce5c00;font-weight:bold">.</span>SetBaseUnitOfMeasure<span style="color:#ce5c00;font-weight:bold">(</span>MyItemStagingTable<span style="color:#ce5c00;font-weight:bold">.</span>UnitCode<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// modify the item to save the changes made by setter
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span>Sender<span style="color:#ce5c00;font-weight:bold">.</span>ModifyItem<span style="color:#ce5c00;font-weight:bold">(</span>false<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">end</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p><em>Figure 5: Example of event subscriber for Item Unit of Measure migration</em></p>
|
||
<h3 id="combining-both-approaches">Combining both approaches:</h3>
|
||
<p>If you want to migrate additional entities, the <strong>Data Migration</strong> framework lets you initialize the migration with entities other than master data. In this case, the <strong>Data Migration Overview</strong> page will show additional lines. Item, vendor, customer, an general ledger accounts are migrated with an event driven approach, and the additional entities are migrated by calling an extension codeunit <strong>OnRun</strong> method.</p>
|
||
<h2 id="error-handling-with-staging-tables">Error handling with staging tables:</h2>
|
||
<p>The migration starts by calling <strong>RUN</strong> on the façade codeunit. Errors thrown during the call are captured by <strong>GETLASTERRORTEXT</strong> and displayed when you choose the <strong>Show Errors</strong> action on the <strong>Data Migration Overview</strong> page.</p>
|
||
<p><a href="errorhandling1.png"><img src="errorhandling1.png" alt=" "></a></p>
|
||
<p><em>Figure 6: List of errors shown when clicking <strong>Show Errors</strong> on the <strong>Data Migration Overview</strong> page</em></p>
|
||
<p>The <strong>Edit Record</strong> action opens a view of the staging table, where you can edit fields to fix errors. Figure 4 shows an example of a page for the vendor staging table in a migration from C5.</p>
|
||
<p><a href="errorhandling2.png"><img src="errorhandling2.png" alt=" "></a></p>
|
||
<p><em>Figure 7: Edit a staging table record</em></p>
|
||
<p>The <strong>Staging Table ID</strong> determines the page to open, so it is important that the page ID is equal to the <strong>Staging Table ID</strong>, at least for the master data staging tables, for example, for <strong>G/L Accounts, Items, Customers</strong> and <strong>Vendor</strong>. You should ensure that pages to edit related entities are linked on this page by means of new actions. For example, Figure 4 uses the <strong>C5 Purchaser</strong> action.</p>
|
||
<p>After you fix the staging table record, you can choose the <strong>Migrate</strong> action to mark the selected records as records to retry, and then run <strong>StartMigration</strong> with the <strong>Retry</strong> flag set to true. This is the only place where the retry flag should be set to true in the <strong>StartMigration</strong> procedure.</p>
|
||
<p>Error handling without staging tables</p>
|
||
<p>When migrating data without staging tables, errors can be registered manually by the extension using <strong>DataMigrationStatusFacade.RegisterErrorNoStagingTablesCase</strong>. Otherwise they can be registered automatically if the codeunits fail when called on their <strong>OnRun</strong> procedure.</p>
|
||
<p>Errors will be displayed in the error list, but you cannot open and edit records because there is no staging table. The Edit action will not be available.</p>
|
||
<h2 id="limitations">Limitations:</h2>
|
||
<ul>
|
||
<li>
|
||
<p>Data migration will fail if there are customers, vendors, items in the database and if these entities are selected for migration. For example, if you choose to migrate items and your company already contains items, you will get an error. This should not be an issue if you migrate your data from another tool to NAV, in which case you will most likely start on a fresh empty company. However, if you just want to import additional items to a company with existing items, then it is not supported by the framework. however, you can still use the different functions provided by the different codeunits (such as <strong>Item Data Migration Facade</strong>) to create the entities without strong coupling on the NAV data model.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>G/L entries</strong> are deleted automatically.</p>
|
||
</li>
|
||
<li>
|
||
<p>There is no automated rollback in case of failure: data that is successfully migrated will be commited, and data that is not successfully migrated with be shown in the errors list. The retry feature (in case of staging tables) then makes it possible for you to retry individual entities or ignore them.</p>
|
||
</li>
|
||
</ul>
|
||
<h2 id="usages-in-nav">Usages in NAV:</h2>
|
||
<p>The Data Migration Façade is available starting from version 2018.</p>
|
||
<p>The following Façade codeunits for data migration management are available:</p>
|
||
<ul>
|
||
<li>
|
||
<p>COD6100 (<strong>Data Migration Facade</strong>)</p>
|
||
</li>
|
||
<li>
|
||
<p>COD6101 (<strong>Data Migration Status Facade</strong>)</p>
|
||
</li>
|
||
</ul>
|
||
<p>The following Entity data migration façade codeunits are available:</p>
|
||
<ul>
|
||
<li>
|
||
<p>COD6110 (<strong>GL Acc. Data Migration Facade</strong>)</p>
|
||
</li>
|
||
<li>
|
||
<p>COD6111 (<strong>Vendor Data Migration Facade</strong>)</p>
|
||
</li>
|
||
<li>
|
||
<p>COD6112 (<strong>Customer Data Migration Facade</strong>)</p>
|
||
</li>
|
||
<li>
|
||
<p>COD6113 (<strong>Item Data Migration Facade</strong>)</p>
|
||
</li>
|
||
<li>
|
||
<p>COD6114 (<strong>Ex. Rate Data Migration Facade</strong>)</p>
|
||
</li>
|
||
</ul>
|
||
<h2 id="references">References:</h2>
|
||
<p>Façade pattern on Wikipedia: <a href="https://en.wikipedia.org/wiki/Facade_pattern">https://en.wikipedia.org/wiki/Facade_pattern</a></p></description></item><item><title>Docs: Discovery Event</title><link>https://alguidelines.dev/docs/navpatterns/patterns/discovery-event/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/discovery-event/</guid><description>
|
||
<p><em>by waldo</em></p>
|
||
<h1 id="abstract">Abstract</h1>
|
||
<p>The &ldquo;Discovery Event&rdquo; pattern is a way for a generic functionality, to call out to other functionalities that want to make use of it, by raising an event, so that they have an event to subscribe to. This is usually done to set itself up within the generic app.</p>
|
||
<h1 id="the-problem">The problem</h1>
|
||
<p>Let&rsquo;s suppose you have a generic piece of functionality, that hooks into lots of places (modules) in your application. To set this up, you might have to hook into all these parts of the application. Well, this pattern turns this setup around: let all the different modules set itself up in the generic app by raising a &ldquo;discovery event&rdquo;.</p>
|
||
<h1 id="usage">Usage</h1>
|
||
<p>The pattern is most easily described when you look at an example. This example is an actual usage of the pattern within the application, in page <strong>Service Connections.</strong></p>
|
||
<p><a href="ServiceConnections.jpg"><img src="ServiceConnections.jpg" alt=" "></a></p>
|
||
<p>The goal of this functionality is to:</p>
|
||
<ul>
|
||
<li>List all the different connections to external services,</li>
|
||
<li>Have a central place to navigate to the corresponding setup of the service.</li>
|
||
</ul>
|
||
<p>The functionality (<strong>Service Connections</strong>) itself, is not aware of the state nor setup nor any context of all the different services in the list. All it does is:</p>
|
||
<ul>
|
||
<li>It raises an event as an opportunity for all services within the NAV application to subscribe to,</li>
|
||
<li>It has a public function <strong>InsertServiceConnection</strong> that the subscribers can use to register itself at the Service Connection.</li>
|
||
</ul>
|
||
<p>The event <strong>OnRegisterServiceConnection</strong> is raised when the page (1279 - <strong>Service Connections</strong>) is opened.</p>
|
||
<p>One example of a subscription is the SMTP setup. In Codeunit 400 you&rsquo;ll find the subscriber function <strong>HandleSMTPRegisterServiceConnection</strong> which subscribes to this discovery event, and calls the <strong>InsertServiceConnection</strong> to register itself.</p>
|
||
<h1 id="description">Description</h1>
|
||
<p>The main idea of this pattern is: &ldquo;Discover the settings, the context, the records, &hellip; which I need for my functionality&rdquo; or &ldquo;Discover the configuration for my functionality&rdquo;. In any case, &ldquo;discover&rdquo; is the main idea. It&rsquo;s a pattern where using both publishers and subscribers in one application makes a lot of sense.<br>
|
||
Let&rsquo;s break down to the steps that are needed to implement the pattern.</p>
|
||
<h2 id="step-1-publish-the-event">Step 1: Publish the event</h2>
|
||
<p>In the below example, I create a table <strong>Module Status</strong> with a published event <strong>OnDiscoverModuleStatuses</strong>.</p>
|
||
<p><a href="Pic2.jpg"><img src="Pic2.jpg" alt=" "></a></p>
|
||
<p>You see that I also include the sender. This way, I will be able to access the methods on my table (which I use as a class). Obviously, other patterns can be applied here as well, like the Argument Table pattern.</p>
|
||
<h2 id="step-2-raise-the-event-on-the-right-place">Step 2: Raise the event on the right place</h2>
|
||
<p>When you publish an event, it should obviously be raised somewhere in the code as well. In the below example, I want to raise the event simply by a method which I want to call from a page. So I create a global function where I raise the event:</p>
|
||
<p><a href="Pic2b.jpg"><img src="Pic2b.jpg" alt=" "></a></p>
|
||
<h2 id="step-3-create-one-or-more-global-functions-so-that-your-subscriber-can-call-into-your-functionality-to-configure-set-up-or-do-whatever-it-needs-to-do-to-make-itself-discoverable">Step 3: Create one or more global functions, so that your subscriber can call into your functionality to configure, set up, or do whatever it needs to do to make itself discoverable</h2>
|
||
<p>The generic functionality that I want to call, should be part of the main class - in this case the <strong>Module Discovery</strong> class, or better, the table (<strong>Module Status</strong>). In this table, I create this global function, because I want to make it available for the subscribers:</p>
|
||
<p><a href="Pic3.jpg"><img src="Pic3.jpg" alt=" "></a><br>
|
||
The business logic doesn&rsquo;t really matter for this pattern. This is obviously dependent on the functionality where you would like to implement the pattern.</p>
|
||
<h2 id="step-4-subscribe-from-the-places-in-the-app-to-this-event-use-the-global-functions">Step 4: subscribe from the places in the app to this event, use the global function(s)</h2>
|
||
<p>This could be anywhere. Any module within your vertical, of within the main application, can subscribe to the event. In the example below, I create the subscriber in Codeunit80, as I was interested in the status of the Sales-module in default NAV.<br>
|
||
The exact place of the subscriber is up to you. The main message is that it&rsquo;s part of the module that wants to subscribe, and not part of the <strong>Module Status</strong> module in the application.<br>
|
||
Here is the subscriber (and one small helper function):</p>
|
||
<p><a href="Pic4.jpg"><img src="Pic4.jpg" alt=" "></a><br>
|
||
You see I can use the &ldquo;sender&rdquo; as a normal Record-variable. I access the previously created global function to &ldquo;register&rdquo; this sales-module.</p>
|
||
<h1 id="microsoft-dynamics-nav-versions">Microsoft Dynamics NAV Versions</h1>
|
||
<p>This pattern only works with Microsoft Dynamics <strong>NAV 2016 and up.</strong></p></description></item><item><title>Docs: Document</title><link>https://alguidelines.dev/docs/navpatterns/patterns/document/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/document/</guid><description>
|
||
<p><em>By Xavier Garonnat, knk Ingénierie (France), xgaronnat@knk.fr</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>A document structure contains a header and a set of lines. Each line is linked to the header and could have common data with header.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>This pattern should be used as a basis to build any document, showing a header and multiple lines in the same page. Basically, a document is at least composed of two tables and three pages, as shown below:</p>
|
||
<p><a href="0005.Document-Pattern-UML-Class-Diagram.jpg"><img src="0005.Document-Pattern-UML-Class-Diagram.jpg" alt=" "></a></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>You should use it any time you have to capture and store a document.</p>
|
||
<h2 id="example">Example</h2>
|
||
<p>To build this example from scratch, you will need:</p>
|
||
<ul>
|
||
<li>Two tables, one for the header (called &ldquo;Document Header&rdquo;), and one for the document lines (called &ldquo;Document Line&rdquo;). Each document will be composed of &ldquo;1 to N&rdquo; line(s).</li>
|
||
<li>Three pages, one for the header, one for the subpage (lines), and the last for the document list obviously.Table &ldquo;Document Header&rdquo;</li>
|
||
</ul>
|
||
<p><strong>Table &ldquo;Document Header&rdquo;</strong>: Is the &ldquo;header&rdquo; table of your document (like Sales Header, Purchase Header, Transfer Header &hellip;)</p>
|
||
<ul>
|
||
<li>Add a field &ldquo;No.&rdquo; (Code 20): Should be the first field and primary key of your documents, to be driven by Serial No. (See corresponding design pattern)</li>
|
||
</ul>
|
||
<p>For this sample, I just added a &ldquo;Sell-to Customer No.&rdquo; to this table. Don&rsquo;t forget to manage deletion of lines with trigger OnDelete().</p>
|
||
<p><strong>Table &ldquo;Document Line&rdquo;</strong>: will store the lines of the document</p>
|
||
<ul>
|
||
<li>Add a field &ldquo;Document No.&rdquo; (Code 20): Should be the first field and is related to table &ldquo;Document Header&rdquo;: set TableRelation to your &ldquo;Document Header&rdquo; table</li>
|
||
<li>Add a field &ldquo;Line No.&rdquo; (Integer): this field will be populated automatically by the subpage Page (see AutoSplitKey)</li>
|
||
</ul>
|
||
<p>First (Primary) Key must be &ldquo;Document No.,Line No.&rdquo;. On table properties, set PasteIsValid to No (to avoid copying/pasting lines, will be implemented by &ldquo;Copy document&rdquo;, another pattern).</p>
|
||
<p>For my sample, I just add a couple of fields: &ldquo;Item No.&rdquo; and &ldquo;Quantity&rdquo; to this table (just copy/paste standard fields from &ldquo;Sales Line&rdquo; table and delete trigger code, this will insure that each field will be well designed)</p>
|
||
<p><strong>Page &ldquo;Document Subpage&rdquo;</strong>: will display the lines in the main form, and will be in charge of assigning line number automatically.</p>
|
||
<p>Create the page for table &ldquo;Document Line&rdquo; with the wizard by selecting the ListPart template, add all yours fields except the primary key (&ldquo;Document No.&rdquo; and &ldquo;Line No.&quot;).</p>
|
||
<p>Then edit the properties:</p>
|
||
<ul>
|
||
<li>Set AutoSplitKey, DelayedInsert and MultipleNewLines to Yes: this combination will make your subpage work as required.</li>
|
||
<li>AutoSplitKey is used to set NAV calculate the last field of the key (&ldquo;Line No.&quot;) with proper numbers (10000, 20000&hellip;).</li>
|
||
</ul>
|
||
<p>Set caption to &ldquo;Lines&rdquo;. Save your page, we will use it on the next step.</p>
|
||
<p><strong>Page &ldquo;Document&rdquo;</strong>: will display the document, and the lines with subpage.</p>
|
||
<p>Create the page for &ldquo;Document Header&rdquo; Table with the wizard by selecting the Document template:</p>
|
||
<ul>
|
||
<li>Add a General FastTab</li>
|
||
<li>Add all the revelant fields for the user (or at least &ldquo;No.&quot;)</li>
|
||
<li>Click Finish to close the wizard</li>
|
||
</ul>
|
||
<p>Then simply add your subpage as new line in the designer, and adjust the property &ldquo;SubFormPerLink&rdquo; with &ldquo;Document No.=FIELD(No.)&rdquo; to link header and lines :</p>
|
||
<p><a href="2086.Design-Pattern-Document-SubPage-Properties.png"><img src="2086.Design-Pattern-Document-SubPage-Properties.png" alt=" "></a></p>
|
||
<p><strong>Page &ldquo;Document List&rdquo;:</strong> Use the Page wizard to create a List page based on the Document table and add fields, FactBox (RecordLinks, Notes&hellip;), etc.</p>
|
||
<p>Once created:</p>
|
||
<ul>
|
||
<li>Set Editable to No on the List</li>
|
||
<li>CardPageID to Page &ldquo;Document&rdquo; to enable New/Edit/&hellip; Pane actions.</li>
|
||
</ul>
|
||
<p>Save our page and add it to the Role Page &ldquo;Order Processor Role Center&rdquo; for example.</p>
|
||
<p>Now, observe how &ldquo;Line No.&rdquo; is calculated on the first line, and when inserting a new line between the first and second one.</p>
|
||
<p>Code sample (copy link to your browser) : <a href="https://knk1fr-my.sharepoint.com/personal/xgaronnat_knk_fr/_layouts/15/guestaccess.aspx?guestaccesstoken=hL0P%2fyQ1ZreY5KlSPc%2b8dHrO4zjUkqQbg8DnGSbgd1Y%3d&amp;docid=02b3cb93e1ff1459380891795fb8441fc">https://knk1fr-my.sharepoint.com/personal/xgaronnat_knk_fr/_layouts/15/guestaccess.aspx?guestaccesstoken=hL0P%2fyQ1ZreY5KlSPc%2b8dHrO4zjUkqQbg8DnGSbgd1Y%3d&amp;docid=02b3cb93e1ff1459380891795fb8441fc</a></p>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>So many: Sales Order, Purchase Order, Transfer Order, Assembly Order&hellip;</p>
|
||
<p>For posted document, it&rsquo;s quite similar, but you don&rsquo;t have to setup subpage properties like AutoSplitKey, used for data entry purpose only (and your pages content should be mainly read-only / non editable).</p>
|
||
<h2 id="ideas-for-improvement">Ideas for improvement</h2>
|
||
<ul>
|
||
<li>A new property like &ldquo;AutoSplitStartNumber&rdquo;, enabled if AutoSplitKey=Yes, default value with &lt;10000&gt;. Allow to change the numbers of created line.</li>
|
||
<li>Be able to copy/paste header AND lines or import header and line from an Excel file.</li>
|
||
</ul>
|
||
<h2 id="when-it-should-not-be-used">When it should not be used</h2>
|
||
<p>This pattern is mainly used for Documents, and may not be used directly for Master data or any other table (Setup, Supplemental, etc&hellip;).</p>
|
||
<h2 id="related-topics">Related Topics</h2>
|
||
<p>Use Series No. Pattern for your documents, and Copy Document to implement document duplication.</p>
|
||
<h2 id="references">References</h2>
|
||
<p>Walkthrough: Creating a Document Page : <a href="http://msdn.microsoft.com/en-us/library/dd338599(v=nav.71).aspx" title="http://msdn.microsoft.com/en-us/library/dd338599(v=nav.71).aspx">http://msdn.microsoft.com/en-us/library/dd338599(v=nav.71).aspx</a><br>
|
||
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;">
|
||
<iframe src="https://www.youtube.com/embed/S9cRD2D4c0" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" allowfullscreen title="YouTube Video"></iframe>
|
||
</div>
|
||
</p></description></item><item><title>Docs: Easy Update Of Setup Or Supplementary Information</title><link>https://alguidelines.dev/docs/navpatterns/patterns/easy-update-of-setup-or-supplementary-information/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/easy-update-of-setup-or-supplementary-information/</guid><description>
|
||
<p><em>Originally by Anders Larsen at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>Users or the administrator must regularly update setup or supplementary information in the day-to-day business, such as setting up a new type of customer. This setup task often arrives when their focus is on registration and execution instead of setup.</p>
|
||
<p>The navigation experience around these extra steps is often quite troublesome and time-consuming. To enable users to easily perform the needed update, a guide often gives the best support.</p>
|
||
<p>To guide users, we can prompt them with a dialog on which they can update the setup or supplementary information instantly and easily, so that they can proceed with the business task without being side-tracked.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>Define two functions in the setup or supplementary table: One for verifying if the needed information is available, and another for exposing the page that contains the fields that the user must update.</p>
|
||
<p>Call the code. For example:</p>
|
||
<pre tabindex="0"><code>Local IsXAvailable : Boolean
|
||
If field X &lt;&gt; '' then
|
||
Exit(True)
|
||
Exit(false)
|
||
VerifyAndSetX
|
||
If IsXAvailable then
|
||
Exit;
|
||
If Confirm('Field X is missing a value. Do you want to update it now?') then
|
||
Open the card page in edit mode
|
||
If not IsXAvailable then
|
||
Error(Field X is missing a value. Please correct it.)
|
||
</code></pre><p>The calling code</p>
|
||
<pre tabindex="0"><code>..
|
||
SetupTable.VerifyAndSetX
|
||
..
|
||
</code></pre><h2 id="nav-specific-example">NAV Specific Example</h2>
|
||
<p>In the <strong>Sales &amp; Receivables Setup</strong> table (311) for the DK version, the following procedures have been added:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">Local</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Procedure</span><span style="color:#f8f8f8;text-decoration:underline"> </span>IsOIOUBLPathAvailable<span style="color:#ce5c00;font-weight:bold">(...)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">Procedure</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VerifyAndSetOIOUBLPath<span style="color:#ce5c00;font-weight:bold">(...)
|
||
</span></code></pre></div><p>The code in the <strong>Sales &amp; Receivables Setup</strong> table can now be called directly from the related processing codeunit, such as the <strong>Sales-Post + Print</strong> codeunit (82).</p>
|
||
<p>Were the code is called:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">(</span>&#34;EAN No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span>&lt;&gt;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesSetup<span style="color:#ce5c00;font-weight:bold">.</span>VerifyAndSetOIOUBLPathSetup<span style="color:#ce5c00;font-weight:bold">(</span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>If the setup is not updated properly, the user is prompted to update it as follows.</p>
|
||
<p><a href="0654.easy-update-1.png"><img src="0654.easy-update-1.png" alt=" "></a></p>
|
||
<p>Choosing <strong>Yes</strong> opens the related setup page.</p>
|
||
<p><a href="4024.easy-update-2.png"><img src="4024.easy-update-2.png" alt=" "></a></p>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<ul>
|
||
<li>Report 206, <strong>Sales invoice</strong></li>
|
||
<li>Table 79, <strong>Company Information</strong></li>
|
||
<li>In OIOUBL fields (DK version) during posting/printing of a sales invoice.</li>
|
||
</ul>
|
||
<h2 id="ideas-for-improvement">Ideas for Improvement</h2>
|
||
<p>Make a more generic platform implementation that launches the corresponding card page for Rec on Rec.testfield with an asterisk mark for the field that needs a proper value.</p>
|
||
<h2 id="related-topics">Related Topics</h2>
|
||
<p>The anti-pattern is to do a testfield on a field that is not in the table that you are currently updating.</p>
|
||
<p>The test field message can often be confusing because the pages are often named differently than the tables, which can lead to misunderstanding and context-switching.</p>
|
||
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;">
|
||
<iframe src="https://www.youtube.com/embed/oeASJN-zqTo" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" allowfullscreen title="YouTube Video"></iframe>
|
||
</div></description></item><item><title>Docs: Error Message Processing</title><link>https://alguidelines.dev/docs/navpatterns/patterns/error-message-processing/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/error-message-processing/</guid><description>
|
||
<p><em>By Jesper Schulz at Microsoft Development Center Copenhagen</em></p>
|
||
<p>Note: This pattern describes new functionality which makes it possible to generalize the <a href="https://alguidelines.dev/navpatterns/1-patterns/journal-error-processing/">Journal Error Processing</a> pattern.</p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>Missing, invalid or incomplete data is a common issue during data processing in NAV. This article describes how to collect all error messages during processing using the error message component and present them to the user in a unified way, which enables the user to correct the errors efficiently. By leveraging the integrated error message logging functions, you can log a message with a single line of code and present it to the user with another one-liner.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>This article describes how to use the Error Message component in NAV, which in short gives you the possibility to:</p>
|
||
<ol>
|
||
<li>Link an error message to the page which enables you to resolve the problem.</li>
|
||
<li>Assemble all error messages in one central view instead of having to encounter them one by one.</li>
|
||
</ol>
|
||
<p>Validating data is a common task during data processing in NAV. Unfortunately, validation is often done using NAV&rsquo;s integrated ERROR and TESTFIELD functions, which halt execution of the process. The user will then have to locate the invalid / missing data, correct it and reinitiate the process, possibly running into the next error, making the cycle repeat itself. This can be a very tedious, time-consuming and frustrating process. The error message component aims at improving this experience by providing a lightweight framework for error message logging and this article will explain how to leverage this functionality in your code. By doing so, all error messages are gathered during (pre-)processing and are finally presented to the user. The user then has the possibility to click on the error message, which will open the record where the invalid / missing data is located, thereby enabling the user to correct all mistakes efficiently, from one central place and in one go.</p>
|
||
<p>The example below comes from a Mexican localization, where the user has to export financial balances and transactions into an XML file for government audit purposes. In order to generate valid files, some mandatory data needs to be entered in the system. By leveraging the error message component, the user will be presented with the following page, if missing or invalid data was discovered:</p>
|
||
<p><a href="image001.png"><img src="image001.png" alt=" "></a></p>
|
||
<p>By clicking on the error message, the user will be presented with the entity, where the invalid / missing data should be corrected / added. This is done by applying the related pattern <a href="https://alguidelines.dev/navpatterns/1-patterns/easy-update-of-setup-or-supplementary-information/">Easy Update of Setup or Supplementary Information</a>.</p>
|
||
<p><a href="image003.png"><img src="image003.png" alt=" "></a></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>In the processing function, define a temporary record of type &ldquo;Error Message&rdquo;. Use the functions on that record to populate the record with error message, a few of them being:</p>
|
||
<ul>
|
||
<li><strong>LogIfEmpty</strong></li>
|
||
<li><strong>LogIfLengthExceeded</strong></li>
|
||
<li><strong>LogIfInvalidCharacters</strong></li>
|
||
<li><strong>LogIfOutsideRange</strong></li>
|
||
<li><strong>LogIfGreaterThan</strong></li>
|
||
<li><strong>LogIfEqualTo</strong></li>
|
||
<li><strong>LogMessage</strong></li>
|
||
</ul>
|
||
<p>The following parameters must be provided to these functions:</p>
|
||
<ul>
|
||
<li><strong>Record:</strong> The record which you want to check</li>
|
||
<li><strong>Field Number:</strong> The field number of the field you want to verify the value of</li>
|
||
<li><strong>Condition:</strong> The condition the field must meet (e.g. length, range, valid characters)</li>
|
||
<li><strong>Message Type:</strong> The type of message, which can be Error, Warning or Message</li>
|
||
</ul>
|
||
<p>When the processing is complete, you can check if any error messages of type &ldquo;Error&rdquo; were logged by calling the <strong>HasErrors</strong> function and you can show the list or error messages by calling the <strong>ShowErrorMessages</strong> function. You can also integrate the error messages list as a FactBox, but that is not part of this example.</p>
|
||
<h2 id="nav-specific-example">NAV Specific Example</h2>
|
||
<p>The code below is an example of how the error message component was used in one part of the before mentioned Mexican feature. This code iterates over all G/L Accounts and pipes information out into an XML file. While doing so, it is validated that all mandatory fields have values and meet certain conditions. And only if that is the case, is the XML document actually exported. Also notice, that an error message is logged, in case no G/L Accounts are found given the provided filters. That way, the user can be guided to setup the system correctly.</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-AL" data-lang="AL"><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ExportChartOfAccounts@<span style="color:#0000cf;font-weight:bold">1</span><span style="color:#ce5c00;font-weight:bold">(</span>Year@<span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#000;font-weight:bold">;</span>Month@<span style="color:#0000cf;font-weight:bold">1001</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempErrorMessage@<span style="color:#0000cf;font-weight:bold">1003</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">TEMPORARY</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">700</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempErrorMessage<span style="color:#ce5c00;font-weight:bold">.</span>ClearLog<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// only necessary if variable is global
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">...
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span>CreateXMLHeader<span style="color:#ce5c00;font-weight:bold">(</span>Document<span style="color:#000;font-weight:bold">,</span>RootNode<span style="color:#000;font-weight:bold">,</span>CatalogoNodeTxt<span style="color:#000;font-weight:bold">,</span>Namespace<span style="color:#000;font-weight:bold">,</span>Year<span style="color:#000;font-weight:bold">,</span>Month<span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;1.1&#39;</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GLAccount<span style="color:#ce5c00;font-weight:bold">.</span>FINDSET<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">REPEAT</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempErrorMessage<span style="color:#ce5c00;font-weight:bold">.</span>LogIfEmpty<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">(</span>GLAccount<span style="color:#000;font-weight:bold">,</span>GLAccount<span style="color:#ce5c00;font-weight:bold">.</span>FIELDNO<span style="color:#ce5c00;font-weight:bold">(</span>Name<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">,</span>TempErrorMessage<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Message Type&#34;<span style="color:#000;font-weight:bold">::</span>Error<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>XMLDOMManagement<span style="color:#ce5c00;font-weight:bold">.</span>AddElement<span style="color:#ce5c00;font-weight:bold">(</span>RootNode<span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;Ctas&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">,</span>Namespace<span style="color:#000;font-weight:bold">,</span>Node<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>XMLDOMManagement<span style="color:#ce5c00;font-weight:bold">.</span>AddAttribute<span style="color:#ce5c00;font-weight:bold">(</span>Node<span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;CodAgrup&#39;</span><span style="color:#000;font-weight:bold">,</span>GLAccount<span style="color:#ce5c00;font-weight:bold">.</span>&#34;SAT Account Code&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">...
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span><span style="color:#204a87;font-weight:bold">CASE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GLAccount<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Debit/Credit&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">OF</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GLAccount<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Debit/Credit&#34;<span style="color:#000;font-weight:bold">::</span>Debit<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>XMLDOMManagement<span style="color:#ce5c00;font-weight:bold">.</span>AddAttribute<span style="color:#ce5c00;font-weight:bold">(</span>Node<span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;Natur&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;D&#39;</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GLAccount<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Debit/Credit&#34;<span style="color:#000;font-weight:bold">::</span>Credit<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>XMLDOMManagement<span style="color:#ce5c00;font-weight:bold">.</span>AddAttribute<span style="color:#ce5c00;font-weight:bold">(</span>Node<span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;Natur&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;A&#39;</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ELSE</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempErrorMessage<span style="color:#ce5c00;font-weight:bold">.</span>LogMessage<span style="color:#ce5c00;font-weight:bold">(
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span>GLAccount<span style="color:#000;font-weight:bold">,</span>GLAccount<span style="color:#ce5c00;font-weight:bold">.</span>FIELDNO<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Debit/Credit&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">,</span>TempErrorMessage<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Message Type&#34;<span style="color:#000;font-weight:bold">::</span>Error<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>STRSUBSTNO<span style="color:#ce5c00;font-weight:bold">(</span>GLAccountTypeErr<span style="color:#000;font-weight:bold">,</span>GLAccount<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Debit/Credit&#34;<span style="color:#000;font-weight:bold">,</span>GLAccount<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">RECORDID</span><span style="color:#ce5c00;font-weight:bold">))</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">UNTIL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GLAccount<span style="color:#ce5c00;font-weight:bold">.</span>NEXT<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ELSE</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempErrorMessage<span style="color:#ce5c00;font-weight:bold">.</span>LogSimpleMessage<span style="color:#ce5c00;font-weight:bold">(</span>TempErrorMessage<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Message Type&#34;<span style="color:#000;font-weight:bold">::</span>Error<span style="color:#000;font-weight:bold">,</span>NoSATAccountDefinedErr<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">NOT</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempErrorMessage<span style="color:#ce5c00;font-weight:bold">.</span>HasErrors<span style="color:#ce5c00;font-weight:bold">(</span>TRUE<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SaveXMLToClient<span style="color:#ce5c00;font-weight:bold">(</span>Document<span style="color:#000;font-weight:bold">,</span>Year<span style="color:#000;font-weight:bold">,</span>Month<span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;CT&#39;</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempErrorMessage<span style="color:#ce5c00;font-weight:bold">.</span>ShowErrorMessages<span style="color:#ce5c00;font-weight:bold">(</span>FALSE<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>One could also do pre-processing in a function of its own, and only if the pre-processing results in no error messages of type &ldquo;Error&rdquo; would the processing continue.</p>
|
||
<h2 id="ideas-for-improvement">Ideas for improvement</h2>
|
||
<p>By using this easy to use component, we have the possibility to extend this functionality going forward. A nice addition to the error message component would be the possibility to log the error messages persistently in a grouped manner, thereby allowing 3rd parties to see the issues the users bump into the most, or allowing 3rd parties to get an detailed insight into what happened, thereby enabling them to provide better support.</p></description></item><item><title>Docs: Extending the Role Center Headlines</title><link>https://alguidelines.dev/docs/navpatterns/patterns/extending-the-role-center-headlines/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/extending-the-role-center-headlines/</guid><description>
|
||
<p><em>By David Bastide at Microsoft Development Center Copenhagen</em></p>
|
||
<p><a href="3733.logo.png"><img src="3733.logo.png" alt=" "></a></p>
|
||
<h2 id="context">Context</h2>
|
||
<p>Headlines are designed as a page of type HeadlinePart containing at least one text field. The part is added to the top of Role Center pages.<br>
|
||
This document provides an elegant and extensible pattern about how to extend the Role Center headlines to add your own business headlines based on your data, and display them only if relevant.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>The Dynamics 365 Business Central release (April 2018) introduces a new HeadlinePart page type. This page type defines a page that rotates a display of several headlines after another, in the web client. A user can also click to switch to another headline. Headlines can also include a drilldown action that will be invoked when the user clicks the headline Text of the payload can be emphasized.<br>
|
||
Headlines are divided in 2 parts: the qualifier, and the payload as you can see in the figure below.</p>
|
||
<p><a href="Headline.png"><img src="Headline.png" alt=" "></a></p>
|
||
<p><em>Figure 1: Qualifier, Payload and emphasized text.</em></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>A page part has been added to each major Role Center:</p>
|
||
<ul>
|
||
<li>Page 9006 Order Processor Role Center, contains Page 1441 Headline RC Order Processor</li>
|
||
<li>Page 9015 Job Project Manager RC, contains Page 1443 Headline RC Project Manager</li>
|
||
<li>Page 9022 Business Manager Role Center, contains Page 1440 Headline RC Business Manager</li>
|
||
<li>Page 9024 Security Admin Role Center, contains Page 1445 Headline RC Administrator</li>
|
||
<li>Page 9026 Sales &amp; Relationship Mgr. RC, contains Page 1444 Headline RC Relationship Mgt.</li>
|
||
<li>Page 9027 Accountant Role Center, contains Page 1442 Headline RC Accountant</li>
|
||
<li>Page 9028 Team Member Role Center, contains Page 1446 Headline RC Team Member</li>
|
||
<li>Page 9010 Production Planner Role Center, contains Page 1447 Headline RC Prod. Planner</li>
|
||
<li>Page 9016 Service Dispatcher Role Center, contains Page 1448 Headline RC Serv. Dispatcher</li>
|
||
</ul>
|
||
<p>You can create extensions that extend these pages to add your own headlines.<br>
|
||
If no headline is added on these pages, fallback headlines will be displayed.</p>
|
||
<p>The process to extend the headlines of a Role Center is simple:</p>
|
||
<ol>
|
||
<li>In a V2 extension, extend the pages (PAG1440 to 1446) with one or more fields you want to add as headlines. The field and its visibility should be variables that are populated in OnAfterGetRecord.</li>
|
||
<li>Subscribe to the OnComputeHeadlines event from the codeunits associated with the page (same ID and name as the page). Here you can compute your headlines. You should store the result in a table in your extension, so you can quickly get the results in step 3. The computation is done in a background task, not to decrease the performance of the role center pages.</li>
|
||
<li>Subscribe to the OnIsAnyExtensionHeadlineVisible event from the page. This event is used to determine if any extension has visible headlines, and if so, hide the fallback headlines. You should set the ExtensionHeadlinesVisible variable to true if your extension has headlines to display at the time of the event. Otherwise, do nothing.</li>
|
||
<li>In the page, in the OnAfterGetRecord trigger, get the headline text and visibility values and copy them to your added fields.</li>
|
||
</ol>
|
||
<p>To format headlines, you should use Codeunit 1439 Headline Management functions:</p>
|
||
<ul>
|
||
<li>Truncate: to truncate a text gracefully when possible with &ldquo;&hellip;&rdquo;. For example, HeadlineManagement.Truncate(&lsquo;the text&rsquo;,6) returns &ldquo;the&hellip;&rdquo;.</li>
|
||
<li>Emphasize: to emphasize part of the headline payload. Emphasized text is shown with a different style.</li>
|
||
<li>GetHeadlineText: to build the headline text. You provide the headline qualifier and payload, and you get the headline in a format that will be interpreted and formatted correctly by the client. It returns false if the qualifier exceeds its maximum length (50 characters) or payload exceeds its maximum length (75 characters). In that case it will not return the headline. If the qualifier you specify is empty, the default text &ldquo;HEADLINE&rdquo; will be displayed in the qualifier area. The payload must not be empty.</li>
|
||
</ul>
|
||
<h3 id="examples">Examples:</h3>
|
||
<h4 id="1-extending-the-page-with-a-new-headline">1. Extending the page with a new headline:</h4>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">group</span><span style="color:#ce5c00;font-weight:bold">(</span>LargestSale<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span>{<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Visible<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span>LargestSaleVisible<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ShowCaption=false<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Editable=false<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">field</span><span style="color:#ce5c00;font-weight:bold">(</span>LargestSaleText<span style="color:#000;font-weight:bold">;</span>LargestSaleText<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span>{<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ApplicationArea<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span>Basic<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Suite<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DrillDown=true<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">trigger</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnDrillDown<span style="color:#ce5c00;font-weight:bold">()
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span><span style="color:#204a87;font-weight:bold">var</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusHeadlineMgt<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Essential Bus. Headline Mgt.&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">begin</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusHeadlineMgt<span style="color:#ce5c00;font-weight:bold">.</span>OnDrillDownLargestSale<span style="color:#ce5c00;font-weight:bold">()</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">end</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>}<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>}<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h4 id="2-subscribing-to-the-oncomputeheadlines-event-and-computing-headlines">2. Subscribing to the OnComputeHeadlines event, and computing headlines</h4>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">[EventSubscriber<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">ObjectType</span><span style="color:#000;font-weight:bold">::</span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#000;font-weight:bold">::</span>&#34;Headline RC Business Manager&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;OnComputeHeadlines&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>true<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>true<span style="color:#ce5c00;font-weight:bold">)</span>]<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">procedure</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnComputeHeadlinesBusinessManager<span style="color:#ce5c00;font-weight:bold">()
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span><span style="color:#204a87;font-weight:bold">begin</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// [...] compute headline, and init the EssentialBusinessHeadline record
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">if</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">not</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ShowHeadline<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">then</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">exit</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// not enough data to compute headline
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">if</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">not</span><span style="color:#f8f8f8;text-decoration:underline"> </span>HeadlineManagement<span style="color:#ce5c00;font-weight:bold">.</span>GetHeadlineText<span style="color:#ce5c00;font-weight:bold">(
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span><span style="color:#4e9a06">&#39;Insight from last week&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>StrSubstNo<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#39;The largest posted sales invoice was for %1&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>HeadlineManagement<span style="color:#ce5c00;font-weight:bold">.</span>Emphasize<span style="color:#ce5c00;font-weight:bold">(</span>Format<span style="color:#ce5c00;font-weight:bold">(</span>CustomerLedgerEntry<span style="color:#ce5c00;font-weight:bold">.</span>Amount<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TypeHelper<span style="color:#ce5c00;font-weight:bold">.</span>GetAmountFormatWithUserLocale<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#39;$&#39;</span><span style="color:#ce5c00;font-weight:bold">))))
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Headline Text&#34;<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span><span style="color:#204a87;font-weight:bold">then</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">exit</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>Validate<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Headline Visible&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>true<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">Modify</span><span style="color:#ce5c00;font-weight:bold">()</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">end</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h4 id="3-subscribing-to-the-onisanyextensionheadlinevisible-event">3. Subscribing to the OnIsAnyExtensionHeadlineVisible event</h4>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">[EventSubscriber<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">ObjectType</span><span style="color:#000;font-weight:bold">::</span><span style="color:#204a87;font-weight:bold">Page</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Page</span><span style="color:#000;font-weight:bold">::</span>&#34;Headline RC Business Manager&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;OnIsAnyExtensionHeadlineVisible&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>true<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>true<span style="color:#ce5c00;font-weight:bold">)</span>]<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">procedure</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnIsAnyExtensionHeadlineVisible<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">var</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ExtensionHeadlinesVisible<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">var</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Essential Business Headline&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>AtLeastOneHeadlineVisible<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">begin</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>SetRange<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Headline Visible&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>true<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>SetFilter<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Headline Name&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;%1|%2|%3|%4|%5&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Headline Name&#34;<span style="color:#000;font-weight:bold">::</span>LargestOrder<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Headline Name&#34;<span style="color:#000;font-weight:bold">::</span>LargestSale<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Headline Name&#34;<span style="color:#000;font-weight:bold">::</span>BusiestResource<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Headline Name&#34;<span style="color:#000;font-weight:bold">::</span>MostPopularItem<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Headline Name&#34;<span style="color:#000;font-weight:bold">::</span>SalesIncrease<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Headline Name&#34;<span style="color:#000;font-weight:bold">::</span>TopCustomer<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>AtLeastOneHeadlineVisible<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">not</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>IsEmpty<span style="color:#ce5c00;font-weight:bold">()</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// only modify the var if this extension is making some headlines visible, setting to false could override some other extensions setting the value to true
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">if</span><span style="color:#f8f8f8;text-decoration:underline"> </span>AtLeastOneHeadlineVisible<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">then</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ExtensionHeadlinesVisible<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>true<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">end</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h4 id="heading"></h4>
|
||
<h4 id="4-setting-the-headline-text-on-the-page">4. Setting the headline text on the page</h4>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">trigger</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnAfterGetRecord<span style="color:#ce5c00;font-weight:bold">()
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">begin</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>GetHeadline<span style="color:#ce5c00;font-weight:bold">(</span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Headline Name&#34;<span style="color:#000;font-weight:bold">::</span>LargestSale<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>LargestSaleVisible<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Headline Visible&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>LargestSaleText<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>EssentialBusinessHeadline<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Headline Text&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">end</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p><a href="0724.Headline-sequence-diagram-v2.png"><img src="0724.Headline-sequence-diagram-v2.png" alt=" "></a></p>
|
||
<p><em>Figure 2: Sequence diagram of headline usage</em></p>
|
||
<h2 id="usages-in-nav">Usages in NAV:</h2>
|
||
<ul>
|
||
<li>Essential Business Headlines extension</li>
|
||
</ul></description></item><item><title>Docs: Feature Localization For Data Structures</title><link>https://alguidelines.dev/docs/navpatterns/patterns/feature-localization-for-data-structures/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/feature-localization-for-data-structures/</guid><description>
|
||
<p><em>Originally by Bogdan Sturzoiu at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>This pattern shows a solution for integrating W1 features to pre-existing country features that use different tables to achieve similar functionality.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>It sometimes happens that certain features are requested in a NAV-supported country, but they are not initially considered generic enough to be included in the W1 build. This is how local features, such as Subcontracting in Italy and India, were created or specific banking and payments functionality in Italy, France, Spain, and others.</p>
|
||
<p>Then, at some point in time, a decision is made to create a W1 feature that is closely related to the local functionality but uses a completely different set of tables, pages, etc. The developers now face the following problem: How to enable the newly-developed W1 feature into a country, such that the customers who are accustomed to their local structures can seamlessly continue working without completely (or immediately) switching to the W1 objects.</p>
|
||
<p>This was the issue that was tackled in the NAV 2013 R2, in relation to the SEPA Credit Transfers functionality.</p>
|
||
<h3 id="using-a-proxy">Using a Proxy</h3>
|
||
<p>The generic Proxy pattern is &ldquo;a class functioning as an interface to something else&rdquo; (<a href="http://en.wikipedia.org/wiki/Proxy_pattern">Wikipedia</a>).</p>
|
||
<p><a href="5123.Feature-localization-for-data-structures-1.png"><img src="5123.Feature-localization-for-data-structures-1.png" alt=" "></a></p>
|
||
<p>Figure 1. Proxy in UML</p>
|
||
<h3 id="pattern-elements">Pattern Elements</h3>
|
||
<p>The NAV data model translation of the proxy pattern can be used as explained below.</p>
|
||
<p>The RealSubject is the NAV data model. Variations in table structures, relationships, and numbers are particular to each country. The W1 model is the base for the country-localized data models. However, some countries have heavy localizations which cannot be directly processed by the W1 core objects.</p>
|
||
<p>The proxy is a codeunit that gathers data from wherever it is stored and transforms it to fit into a standard table, which is later used across all localizations.</p>
|
||
<p>The interface is the fixed form in which the data is presented to be consumed by the client.</p>
|
||
<p>The client can be an XML port that is fed from the common data interface. It can also be any other data processor (a codeunit fed to another table, etc.) or data display object (page or report).</p>
|
||
<h3 id="pattern-steps">Pattern Steps</h3>
|
||
<ol>
|
||
<li>
|
||
<p>The user creates records in the local tables.</p>
|
||
</li>
|
||
<li>
|
||
<p>The user invokes an action that must be processed using the W1 feature code.</p>
|
||
</li>
|
||
<li>
|
||
<p>The proxy codeunit moves the data from the local tables to the W1 tables, either into a temporary or persistent set of records, as needed.</p>
|
||
</li>
|
||
<li>
|
||
<p>The W1 code now performs the action on the W1 table data.</p>
|
||
</li>
|
||
</ol>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>In NAV 2013 R2, we released the SEPA Credit Transfer functionality. It involves exporting vendor payments to an XML file that is subsequently processed by the customer&rsquo;s bank. The payments are exported from the Payment Journal page through a configurable XMLport. Therefore, the data source for these payment lines is the Gen. Journal Line table (81).</p>
|
||
<p>In various countries, we already had payment export functionality, usually into flat bank files. However, the files are generated from different tables than in W1. For example, in Italy, vendor payments are handled through the Vendor Bill Header table (12181) and the Vendor Bill Line table (12182). They are the RealSubject.</p>
|
||
<p>The W1 feature flow is as follows:</p>
|
||
<p><a href="6052.Feature-localization-for-data-structures-2.png"><img src="6052.Feature-localization-for-data-structures-2.png" alt=" "></a></p>
|
||
<p>Figure 2. W1 object call sequence</p>
|
||
<p><strong>Note:</strong> CT = Credit Transfers, pain = payments initiation (the XML format used for SEPA Credit Transfers and SEPA Direct Debit).</p>
|
||
<p>The key question is: Where to tap into this flow when using a local data structure. For this purpose, a proxy codeunit has been added in W1, called 1222 &ndash; SEPA CT-Prepare Source. This codeunit feeds the client (XML1000) data in a standard format (the interface is the Gen. Journal Line table (81)).</p>
|
||
<p>In W1, the codeunit simply outputs the same set of general journal lines that it receives as an input:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-AL" data-lang="AL">OnRun<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Rec<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span>GenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>COPYFILTERS<span style="color:#ce5c00;font-weight:bold">(</span>Rec<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>CopyJnlLines<span style="color:#ce5c00;font-weight:bold">(</span>GenJnlLine<span style="color:#000;font-weight:bold">,</span>Rec<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CopyJnlLines<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromGenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempGenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">TEMPORARY</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromGenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>FINDSET<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>GenJnlBatch<span style="color:#ce5c00;font-weight:bold">.</span>GET<span style="color:#ce5c00;font-weight:bold">(</span>FromGenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Journal Template Name&#34;<span style="color:#000;font-weight:bold">,</span>FromGenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Journal Batch Name&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">REPEAT</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>TempGenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromGenJnlLine<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>TempGenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>INSERT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">UNTIL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromGenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>NEXT<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ELSE</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>CreateTempJnlLines<span style="color:#ce5c00;font-weight:bold">(</span>FromGenJnlLine<span style="color:#000;font-weight:bold">,</span>TempGenJnlLine<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CreateTempJnlLines<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromGenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempGenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">TEMPORARY</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#8f5902;font-style:italic">// To fill TempGenJnlLine from the source identified by filters set on FromGenJnlLine
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>TempGenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromGenJnlLine<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>In a country, such as Italy, the codeunit will have the following functions:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Gets an empty set of general journal lines that carry the local payment document key as a filter on the Document No. field (as opposed to W1 that gets the real set of records to be exported). This is done so that the local data can be extracted at runtime.</p>
|
||
</li>
|
||
<li>
|
||
<p>Selects the local payment data, for example in Italy, in the Vendor Bill Header and Vendor Bill Lines tables.</p>
|
||
</li>
|
||
<li>
|
||
<p>Transforms the local payment data into temporary records of the Gen. Journal Line table.</p>
|
||
</li>
|
||
<li>
|
||
<p>Outputs the temporary general journal lines that will be further processed and exported, exactly as in W1.</p>
|
||
</li>
|
||
</ol>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-AL" data-lang="AL">OnRun<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Rec<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span>GenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>COPYFILTERS<span style="color:#ce5c00;font-weight:bold">(</span>Rec<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>CopyJnlLines<span style="color:#ce5c00;font-weight:bold">(</span>GenJnlLine<span style="color:#000;font-weight:bold">,</span>Rec<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CopyJnlLines<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromGenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempGenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">TEMPORARY</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromGenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>FINDSET<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>GenJnlBatch<span style="color:#ce5c00;font-weight:bold">.</span>GET<span style="color:#ce5c00;font-weight:bold">(</span>FromGenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Journal Template Name&#34;<span style="color:#000;font-weight:bold">,</span>FromGenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Journal Batch Name&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">REPEAT</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>TempGenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromGenJnlLine<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>TempGenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>INSERT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">UNTIL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromGenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>NEXT<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ELSE</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>CreateTempJnlLines<span style="color:#ce5c00;font-weight:bold">(</span>FromGenJnlLine<span style="color:#000;font-weight:bold">,</span>TempGenJnlLine<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CreateTempJnlLines<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromGenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempGenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">TEMPORARY</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span>PaymentDocNo<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromGenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>GETFILTER<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Document No.&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>VendorBillHeader<span style="color:#ce5c00;font-weight:bold">.</span>GET<span style="color:#ce5c00;font-weight:bold">(</span>PaymentDocNo<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>RESET<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>SETCURRENTKEY<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Vendor Bill List No.&#34;<span style="color:#000;font-weight:bold">,</span>&#34;Vendor No.&#34;<span style="color:#000;font-weight:bold">,</span>&#34;Due Date&#34;<span style="color:#000;font-weight:bold">,</span>&#34;Vendor Bank Acc. No.&#34;<span style="color:#000;font-weight:bold">,</span>&#34;Cumulative Transfers&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Vendor Bill List No.&#34;<span style="color:#000;font-weight:bold">,</span>VendorBillHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;No.&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Cumulative Transfers&#34;<span style="color:#000;font-weight:bold">,</span>TRUE<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>FINDSET<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>CumulativeAmount<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>PrevVendorBillLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">REPEAT</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">TESTFIELD</span><span style="color:#ce5c00;font-weight:bold">(</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">,</span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>Invoice<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">((</span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Vendor No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span>&lt;&gt;<span style="color:#f8f8f8;text-decoration:underline"> </span>PrevVendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Vendor No.&#34;<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">OR</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">(</span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Vendor Bank Acc. No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span>&lt;&gt;<span style="color:#f8f8f8;text-decoration:underline"> </span>PrevVendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Vendor Bank Acc. No.&#34;<span style="color:#ce5c00;font-weight:bold">)) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline"> </span>InsertTempGenJnlLine<span style="color:#ce5c00;font-weight:bold">(</span>TempGenJnlLine<span style="color:#000;font-weight:bold">,</span>VendorBillHeader<span style="color:#000;font-weight:bold">,</span>PrevVendorBillLine<span style="color:#000;font-weight:bold">,</span>CumulativeAmount<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>CumulativeAmount<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Amount to Pay&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ELSE</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>CumulativeAmount<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">+=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Amount to Pay&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>PrevVendorBillLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">UNTIL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>NEXT<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span>InsertTempGenJnlLine<span style="color:#ce5c00;font-weight:bold">(</span>TempGenJnlLine<span style="color:#000;font-weight:bold">,</span>VendorBillHeader<span style="color:#000;font-weight:bold">,</span>PrevVendorBillLine<span style="color:#000;font-weight:bold">,</span>CumulativeAmount<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Cumulative Transfers&#34;<span style="color:#000;font-weight:bold">,</span>FALSE<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>FINDSET<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">REPEAT</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">TESTFIELD</span><span style="color:#ce5c00;font-weight:bold">(</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">,</span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>Invoice<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span>InsertTempGenJnlLine<span style="color:#ce5c00;font-weight:bold">(</span>TempGenJnlLine<span style="color:#000;font-weight:bold">,</span>VendorBillHeader<span style="color:#000;font-weight:bold">,</span>VendorBillLine<span style="color:#000;font-weight:bold">,</span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Amount to Pay&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">UNTIL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>NEXT<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>InsertTempGenJnlLine<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempGenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">TEMPORARY</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#000;font-weight:bold">;</span>VendorBillHeader<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Vendor Bill Header&#34;<span style="color:#000;font-weight:bold">;</span>VendorBillLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Vendor Bill Line&#34;<span style="color:#000;font-weight:bold">;</span>AmountToPay<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Decimal</span><span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">WITH</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempGenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DO</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>INIT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Journal Template Name&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Journal Batch Name&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Document Type&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>Payment<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Document No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Vendor Bill List No.&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Line No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Line No.&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Account No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Vendor No.&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Account Type&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempGenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Account Type&#34;<span style="color:#000;font-weight:bold">::</span>Vendor<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Bal. Account Type&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempGenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Bal. Account Type&#34;<span style="color:#000;font-weight:bold">::</span>&#34;Bank Account&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Bal. Account No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Bank Account No.&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Applies-to Ext. Doc. No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;External Document No.&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>Amount<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>AmountToPay<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Applies-to Doc. Type&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Applies-to Doc. No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document No.&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Currency Code&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Currency Code&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Due Date&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Due Date&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Posting Date&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Posting Date&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Recipient Bank Account&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Vendor Bank Acc. No.&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>Description<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>Description<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Message to Recipient&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VendorBillLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Description 2&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>INSERT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>The derived local feature flow is as follows:</p>
|
||
<p><a href="3058.Feature-localization-for-data-structures-3.png"><img src="3058.Feature-localization-for-data-structures-3.png" alt=" "></a></p>
|
||
<p>Figure 3. The local country object flow</p>
|
||
<p>As we can see from the diagram, this solution allows integration of the local and W1 features with a minimum amount of changes in W1 code. The only two differences are:</p>
|
||
<ol>
|
||
<li>
|
||
<p>The entry point of the flow is the local table/page.</p>
|
||
</li>
|
||
<li>
|
||
<p>Codeunit 1222 is overloaded to prepare general journal lines from the local records.</p>
|
||
</li>
|
||
</ol>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>The data mapping technique has been used for the SEPA Credit Transfer feature, and will be used in subsequent local integration projects.</p>
|
||
<h2 id="ideas-for-improvement">Ideas for improvement</h2>
|
||
<p>A weak point for this pattern is the need to set a filter on the empty journal line in order to retrieve the local data when exporting from a local page. This can cause problems if the size of the local table document number is larger than the Document No. field (ID 20) in the Gen. Journal line table (81).</p>
|
||
<p>Also, there is a strong need for thorough testing when using this pattern, because there might be differences in the behavior of the local table and table 81. Whatever is acceptable for the local table may not be acceptable for the W1 table. A deep functional analysis is needed to see if the local export feature uses the same constraints as the W1 feature.</p></description></item><item><title>Docs: Hooks</title><link>https://alguidelines.dev/docs/navpatterns/patterns/hooks/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/hooks/</guid><description>
|
||
<p><em>By Eric Wauters (<a href="http://www.waldo.be" title="waldo's blog">waldo</a>), Partner-Ready-Software</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>As a partner, adding new code to NAV means interfering with code shipped by Microsoft. Minimize your footprint of changes in Microsoft code, so that, when a new NAV version is shipped, you avoid conflicts and upgrade impact. The core NAV code is the &ldquo;danger zone&rdquo; - the less you touch it, the happier your upgrade will be.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>When doing development over years, by different developers with different mindsets, the standard codebase gets changed a lot, adding multiple lines of code, adding local and global variants, adding or changing keys, changing existing business logic, &hellip; . In other terms, the standard text objects are being changed all over the place.. .</p>
|
||
<p>After years, it&rsquo;s not clear why a change was done, and what was the place where the change was intended to be done. And the latter is quite important in an upgrade process, when code in the base product is being refactored: if the exact place of the posting of the Customer Entry is being redesigned to a separate number, the first thing I need to know, is that I did a certain change at the place: &ldquo;where the posting of the Customer Entry starts&rdquo;. The definition of that place, we call a &ldquo;Hook&rdquo;.</p>
|
||
<p>By minimizing the code in already existing application objects, you will make the upgrade process much easier, and all customization business logic will be grouped in new objects. When using atomic coding, it will be very readable what is being customized on a certain place in an existing part of the application.</p>
|
||
<p>To minimize the impact of customizations, the idea of hooks is:</p>
|
||
<ul>
|
||
<li>First of all, name the places in the already existing code where customization is needed;</li>
|
||
<li>Second, place your business logic completely outside the already existing application code.</li>
|
||
</ul>
|
||
<p>I recommend to use this concept on:</p>
|
||
<ul>
|
||
<li>All objects of the default applications that need to be changed</li>
|
||
<li>On objects that should not hold any business logic (like tables, pages, XMLPorts)</li>
|
||
</ul>
|
||
<h2 id="usage">Usage</h2>
|
||
<p><strong>Step 1</strong> - if it doesn&rsquo;t exist yet - you create your Hook Codeunit. As the name assumes .. this is always a codeunit. We apply the following rules to it:</p>
|
||
<ul>
|
||
<li>One Hook always hooks into one object. Which basically means that I will only declare this new codeunit in one other object (which is its parent object)</li>
|
||
<li>The naming convention is: &ldquo;The_Original_Object_Name Hook&rdquo;. Naming conventions are important, just to find your mapped object, and also to be able to group the Hooks.</li>
|
||
</ul>
|
||
<p><strong>Step 2</strong>, you create the hook, which is basically a method (function) in your codeunit. The naming is important:</p>
|
||
<ul>
|
||
<li>The naming of the hook should NOT describe what it is going to do (So, examples like &ldquo;CheckMandatoryFields&rdquo;, &ldquo;FillCustomFields&rdquo; should not be used as a hook)</li>
|
||
<li>The naming of the hook should describe WHERE the hook is placed, not what the hook will be doing (as nobody is able to look into the future .. :-))</li>
|
||
<li>To help with the naming, it is a good convention to use the &ldquo;On&rdquo;-prefix for these triggers. This way, it&rsquo;s very clear what are hooks, and what aren&rsquo;t..</li>
|
||
</ul>
|
||
<p><strong>Step 3</strong>, it&rsquo;s time to hook it to its corresponding object and right place in the business logic of that object. You do this by declaring your codeunit as a global in your object, and using the created hook function on its place in the business logic. This way, these one-liners apply:</p>
|
||
<ul>
|
||
<li>A Hook Codeunit is only used once in one object only (its corresponding object)</li>
|
||
<li>A Hook (function) is used only once in that object. As a consequence, changing the parameters has no consequence: you only need to change one function-call</li>
|
||
<li>The codeunit is declared as a global. That exact global is the only custom declaration in the existing object .. Everything else is pushed to the hook-codeunit.</li>
|
||
</ul>
|
||
<p><strong>Step 4</strong>, implement your business logic in the hook. Do this in the most atomic way, as there is a good chance that this same hook is going to be used for other business logic as well. Best is to use a one-line-function-call to business logic, so that the Hook Function itself stays readable.</p>
|
||
<h2 id="example">Example</h2>
|
||
<p>Suppose, we want to add business logic just before posting a sales document. In that case, we have to look for the most relevant place, which is somewhere in the &ldquo;Sales-Post&rdquo; codeunit. So:</p>
|
||
<p><strong>Step 1</strong>: create codeunit &ldquo;Sales-Post Hook&rdquo;</p>
|
||
<p><a href="5383.HookPattern1.png"><img src="5383.HookPattern1.png" alt=" "></a></p>
|
||
<p><strong>Step 2</strong>: create the hook function &ldquo;OnBeforePostDocument&rdquo;</p>
|
||
<p><a href="6378.HookPattern2.png"><img src="6378.HookPattern2.png" alt=" "></a></p>
|
||
<p><strong>Step 3</strong>: declare a global in the &ldquo;Sales-Post&rdquo;-codeunit, called &ldquo;SalesPostHook&rdquo;. Then, call the Hook Function that you created in Step 2 in the right place.</p>
|
||
<p><a href="8156.HookPattern3.png"><img src="8156.HookPattern3.png" alt=" "></a></p>
|
||
<p><strong>Step 4</strong>: implement the business logic, by calling out to a new function. And implement the test-codeunit.</p>
|
||
<p><a href="8875.HookPattern4.png"><img src="8875.HookPattern4.png" alt=" "></a></p>
|
||
<h2 id="consequences">Consequences</h2>
|
||
<p>This pattern can be used in all cases to put business logic. But I see three possible approaches</p>
|
||
<ol>
|
||
<li>You only declare the most important and most used hooks
|
||
<ul>
|
||
<li>This way, you limit the amount of objects and hooks to only a few in the default product</li>
|
||
<li>For example, only the OnBeforePostSalesHeader, OnBeforeReleaseSalesDocument, .. And no field validation or such&hellip;</li>
|
||
</ul>
|
||
</li>
|
||
<li>Only at objects of the default application which you are customizing.
|
||
<ul>
|
||
<li>This way, you don&rsquo;t want to create hooks for your own objects, only default existing objects.</li>
|
||
</ul>
|
||
</li>
|
||
<li>(recommended) You create hooks on all places you don&rsquo;t want to write business logic, and on all existing objects which you would like to customize.
|
||
<ul>
|
||
<li>This is a very consistent way of working, as in any case, your business logic ends up in either a hook, or in its corresponding objects from a specific design pattern. But you know that the entry point is always a hook.</li>
|
||
<li>You know what to expect in any case, both changed business logic in existing code and business logic in newly created code is entered from a hook.</li>
|
||
</ul>
|
||
</li>
|
||
</ol>
|
||
<h2 id="related-topics">Related Topics</h2>
|
||
<p>Atomic coding: It&rsquo;s important that the hook function is readable in the most extreme way. For this, we recommend to use the &ldquo;Atomic Coding&rdquo; concept.</p>
|
||
<p>See here a comparison / extension of hooks : <a href="http://www.waldo.be/2016/02/29/nav-2016-hooks-or-events/">http://www.waldo.be/2016/02/29/nav-2016-hooks-or-events/</a></p></description></item><item><title>Docs: Surrogate keys using Autoincrement Pattern</title><link>https://alguidelines.dev/docs/navpatterns/patterns/implementation-of-surrogate-keys-using-autoincrement-pattern/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/implementation-of-surrogate-keys-using-autoincrement-pattern/</guid><description>
|
||
<p><em>By <a href="http://mvp.microsoft.com/en-us/mvp/Soren%20Klemmensen-5001002" title="Soren Klemmensen">Soren Klemmensen</a>, <a href="http://partner-ready-software.com/" title="Partner-Ready-Software"><em>Partner-Ready-Software</em> </a> &amp; <a href="http://www.360visibility.com/" title="360 Visibility">360 Visibility</a></em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>This Pattern is meant to create generic &amp; reusable links between tables. The goal is to have an easy generic way to link a generically designed sub table to a record on a main table which can be used for other links too.</p>
|
||
<p>To minimize the impact of customizations and to keep modules as generic and reusable as possible the idea of the Implementation of surrogate keys using AutoIncrement pattern is:</p>
|
||
<ul>
|
||
<li>To create a generic and reusable auto generated link (A Surrogate Key), Immune to natural key data &amp; requirement changes, on a main table with minimum impact on the table.</li>
|
||
<li>To create generic and reusable sub tables that effortless can be reused anywhere in the application.</li>
|
||
</ul>
|
||
<h2 id="description">Description</h2>
|
||
<p>Over years of development many things are repeated across different implementation and even inside the same application. A typical example could be adding comments to an area just as it is done in Microsoft Dynamics NAV multiple times. There can be reasons for doing this again and again, but not only does this need to be maintained and upgraded over the years, but all the implementations of comments also needs to be tested separately. If a standard and generic comment could be developed and a generic way of connecting it to a main table this could be resolved. This is exactly what this pattern is trying accomplish.</p>
|
||
<p><a href="0458.Figure-1.PNG"><img src="0458.Figure-1.PNG" alt=" "></a></p>
|
||
<p><em>Figure 1: Table structure for linking a Document Header and Line Table with a Document Comment Table.</em></p>
|
||
<p><a href="0638.Figure-2.PNG"><img src="0638.Figure-2.PNG" alt=" "></a></p>
|
||
<p><em>Figure 2: Table Structure for linking a Master Data Table with a Master Data Comment Table</em></p>
|
||
<p>A typical way of linking a table to master data or to a document has been to use the primary key of the table being linked to. This causes some issues as the linked table now is designed specifically for the main table and it functionality cannot be reused. In case of renames the linked table needs to be renamed too which is costly in processing. Code also needs to be added on the delete trigger of the table to ensure that the attached records get removed if needed which increases the over all footprint of any change.</p>
|
||
<p><a href="0333.Figure-3.PNG"><img src="0333.Figure-3.PNG" alt=" "></a></p>
|
||
<p><em>Figure 3: A Generic Way of creating a Comment table and linking it in a generic way to the main table no matter what this table might be. The Unique Record Identifier on the main tables is an Integer with AutoIncrement set to yes.</em></p>
|
||
<p>It is recommended using this pattern in all tables which need sub tables unless specific reasons exists for not doing this.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p><strong>Step 1</strong>: Create a generic Unique Record Identifier in the main table</p>
|
||
<p>The Pattern is implemented by adding a Field (I have called it Unique Record Identifier for this article) in a table (the main Table) where links are needed to be established to. Set the Property Data Type to Integer, Editable to No &amp; AutoIncrement to Yes.</p>
|
||
<p><strong>Step 2</strong>: Create a generic link-able sub table.</p>
|
||
<p>Create a new table (Sub Table) which you would like to be reusable with a primary key containing</p>
|
||
<ul>
|
||
<li>Table No. of Data Type Integer</li>
|
||
<li>Unique Record Identifier of Data Type Integer</li>
|
||
<li>A 3 field for allowing multiple entries to exist per record in the main table if so needed. This could be a Line No. of Data Type Integer or a Code field of Data Type Code(10) and so on.</li>
|
||
</ul>
|
||
<p>The important part here is that the 2 or 3 first fields in the tables primary key is the Table No. and the Unique Record Identifier. If a 3rd field was added to allow for multiple entries to exist per record in the main table this should also be included in the primary key.</p>
|
||
<p>Make sure to also add any other fields containing the information you wish to store as needed to the table.</p>
|
||
<p>The sub table will be immune to renames from the main table as the main tables primary key is not used in the primary key of the sub table. The Insert, Modify and Rename triggers are not causing any issues and only the delete trigger will need to be considered. This can be dealt with generically from the OnDatabaseDelete trigger in Codeunit 1. I would recommend to use a Hook Pattern for this.</p>
|
||
<p><strong>Step 3</strong>: Create a page showing the sub table information.</p>
|
||
<p>Now create a page showing the data in the sub table.</p>
|
||
<p><strong>Step 4</strong>: Add an Action or factbox.</p>
|
||
<p>Create an action or factbox on the pages showing the main table data linking to the subpage with Table ID filtered to a constant of the Table No. of the main table and the Unique Record Identifier of the sub table filtering to the Unique Record Identifier of the main table.</p>
|
||
<p><strong>Step 5</strong>: Create a Hook for Function OnDatabaseDelete in Codeunit 1 ApplicationManagement if one doesn&rsquo;t already exist. See the Hook pattern.</p>
|
||
<p><strong>Step 6</strong>: Create a code to delete records in the Sub table if a main table record is deleted if this is required. This function needs to be called from the Hook created in Step 5.</p>
|
||
<h2 id="nav-specific-example"><strong>NAV Specific Example</strong></h2>
|
||
<p>Let&rsquo;s assume we would like to create comment for a larger number of very different tables in the system.</p>
|
||
<p><strong>Update the Customer table (Step 1)</strong>: Go to table 18 Customer and add Field 50000 Unique Record Identifier. Set the Property Data Type to Integer, Editable to No &amp; AutoIncrement to Yes. Save the changes.</p>
|
||
<p><a href="1488.Example-Figure-1.png"><img src="1488.Example-Figure-1.png" alt=" "></a></p>
|
||
<p>_<a href="4682.Example-Figure-2.png"><img src="4682.Example-Figure-2.png" alt=" "></a></p>
|
||
<p><strong>Create Comment table (Step 2)</strong>: Create a new table called Comment. Add 3 fields Table No., Unique Record Identifier &amp; Line No. all of Data Type Integer. Make these 3 fields into the primary key for the table. Add a 4 field called Comment with Data Type Text(80). Save the changes.</p>
|
||
<p><a href="4532.Example-Figure-3.png"><img src="4532.Example-Figure-3.png" alt=" "></a></p>
|
||
<p><strong>Create the Comments page (Step 3)</strong>: Start the page wizard and create a Page based on table comment created above as a List only showing the Comment field. Set AutoSplitKey property to Yes on the page.</p>
|
||
<p>_<a href="2068.Example-Figure-4.png"><img src="2068.Example-Figure-4.png" alt=" "></a>_</p>
|
||
<p><strong>Update the Customer Card (Step 4)</strong>: Add an action to the Customer Card to open the Comments. Go to Actions and create an action called Smart Comment. Populate the properties RunObject, RunPageView and RunPageLink as see in the picture below.</p>
|
||
<p><a href="https://alguidelines.dev/cfs-file.ashx/__key/communityserver-wikis-components-files/00-00-00-00-42/0552.Example-Figure-5.png"><img src="0552.Example-Figure-5.png" alt=" "></a></p>
|
||
<p><strong>Create a hook OnDatabaseDelete (Step 5)</strong>:</p>
|
||
<p>Create a codeunit 50000 called &ldquo;ApplicationManagement Hook&rdquo; with one function called OnAfterOnDatabaseDelete taking the parameter RecRef of Data Type RecordRef. Add it as a global variable to Codeunit 1 ApplicationManagement and call the function as the last line in OnDatabaseDelete. Please read about the hook pattern before implementing it.</p>
|
||
<p><a href="https://alguidelines.dev/cfs-file.ashx/__key/communityserver-wikis-components-files/00-00-00-00-42/4477.Example-Figure-6.png"><img src="4477.Example-Figure-6.png" alt=" "></a></p>
|
||
<p><strong>Create the code needed to delete comments linked to a deleted record (Step6)</strong>:</p>
|
||
<p>Create a DeleteComments function taking the RecRef of Data Type RecordRef and add the code as shown blow.</p>
|
||
<p><a href="https://alguidelines.dev/cfs-file.ashx/__key/communityserver-wikis-components-files/00-00-00-00-42/1884.Example-Figure-7.png"><img src="1884.Example-Figure-7.png" alt=" "></a></p>
|
||
<p>It is assumed in this example for simplicity that the Field 50000 is reserved across the entire application for the Unique Record Identifier as defined in Step 1.</p>
|
||
<p>The comments are now fully working if we look away from the fact that we did not deal with a few things specific to Sales orders like RecreateSalesLines function, Archiving and Copy Document. All of which can easily be dealt with.</p>
|
||
<p>These comments are now completely reusable everywhere else in the system. Sales Document is a perfect example as the primary keys of the Sales Header and the Sales line are both different from the customer and normally we would not be able to use the comments header or the line. All that needs to be done is adding the Field 50000 Unique Record Identifier to the Sales Header &amp; Sales Line (Disregarding the posted documents in this example) and creating the actions on the Page Actions with the needed filters. Deletion is already handled of comments no matter what the main table might be.</p>
|
||
<p>Looking at the main table the Unique Record Identifier is also completely reusable for any other linking needed.</p>
|
||
<p>Other ideas for use of this pattern could be. An Error table, Tags, Dynamically defined fields and Generic fact boxes. Only the imagination sets limits for its use.</p>
|
||
<p>Upgrade wise there can be an impact if data is moved out of tables to be reinserted again because of a change to a database structure. This will cause the Unique Record Identifier to change, unless steps are taken to avoid this, and the links will need to be reestablished.</p>
|
||
<p>Other risks could be if Transfer Fields are used and data is being copied unintentionally.</p>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>This is a new pattern not currently used in Microsoft Dynamics NAV.</p>
|
||
<h2 id="ideas-for-improvement">Ideas for improvement</h2>
|
||
<p>The reason for doing it this way is that you now can reuse your code again and again with only creating the same link on other tables instead of building it from scratch each time reducing testing needed and improving the quality of the overall product.</p>
|
||
<h2 id="consequences-when-it-should-not-be-used">Consequences (When it should not be used)</h2>
|
||
<p>This can be used on any table when linking anything to it that can be considered a generic module which can be reused. That said it should not be used in cases where there is a risk of tables growing so much that performance could be impacted. There are ways to reduce performance impact when using high volume tables, but that is outside the scope of this pattern.</p>
|
||
<h2 id="related-topics">Related Topics</h2>
|
||
<p>This is related to the hook pattern as far as they both try to reduce the footprint changes have on the standard application, by creating reusable ways to interact with the standard code. That said the hook pattern is more about hooking the functionality to existing while this pattern is more about creating reusable ways of creating functionality.</p></description></item><item><title>Docs: Instructions in the UI</title><link>https://alguidelines.dev/docs/navpatterns/patterns/instructions-in-the-ui/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/instructions-in-the-ui/</guid><description>
|
||
<p><em>Originally by Nikola Kukrika at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>To mitigate usability problems with learnability or discoverability of NAV functionality, it is possible to embed instructions in the UI in connection with the task that the user is performing. The goal is to explain how to use the product or feature without impairing the user&rsquo;s productivity after user has learned how to use a feature.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>Users must often go through a few days of training to learn how to use NAV, and even then, many users rely on super users to help them mitigate difficulties using NAV. In addition, because of low discoverability and learnability, many useful features are not being used at all.</p>
|
||
<p>Users' expectations are changing. They expect the software to be usable out-of-the-box because this is the trend in software generally.</p>
|
||
<p>One of the cheapest and most effective methods to solve usability issues is to embed instructional messages in the product. From a user-experience point of view, <strong>this should be used as a last resort</strong>. UI should be self-explanatory, efficient, and simple to use. Accordingly, you should only implement this pattern if simplifying and improving a scenario is not possible or is too expensive.</p>
|
||
<p>In this connection, the most important requirement is not to impair productivity of the users. One of the biggest and most common UX mistakes that developers make is to &ldquo;optimize for new users&rdquo;. After the user has learned how to use the product, all the instruction texts and dialogs that we added to the UI will clutter the page and make information less visible. Instructional dialogs on routine tasks will become annoying. Therefore, we must make all instructions dismissible.</p>
|
||
<p>In the Mini App solution we have used following elements:</p>
|
||
<ol>
|
||
<li>Dismissible dialogs</li>
|
||
<li>FastTabs with instructional text</li>
|
||
<li>Help tiles on a Role Center</li>
|
||
<li>Tooltips on actions and fields</li>
|
||
<li>Task-oriented page Help</li>
|
||
</ol>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>The following pattern applies to dismissible parts in the UI.</p>
|
||
<p>We have a table that stores the instructional code ID and the UserID, so that we can track which user has turned off which instruction. All the logic handling is done from a codeunit. It is the responsibility of the codeunit to show/hide dialogs if needed.</p>
|
||
<p><a href="6215.picture-1.png"><img src="6215.picture-1.png" alt=" "></a></p>
|
||
<h2 id="dismissible-dialogs">Dismissible Dialogs</h2>
|
||
<p>Dismissible dialogs show the instructional message about the functionality, with the user option to select &ldquo;Don&rsquo;t show this again&rdquo;. This is a good solution to problems where users enter text in the wrong place, or to explain behavior of a somewhat hidden feature.</p>
|
||
<p><a href="2804.Picture-2.png"><img src="2804.Picture-2.png" alt=" "></a></p>
|
||
<p>On a recent usability study of the <strong>Description</strong> field on sales or purchase lines, most users ignored the <strong>No.</strong> field and started entering text in the description field before proceeded to enter a quantity. In the solution in question, text only is treated as a line comment if the <strong>No.</strong> field is blank. The fix was to update the field name to <strong>Description/Comment</strong> and to provide a message that typing in the field creates a comment only. Users that often use comments can then choose &ldquo;Do not show again&rdquo; to get rid of the instructional text.</p>
|
||
<p><strong>When to use:</strong> Recommendation is to use only when many users are entering data in the wrong way and modifying the code is costly. This is an interrupting dialog, but the benefits are that it is very hard to overlook this dialog.</p>
|
||
<h2 id="fasttabs-with-instructional-text">FastTabs with Instructional Text</h2>
|
||
<p>Instructional text on FastTabs is ideal for showing larger amounts of text in the UI.</p>
|
||
<p><a href="6685.picture-3.png"><img src="6685.picture-3.png" alt=" "></a></p>
|
||
<p>When a user changes a filter in the <strong>Navigate</strong> page, we blank the grid. This may confuse the users as to how to proceed. The <strong>Notification</strong> FastTab provides information on what has happened and gives instructions on how to proceed.</p>
|
||
<p>Similar implementation is to have the FastTab always visible with the <strong>Do not show again</strong> check box present, so that users can dismiss it after they have read the message. This is less intrusive than using a dialog, and it has the benefit of being always visible compared to the dialog. The drawback is that users may not read it or may not dismiss it.</p>
|
||
<h2 id="information-tiles-on-role-centers">Information Tiles on Role Centers</h2>
|
||
<p>On the <strong>Small Business Role Center</strong> page (9022), we have implemented a <strong>Getting Started</strong> group containing action tiles. Clicking on the first two tiles will play instructional videos. Clicking on the third tile launches a dedicated help topic. Since these tiles will get in the way of the experienced users, an option to hide the entire group is provided.</p>
|
||
<p><a href="5707.Picture-4.png"><img src="5707.Picture-4.png" alt=" "></a></p>
|
||
<p><strong>Note</strong>: in NAV 2013 R2, actions appear as tiles in the web client only. In the win client, they appear as links. In the web client, the actions only appear if they are in a group for themselves (without Stack Queues &ndash; empty group with only actins defined).</p>
|
||
<h3 id="to-implement-tiles-for-instructional-videos">To implement tiles for instructional videos</h3>
|
||
<ol>
|
||
<li>Upload a video to a video hosting service (check if licensing is allowing you to use if for this usage. Examples of video hosting services are: YouTube, Vimeo, Yahoo Video.)</li>
|
||
<li>Get the code to embed the video (select option embed).</li>
|
||
<li>You can reuse the code on the <strong>Mini Video Player Page</strong> page (1395) or implement a custom one.</li>
|
||
</ol>
|
||
<p>Important parts:<br>
|
||
<strong>VideoPlayerAddIn.SetFrameAttribute</strong> function is used to set an attribute to the iframe that will be playing the video.</p>
|
||
<p>Example of the embed code:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-js" data-lang="js"><span style="color:#ce5c00;font-weight:bold">&lt;</span><span style="color:#000">iframe</span> <span style="color:#000">width</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#34;560&#34;</span> <span style="color:#000">height</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#34;315&#34;</span> <span style="color:#000">src</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#34;//www.youtube.com/embed/7SGp9pA9cAY&#34;</span> <span style="color:#000">frameborder</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#34;0&#34;</span> <span style="color:#000">allowfullscreen</span><span style="color:#a40000">\</span><span style="color:#ce5c00;font-weight:bold">&gt;&lt;</span><span style="color:#a40000">/iframe\&gt;</span>
|
||
</code></pre></div><p>You must assign <strong>src attribute</strong> to src of the embed code, for example:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#f8f8f8;text-decoration:underline"> </span>VideoPlayer<span style="color:#ce5c00;font-weight:bold">.</span>SetFrameAttribute<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#39;src&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;https://www.youtube.com/embed/7SGp9pA9cAY&#39;</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>Without this, the video will not play. You can use the same function to assign other attributes, for example to remove frame border use:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#f8f8f8;text-decoration:underline"> </span>VideoPlayer<span style="color:#ce5c00;font-weight:bold">.</span>SetFrameAttribute<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#39; frameborder&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;0&#39;</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>Height and width should be set by using the following functions, since they ensure that the video will be centered on the page.</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#f8f8f8;text-decoration:underline"> </span>VideoPlayerAddIn<span style="color:#ce5c00;font-weight:bold">.</span>SetHeight<span style="color:#ce5c00;font-weight:bold">(</span>Height<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">and</span><span style="color:#f8f8f8;text-decoration:underline"> </span>VideoPlayerAddIn<span style="color:#ce5c00;font-weight:bold">.</span>SetWidth<span style="color:#ce5c00;font-weight:bold">(</span>Width<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>If you would like to reuse the <strong>Mini Video Player Page</strong> page (1395), then use:</p>
|
||
<pre><code>SetParameters(Height,Width,Src,Caption), which uses the functions described above.
|
||
</code></pre>
|
||
<p>4. As a last step you need to implement the action on the group and assign a video icon</p>
|
||
<p><strong>Note:</strong></p>
|
||
<p>Videos are implemented to be Web Client only. This is done because Flash player control that is used by most of the providers is not working well with WebBrowser control that the Windows Client is using.</p>
|
||
<p>For displaying the videos on the Windows client, the simplest option is to provide an action with a link that opens a video page in a browser or a page hosting all of the instructional videos you have provided. Optionally you can implement a .NET add-in control that would be able to play the video from selected provider.</p>
|
||
<h3 id="to-implement-tiles-for-help-topics">To implement tiles for help topics</h3>
|
||
<p>You only need to add an empty action with a <strong>TileHelp</strong> icon. Platform will render the action and will generate the logic to trigger a help call when user clicks on the icon. On the Help Server create an help topic that matches the URL.</p>
|
||
<h2 id="tooltips-on-actions-and-fields">Tooltips on actions and fields</h2>
|
||
<p>Platform improvements in NAV 2013 R2 provide ability to create tooltips for actions and all kinds of fields in the web client simply by filling the <strong>TooltipML</strong> property on the page object.</p>
|
||
<p><a href="7217.picture-1.png"><img src="7217.picture-1.png" alt=" "></a></p>
|
||
<p><strong>Note</strong>: In NAV 2013 R2, tooltips (in the 1330-range pages only) are extracted from intro paragraphs in the related field topic and inserted build-time using an infrastructure system.</p>
|
||
<h2 id="task-oriented-page-help">Task-oriented page Help</h2>
|
||
<p>Every page in NAV 2013 R2 has a help icon in top right corner that should open a Task-oriented help topic that should be related to this page. We recommend providing help topics for new task pages that you provide with your solutions.</p>
|
||
<p><a href="7245.Picture-2.png"><img src="7245.Picture-2.png" alt=" "></a></p>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>Dismissible dialogs - Used in the <strong>Description</strong> field in pages 1305, 1325, 1355, 1373, &hellip;.</p>
|
||
<p>FastTabs with instructional text &ndash; <strong>Navigate</strong> page (344).</p>
|
||
<p>Help Tiles on Role Center &ndash; <strong>Small Business Role Center</strong> page (9022) and <strong>Mini Activities</strong> page (1310).</p>
|
||
<p>Tooltips &ndash; All pages in the 1300 number range.</p>
|
||
<p>Task-oriented page help &ndash; all task pages in 1300 number range</p>
|
||
<h2 id="ideas-for-improvement">Ideas for Improvement</h2>
|
||
<p>Provide the support for the invoking any Help topics (URL on the Help Server from C/AL code. Then we would be able to promote help actions anywhere or launch them from C/AL code if needed.</p>
|
||
<p>Implement tooltips across the application and in all country versions. (Requires a run-time infrastructure system.)</p>
|
||
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;">
|
||
<iframe src="https://www.youtube.com/embed/loobQ1TVO3o" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" allowfullscreen title="YouTube Video"></iframe>
|
||
</div></description></item><item><title>Docs: Integration of Addresses</title><link>https://alguidelines.dev/docs/navpatterns/patterns/integration-of-addresses/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/integration-of-addresses/</guid><description>
|
||
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;">
|
||
<iframe src="https://www.youtube.com/embed/60Wrx9N-gfY" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" allowfullscreen title="YouTube Video"></iframe>
|
||
</div></description></item><item><title>Docs: Journal Error Processing</title><link>https://alguidelines.dev/docs/navpatterns/patterns/journal-error-processing/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/journal-error-processing/</guid><description>
|
||
<p><em>Originally by Bogdana Botez at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>This pattern describes an optimized way to handle invalid, incomplete, or inconsistent data that users enter in journals.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>Scenario: A user has entered data on a journal line and proceeds to invoke a processing action on it, such as posting or exporting to electronic payments. NAV validates the data before it is committed. If any validation errors are found, the user must be informed of validation errors in the most optimal way.</p>
|
||
<p>One design is that when an error is found, stop execution and prompt the user to correct the error. After correcting the error, the user restarts processing and is stopped again at the next error, and so on. Stopping and showing each error is time-consuming and frustrating for the user.</p>
|
||
<p>Another design is that processing does not stop when an error is found. Instead, all errors are gathered in a table and displayed all at once at the end of processing. This way, the processing is ideally invoked only once, reducing the time and effort spent by the user to expose and correct all data validation errors.</p>
|
||
<p>In both designs, the processing is not finalized if any errors are found (for example, exporting to electronic payments is not done, until the data error is resolved).</p>
|
||
<p>This document describes how to implement the second error-handling design: Showing all errors at the end.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>The example below comes from the implementation of SEPA Credit Transfer.</p>
|
||
<p>After setting up SEPA-specific configurations, the user can start entering vendor payments that will later be exported to the payment file. (The setup depends on the country, but generally involves choosing number series for SEPA export files, choosing the export format, and enabling SEPA Credit Transfer.)</p>
|
||
<p>In the W1 solution (and most of the countries), payment lines are created in the Payment Journal page, from where the user can invoke the Export Payments to File action, which will attempt to create a SEPA-compliant XML file containing the description of the journal payments that are to be made by the bank.</p>
|
||
<p>When the Export Payments to File function is invoked, NAV validates the journal line data. If the data must be completed or updated, then no file will be created and the user sees the following message:</p>
|
||
<p><a href="5518.Journal-Error-Processing-1.jpg"><img src="5518.Journal-Error-Processing-1.jpg" alt=" "></a></p>
|
||
<p>To give a visual overview, the lines that need corrections are highlighted in red. The factbox is context-sensitive, meaning that it shows only the errors that relate to the currently selected line.</p>
|
||
<p>When the first payment journal line is selected, the FactBox show errors for the first line.</p>
|
||
<p><a href="0005.Journal-Error-Processing-2.jpg"><img src="0005.Journal-Error-Processing-2.jpg" alt=" "></a></p>
|
||
<p>When the second payment journal line is selected, the FactBox shows errors for the second line.</p>
|
||
<p><a href="8640.Journal-Error-Processing-3.jpg"><img src="8640.Journal-Error-Processing-3.jpg" alt=" "></a></p>
|
||
<h2 id="application-objects">Application Objects</h2>
|
||
<p>In the following table, the Generic Object column contains the objects that you can use as a base for your implementation.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Generic Object</th>
|
||
<th>Description</th>
|
||
<th>Sample W1 implementation of SEPA Credit Transfer</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Journal Page</td>
|
||
<td>This is the journal list page where the user invokes the processing action.</td>
|
||
<td>Payment Journal</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Action on Page</td>
|
||
<td>The processing action invoked by the user on the journal list page.</td>
|
||
<td>Export Payments to File</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Errors Page List Part</td>
|
||
<td>A FactBox that displays any journal line validation errors.</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>To improve user experience, the developer can highlight the lines with errors in red and conveniently sort the lines with errors at the top.</td>
|
||
<td>Payment Journal Errors Part</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>Validation codeunit</td>
|
||
<td>Contains code that checks that the journal line contains correct, complete, and coherent data and that the line is ready for whatever process must be done next.</td>
|
||
<td>SEPA CT-Check Line</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Processing codeunit</td>
|
||
<td>Executes the processing of the journal lines.</td>
|
||
<td>SEPA CT-Export File</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p><strong>Generic Object:</strong> Journal Error Text Table</p>
|
||
<p><strong>Description:</strong></p>
|
||
<p>Contains:</p>
|
||
<ul>
|
||
<li>The error messages</li>
|
||
<li>Link information about where the error messages belong. For example, in table 1228, Payment Jnl. Export Error Text, the error is linked uniquely to a journal line by the following fields:</li>
|
||
<li>Journal Template Name, with TableRelation=&ldquo;Gen. Journal Template&rdquo;</li>
|
||
<li>Journal Batch Name, with TableRelation=&ldquo;Gen. Journal Batch&rdquo;.Name WHERE (Journal Template Name=FIELD(Journal Template Name))</li>
|
||
<li>Journal Line No.</li>
|
||
</ul>
|
||
<p>Other related information can be added, such as document number of the original source document, if the current journal line originates from a document.</p>
|
||
<p>An extra improvement would be to add a drilldown or a link to the page where the user can fix the error. This would significantly simplify the scenario by excluding manual navigation and investigation by the user to find the page where the error can be fixed.</p>
|
||
<p><strong>Sample W1 implementation of SEPA Credit Transfer:</strong> Payment Jnl. Export Error Text</p>
|
||
<p>* The W1 implementation of file export for SEPA Credit Transfer contains the generic SEPA functionality. However, due to differences in data models and user scenarios in various country implementations, the selected local versions contain adaptations of the generic functionality.</p>
|
||
<h2 id="flow">Flow</h2>
|
||
<p>Find below a diagram describing the flow between the objects involved in the journal error processing.</p>
|
||
<p><a href="0777.Journal-Error-Processing.jpg"><img src="0777.Journal-Error-Processing.jpg" alt=" "></a></p>
|
||
<h2 id="code">Code</h2>
|
||
<p>Following the flow above, the code (in the SEPA Credit Transfer example) is as follows.</p>
|
||
<p><a href="5661.Journal-Error-Processing-8.jpg"><img src="5661.Journal-Error-Processing-8.jpg" alt=" "></a></p>
|
||
<p>The public interface of this table contains simple functionality for adding/deleting errors and for interrogation on if any errors are associated with the current journal template and batch.</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-AL" data-lang="AL">CreateNew<span style="color:#ce5c00;font-weight:bold">(</span>GenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#000;font-weight:bold">;</span>NewText<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span>SetLineFilters<span style="color:#ce5c00;font-weight:bold">(</span>GenJnlLine<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FINDLAST<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Journal Template Name&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Journal Template Name&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Journal Batch Name&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Journal Batch Name&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Document No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document No.&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Journal Line No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GenJnlLine<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Line No.&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Line No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">+=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Error Text&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>COPYSTR<span style="color:#ce5c00;font-weight:bold">(</span>NewText<span style="color:#000;font-weight:bold">,</span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span>MAXSTRLEN<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Error Text&#34;<span style="color:#ce5c00;font-weight:bold">))</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>INSERT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>JnlLineHasErrors<span style="color:#ce5c00;font-weight:bold">(</span>GenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>SetLineFilters<span style="color:#ce5c00;font-weight:bold">(</span>GenJnlLine<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">NOT</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ISEMPTY<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>JnlBatchHasErrors<span style="color:#ce5c00;font-weight:bold">(</span>GenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>SetBatchFilters<span style="color:#ce5c00;font-weight:bold">(</span>GenJnlLine<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">NOT</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ISEMPTY<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>DeleteJnlLineErrors<span style="color:#ce5c00;font-weight:bold">(</span>GenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>JnlLineHasErrors<span style="color:#ce5c00;font-weight:bold">(</span>GenJnlLine<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>DELETEALL<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>DeleteJnlBatchErrors<span style="color:#ce5c00;font-weight:bold">(</span>GenJnlLine<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Gen. Journal Line&#34;<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>JnlBatchHasErrors<span style="color:#ce5c00;font-weight:bold">(</span>GenJnlLine<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>DELETEALL<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h2 id="nav-usages">NAV Usages</h2>
|
||
<ul>
|
||
<li>
|
||
<p>SEPA Credit Transfer feature - for export of vendor payments</p>
|
||
</li>
|
||
<li>
|
||
<p>SEPA Direct Debit feature for export of customer payment instructions</p>
|
||
</li>
|
||
</ul>
|
||
<p>The same concept of storing error messages (but with a different flow) is also present in:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Planning Error Log table (5430) - Supply Planning feature</p>
|
||
</li>
|
||
<li>
|
||
<p>Costing table (5890) - Costing feature</p>
|
||
</li>
|
||
</ul>
|
||
<h2 id="ideas-for-improvement">Ideas for Improvement</h2>
|
||
<p>Older code in NAV does not use this pattern yet. It would be good for consistency reasons, and also for overall user experience, to extend this pattern to replace the error processing in more areas.</p>
|
||
<p>We can also improve by helping users find the place where they must fix the error by providing auto-navigation to the required page.</p></description></item><item><title>Docs: Journal Template Batch Line</title><link>https://alguidelines.dev/docs/navpatterns/patterns/journal-template-batch-line/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/journal-template-batch-line/</guid><description>
|
||
<p><em>Originally by Bogdana Botez at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>The role of a journal line is to temporarily hold transaction data until the transaction is posted. Before posting, the entries are in a draft state, which means that they are available for corrections and/or deletion. As soon as the entries are posted, they are converted to ledger entries.</p>
|
||
<p>Journal templates are used to specify the underlying journal structure and to provide the default information for the journal batches. Journal batches usually serve to group journal lines, such as lines created by two different users.</p>
|
||
<p><a href="2438.Journal-Template-Batch-Line-1.jpg"><img src="2438.Journal-Template-Batch-Line-1.jpg" alt=" "></a></p>
|
||
<h2 id="description">Description</h2>
|
||
<p>Journal templates and journal batches are used if there is a need to create and post one or more entries. They are implemented in multiple areas of the application, like Sales, Purchases, Cash Receipts, Payments, Fixed Assets1.</p>
|
||
<h3 id="journal-templates">Journal Templates</h3>
|
||
<p>The journal templates are located on the Journal Template page. A Journal Template definition contains a series of attributes, such as:</p>
|
||
<ul>
|
||
<li>Name</li>
|
||
<li>Description</li>
|
||
<li>Type</li>
|
||
<li>Recurring</li>
|
||
<li>No. Series</li>
|
||
</ul>
|
||
<p>The Journal Template table stores the relevant attributes that define the nature and behavior of the journal templates, for example:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Journal Template Table Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Test Report ID</td>
|
||
<td>The journals offer the possibility of running test reports3. The role of a test report is to simulate the posting process. The verification criteria for the journal lines is ran, and the report can be displayed, all without doing the actual posting. This helps finding and correcting any errors that might exist in the data. The name of the test report is the same with the name of the corresponding journal, plus the suffix &quot; - Test&quot;. For example, the General Journal has the associated test report named General Journal - Test.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Posting Report ID</td>
|
||
<td>This report is printed when a user selects Post and Print4.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Page ID</td>
|
||
<td>For some journals, more UI objects are required. For example, the General Journals have a special page for bank and cash.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Source Code</td>
|
||
<td>Here you can enter a Trail Code for all the postings done through this Journal4.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Recurring</td>
|
||
<td>Whenever you post lines from a recurring journal, new lines are automatically created with a posting date defined in the recurring date formula.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Each journal template defines a default value of those attributes. The values that are defined in a template will be inherited by the journal batches, which will be created from a journal template.</p>
|
||
<p>Microsoft Dynamics NAV is released with a number of standard journal templates predefined in the Journal Templates page. More templates can be defined by the users.</p>
|
||
<h3 id="journal-batches">Journal Batches</h3>
|
||
<p>Journal batches are created with the help of the journal templates.</p>
|
||
<p>A journal batch is typically used to make a distinction between collections of logically grouped journal lines. A typical design is to have a journal batch for each user who enters lines. The batches are used during the posting process, in order to post one or multiple lines at once.</p>
|
||
<h3 id="journal-lines">Journal Lines</h3>
|
||
<p>Journal lines contain the actual business data (posting dates, account numbers, amounts) that will be posted as ledger entries.</p>
|
||
<p>During posting, only the information from the journal lines is needed. However, the information has been created with the help of the journal templates and grouped together using the journal batches.</p>
|
||
<p>Posting creates ledger entries from the temporary content that is stored in the journal lines. Ledger entries are not created directly. Instead, they are posted from journal lines.</p>
|
||
<p><a href="8103.Journal-Template-Batch-Line-2.jpg"><img src="8103.Journal-Template-Batch-Line-2.jpg" alt=" "></a></p>
|
||
<h3 id="aggregation">Aggregation</h3>
|
||
<p>There is a 1:n aggregation relationship between journal templates and journal batches, as well as between journal batches and journal lines. Deleting a template will cascade deletion of the related batches and lines. Deleting a batch will cascade into deletion of related lines.</p>
|
||
<h3 id="recurring-journals">Recurring Journals</h3>
|
||
<p>A recurring journal is used to post transactions that repeat periodically. In a recurring journal, the user enters only the variable data, such as posting date, amounts, and accounts to be used for posting.</p>
|
||
<p>After posting a recurring journal, new journal lines are created containing the posting date for the next recurring period. The posting date recurrence pattern is previously defined in the Recurring Frequency field (for example, monthly recurrences are defined with the date formula 1M).</p>
|
||
<p>A boolean field named Recurring is placed on both the journal templates and journal batches, giving the possibility of defining the type of the journal to be used.</p>
|
||
<h3 id="consistent-user-experience">Consistent User Experience</h3>
|
||
<p>To keep a consistent user interface experience, it is recommended that the the following guidelines are taken respected concerning navigation:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Journal template to journal batches:</p>
|
||
</li>
|
||
<li>
|
||
<p>On the Journal Templates page, create an action called &ldquo;Batches&rdquo; and place it in the Navigate tab of the ribbon. Link the action to the batches list page.</p>
|
||
</li>
|
||
<li>
|
||
<p>Journal batch to journal lines:</p>
|
||
</li>
|
||
<li>
|
||
<p>On the Batch page, create an action called &ldquo;Edit Journal&rdquo; in the Home ribbon tab. Link the action to the journal lines list page.</p>
|
||
</li>
|
||
</ul>
|
||
<p>To keep a consistent user interface experience, it is recommended that the the following guidelines are taken respected concerning posting:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Posting multiple batches</p>
|
||
</li>
|
||
<li>
|
||
<p>On the Journal Batches page, posting actions (Post, Post and Print) are available. When invoked, the batch posting will iterate through all related journal lines and trigger the posting routine for all of the lines.</p>
|
||
</li>
|
||
</ul>
|
||
<h2 id="usage">Usage</h2>
|
||
<h3 id="general-journals">General Journals</h3>
|
||
<p>The General Journal Templates page (101) uses the Gen. Journal Template table (80).</p>
|
||
<p>Various template types are defined: General,Sales,Purchases,Cash Receipts,Payments,Assets,Intercompany,Jobs. Based on the journal type, two other attributes are automatically set on the template lines as follows:</p>
|
||
<ul>
|
||
<li>Page ID: Defines which journal page relates to the current journal template</li>
|
||
<li>Source Code: Filled with the default codes that are defined in Source Code Setup table (242).</li>
|
||
</ul>
|
||
<p>The General Journals Batches page (251) is linked to the Gen. Journal Batch source table (232), which has a multiple-to-1 relationship with Gen. Journal Template table, based on the Journal Template Name field.</p>
|
||
<p>Some of the fields in the Gen. Journal Batch table are not editable. Instead, their value is automatically calculated from the parent Gen. Journal Template table. For example, the Recurring field (22) is a FlowField with the following calculation formula:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">Lookup</span><span style="color:#ce5c00;font-weight:bold">(</span>&#34;Gen. Journal Template&#34;<span style="color:#ce5c00;font-weight:bold">.</span>Recurring<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">WHERE</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">(</span>Name=<span style="color:#204a87;font-weight:bold">FIELD</span><span style="color:#ce5c00;font-weight:bold">(</span>Journal<span style="color:#f8f8f8;text-decoration:underline"> </span>Template<span style="color:#f8f8f8;text-decoration:underline"> </span>Name<span style="color:#ce5c00;font-weight:bold">)))
|
||
</span></code></pre></div><p>Similarly, the Template Type field is a FlowField that gets its value from the parent table:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">Lookup</span><span style="color:#ce5c00;font-weight:bold">(</span>&#34;Gen. Journal Template&#34;<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">Type</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">WHERE</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">(</span>Name=<span style="color:#204a87;font-weight:bold">FIELD</span><span style="color:#ce5c00;font-weight:bold">(</span>Journal<span style="color:#f8f8f8;text-decoration:underline"> </span>Template<span style="color:#f8f8f8;text-decoration:underline"> </span>Name<span style="color:#ce5c00;font-weight:bold">)))
|
||
</span></code></pre></div><h3 id="setting-up-a-new-batch">Setting up a New Batch</h3>
|
||
<p>When the user creates a new batch, the following field values are transferred from the Gen. Journal Template table to the Gen. Journal Batch table:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">&#34;Bal. Account Type&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GenJnlTemplate<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Bal. Account Type&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Bal. Account No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GenJnlTemplate<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Bal. Account No.&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;No. Series&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GenJnlTemplate<span style="color:#ce5c00;font-weight:bold">.</span>&#34;No. Series&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Posting No. Series&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GenJnlTemplate<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Posting No. Series&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Reason Code&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GenJnlTemplate<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Reason Code&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Copy VAT Setup to Jnl. Lines&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GenJnlTemplate<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Copy VAT Setup to Jnl. Lines&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>&#34;Allow VAT Difference&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GenJnlTemplate<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Allow VAT Difference&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h3 id="cascade-record-deletion">Cascade record deletion</h3>
|
||
<p>When a record from the Gen. Journal Template table is deleted, the corresponding Gen. Journal Batch and Gen. Journal Line records are also deleted.</p>
|
||
<h3 id="cascade-updates">Cascade updates</h3>
|
||
<p>When the reason code or the posting number series change in the current batch, all linked Gen. Journal Line records are updated (see ModifyLines function on the Gen. Journal Batch table).</p>
|
||
<p>The Gen. Journal Line table (814) stores a relation with the Journal Batch Name field (51) in the Gen. Journal Batch table. The Gen. Journal Line table also inherits the table relation with the Journal Template Name field (1) in the Gen. Journal Template table.</p>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>Implementations of this pattern in NAV include:</p>
|
||
<ul>
|
||
<li>General Journal (see &ldquo;Use the Pattern&rdquo; above)</li>
|
||
<li>Item Journal</li>
|
||
<li>Resource Journal</li>
|
||
<li>Job Journal</li>
|
||
</ul>
|
||
<p>References</p>
|
||
<ol>
|
||
<li><a href="https://mbs.microsoft.com/partnersource/communities/training/trainingmaterials/student/course80534.htm?printpage=false">NAV Course 50534</a> Finance Essentials in Microsoft Dynamics NAV 2013, Chapter 3: &ldquo;General Journals&rdquo;.</li>
|
||
<li><a href="https://mbs.microsoft.com/partnersource/communities/training/trainingmaterials/student/course80435.htm?printpage=false">NAV Course 50435</a> Application Setup in Microsoft Dynamics NAV 2013, Chapter 5: &ldquo;Set up Journal Templates and Batches&rdquo;</li>
|
||
<li><a href="http://msdn.microsoft.com/en-us/library/dd338776.aspx">Test reports</a> Definition on MSDN.</li>
|
||
<li><a href="http://www.packtpub.com/article/microsoft-dynamics-nav-2009-using-journals-and-entries-custom-application">Microsoft Dynamics NAV 2009: Using the journals and entries in a custom application</a> Blog article by Mark Brummel</li>
|
||
<li><a href="http://social.msdn.microsoft.com/Search/en-US?query=journals%20nav&amp;ac=3">Search result for &ldquo;Journal+NAV&rdquo; </a>Various topics on MSDN</li>
|
||
</ol>
|
||
<h2 id="related-pattern-standard-journal">Related Pattern: Standard Journal</h2>
|
||
<p>For cases when most of the journal data can be used later (like monthly electricity payments, for example), the user has the possibility to save the current transaction details for later use. See the related pattern, Standard Journal.</p>
|
||
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;">
|
||
<iframe src="https://www.youtube.com/embed/xtsZ5beNdZg" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" allowfullscreen title="YouTube Video"></iframe>
|
||
</div></description></item><item><title>Docs: Master Data</title><link>https://alguidelines.dev/docs/navpatterns/patterns/master-data/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/master-data/</guid><description>
|
||
<p><em>By <a href="http://mvp.microsoft.com/en-us/mvp/Soren%20Klemmensen-5001002" title="Soren Klemmensen">Soren Klemmensen</a>, <a href="http://partner-ready-software.com/" title="Partner-Ready-Software"><em>Partner-Ready-Software</em> </a> &amp; <a href="http://www.360visibility.com/" title="360 Visibility">360 Visibility</a></em></p>
|
||
<h1 id="abstract">Abstract</h1>
|
||
<p>The goal of this design pattern is to outline a standard way of creating master data, such as customers, vendors or items, in NAV.</p>
|
||
<h1 id="description">Description</h1>
|
||
<p>This pattern creates a standard master data entity, listing all necessary prerequisites, attributes and methods to generate a basic version of the data entity.</p>
|
||
<p>It is being used for creating a master data entity and can roughly be divided into 2 categories: Business and Product</p>
|
||
<p>Examples of Master Data tables are:</p>
|
||
<p>Business Data:</p>
|
||
<ul>
|
||
<li>Table 18: Customer</li>
|
||
<li>Table 23: Vendor</li>
|
||
<li>Table 270: Bank Account</li>
|
||
<li>Table 5050: Contact</li>
|
||
</ul>
|
||
<p>Product Data:</p>
|
||
<ul>
|
||
<li>Table 15 G/L Account</li>
|
||
<li>Table 27: Item</li>
|
||
<li>Table 156: Resource</li>
|
||
<li>Table 5600: Fixed Asset</li>
|
||
<li>Table 5718: Nonstock Item</li>
|
||
<li>Table 5913: Loaner</li>
|
||
</ul>
|
||
<p>Master Data has attributes such as Location, Countries &amp; Item Vendors. These tables are closely related to Master Data tables and are called Supplemental and Subsidiary tables.</p>
|
||
<p>Supplemental:</p>
|
||
<ul>
|
||
<li>Table 9: Country/Region</li>
|
||
<li>Table 14: Location</li>
|
||
</ul>
|
||
<p>Subsidiary:</p>
|
||
<ul>
|
||
<li>Table 99: Item Vendor</li>
|
||
</ul>
|
||
<p>Master Data is among other used in journals, posting routines and historic data like ledger entries.</p>
|
||
<p><strong>Naming &amp; Conventions</strong></p>
|
||
<p>Table &amp; Card Page</p>
|
||
<ul>
|
||
<li>
|
||
<p>Singular</p>
|
||
</li>
|
||
<li>
|
||
<p>Examples: Customer, Vendor &amp; Item</p>
|
||
</li>
|
||
</ul>
|
||
<p>List Page</p>
|
||
<ul>
|
||
<li>
|
||
<p>Plural if Editable = TRUE.</p>
|
||
</li>
|
||
<li>
|
||
<p>Singular + &ldquo;List&rdquo; if Editable = FALSE.</p>
|
||
</li>
|
||
</ul>
|
||
<h1 id="example">Example</h1>
|
||
<p>The data entity has a single primary key field with the following properties:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th></th>
|
||
<th></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Field No.</td>
|
||
<td>1</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Name</td>
|
||
<td>&ldquo;No.&rdquo;</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Date Type</td>
|
||
<td>Code 20</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Each master data entity has a field which gives a name tag to the data entity carrying the natural name of the entity. This field is called Name if the data entity refers to a living person or an organization, such as a customer or a vendor; it is called Description instead if the data entity does not refer to a person or organization, such as an item. The field has the following properties:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th></th>
|
||
<th></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Name</td>
|
||
<td>Name or Description</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Date Type</td>
|
||
<td>Text 50</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>An added benefit of using the Name or Description field naming is that this will be part of the dropdown when looking up based on the table relation.</p>
|
||
<p>The table properties of a master data table contain the following entries:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th></th>
|
||
<th></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>LookupPageID</td>
|
||
<td>A ListType Page referring to the table which is not editable.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>DrillDownPageID</td>
|
||
<td>The same page as defined in the LookupPageID</td>
|
||
</tr>
|
||
<tr>
|
||
<td>DataCaptionFields</td>
|
||
<td>The primary key plus the field which provides the primary name tag for the record. This will typically be the Name or Description field defined earlier.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h1 id="nav-specific-example">NAV Specific Example</h1>
|
||
<p>We will create an Example table here with a Card and List Page as described above.</p>
|
||
<p>First we create the Table with No. as the primary key.</p>
|
||
<p><a href="Table.PNG"><img src="Table.PNG" alt=" "></a></p>
|
||
<p>Than we create a non-editable Page called Example List</p>
|
||
<p><a href="PageListDefinition.PNG"><img src="PageListDefinition.PNG" alt=" "></a></p>
|
||
<p>Than we create an Example Card Page with the following definition</p>
|
||
<p><a href="PageCardDefinition.PNG"><img src="PageCardDefinition.PNG" alt=" "></a></p>
|
||
<p>Now we can set the properties of the 2 pages.</p>
|
||
<p>First the Example Card Page Properties</p>
|
||
<p><a href="PageCardPropertiesV2.PNG"><img src="PageCardPropertiesV2.PNG" alt=" "></a></p>
|
||
<p>Than the Example List Page Properties</p>
|
||
<p><a href="PageListPropertiesV2.PNG"><img src="PageListPropertiesV2.PNG" alt=" "></a></p>
|
||
<p>Last but not least we set the Table Properties</p>
|
||
<p><a href="TablePropertiesV2.PNG"><img src="TablePropertiesV2.PNG" alt=" "></a></p>
|
||
<h1 id="nav-usages">NAV Usages</h1>
|
||
<p>You can see this pattern used in the following tables &amp; pages:</p>
|
||
<p>Business Data:</p>
|
||
<ul>
|
||
<li>Table 18: Customer, Page 21 Customer Card &amp; Page 22 Customer List</li>
|
||
<li>Table 23: Vendor, Page 26 Vendor Card &amp; Page 27 Vendor List</li>
|
||
<li>Table 270: Bank Account, Page 370 Bank Account Card &amp; Page 371 Bank Account List</li>
|
||
<li>Table 5050: Contact, Page 5050 Contact Card &amp; Page 5052 Contact List</li>
|
||
</ul>
|
||
<p>Product Data:</p>
|
||
<ul>
|
||
<li>Table 15 G/L Account, Page 17 G/L Account Card &amp; Page 18 G/L Account List</li>
|
||
<li>Table 27: Item, Page 30 Item Card &amp; Page 31 Item List</li>
|
||
<li>Table 156: Resource, Page 76 Resource Card &amp; Page 77 Resource List</li>
|
||
<li>Table 5600: Fixed Asset, Page 5600 Fixed Asset Card &amp; Page 5601 Fixed Asset List</li>
|
||
<li>Table 5718: Nonstock Item, Page 5725 Nonstock Item Card &amp; Page 5726 Nonstock Item List</li>
|
||
<li>Table 5913: Loaner, Page 5922 Loaner Card &amp; Page 5923 Loaner List</li>
|
||
</ul>
|
||
<h1 id="consequences">Consequences</h1>
|
||
<p>This pattern should not be used when this is not Master Data.</p>
|
||
<h1 id="references">References</h1>
|
||
<p>Patterns that are typically used in connection with the Master Data Pattern could be the <strong>&ldquo;No. Series&rdquo;, &ldquo;Address Integration&rdquo;</strong> and/or the <strong>&ldquo;Entity State&rdquo;</strong> design patterns., Master Data are central to almost everything we do, so most patterns connect in one way or another to the Master Data Pattern.</p></description></item><item><title>Docs: Multi-file Download</title><link>https://alguidelines.dev/docs/navpatterns/patterns/multi-file-download/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/multi-file-download/</guid><description>
|
||
<p><em>By Martin Dam at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>The goal of this pattern is to enable the users to download multiple files as a zip file instead of downloading one by one. On the Web Client this is preferred way of delivering multiple files since it is one of the web patterns and we cannot use File Management code unit to place files silently on the machine.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>When generating reports that consists of multiple, and usually an unknown number of files, the developer will have to handle the download which also depends on the client the user is on. The problem is that the WinClient has access to the user&rsquo;s file system, whereas the web client does not. Following web guidelines, and the fact that client side .NET is not available in Web client, you can&rsquo;t initiate multiple downloads which requires the developer respond to the type of client. In some browsers it is possible to download files one-by-one in the Web client by using a confirm dialog, however this is a hack and should not be used.</p>
|
||
<p>To solve this problem, a generic download mechanism is used that is client dependent event when multiple files need to be downloaded. For Web client the files are compressed using ZIP and for WinClient the files are downloaded directly to the file system.</p>
|
||
<p>The pattern is usable for all objects that output multiple files and is available in both WinClient and Web client.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>The pattern consists of two steps: 1) Gathering the files and 2) downloading the file(s)</p>
|
||
<p>For first step consists of a loop that goes through the files that needs to be downloaded. If it is on the Web client, the files are added to a ZIP archive server-side using a naming convention defined by the integration function GetSeriesFileName. This function takes a filename and number, and transforms it to unique names following a meaningful deterministic pattern e.g. prepend an integer before the file extension. The same function is used when the temporary files are created server side, so the files can be found deterministically later. This removes the need for storing filenames and consequently allows an arbitrary number of files. The second integration function: GetTotalNumberOfFiles, returns the total number of files generated during the data processing and makes the pattern able to handle an arbitrary number of files.</p>
|
||
<p>The second step is the actually download of file(s). For the Web client this consists of closing the ZIP achieve and downloading via the standard download handler that works in the Web client. For the Win client, the files are saved directly to the client during the first step.</p>
|
||
<p>Code 1: File loop shows an example implementation of this pattern. ServerFileName is generated at the beginning of the report/codeunit, and is the base for GetSeriesFilename. The file that is actually written to during data processing is stored in another variable which holds the output from GetSeriesFilename on the current file number. Note; the example code will only create a ZIP file if there in fact are multiple files to be downloaded.</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileName<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ERROR<span style="color:#ce5c00;font-weight:bold">(</span>SupplyFileNameErr<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ZipMultipleFiles<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">AND</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">(</span>GetTotalNumberOfFiles<span style="color:#f8f8f8;text-decoration:underline"> </span>\&gt;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">AND</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileManagement<span style="color:#ce5c00;font-weight:bold">.</span>IsWebClient<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Basename<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileManagement<span style="color:#ce5c00;font-weight:bold">.</span>GetFileName<span style="color:#ce5c00;font-weight:bold">(</span>FileName<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ZipFileName<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileManagement<span style="color:#ce5c00;font-weight:bold">.</span>CreateZipArchiveObject<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">FOR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileNo<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">TO</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GetTotalNumberOfFiles<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DO</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileManagement<span style="color:#ce5c00;font-weight:bold">.</span>AddFileToZipArchive<span style="color:#ce5c00;font-weight:bold">(
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span>GetSeriesFilename<span style="color:#ce5c00;font-weight:bold">(</span>ServerFileName<span style="color:#000;font-weight:bold">,</span>FileNo<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">,</span>GetSeriesFilename<span style="color:#ce5c00;font-weight:bold">(</span>Basename<span style="color:#000;font-weight:bold">,</span>FileNo<span style="color:#ce5c00;font-weight:bold">))</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileManagement<span style="color:#ce5c00;font-weight:bold">.</span>DownloadHandler<span style="color:#ce5c00;font-weight:bold">(</span>ZipFileName<span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>STRSUBSTNO<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#39;%1.zip&#39;</span><span style="color:#000;font-weight:bold">,</span>FileManagement<span style="color:#ce5c00;font-weight:bold">.</span>GetFileNameWithoutExtension<span style="color:#ce5c00;font-weight:bold">(</span>FileName<span style="color:#ce5c00;font-weight:bold">)))
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ELSE</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileManagement<span style="color:#ce5c00;font-weight:bold">.</span>IsWebClient<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GetTotalNumberOfFile<span style="color:#f8f8f8;text-decoration:underline"> </span>&gt;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ERROR<span style="color:#ce5c00;font-weight:bold">(</span>MultipleFilesWebClientErr<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileManagementDownloadHandler<span style="color:#ce5c00;font-weight:bold">(</span>GetSeriesFilename<span style="color:#ce5c00;font-weight:bold">(</span>ServerFileName<span style="color:#000;font-weight:bold">,</span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileManagement<span style="color:#ce5c00;font-weight:bold">.</span>GetFileName<span style="color:#ce5c00;font-weight:bold">(</span>FileName<span style="color:#ce5c00;font-weight:bold">))</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ELSE</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">FOR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileNo<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">TO</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GetTotalNumberOfFiles<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DO</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileManagement<span style="color:#ce5c00;font-weight:bold">.</span>DownloadToFile<span style="color:#ce5c00;font-weight:bold">(</span>GetSeriesFilieName<span style="color:#ce5c00;font-weight:bold">(</span>ServerFileName<span style="color:#000;font-weight:bold">,</span>FileNo<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GetSeriesFilename<span style="color:#ce5c00;font-weight:bold">(</span>FileName<span style="color:#000;font-weight:bold">,</span>FileNo<span style="color:#ce5c00;font-weight:bold">))</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p><em>Code 1: File loop</em></p>
|
||
<p>The following code is an example implementation of the GetSeriesFilename function. It needs to support the case where no directory is given, only a filename, in order to add files to the root of the ZIP archive. The example will add a file number right before the extension, e.g. C:\directory\file.txt will become C:\directory\file1.txt etc.</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GetSeriesFilename<span style="color:#ce5c00;font-weight:bold">(</span>FileName<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#000;font-weight:bold">;</span>FileNo<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>STRPOS<span style="color:#ce5c00;font-weight:bold">(</span>FileName<span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;\\&#39;</span><span style="color:#ce5c00;font-weight:bold">) </span>&lt;&gt;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Directory<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileMgt<span style="color:#ce5c00;font-weight:bold">.</span>GetDirectoryName<span style="color:#ce5c00;font-weight:bold">(</span>FileName<span style="color:#ce5c00;font-weight:bold">) </span>+<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;\\&#39;</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span>Directory<span style="color:#f8f8f8;text-decoration:underline"> </span>+<span style="color:#f8f8f8;text-decoration:underline"> </span>FileMgt<span style="color:#ce5c00;font-weight:bold">.</span>GetFileNameWithoutExtension<span style="color:#ce5c00;font-weight:bold">(</span>FileName<span style="color:#ce5c00;font-weight:bold">) </span>+<span style="color:#f8f8f8;text-decoration:underline"> </span>FORMAT<span style="color:#ce5c00;font-weight:bold">(</span>FileNo<span style="color:#ce5c00;font-weight:bold">) </span>+<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;.&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> </span>+<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileMgt<span style="color:#ce5c00;font-weight:bold">.</span>GetExtension<span style="color:#ce5c00;font-weight:bold">(</span>FileName<span style="color:#ce5c00;font-weight:bold">))</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h4 id="_code-2-getseriesfilename_"><em>Code 2: GetSeriesFilename</em></h4>
|
||
<p>The pattern depends on .NET library System.IO.Compression.ZipFile, which from NAV 2015 is implemented in Codeunit 419 (File management). It consists of three functions:</p>
|
||
<ul>
|
||
<li>CreateZipArchiveObject: Which creates a System.IO.Compression.ZipArchive on a server side file</li>
|
||
<li>AddFileToZipArchive: Which adds a server side file to the archive using System.IO.Compression.ZipFileExtensions.CreateEntryFromFile(). This function allows to use arbitrary naming and does not require to create a server directory before creating the ZIP achieve.</li>
|
||
<li>CloseZipArchive: Which simply closes the ZIP file and saves it to disk.</li>
|
||
</ul>
|
||
<p>The pattern is integrated into the report/codeunit in question by providing a filename field on the request page if it is on WinClient but hidden if it is in Web client. On the Web client, a meaningful default filename is used for the file to download, e.g. in Code 1, Filename is set by the user on the request page if it is WinClient, and set to a default value in Web client.</p>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>This pattern is used by VAT Report and Blacklist communication in the Italian localization in NAV 2015. The ZIP archive functions are available on all localization from NAV 2015.</p>
|
||
<h2 id="consequences">Consequences</h2>
|
||
<p>This pattern can be used whenever you need to ZIP one or more files. The above example downloads the file, but it could have been transmitted, saved to a persistent storage etc. It could also be used to improve download speed between server and client where the WinClient would unzip the files locally and save individually to disk. This follows the normal procedure in NAV in the WinClient, which is to download files directly to disk, so a ZIP file should only be created when the user specifically needs it or the Web client is invoking the report/codeunit.</p>
|
||
<h2 id="related-topics">Related Topics</h2>
|
||
<p>File Management</p>
|
||
<h2 id="references">References</h2>
|
||
<p><a href="http://msdn.microsoft.com/en-us/library/vstudio/system.io.compression.zipfile">System.IO.Compression.ZipFile</a></p></description></item><item><title>Docs: Multi-Page List</title><link>https://alguidelines.dev/docs/navpatterns/patterns/multi-page-list/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/multi-page-list/</guid><description>
|
||
<p><em>By Bogdana Botez at Microsoft Development Center Copenhagen</em></p>
|
||
<h3 id="abstract">Abstract</h3>
|
||
<p>This pattern describes how to open a related document (or card) page from a list page, for the case when there can be more than one pages associated to the rows of the list page.</p>
|
||
<h3 id="description">Description</h3>
|
||
<p>The example below illustrates the connection of a List Page with multiple Document Pages, while the second example links the List Page with Card Pages.</p>
|
||
<p><a href="Multi-page-list-img-1.jpg"><img src="Multi-page-list-img-1.jpg" alt=" "></a></p>
|
||
<p>The records contained in a list page have an associated page, which is specified in the CardPageID property of the list page. The NAV infrastructure assures the following scenarios are in place, without the need to add any explicit C/AL code:</p>
|
||
<ol>
|
||
<li>From the selected record in the list page, the user can double-click in order to open the related card page.</li>
|
||
<li>The &ldquo;Edit&rdquo; action is available on the ribbon as well as in the right-click context menu of the list page rows. Invoking this action, opens the related card page.</li>
|
||
</ol>
|
||
<p>However, there are situations when rows of the list page can correspond to different pages each (either cards or documents). For example, consider a list page containing 3 rows, requiring the following behaviour:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th></th>
|
||
<th></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Row1</td>
|
||
<td>Opens page ID 1</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Row2</td>
|
||
<td>Opens page ID 2</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Row3</td>
|
||
<td>Opens page ID 3</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>This situation is not handled automatically by NAV. There is no possibility to specify more than one CardPageID in the list page properties. Furthermore, there is no possibility to specify one or more document page IDs on the list page. Therefore, those cases need to be handled explicitly by the C/AL developer.</p>
|
||
<h3 id="usage">Usage</h3>
|
||
<p>The solution used in NAV implementations is at the list page level, as following:</p>
|
||
<ol>
|
||
<li>
|
||
<p>The property CardPageID of the list page remains undefined.</p>
|
||
</li>
|
||
<li>
|
||
<p>An action named &ldquo;Show Document&rdquo; or &ldquo;Card&rdquo; is created on the Navigate tab, with the properties:</p>
|
||
<ul>
|
||
<li>Image = EditLines</li>
|
||
<li>Promoted = Yes</li>
|
||
<li>ShortCutKey = Shift+F7</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>The OnAction trigger for the Card action, contains explicit logic to run the targeted card page. It can, for example, be a CASE statement, which invokes PAGE.RUN(&hellip;) based on an enumeration field of the current row.</p>
|
||
</li>
|
||
</ol>
|
||
<h3 id="nav-specific-example">NAV Specific Example</h3>
|
||
<p>For example, the NAV page Sales List (page ID 45), which displays the Sales Header Table (table ID 36), chooses which card to open, based on the Document Type field. This is an option field, which can have the following values: Quote, Order, Invoice, Credit Memo, Blanket Order, Return Order. For each document type, the related card page must be opened.</p>
|
||
<p><a href="Multi-page-list-img-2.jpg"><img src="Multi-page-list-img-2.jpg" alt=" "></a></p>
|
||
<p>For this purpose, a new action (&ldquo;Card&rdquo;) is added to the Sales List page. The OnAction trigger of this new action contains the page selection logic:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">CASE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Document Type&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">OF</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>Quote<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PAGE</span><span style="color:#ce5c00;font-weight:bold">.</span>RUN<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">PAGE</span><span style="color:#000;font-weight:bold">::</span>&#34;Sales Quote&#34;<span style="color:#000;font-weight:bold">,</span>Rec<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span><span style="color:#204a87;font-weight:bold">Order</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PAGE</span><span style="color:#ce5c00;font-weight:bold">.</span>RUN<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">PAGE</span><span style="color:#000;font-weight:bold">::</span>&#34;Sales Order&#34;<span style="color:#000;font-weight:bold">,</span>Rec<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>Invoice<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PAGE</span><span style="color:#ce5c00;font-weight:bold">.</span>RUN<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">PAGE</span><span style="color:#000;font-weight:bold">::</span>&#34;Sales Invoice&#34;<span style="color:#000;font-weight:bold">,</span>Rec<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>&#34;Return Order&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PAGE</span><span style="color:#ce5c00;font-weight:bold">.</span>RUN<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">PAGE</span><span style="color:#000;font-weight:bold">::</span>&#34;Sales Return Order&#34;<span style="color:#000;font-weight:bold">,</span>Rec<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>&#34;Credit Memo&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PAGE</span><span style="color:#ce5c00;font-weight:bold">.</span>RUN<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">PAGE</span><span style="color:#000;font-weight:bold">::</span>&#34;Sales Credit Memo&#34;<span style="color:#000;font-weight:bold">,</span>Rec<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>&#34;Blanket Order&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PAGE</span><span style="color:#ce5c00;font-weight:bold">.</span>RUN<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">PAGE</span><span style="color:#000;font-weight:bold">::</span>&#34;Blanket Sales Order&#34;<span style="color:#000;font-weight:bold">,</span>Rec<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h3 id="nav-usages">NAV Usages</h3>
|
||
<p>Some of the NAV implementations of this pattern can be found in the following pages:</p>
|
||
<ol>
|
||
<li>Sales List (45) and Sales List Archive (5159)</li>
|
||
<li>Purchase List (53) and Purchase List Archive (5166)</li>
|
||
<li>Available - Sales Lines (499)</li>
|
||
<li>Sales Lines (516)</li>
|
||
<li>Purchase Lines (518)</li>
|
||
</ol></description></item><item><title>Docs: Multilanguage Application Data</title><link>https://alguidelines.dev/docs/navpatterns/patterns/multilanguage-application-data/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/multilanguage-application-data/</guid><description>
|
||
<p><em>Originally by Bogdana Botez at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>Generally, NAV translation refers to the translation of UI elements like captions and user texts (messages on dialogs, warnings, error messages). This translation is done by the Microsoft Dynamics NAV team before releasing the localized version of the product.</p>
|
||
<p>But there is one more scenario. In this scenario, Cronus International Ltd., wants to sell a &ldquo;Fiets&rdquo; to a Dutch customer, a&quot;Cykel&quot; to a Danish one, and a &ldquo;Bicicletta&rdquo; to an Italian customer. All 3 are the same inventory item - and its default name is &ldquo;Bicycle&rdquo;. But for reporting, Cronus International Ltd. wants to use the customer language preferences for translating the bicycle&rsquo;s name.</p>
|
||
<p>Sometimes there&rsquo;s a need to support multiple languages for domestic transactions, too. For example, <a href="http://en.wikipedia.org/wiki/Languages_of_Switzerland" title="Switzerland has 4 official languages">Switzerland has 4 official languages</a>: German, French, Italian and Romansh, the first 3 of them being supported by NAV.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>The example below uses the Item Translation feature of NAV, however, implementations of the same pattern exist for other application areas.</p>
|
||
<h3 id="how-to-use-the-pattern">How to use the pattern</h3>
|
||
<p><strong>Enter translations for &ldquo;Bicycle&rdquo;</strong></p>
|
||
<p>In the Windows client, on the bicycle Item card, on the Home ribbon tab, choose Translations.</p>
|
||
<p><a href="5670.1.png"><img src="5670.1.png" alt=" "></a></p>
|
||
<p>On the opened page, enter the Danish (language code DAN), the Italian (ITA), and the Dutch (NLD) translations for &ldquo;Bicycle&rdquo;.</p>
|
||
<p><a href="6746.2.png"><img src="6746.2.png" alt=" "></a></p>
|
||
<p><strong>Set the desired language for the Dutch, Danish, and Italian customers</strong></p>
|
||
<p>On the customer card for your 3 customers, in the Foreign Trade FastTab, choose the preferred language for each customer. If no language is specified, then the default item description will be used for items sold or anyhow associated to that customer. If for example, the DAN (Danish) language is specified for the customer, and the &ldquo;Bicycle&rdquo; has a translation in Danish, then this translation &ldquo;Cykel&rdquo; will be used instead of the default name &ldquo;Bicycle&rdquo;.</p>
|
||
<p><a href="2746.3.png"><img src="2746.3.png" alt=" "></a></p>
|
||
<p><strong>See the result</strong></p>
|
||
<p>After those changes, when the customer (in this case the Danish &ldquo;Lauritzen Kontormøbler A/S&rdquo;) transactions a bicycle, the translated description &ldquo;Cykel&rdquo; will be displayed on the documents and reports. For example, creating a sales order for this customer with 1 item No. 1000, shows:</p>
|
||
<p><a href="4812.4.png"><img src="4812.4.png" alt=" "></a></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p><strong>Create the translation table</strong></p>
|
||
<p>Named &ldquo;&lt;Entity&gt; Translation&rdquo; table, where &lt;Entity&gt; is replaced with the name of the actual object being translated. For the Item example above, this table will be named &ldquo;Item Translation&rdquo;.</p>
|
||
<p>The table definition contains at a minimum:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Entity ID field</td>
|
||
<td>For example, Item No.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Language Code</td>
|
||
<td>Identifies the language of this translation string (for example, &ldquo;DAN&rdquo; (Danish), &ldquo;BGR&rdquo;(Bulgarian). This is one of the language codes defined in the Languages table.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Translation</td>
|
||
<td>The translated string.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>The table above has a key composed of the first two fields.</p>
|
||
<p><strong>Create the user interface for entering new translations of &lt;Entity&gt;</strong></p>
|
||
<ul>
|
||
<li>Create a Translations page to present the table created above</li>
|
||
<li>On the Entity card - add a Translations menu option which will open the Translations page</li>
|
||
</ul>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>Some of the NAV implementations of this pattern are:</p>
|
||
<ol>
|
||
<li>Item Translation</li>
|
||
<li>Payment Term Translation</li>
|
||
<li>Shipment Method Translation</li>
|
||
<li>Unit of Measure Translation</li>
|
||
</ol>
|
||
<h2 id="related-topics">Related Topics</h2>
|
||
<p>The <strong>Extended Text</strong> pattern is a more powerful version of the <strong>Multilanguage application data</strong> pattern presented in this section. The main differences are:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Pattern</th>
|
||
<th>Multilanguage Application Data</th>
|
||
<th>Extended Text</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Supports translation of application data</td>
|
||
<td>Yes</td>
|
||
<td>Yes</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Format</td>
|
||
<td>Single- or multi-line</td>
|
||
<td>Single-line</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Applies to document type</td>
|
||
<td>Can choose which document types are affected.</td>
|
||
<td>All document types are affected.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></description></item><item><title>Docs: NET Exception Handling in CAL</title><link>https://alguidelines.dev/docs/navpatterns/patterns/net-exception-handling-in-cal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/net-exception-handling-in-cal/</guid><description>
|
||
<p><em>Originally by Mostafa Balat, Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>When there is a need to use .NET classes within C/AL, one of the main challenges is to handle the exceptions the methods of these .NET classes may throw. Eventually, if not handled, they will basically bubble up as runtime errors, halting the current operation a user is doing without having a chance to properly display errors in a user-friendly format.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>Using the .NET classes in order to extend NAV&rsquo;s functionality usually triggers the need to create an add-on assembly. This is a pretty powerful approach and opens the door for empowering NAV with new and extra functionality while harnessing the full power of .NET.</p>
|
||
<p>For example, integration with a Web service into NAV can be done to extend NAV&rsquo;s functionality or benefit from a service model offered through a 3rd party. To do so, it is possible to write a .NET add-in to handle the required bi-directional communication between NAV and the Web service. Alternatively, the implementation itself can be done in C/AL, with no add-in dependency. The latter option simplifies customization, deployment and upgradeability. Additionally, it builds up on the knowledge NAV developers have with C/AL programming.</p>
|
||
<p>On the other hand, not using an add-in exposes NAV to runtime errors due to unhandled exceptions that get thrown at different levels. The first is the communication layer, in which HTTP requests and responses are exchanged. The second is the business logic layer, at which the content of the requests and response is being prepared and groomed using XML Elements and being retrieved or edited based on the respective XPaths.</p>
|
||
<h3 id="when-to-use-it">When to Use It</h3>
|
||
<p>When .NET classes are used, they may throw exceptions upon failure. Some of these exceptions cannot pre-checked (e.g. like existence of a file on disk) and will only be figured out at runtime. Eventually, to present the error reason to a user and explain what needs to be done to address it, the exception needs to be handled gracefully. This also protects the client for unexpected crashes that may deteriorate the user experience.</p>
|
||
<h3 id="diagram">Diagram</h3>
|
||
<p><a href="1856.DotNet_5F00_Exception_5F00_Handling_5F00_in_5F00_CAL_5F00_Diagram.png"><img src="1856.DotNet_5F00_Exception_5F00_Handling_5F00_in_5F00_CAL_5F00_Diagram.png" alt=" "></a></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>A Try-Catch-Finally statement does not exist in C/AL. The alternative is to run the code consuming .NET objects within a codeunit, and handle the runtime errors, as follows:</p>
|
||
<ol>
|
||
<li>Write the code that uses the .NET classes in a codeunit.</li>
|
||
<li>Run the codeunit using <strong>CODEUNIT.RUN</strong> or the Run function on a codeunit variable.</li>
|
||
<li>Handle the return value of the <strong>OnRun</strong> trigger for the codeunit within an <strong>IF</strong> statement.</li>
|
||
<li>Write the exception handling code in a function, and call it when the return value for <strong>OnRun</strong> is <strong>FALSE</strong>.</li>
|
||
<li>The exception handling function should determine which exception to handle, and pass this over to <strong>COD1291 DotNet Exception Handler</strong> codeunit.</li>
|
||
</ol>
|
||
<p>When an exception is thrown, it is already wrapped up within an NAV exception. This means the real exception to look for is retrievable through the <strong>InnerException</strong> property of the NAV exception. Then, next step would be to properly determine the type of that exception, and act accordingly. The <strong>COD1291 DotNet Exception Handler</strong> codeunit takes care of looping through the nested levels of inner exceptions, digging for an exception with the expected type. If found, it is retrieved; otherwise, the main (outer) exception&rsquo;s message is retrieved.</p>
|
||
<h2 id="nav-specific-example">NAV Specific Example</h2>
|
||
<h3 id="overview">Overview</h3>
|
||
<p>The exception handling pattern is implemented in the integration with a web service for bank file format conversion. Within the respective &ldquo;External Data Handling Codeunit&rdquo; for that web service, communication through SOAP requests is required. Eventually, the HTTP web request and response .NET classes are used for that purpose.</p>
|
||
<p>For instance, if a failure to establish a connection to the web service due to lack of Internet access, a <strong>WebException</strong> is thrown with the relevant error details. <strong>COD1290 Web Service Mgt.</strong> codeunit wraps up the required functionality to interact with a web service in C/AL, handling all the required plumping work to send web requests, receive web responses, and extract valid and error details from the web response.</p>
|
||
<h3 id="code-sample">Code Sample</h3>
|
||
<p>The &ldquo;External Data Handling Codeunit&rdquo; is a consumer of <strong>COD1290 Web Service Mgt.</strong> codeunit. If a runtime exception occurs, it gets handled as follows:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SendDataToConversionService@<span style="color:#0000cf;font-weight:bold">1</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>PaymentFileTempBlob@<span style="color:#0000cf;font-weight:bold">1003</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">99008535</span><span style="color:#000;font-weight:bold">;</span>BodyTempBlob@<span style="color:#0000cf;font-weight:bold">1004</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">99008535</span><span style="color:#000;font-weight:bold">;</span>PostingExch@<span style="color:#0000cf;font-weight:bold">1007</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1220</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BankDataConvServiceSetup@<span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1260</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>WebServiceRequestMgt@<span style="color:#0000cf;font-weight:bold">1001</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1290</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BodyInStream@<span style="color:#0000cf;font-weight:bold">1005</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">InStream</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ResponseInStream@<span style="color:#0000cf;font-weight:bold">1002</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">InStream</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">NOT</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BodyTempBlob<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">Blob</span><span style="color:#ce5c00;font-weight:bold">.</span>HASVALUE<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ERROR<span style="color:#ce5c00;font-weight:bold">(</span>NoRequestBodyErr<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>PrepareSOAPRequestBody<span style="color:#ce5c00;font-weight:bold">(</span>BodyTempBlob<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>COMMIT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BankDataConvServiceSetup<span style="color:#ce5c00;font-weight:bold">.</span>GET<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BodyTempBlob<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">Blob</span><span style="color:#ce5c00;font-weight:bold">.</span>CREATEINSTREAM<span style="color:#ce5c00;font-weight:bold">(</span>BodyInStream<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>WebServiceRequestMgt<span style="color:#ce5c00;font-weight:bold">.</span>SetGlobals<span style="color:#ce5c00;font-weight:bold">(</span>BodyInStream<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BankDataConvServiceSetup<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Service URL&#34;<span style="color:#000;font-weight:bold">,</span>BankDataConvServiceSetup<span style="color:#ce5c00;font-weight:bold">.</span>&#34;User Name&#34;<span style="color:#000;font-weight:bold">,</span>BankDataConvServiceSetup<span style="color:#ce5c00;font-weight:bold">.</span>GetPassword<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">NOT</span><span style="color:#f8f8f8;text-decoration:underline"> </span>WebServiceRequestMgt<span style="color:#ce5c00;font-weight:bold">.</span>RUN<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>WebServiceRequestMgt<span style="color:#ce5c00;font-weight:bold">.</span>ProcessFaultResponse<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>WebServiceRequestMgt<span style="color:#ce5c00;font-weight:bold">.</span>GetResponseContent<span style="color:#ce5c00;font-weight:bold">(</span>ResponseInStream<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CheckIfErrorsOccurred<span style="color:#ce5c00;font-weight:bold">(</span>ResponseInStream<span style="color:#000;font-weight:bold">,</span>PostingExch<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ReadContentFromResponse<span style="color:#ce5c00;font-weight:bold">(</span>PaymentFileTempBlob<span style="color:#000;font-weight:bold">,</span>ResponseInStream<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ProcessFaultResponse@<span style="color:#0000cf;font-weight:bold">15</span><span style="color:#ce5c00;font-weight:bold">()</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>XMLDOMMgt@<span style="color:#0000cf;font-weight:bold">1006</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">6224</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DotNetExceptionHandler@<span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1291</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>WebException@<span style="color:#0000cf;font-weight:bold">1005</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DotNet</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;&#39;System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089&#39;.System.Net.WebException&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>WebExceptionStatus@<span style="color:#0000cf;font-weight:bold">1004</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DotNet</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;&#39;System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089&#39;.System.Net.WebExceptionStatus&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>XmlDoc@<span style="color:#0000cf;font-weight:bold">1003</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DotNet</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;&#39;System.Xml, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089&#39;.System.Xml.XmlDocument&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>HttpWebResponseError@<span style="color:#0000cf;font-weight:bold">1007</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DotNet</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;&#39;System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089&#39;.System.Net.HttpWebResponse&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>HttpStatusCode@<span style="color:#0000cf;font-weight:bold">1008</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DotNet</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;&#39;System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089&#39;.System.Net.HttpStatusCode&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ResponseInputStream@<span style="color:#0000cf;font-weight:bold">1002</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">InStream</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DotNetExceptionHandler<span style="color:#ce5c00;font-weight:bold">.</span>Collect<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">NOT</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DotNetExceptionHandler<span style="color:#ce5c00;font-weight:bold">.</span>CastToType<span style="color:#ce5c00;font-weight:bold">(</span>WebException<span style="color:#000;font-weight:bold">,</span>GETDOTNETTYPE<span style="color:#ce5c00;font-weight:bold">(</span>WebException<span style="color:#ce5c00;font-weight:bold">)) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DotNetExceptionHandler<span style="color:#ce5c00;font-weight:bold">.</span>Rethrow<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">NOT</span><span style="color:#f8f8f8;text-decoration:underline"> </span>WebException<span style="color:#ce5c00;font-weight:bold">.</span>Status<span style="color:#ce5c00;font-weight:bold">.</span>Equals<span style="color:#ce5c00;font-weight:bold">(</span>WebExceptionStatus<span style="color:#ce5c00;font-weight:bold">.</span>ProtocolError<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ERROR<span style="color:#ce5c00;font-weight:bold">(</span>WebException<span style="color:#ce5c00;font-weight:bold">.</span>Message<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ResponseInputStream<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>WebException<span style="color:#ce5c00;font-weight:bold">.</span>Response<span style="color:#ce5c00;font-weight:bold">.</span>GetResponseStream<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DebugLogStreamToTempFile<span style="color:#ce5c00;font-weight:bold">(</span>ResponseInputStream<span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;WebExceptionResponse&#39;</span><span style="color:#000;font-weight:bold">,</span>TempDebugLogTempBlob<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>HttpWebResponseError<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>WebException<span style="color:#ce5c00;font-weight:bold">.</span>Response<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">NOT</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">(</span>HttpWebResponseError<span style="color:#ce5c00;font-weight:bold">.</span>StatusCode<span style="color:#ce5c00;font-weight:bold">.</span>Equals<span style="color:#ce5c00;font-weight:bold">(</span>HttpStatusCode<span style="color:#ce5c00;font-weight:bold">.</span>Found<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">OR</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>HttpWebResponseError<span style="color:#ce5c00;font-weight:bold">.</span>StatusCode<span style="color:#ce5c00;font-weight:bold">.</span>Equals<span style="color:#ce5c00;font-weight:bold">(</span>HttpStatusCode<span style="color:#ce5c00;font-weight:bold">.</span>InternalServerError<span style="color:#ce5c00;font-weight:bold">))
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ERROR<span style="color:#ce5c00;font-weight:bold">(</span>WebException<span style="color:#ce5c00;font-weight:bold">.</span>Message<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>XmlDoc<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>XmlDoc<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">XmlDocument</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>XmlDoc<span style="color:#ce5c00;font-weight:bold">.</span>Load<span style="color:#ce5c00;font-weight:bold">(</span>ResponseInputStream<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ERROR<span style="color:#ce5c00;font-weight:bold">(</span>XMLDOMMgt<span style="color:#ce5c00;font-weight:bold">.</span>FindNodeTextWithNamespace<span style="color:#ce5c00;font-weight:bold">(</span>XmlDoc<span style="color:#ce5c00;font-weight:bold">.</span>DocumentElement<span style="color:#000;font-weight:bold">,</span>FaultStringXmlPathTxt<span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#39;soap&#39;</span><span style="color:#000;font-weight:bold">,</span>SoapNamespaceTxt<span style="color:#ce5c00;font-weight:bold">))</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">OBJECT<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1291</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DotNet</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Exception<span style="color:#f8f8f8;text-decoration:underline"> </span>Handler<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>{<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OBJECT<span style="color:#ce5c00;font-weight:bold">-</span>PROPERTIES<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Date</span>=<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Time</span>=<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Version</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">List</span>=<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>}<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>PROPERTIES<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnRun=<span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>}<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">CODE</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OuterException@<span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DotNet</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;&#39;mscorlib&#39;.System.Exception&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Catch@<span style="color:#0000cf;font-weight:bold">3</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Exception@<span style="color:#0000cf;font-weight:bold">1002</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DotNet</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;&#39;mscorlib&#39;.System.FormatException&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">Type</span>@<span style="color:#0000cf;font-weight:bold">1007</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DotNet</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;&#39;mscorlib&#39;.System.Type&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Collect<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">NOT</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CastToType<span style="color:#ce5c00;font-weight:bold">(</span>Exception<span style="color:#000;font-weight:bold">,</span><span style="color:#204a87;font-weight:bold">Type</span><span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Rethrow<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Collect@<span style="color:#0000cf;font-weight:bold">1</span><span style="color:#ce5c00;font-weight:bold">()</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OuterException<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GETLASTERROROBJECT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TryCastToType@<span style="color:#0000cf;font-weight:bold">5</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">Type</span>@<span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DotNet</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;&#39;mscorlib&#39;.System.Type&#34;<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Exception@<span style="color:#0000cf;font-weight:bold">1001</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DotNet</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;&#39;mscorlib&#39;.System.FormatException&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span>CastToType<span style="color:#ce5c00;font-weight:bold">(</span>Exception<span style="color:#000;font-weight:bold">,</span><span style="color:#204a87;font-weight:bold">Type</span><span style="color:#ce5c00;font-weight:bold">))</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CastToType@<span style="color:#0000cf;font-weight:bold">2</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Exception@<span style="color:#0000cf;font-weight:bold">1002</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DotNet</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;&#39;mscorlib&#39;.System.FormatException&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">Type</span>@<span style="color:#0000cf;font-weight:bold">1007</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DotNet</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;&#39;mscorlib&#39;.System.Type&#34;<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Exception<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OuterException<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">REPEAT</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Type</span><span style="color:#ce5c00;font-weight:bold">.</span>Equals<span style="color:#ce5c00;font-weight:bold">(</span>Exception<span style="color:#ce5c00;font-weight:bold">.</span>GetType<span style="color:#ce5c00;font-weight:bold">()) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span>TRUE<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Exception<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Exception<span style="color:#ce5c00;font-weight:bold">.</span>InnerException<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">UNTIL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ISNULL<span style="color:#ce5c00;font-weight:bold">(</span>Exception<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span>FALSE<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Rethrow@<span style="color:#0000cf;font-weight:bold">4</span><span style="color:#ce5c00;font-weight:bold">()</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">NOT</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ISNULL<span style="color:#ce5c00;font-weight:bold">(</span>OuterException<span style="color:#ce5c00;font-weight:bold">.</span>InnerException<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ERROR<span style="color:#ce5c00;font-weight:bold">(</span>OuterException<span style="color:#ce5c00;font-weight:bold">.</span>InnerException<span style="color:#ce5c00;font-weight:bold">.</span>Message<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ERROR<span style="color:#ce5c00;font-weight:bold">(</span>OuterException<span style="color:#ce5c00;font-weight:bold">.</span>Message<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#ce5c00;font-weight:bold">.
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span>}<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>}<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h2 id="nav-usages">NAV Usages</h2>
|
||
<p>The DotNet Exception Handler codeunit has been used for the Web service integration required for:</p>
|
||
<ol>
|
||
<li>Payment Export from the Payment Journal for creating bank-specific payment files.</li>
|
||
<li>Bank Statement Import on the Bank Acc. Reconciliation card for importing the content of bank-specific statements.</li>
|
||
<li>Bank name lookup on the Bank Account card for dynamically identifying the format to use to generate a bank-specific payment file.</li>
|
||
</ol>
|
||
<h2 id="ideas-for-improvement">Ideas for Improvement</h2>
|
||
<p>Extend the language support in C/AL to provide a built-in Try-Catch-Finally statement, similar to .NET languages.</p>
|
||
<h2 id="consequences">Consequences</h2>
|
||
<p>When this pattern should not be used: avoid nesting of codeunits. To properly handle the exceptions, you need to use the codeunit as an atomic piece of functionality that may pass or fail without using Codeunit.Run internally.</p></description></item><item><title>Docs: No Series</title><link>https://alguidelines.dev/docs/navpatterns/patterns/no-series/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/no-series/</guid><description>
|
||
<p><em>By Bogdana Botez, at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>Number series assignment is widely used in Microsoft Dynamics NAV to automatically assign unique numbers to data entries.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>Documents and entities of any type (invoices, orders, customers, inventory items etc) are usually assigned an unique number, which can be later referenced whenever that particular entry needs to be consulted. When a new data entry is created, NAV implements the possibility to auto-assign a new number for this entry. For example, whenever a new sales order is created, it can be auto-numbered. This number has a specific format which is set up previously by the NAV administrator. For example, sales orders could have numbers between SO00001 and SO99999. When all the numbers in this series have been used, NAV will show an error and the administrator has to either extend the current number series, or create a new series to be used.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>The number series is implemented at the table level. Each time a new record is inserted, the user can either:</p>
|
||
<ul>
|
||
<li>type a new number (if allowed by the setup), or</li>
|
||
<li>have an auto-generated number created.</li>
|
||
</ul>
|
||
<h3 id="number-series-definition">Number Series definition</h3>
|
||
<p>From the implementation point of view, a number series is a record in the table 308 - &ldquo;No. Series&rdquo;.</p>
|
||
<p><a href="5661.1.png"><img src="5661.1.png" alt=" "></a></p>
|
||
<p>The most relevant fields are:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th></th>
|
||
<th></th>
|
||
<th></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Code</td>
|
||
<td>Code 10</td>
|
||
<td>Used to identify the number series in further places where it will be used.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Default Nos.</td>
|
||
<td>Boolean</td>
|
||
<td>The boolean <strong>Default Nos.</strong> decides whether this number series can use automatic numbering. If false, then the user is expected to manually look up the No. field and select it from the number series.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Manual Nos.</td>
|
||
<td>Boolean</td>
|
||
<td>If the <strong>Manual Nos.</strong> is Yes, then the used will be allowed to manually type the value of the next number (&ldquo;No.&quot;) field.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Date Order</td>
|
||
<td>Boolean</td>
|
||
<td><strong>Date Order</strong> is used to decide whether or not the numbers from the range are assigned chronologically.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="number-series-sequence">Number Series sequence</h3>
|
||
<p>The sequence definition is found in table 309 - No. Series Line. Contains the explicit definition of the series, for example a series called BANK, could start with BANK001 and increase incrementally by one, in the sequence BANK001, BANK002, BANK003, &hellip;. Until the last number BANK999. When hitting the number BANK990, the user will receive a warning that the series is about to be exhausted and it must either be increased, or a new series should be assigned.</p>
|
||
<p><a href="1452.2.png"><img src="1452.2.png" alt=" "></a></p>
|
||
<p><a href="3527.3.png"><img src="3527.3.png" alt=" "></a></p>
|
||
<p>The most relevant fields are:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th></th>
|
||
<th></th>
|
||
<th></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Series Code</td>
|
||
<td>Code 10</td>
|
||
<td>Links it to the number series defined in table 308.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Starting No.</td>
|
||
<td>Integer</td>
|
||
<td>This is the first number in the sequence, for a book indexing application it can be BOOK0001.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Ending No.</td>
|
||
<td>Integer</td>
|
||
<td>The last number in the sequence, for example BOOK5000.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Warning No.</td>
|
||
<td>Integer</td>
|
||
<td>When this number is reached, the user will see a warning message stating that the number series is running out of assignable numbers.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Increment-by No.</td>
|
||
<td>Integer</td>
|
||
<td>The value for incrementing the numeric part of the series.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Last No. Used</td>
|
||
<td>Code 20</td>
|
||
<td>The last number from the sequence that was assigned.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Last Date Used</td>
|
||
<td>Date</td>
|
||
<td>Stating when the last number was assigned.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="add-the-default-number-series-to-the-setup">Add the default number series to the setup</h3>
|
||
<p>Various series of numbers can be defined as seen above. For example, a library can have a number series for indexing rental of each of the following: books, movies, music, video. The books series can be split by domain, for example a series BOOKSCIFI can have BOOK0001&hellip;BOOK1500, then BOOKTECH can use the sequence BOOK1501&hellip;BOOK4000 and so on.</p>
|
||
<p>The default number series for a certain application area is typically stored in the domain setup table. For example, NAV Demo Database stores the default Item number series in the Inventory Setup table 313. This means that you will need to add the Number Series fields in your setup table and ensure that before the customer starts using the solution, the number series is created and added to the setup defaults.</p>
|
||
<h3 id="how-to-use-the-number-series">How to use the Number Series</h3>
|
||
<p>The table which will host the number from the number series, needs the following fields:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th></th>
|
||
<th></th>
|
||
<th></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>No.</td>
|
||
<td>Code 20</td>
|
||
<td>Contains the auto-generated sequential number.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>No. Series</td>
|
||
<td>Code 10</td>
|
||
<td>The number series definition, which decides what the next No. will be.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>And the code to make the number series alive:</p>
|
||
<p><strong>OnInsert</strong></p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">OnInsert<span style="color:#ce5c00;font-weight:bold">()
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>NoSeriesMgt<span style="color:#ce5c00;font-weight:bold">.</span>InitSeries<span style="color:#ce5c00;font-weight:bold">(</span>DefaultNoSeriesCode<span style="color:#000;font-weight:bold">,</span>OldNoSeriesCode<span style="color:#000;font-weight:bold">,</span>NewDate<span style="color:#000;font-weight:bold">,</span>NewNo<span style="color:#000;font-weight:bold">,</span>NewNoSeriesCode<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p><strong>Field &ldquo;No.&quot;</strong></p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">No<span style="color:#ce5c00;font-weight:bold">. </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>OnValidate<span style="color:#ce5c00;font-weight:bold">()
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span>&lt;&gt;<span style="color:#f8f8f8;text-decoration:underline"> </span>xRec<span style="color:#ce5c00;font-weight:bold">.</span>&#34;No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">// Validate that &#34;No.&#34; corresponds to the current No. Series rules
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline"> </span>NoSeriesMgt<span style="color:#ce5c00;font-weight:bold">.</span>TestManual<span style="color:#ce5c00;font-weight:bold">(</span>DefaultNoSeriesCode<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;No. Series&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p><strong>AssistEdit</strong></p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">AssistEdit<span style="color:#ce5c00;font-weight:bold">() </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>NoSeriesMgt<span style="color:#ce5c00;font-weight:bold">.</span>InitSeries<span style="color:#ce5c00;font-weight:bold">(</span>DefaultNoSeriesCode<span style="color:#000;font-weight:bold">,</span>OldNoSeriesCode<span style="color:#000;font-weight:bold">,</span>NewDate<span style="color:#000;font-weight:bold">,</span>NewNo<span style="color:#000;font-weight:bold">,</span>NewNoSeriesCode<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>Where:</p>
|
||
<ul>
|
||
<li><strong>DefaultNoSeriesCode</strong> is typically found in the application domain setup table.</li>
|
||
<li><strong>OldNoSeriesCode</strong> is typically the previous value of the &ldquo;No. Series&rdquo; code, which is found in <strong>xRec.&ldquo;No. Series&rdquo;</strong></li>
|
||
<li><strong>NewDate</strong> is typically 0D (empty date)</li>
|
||
<li>NewNo and <strong>NewNoSeriesCode</strong> are the current values found in <strong>&ldquo;No.&quot;</strong> and <strong>&ldquo;No. Series&rdquo;</strong></li>
|
||
</ul>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>See below an example of how NAV implements the number series pattern.</p>
|
||
<h3 id="sales-and-receivables">Sales and Receivables</h3>
|
||
<p>The setup table 311 (Sales &amp; Receivables Setup) contains the default number series to be used in the whole application domain. In the demo data, some of the series defined here are: Customer Nos., Quote Nos., Order Nos., Invoice Nos., Posted Invoice Nos., Credit Memo Nos., Posted Credit Memo Nos., etc. Those number series are dimensioned for the needs of a typical small to medium sized company, however, various business have different patterns (for example, posting an unusual high number of invoices). In this case, the number series should be adjusted accordingly to make space for the customized company needs.</p>
|
||
<p>The default number series defined in the setup is then used in the individual tables. For example, table 18 - Customer, has</p>
|
||
<h3 id="field-no">Field &ldquo;No.&rdquo;</h3>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">{<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">;</span>No<span style="color:#ce5c00;font-weight:bold">. </span><span style="color:#000;font-weight:bold">;</span>Code20<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">;</span>AltSearchField=Search<span style="color:#f8f8f8;text-decoration:underline"> </span>Name<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>OnValidate=<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span>&lt;&gt;<span style="color:#f8f8f8;text-decoration:underline"> </span>xRec<span style="color:#ce5c00;font-weight:bold">.</span>&#34;No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesSetup<span style="color:#ce5c00;font-weight:bold">.</span>GET<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>NoSeriesMgt<span style="color:#ce5c00;font-weight:bold">.</span>TestManual<span style="color:#ce5c00;font-weight:bold">(</span>SalesSetup<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Customer Nos.&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;No. Series&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Invoice Disc. Code&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Invoice Disc. Code&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;No.&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>}<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h3 id="field-no-series">Field &ldquo;No. Series&rdquo;</h3>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">{<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">107</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">;</span>No<span style="color:#ce5c00;font-weight:bold">. </span>Series<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">;</span>Code10<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">;</span>TableRelation=&#34;No. Series&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Editable=No<span style="color:#f8f8f8;text-decoration:underline"> </span>}<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h3 id="assistedit">AssistEdit</h3>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>AssistEdit@<span style="color:#0000cf;font-weight:bold">2</span><span style="color:#ce5c00;font-weight:bold">(</span>OldCust@<span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">18</span><span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Cust@<span style="color:#0000cf;font-weight:bold">1001</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Record</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">18</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">WITH</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Cust<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DO</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Cust<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Rec<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesSetup<span style="color:#ce5c00;font-weight:bold">.</span>GET<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesSetup<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">TESTFIELD</span><span style="color:#ce5c00;font-weight:bold">(</span>&#34;Customer Nos.&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>NoSeriesMgt<span style="color:#ce5c00;font-weight:bold">.</span>SelectSeries<span style="color:#ce5c00;font-weight:bold">(</span>SalesSetup<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Customer Nos.&#34;<span style="color:#000;font-weight:bold">,</span>OldCust<span style="color:#ce5c00;font-weight:bold">.</span>&#34;No. Series&#34;<span style="color:#000;font-weight:bold">,</span>&#34;No. Series&#34;<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>NoSeriesMgt<span style="color:#ce5c00;font-weight:bold">.</span>SetSeries<span style="color:#ce5c00;font-weight:bold">(</span>&#34;No.&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Rec<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Cust<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span>TRUE<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h3 id="oninsert">OnInsert</h3>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">OnInsert=<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesSetup<span style="color:#ce5c00;font-weight:bold">.</span>GET<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesSetup<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">TESTFIELD</span><span style="color:#ce5c00;font-weight:bold">(</span>&#34;Customer Nos.&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>NoSeriesMgt<span style="color:#ce5c00;font-weight:bold">.</span>InitSeries<span style="color:#ce5c00;font-weight:bold">(</span>SalesSetup<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Customer Nos.&#34;<span style="color:#000;font-weight:bold">,</span>xRec<span style="color:#ce5c00;font-weight:bold">.</span>&#34;No. Series&#34;<span style="color:#000;font-weight:bold">,</span>0D<span style="color:#000;font-weight:bold">,</span>&#34;No.&#34;<span style="color:#000;font-weight:bold">,</span>&#34;No. Series&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">...
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>To run the AssistEdit procedure, include this code on the No. - OnAssistEdit() trigger of the Page:</p>
|
||
<h3 id="no---onassistedit">No. - OnAssistEdit()</h3>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>AssistEdit<span style="color:#ce5c00;font-weight:bold">(</span>xRec<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>CurrPage<span style="color:#ce5c00;font-weight:bold">.</span>UPDATE<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div>
|
||
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;">
|
||
<iframe src="https://www.youtube.com/embed/1lG9rY_dmM4" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" allowfullscreen title="YouTube Video"></iframe>
|
||
</div></description></item><item><title>Docs: Notifications</title><link>https://alguidelines.dev/docs/navpatterns/patterns/notifications/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/notifications/</guid><description>
|
||
<p>A collection of patterns about notifications.</p></description></item><item><title>Docs: Observer</title><link>https://alguidelines.dev/docs/navpatterns/patterns/observer/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/observer/</guid><description>
|
||
<p><em>By Nikolai L&rsquo;Estrange, from TVision Technology Ltd. in the UK</em></p>
|
||
<h3 id="abstract">Abstract</h3>
|
||
<p>Track all record changes against a defined table or set of tables.</p>
|
||
<h3 id="problem">Problem</h3>
|
||
<p>Microsoft Dynamics NAV has the built in ability to track all record changes against any table, however it does not always fire the triggers for every table.</p>
|
||
<h3 id="solution">Solution</h3>
|
||
<p>Create a setup table to define which other tables you want to track changes for, and optionally what triggers you want to fire, then link this up to the standard triggers in Codeunit 1.</p>
|
||
<p>Codeunit 1 Application Management contains the triggers OnDatabaseInsert, OnDatabaseModify, OnDatabaseDelete and OnDatabaseRename which are what we need to subscribe to in order to track record changes. However these triggers are only fired sometimes. This is determined by the parameters set in the function GetTableTriggerSetup, which is called once per table per session.</p>
|
||
<p>In order to define which tables we are interested in we can create a new table with the following fields:</p>
|
||
<p><strong>Observable Table:</strong></p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>&ldquo;Table ID&rdquo;</th>
|
||
<th>Integer</th>
|
||
<th>Object.ID WHERE (Type=CONST(Table))</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>TrackInsert</td>
|
||
<td>Boolean</td>
|
||
<td>[optional]</td>
|
||
</tr>
|
||
<tr>
|
||
<td>TrackModify</td>
|
||
<td>Boolean</td>
|
||
<td>[optional]</td>
|
||
</tr>
|
||
<tr>
|
||
<td>TrackDelete</td>
|
||
<td>Boolean</td>
|
||
<td>[optional]</td>
|
||
</tr>
|
||
<tr>
|
||
<td>TrackRename</td>
|
||
<td>Boolean</td>
|
||
<td>[optional]</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Then we can create a Codeunit that will set the Table Trigger Setup parameters and also subscribe to the OnDatabase triggers.</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>[EventSubscriber]<span style="color:#f8f8f8;text-decoration:underline"> </span>GetTableTriggerSetup<span style="color:#ce5c00;font-weight:bold">(</span>TableId<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Integer</span><span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnDatabaseInsert<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnDatabaseModify<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnDatabaseDelete<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#000;font-weight:bold">;</span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnDatabaseRename<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Boolean</span><span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observable<span style="color:#ce5c00;font-weight:bold">.</span>GET<span style="color:#ce5c00;font-weight:bold">(</span>TableId<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observable<span style="color:#ce5c00;font-weight:bold">.</span>TrackInsert<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnDatabaseInsert<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TRUE<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observable<span style="color:#ce5c00;font-weight:bold">.</span>TrackModify<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnDatabaseModify<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TRUE<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observable<span style="color:#ce5c00;font-weight:bold">.</span>TrackDelete<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnDatabaseDelete<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TRUE<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observable<span style="color:#ce5c00;font-weight:bold">.</span>TrackRename<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>OnDatabaseRename<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TRUE<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>[EventSubscriber]<span style="color:#f8f8f8;text-decoration:underline"> </span>OnDatabaseInsert<span style="color:#ce5c00;font-weight:bold">(</span>RecRef<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">RecordRef</span><span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observable<span style="color:#ce5c00;font-weight:bold">.</span>Get<span style="color:#ce5c00;font-weight:bold">(</span>RecRef<span style="color:#ce5c00;font-weight:bold">.</span>NUMBER<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">AND</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observable<span style="color:#ce5c00;font-weight:bold">.</span>TrackInsert<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">//do something
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>[EventSubscriber]<span style="color:#f8f8f8;text-decoration:underline"> </span>OnDatabaseModify<span style="color:#ce5c00;font-weight:bold">(</span>RecRef<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">RecordRef</span><span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observable<span style="color:#ce5c00;font-weight:bold">.</span>Get<span style="color:#ce5c00;font-weight:bold">(</span>RecRef<span style="color:#ce5c00;font-weight:bold">.</span>NUMBER<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">AND</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observable<span style="color:#ce5c00;font-weight:bold">.</span>TrackModify<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">//do something
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>[EventSubscriber]<span style="color:#f8f8f8;text-decoration:underline"> </span>OnDatabaseDelete<span style="color:#ce5c00;font-weight:bold">(</span>RecRef<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">RecordRef</span><span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observable<span style="color:#ce5c00;font-weight:bold">.</span>Get<span style="color:#ce5c00;font-weight:bold">(</span>RecRef<span style="color:#ce5c00;font-weight:bold">.</span>NUMBER<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">AND</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observable<span style="color:#ce5c00;font-weight:bold">.</span>TrackDelete<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">//do something
|
||
</span><span style="color:#8f5902;font-style:italic"></span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">LOCAL</span><span style="color:#f8f8f8;text-decoration:underline"> </span>[EventSubscriber]<span style="color:#f8f8f8;text-decoration:underline"> </span>OnDatabaseRename<span style="color:#ce5c00;font-weight:bold">(</span>RecRef<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">RecordRef</span><span style="color:#000;font-weight:bold">;</span>xRecRef<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">RecordRef</span><span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observable<span style="color:#ce5c00;font-weight:bold">.</span>Get<span style="color:#ce5c00;font-weight:bold">(</span>RecRef<span style="color:#ce5c00;font-weight:bold">.</span>NUMBER<span style="color:#ce5c00;font-weight:bold">) </span><span style="color:#204a87;font-weight:bold">AND</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Observable<span style="color:#ce5c00;font-weight:bold">.</span>TrackRename<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">//do something
|
||
</span></code></pre></div><p><em><strong>Note:</strong></em> In NAV2016 all these functions can be EventSubscribers that subscribe to the functions in Codeunit 1 as per above, in earlier versions of NAV these functions will need to be Global and called explicitly from within the Codeunit 1 functions.</p>
|
||
<h3 id="nav-usages">NAV Usages</h3>
|
||
<p>Variations of this pattern exists in the standard product in:</p>
|
||
<ul>
|
||
<li>Codeunit 423 Change Log Management</li>
|
||
<li>Codeunit 5150 Integration Management. In this Codeunit the tables that fire triggers are hardcoded in C/AL.</li>
|
||
</ul>
|
||
<h3 id="consequences">Consequences</h3>
|
||
<p>It is important that in our GetTableTriggerSetup function we only ever set the parameters to <strong>TRUE</strong>, and <strong>never</strong> set them to <strong>FALSE</strong>. This is because there may be other Codeunits listening to the triggers for that table, e.g. Change Log. This is also why we check the setup again within each trigger.</p>
|
||
<h3 id="related-topics">Related Topics</h3>
|
||
<p>This pattern was originally described in the following blog:</p>
|
||
<p><a href="https://geeknikolai.wordpress.com/2015/10/30/observer-pattern-in-dynamics-nav-2016/">https://geeknikolai.wordpress.com/2015/10/30/observer-pattern-in-dynamics-nav-2016/</a></p>
|
||
<h3 id="nav-versions">NAV Versions</h3>
|
||
<ul>
|
||
<li>From NAV 2016 use the code as shown</li>
|
||
<li>For earlier versions see <em>Note</em> above</li>
|
||
</ul></description></item><item><title>Docs: Posting Routine - Select Behavior</title><link>https://alguidelines.dev/docs/navpatterns/patterns/posting-routine-select-behavior/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/posting-routine-select-behavior/</guid><description>
|
||
<p><em>By waldo</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>Send information (parameters) to a processing framework/routine so that it knows what to do, how to behave.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>For a processing routine to behave correctly, it needs sometimes input of a user to know what it has to do, check or avoid doing. To do this, usually a piece of UI is getting called (STRMENU) with the question what to do. These input needs to get to the routine.</p>
|
||
<ol>
|
||
<li>The user selects the option on how he wants the process to behave</li>
|
||
<li>There are extra fields on the processing table, that are used internally and act like parameters. These Fields get filled according to the selections that the user has made</li>
|
||
<li>The processing codeunit receives the processing table, and therefor also the parameters</li>
|
||
</ol>
|
||
<p><a href="7585.PostingRoutineSelectBehaviour1.png"><img src="7585.PostingRoutineSelectBehaviour1.png" alt=" "></a></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>Example: Sales Post.</p>
|
||
<p>On Sales Header, there were fields created which act like internal parameter-fields for the &ldquo;Sales Post&rdquo; routine:</p>
|
||
<p><a href="1563.PostingRoutineSelectBehaviour2.png"><img src="1563.PostingRoutineSelectBehaviour2.png" alt=" "></a></p>
|
||
<p>When pressing &ldquo;Post&rdquo;, the Selection Codeunit is getting called:</p>
|
||
<p><a href="5428.PostingRoutineSelectBehaviour3.png"><img src="5428.PostingRoutineSelectBehaviour3.png" alt=" "></a></p>
|
||
<p>Or in case of the Post&amp;Print, the selection codeunit is different:</p>
|
||
<p><a href="6170.PostingRoutineSelectBehaviour4.png"><img src="6170.PostingRoutineSelectBehaviour4.png" alt=" "></a></p>
|
||
<p>Next, the user is able to select the options with an STRMENU, which results in filling in the fields above, like:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">Selection<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>STRMENU<span style="color:#ce5c00;font-weight:bold">(</span>Text000<span style="color:#000;font-weight:bold">,</span><span style="color:#0000cf;font-weight:bold">3</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Selection<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>Ship<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Selection<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IN</span><span style="color:#f8f8f8;text-decoration:underline"> </span>[<span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span><span style="color:#0000cf;font-weight:bold">3</span>]<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>Invoice<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Selection<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IN</span><span style="color:#f8f8f8;text-decoration:underline"> </span>[<span style="color:#0000cf;font-weight:bold">2</span><span style="color:#000;font-weight:bold">,</span><span style="color:#0000cf;font-weight:bold">3</span>]<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>The processing codeunit is being called after these options were set.</p>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>This is also being used in the Purchase Post.</p>
|
||
<p>However, the Service Post works different. In Short:</p>
|
||
<ul>
|
||
<li>There were no parameter fields added to the processing table (Service Header)</li>
|
||
<li>The processing routine isn&rsquo;t called by CODEUNIT.RUN, but a function in a declared codeunit, where you pass the Invoice and Ship parameter separately.</li>
|
||
</ul>
|
||
<h2 id="ideas-for-improvement">Ideas for improvement</h2>
|
||
<p>Implement it consequently. There is (in my knowledge) no reason to do Service Posting differently from Sales and Purchase.</p>
|
||
<p>Furthermore, one might argue if adding fields to a table (which also means adding fields to the SQL Table) is the right solution to pass parameters to processing methods.</p>
|
||
<p>On the other hand, as we are handling tables as being &ldquo;classes&rdquo; in many cases, it does make sense to add &ldquo;properties&rdquo; to those &ldquo;classes&rdquo; to change the behavior of the method (SalesHeader.Post).</p>
|
||
<h2 id="related-topics">Related Topics</h2>
|
||
<p>I would like to add a pattern like &ldquo;Using Argument tables&rdquo; (as a sub-pattern for the facade-pattern). It somewhat is related to this way of handling parameters: using tablefields to pass a flexible amount of parameters to functions/codeunits.</p>
|
||
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;">
|
||
<iframe src="https://www.youtube.com/embed/SxywT2XSpcI" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" allowfullscreen title="YouTube Video"></iframe>
|
||
</div></description></item><item><title>Docs: Product Name</title><link>https://alguidelines.dev/docs/navpatterns/patterns/product-name/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/product-name/</guid><description>
|
||
<h4 id="abstract"><strong>Abstract</strong></h4>
|
||
<p>On many occasions, it&rsquo;s needed to refer to the product name in messages or errors. It&rsquo;s not a good practice to hardcode the brand name like Dynamics NAV 2017, and change this value with each rebranding. You can use client <strong>ProductName</strong> System Object instead to refer to the product name.</p>
|
||
<p><a href="ProductName-Logo.png"><img src="ProductName-Logo.png" alt=" "></a></p>
|
||
<h4 id="problem"><strong>Problem</strong></h4>
|
||
<p>When you want to refer to product name in informational messages or errors, it&rsquo;s not a good practice to hardcode the brand name, as this requires changing this text when a rebranding happens.</p>
|
||
<h4 id="solution"><strong>Solution</strong></h4>
|
||
<p>Instead of hardcoding the product name like &ldquo;Dynamics NAV 2017&rdquo;, it&rsquo;s recommended to use <strong>ProductName</strong> System Object that platform provides.</p>
|
||
<p>You can use <strong>ProductName</strong> to refer to the product name, this you can use in text messages. <strong>ProductName</strong> has 3 values <strong>ProductName.Short</strong>, <strong>ProductName.Full</strong>, and <strong>ProductName.Marketing</strong>, each one should be used according to the context of your message.</p>
|
||
<p>It&rsquo;s recommended to use <strong>ProductName.Short</strong> for most in-product texts , <strong>ProductName.Full</strong> when other dynamics apps are present in the message context (like CRM), and <strong>ProductName.Marketing</strong> only when absolutely necessary.</p>
|
||
<p><strong>Usage</strong>: You should make a placeholder in your text constant and substitute this placeholder with <strong>ProductName</strong> as shown below.</p>
|
||
<p><a href="ProductName-Sample.PNG"><img src="ProductName-Sample.PNG" alt=" "></a></p>
|
||
<p><strong>Output</strong></p>
|
||
<p><a href="ProductName-output.png"><img src="ProductName-output.png" alt=" "></a></p>
|
||
<h4 id="benefits"><strong>Benefits</strong></h4>
|
||
<ul>
|
||
<li>This decouples your messages from the application name</li>
|
||
<li>This removes the effort of maintaining these messages and keeping them up to date with the brand name.</li>
|
||
</ul>
|
||
<h4 id="limitations"><strong>Limitations</strong></h4>
|
||
<ul>
|
||
<li><strong>ProductName</strong> can&rsquo;t be used for tooltips and captions, it can only be used for text constants (Labels).</li>
|
||
<li><strong>ProductName</strong> System object doesn&rsquo;t exist in NAV 2016 and earlier version.</li>
|
||
</ul></description></item><item><title>Docs: Queries</title><link>https://alguidelines.dev/docs/navpatterns/patterns/queries/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/queries/</guid><description>
|
||
<p>Expand to see NAV design patterns which use queries.</p></description></item><item><title>Docs: Read-once Initialization and Validation</title><link>https://alguidelines.dev/docs/navpatterns/patterns/read-once-initialization-and-validation/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/read-once-initialization-and-validation/</guid><description>
|
||
<p><em>By Tim Grant</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>One time query and validation of a setup table.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>Firstly identifies if a setup table record is in memory, removing the need to execute and validate the re-query again within a code unit. (From NAV 2013+ service tier database caching exists).</p>
|
||
<p>If you need to query a setup table, but not sure if the table is yet in memory from earlier code, this helps to determine this call (see Singleton Table pattern).</p>
|
||
<p>Allows a central function to validate critical fields before processing automated code. <strong>TESTFIELD</strong> calls are added to the function and not the INIT call in order to ensure that critical functions do not run without this human check in place as these may rely on key configuration. If you have a design where specific field values are critical (custom or standard) for integrity, then INIT INSERT is a dangerous default which could result in the corruption of processes. This is separate automated INIT INSERT from a setup page.</p>
|
||
<h2 id="nav-specific-example">NAV Specific Example</h2>
|
||
<p>A global variable record and a global status indicator, but within the context of a local function.</p>
|
||
<p><a href="6332.1.png"><img src="6332.1.png" alt=" "></a></p>
|
||
<p><a href="5025.2.png"><img src="5025.2.png" alt=" "></a></p>
|
||
<p><img src="5672.8.png" alt=" "></p>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>A similar example of this is in Codeunit 80, but without any validation.</p>
|
||
<p><a href="4.png"><img src="4.png" alt=" "></a></p>
|
||
<p>E.g. If there is a bespoke change, then this existing <strong>GetGLSetup</strong> can be called earlier to accommodate for an earlier bespoke change:</p>
|
||
<p><a href="5.png"></a><a href="2465.5.png"><img src="2465.5.png" alt=" "></a></p>
|
||
<p>This means that by the time the code reaches the original <strong>GetGLSetup</strong> code requirement, this record is already in memory as the status flag is set to True, eliminating another check. For such Patterns the setup record should never be cleared, it should be called once globally, initiated and left in memory for future checks. It should <strong>not</strong> be declared locally at the same time, review your code for matching local variable usage before implementing this.</p>
|
||
<h2 id="ideas-for-improvement">Ideas for improvement</h2>
|
||
<p>Merge <strong>Singleton Table</strong> with dynamic validation field meta configuration. This removes the coding of <strong>TESTFIELD</strong> to a central setup check.</p>
|
||
<p>Example with the <strong>Sales &amp; Receivables Setup</strong></p>
|
||
<p><a href="5857.1.png"><img src="5857.1.png" alt=" "></a></p>
|
||
<p><a href="4477.2.png"><img src="4477.2.png" alt=" "></a></p>
|
||
<p><a href="4314.3.png"><img src="4314.3.png" alt=" "></a></p>
|
||
<h2 id="consequences">Consequences</h2>
|
||
<p>If in the circumstance that a field value in the setup table is expected to change within the life of the code component instance. e.g. If a CHANGECOMPANY is required to cross reference another Setup table, use a separate variable.</p>
|
||
<h2 id="related-topics">Related Topics</h2>
|
||
<p>This is related to the <strong>Singleton Table</strong> pattern.</p></description></item><item><title>Docs: Released Entity</title><link>https://alguidelines.dev/docs/navpatterns/patterns/released-entity/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/released-entity/</guid><description>
|
||
<p><em>Authors: Henrik Langbak and Kim Ginnerup, Bording Data</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>This pattern prevent data from being used elsewhere before it is in a system consistent state.<br>
|
||
NAV inserts a record as soon as the primary key has been set. But the record may not be in a valid state at this point in time. How do you know if a newly inserted record is ready for use?</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>Whenever you need to stall the release of data, you can use this pattern.</p>
|
||
<p>Because NAV decides when a record is written to the database, it may not be in a system consistent state. Nobody should use the record before everything is in place and the record is valid. An inserted record may even have data in other tables that needs to be inserted and in a valid state before other parts of the system can use the data without running into a problem.</p>
|
||
<p>Data entered into the system may have to be approved by a second person before it can be used.</p>
|
||
<p>Data requires different parties (e.g. Departments) to add information before data is valid.</p>
|
||
<p>The solution is an Option Field with two or three values:<br>
|
||
(Open, Released) or (Open, Pending, Released)</p>
|
||
<p>The states should be interpreted as:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>State</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Open</td>
|
||
<td>Not all data is in place. The record is system inconsistent. The record or record hierarchy is invisible for all other parts of the system.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Pending</td>
|
||
<td>The record is system consistent. But is awaiting someone to manually raise the state to Released. The record is still invisible.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Released</td>
|
||
<td>All data is in place and the record is system consistent, and ready for use. It is now visible for the rest of the system. The state can never be reversed.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>The option field name: Release State.</p>
|
||
<p>This pattern is very similar to the Blocked Entity pattern, but it has one significant difference.<br>
|
||
The record is not visible to any part of the system, before it is in the Released state.<br>
|
||
There is no going back. When the Released state is reached, it will stay that way for the life of the record. In case of a tri-state, it is ok to bypass Pending seen from a system state perspective.</p>
|
||
<p>If there is a hierarchy, e.g. Header and Lines, then the Release State field resides on the Header. As long as the Header remains unreleased, the lines are considered inconsistent and must not be used.</p>
|
||
<p>The important and critical part of this pattern is that the whole application needs to obey the &ldquo;Release State&rdquo;-contract or the system will fail.</p>
|
||
<h2 id="usage"><strong>Usage</strong></h2>
|
||
<p>To use this pattern you need to create an Option Field named: &ldquo;Release State&rdquo; with at least the two states: Open, Released.</p>
|
||
<h3 id="automatic-pending-or-release">Automatic pending or release</h3>
|
||
<p>If it is feasible to set the Release State automatically, create a local function named: &ldquo;CheckAndSetReleaseState&rdquo; that validates the record and sets Release State to Pending or Released, when all system requirements are met.</p>
|
||
<p>The function only works one way. It can only increase the state. If the function is called when release state is Pending or Release, the function will do nothing.</p>
|
||
<p>If the function is implemented, then the user should not be able to change the value from Open to Pending or Released, only the function can do that.</p>
|
||
<p>The function should be called on every change, this way it will be visible to the end user immediately when all requirements are met.<br>
|
||
If the Pattern is implemented without this function, then field is maintained by the end user.</p>
|
||
<h2 id="nav-specific-example"><strong>NAV Specific Example</strong></h2>
|
||
<p>NAV has Table 36 Sales Header, Field 120 Status.<br>
|
||
In this example, it is called: Status.<br>
|
||
Status has 4 values: Open, Released, Pending Approval, Pending Prepayment.</p>
|
||
<h2 id="nav-usages"><strong>NAV Usages</strong></h2>
|
||
<p>The example above, taken from NAV, shows similarity with this pattern, but in the Sales Header example it is possible to modify the Release state to an earlier state, through a function in NAV. This is not recommended in the pattern.</p>
|
||
<h2 id="ideas-for-improvement"><strong>Ideas for improvement</strong></h2>
|
||
<p>In case of a Pending State, you may need an Approved Date and Approved By. Depending on how formal it needs to be.</p>
|
||
<h2 id="consequences"><strong>Consequences</strong></h2>
|
||
<p>This pattern is only used on data creation.<br>
|
||
If there is a need for shuffling between states back and forth, then this is not the pattern to use.</p>
|
||
<h2 id="related-topics"><strong>Related Topics</strong></h2>
|
||
<p>Blocked Entity is a variant of this pattern but Blocked Entity is used later in the life-cycle.</p>
|
||
<p>An alternative to the pattern is temporary tables. But the temporary table is an all or nothing approach. If all data in the Record is valid, the temporary record can update the real data. If not, abandon the process. The Release State pattern is simpler and requires less code.</p>
|
||
<h2 id="references"><strong>References</strong></h2>
|
||
<p>There is a term called: Long Term Lock. This pattern has some resemblance.<br>
|
||
When talking about hierarchical data structures and the Release State is held on the root node, there is a pattern called Hierarchical Locking that has some resemblance.</p></description></item><item><title>Docs: Report Selection</title><link>https://alguidelines.dev/docs/navpatterns/patterns/report-selection/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/report-selection/</guid><description>
|
||
<p>From the PRS workshop at NAVTechDays 2013, this pattern was written by 2 work groups</p>
|
||
<p>Group 1: Dale Gauci &amp; Kimberly Congleton</p>
|
||
<p>Group 2: Jens Winberg, Tim Grant, Alen Tot</p>
|
||
<p>Thanks to Tim Grant who had merged the two patterns, corrected, sent for review and finalized them.</p>
|
||
<h2 id="meet-the-pattern">Meet the Pattern</h2>
|
||
<p>It should be possible to change which document report object should be used when printing. This configuration can be stored in one place (Report Selection) and available at configuration time. In this situation, the code for printing records can remain the same.</p>
|
||
<p>The purpose of this pattern is to describe the process to implement a reports selection by retrieving the specific <strong>Document Header</strong>, determining which type of document is related to it in the <strong>Report Selection Screen</strong>, and call the report which needs to be printed by passing the specific document header. This specifies the reports that you can print when you work with the various documents for sales and purchases, such as orders, quotes, invoices, and credit memos.</p>
|
||
<h2 id="know-the-pattern">Know the Pattern</h2>
|
||
<p>The program can preselect which report will be printed when you print from various types of purchase and sales headers. For example, on an order, the <strong>Order Confirmation</strong> report is automatically printed.</p>
|
||
<p>The <strong>Report Selection</strong> table contains the specification of which report will be printed in different situations. The <strong>Report Selection</strong> table also contains the report ID and report name for the report that will be printed when the user works with a given document type.</p>
|
||
<p>The user can, of course, choose to have the program print a different report than the preselected one. You can also add reports to the <strong>Report Selection</strong> table to have the program print more than one report per document type.</p>
|
||
<p>This pattern should be used when the user needs to print a new type of document which can have different report layouts, or when the user needs to print several different reports in sequence. This can also be used during a new post and print routine, a test report for journal posting or for re-printing a posted document. Using this pattern will minimize code by allowing a flexible means of specifying different reports to print, instead of hard-coding a report id when printing a document.</p>
|
||
<h2 id="use-the-pattern">Use the Pattern</h2>
|
||
<p>The Report Selection Pattern involves the <strong>Report Selection</strong> table as the central configuration element also with the <strong>Report Selection</strong> Page. The table is used in 4 generic functional workflows:</p>
|
||
<ol>
|
||
<li>Test Print un-posted</li>
|
||
</ol>
|
||
<p>If the Report Selection is related to a Test Report relating to a Document:</p>
|
||
<ul>
|
||
<li>The Document&rsquo;s Page including Printing Actions</li>
|
||
<li>Test Report-Print Codeunit 228</li>
|
||
</ul>
|
||
<ol start="2">
|
||
<li>Print un-posted. If the Report Selection is related to an existing Document (un-posted):</li>
|
||
</ol>
|
||
<ul>
|
||
<li>The Document&rsquo;s Page (Document / List) including the Printing Actions</li>
|
||
<li>The Document-Print Codeunit 229 is used atomically to use the document type in the generic Sales Header table before the report selection is found.</li>
|
||
</ul>
|
||
<ol start="3">
|
||
<li>Print while posting. If the Document is printed at the point of posting then:</li>
|
||
</ol>
|
||
<ul>
|
||
<li>The Document&rsquo;s Post + Print Codeunit (82 or 92), with the related <strong>GetReport</strong> and <strong>PrintReport</strong> functions.</li>
|
||
</ul>
|
||
<ol start="4">
|
||
<li>Print after posting. If the Report Selection is related to an existing Document (posted):</li>
|
||
</ol>
|
||
<ul>
|
||
<li>The specific document related posted header table is used along with a typical function: <strong>PrintRecords</strong> within the respective table.</li>
|
||
</ul>
|
||
<h2 id="example">Example</h2>
|
||
<p>Sales Document (Invoice)</p>
|
||
<p>Pre-conditions</p>
|
||
<ul>
|
||
<li>The document header/lines table is present and there is a report which has a parent DataItem linked to this document.</li>
|
||
<li>A document and list page is present and related to the document.</li>
|
||
<li>A post and print Codeunit exists for the document.</li>
|
||
</ul>
|
||
<p>Implementation:</p>
|
||
<ul>
|
||
<li>Add a new <strong>Option String</strong> to the <strong>Report Selection</strong> table, <strong>Usage</strong> field (including any ML Captions).</li>
|
||
<li>Calling of <strong>GetReport</strong> function, passing the document header.</li>
|
||
</ul>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">SalesSetup<span style="color:#ce5c00;font-weight:bold">.</span>GET<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesSetup<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Post &amp; Print with ob Queue&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesPostViaobQueue<span style="color:#ce5c00;font-weight:bold">.</span>EnqueueSalesDoc<span style="color:#ce5c00;font-weight:bold">(</span>SalesHeader<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span><span style="color:#204a87;font-weight:bold">ELSE</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">CODEUNIT</span><span style="color:#ce5c00;font-weight:bold">.</span>RUN<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">CODEUNIT</span><span style="color:#000;font-weight:bold">::</span>&#34;Sales-Post&#34;<span style="color:#000;font-weight:bold">,</span>SalesHeader<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>GetReport<span style="color:#ce5c00;font-weight:bold">(</span>SalesHeader<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>COMMIT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><ul>
|
||
<li>Implementing the new document type within the <strong>GetReport</strong> Function, and calling <strong>PrintReport</strong> with the New OptionString</li>
|
||
</ul>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>Invoice<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Last Posting No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesInvHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;No.&#34;<span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;No.&#34;<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ELSE</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesInvHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;No.&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&#34;Last Posting No.&#34;<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesInvHeader<span style="color:#ce5c00;font-weight:bold">.</span>SETRECFILTER<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>PrintReport<span style="color:#ce5c00;font-weight:bold">(</span>ReportSelection<span style="color:#ce5c00;font-weight:bold">.</span>Usage<span style="color:#000;font-weight:bold">::</span>&#34;S.Invoice&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><ul>
|
||
<li>Implement the new Document Type and calling the associated report ID, passing the document header</li>
|
||
</ul>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<ul>
|
||
<li>Codeunits 82, 92, for post and printing purchase and sales documents</li>
|
||
<li>Codeunit 229 for Document printing</li>
|
||
<li>Header Tables 110, 112, 114, 120, 122, 124, 295, 297, 302, 304. 5744, 5746, 6650, 6660</li>
|
||
</ul>
|
||
<p>This pattern is already used for printing documents like sales invoices, proforma, waybills, Finance Charge Memos, Receipt Documents.</p>
|
||
<h2 id="ideas-for-improvement">Ideas for improvement</h2>
|
||
<p>The &ldquo;Usage&rdquo; Field could be more dynamic through a setup field linked to a document type table mapped to the document header Table ID.</p>
|
||
<p>Report Selection table is currently based on the Usage of the report to be defined. A more generic way could be to only select what record id the printing selection is based on could also be implemented. (I think this means Recordref and Table Number could be used to identify the posted tables)</p>
|
||
<p>The Report Selection matrix could be evolved to accommodate the Journal post &amp; print configuration. This setup currently resides in the Gen. Journal Template table.</p>
|
||
<p>Merge the <strong>PrintReport</strong> functions in the purchase and sales post printing functions (82, 92) into a more atomic print selection component.</p>
|
||
<p>Merge the <strong>PrintRecords</strong> functions in the separate posted header tables into a more atomic print selection component.</p>
|
||
<h2 id="related-patterns">Related Patterns</h2>
|
||
<ul>
|
||
<li>Posting Routine Pattern (Journal/Document)</li>
|
||
<li>Post Batch Routine Pattern</li>
|
||
</ul></description></item><item><title>Docs: Security</title><link>https://alguidelines.dev/docs/navpatterns/patterns/security/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/security/</guid><description>
|
||
<p><em>By Bogdana Botez at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="security-patterns-for-nav"><strong>Security patterns for NAV</strong></h2>
|
||
<h3 id="problem-statement"><strong>Problem statement</strong></h3>
|
||
<p>When sensitive data is stored inside the Dynamics NAV database, if negligently handled, it can become vulnerable. Particularly, the location, access and the state of the data are critical.</p>
|
||
<p>Use the following patterns to enhance security on your NAV system.</p>
|
||
<ol>
|
||
<li><a href="https://alguidelines.dev/navpatterns/1-patterns/security/1-sensitive-data-encapsulation/">Sensitive Data Encapsulation</a></li>
|
||
<li><a href="https://alguidelines.dev/navpatterns/1-patterns/security/2-data-encryption/">Data Encryption</a></li>
|
||
<li><a href="https://alguidelines.dev/navpatterns/1-patterns/security/3-single-point-of-access/">Single Point of Access</a></li>
|
||
<li><a href="https://alguidelines.dev/navpatterns/1-patterns/security/4-masked-text/">Masked Text</a></li>
|
||
<li><a href="https://alguidelines.dev/navpatterns/1-patterns/security/5-ssl-in-nav/">SSL in NAV</a></li>
|
||
</ol></description></item><item><title>Docs: Setup Specificity Fallback</title><link>https://alguidelines.dev/docs/navpatterns/patterns/setup-specificity-fallback/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/setup-specificity-fallback/</guid><description>
|
||
<p><em>By Jan Hoek at IDYN</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>The Setup Specificity Fallback pattern allows users to efficiently define a potentially complex setup in terms of rules and exceptions to these rules, exceptions to the exceptions, etc.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>The pattern involves a setup table with a compound (i.e. consisting of more than one field) primary key, where each record in the table maps a combination of primary key values to a particular setup value. However, setting up and maintaining each and every combination could prove to be rather labour-intensive.</p>
|
||
<p>With the Setup Specificity Pattern in place, primary key fields in the setup table can have a special value (typically: zero or an empty string) that acts as a wildcard, meaning that the setup record in question applies to a combination of primary key fields with any value in the field containing that wildcard. According to the pattern, when querying the setup table, the application attempts to find the appropriate setup record by searching less and less specific, starting with only specified primary key values, and possibly ending with only wildcard values, replacing specific values with wildcards in a predefined order until a setup record is found, e.g.:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th></th>
|
||
<th></th>
|
||
<th></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Step 1.</td>
|
||
<td>Try to find record with: Field A = value &ldquo;a&rdquo; and Field B = value &ldquo;b&rdquo;</td>
|
||
<td>If found, return record; if not, go to step 2.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Step 2.</td>
|
||
<td>Try to find record with: Field A = value &ldquo;a&rdquo; and Field B = wildcard value</td>
|
||
<td>If found, return record; if not, go to step 3.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Step 3.</td>
|
||
<td>Try to find record with: Field A = wildcard value and Field B = value &ldquo;b&rdquo;</td>
|
||
<td>If found, return record; if not, go to step 4.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Step 4.</td>
|
||
<td>Try to find record with: Field A = wildcard value and Field B = wildcard value</td>
|
||
<td>If found, return record; if not, optionally return hard-coded value</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>The least specific record can be thought of as the general rule, and each of the subsequent records is an exception to that rule. By defining only exceptions to the rule, instead of each and every combination, the burden of setting up and maintaining the setup records is strongly reduced, and the overall setup is much easier to read and understand.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<ol>
|
||
<li>Create your setup table. Remember that this pattern applies only to setup tables with a compound primary key;</li>
|
||
<li>Create a function that will return the required value from the setup;</li>
|
||
<li>For each level of specificity, the function should test if the corresponding record exists. If it does, the setup value should be returned. If it doesn&rsquo;t, the logic should fall-back to a lower level of specificity.</li>
|
||
<li>(Optional) If even the least specific setup record can not be found, the function may return a blank value or hard-coded default value.</li>
|
||
</ol>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>The Printer Selection table in NAV is an example of the Setup Specificity Fallback pattern. Its primary key consists of two fields. A blank value in either field means that the record applies to any user or report respectively.</p>
|
||
<p><a href="0724.Printer-Selection.png"><img src="0724.Printer-Selection.png" alt=" "></a></p>
|
||
<p>The FindPrinter function in codeunit 1 searches for the printer to use, with a decreasing level of specificity.</p>
|
||
<p><a href="2335.FindPrinter.png"><img src="2335.FindPrinter.png" alt=" "></a></p></description></item><item><title>Docs: Silent File Upload and Download</title><link>https://alguidelines.dev/docs/navpatterns/patterns/silent-file-upload-and-download/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/silent-file-upload-and-download/</guid><description>
|
||
<p><em>By Bogdana Botez, at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>This pattern is about silently handing file transfers between NAV Service Tier and the NAV client. By &ldquo;silently&rdquo; we mean: without showing a dialog box at upload or download time.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>As a terminology clarification [1], note that both &ldquo;upload&rdquo; and &ldquo;download&rdquo; are named as seen from the client&rsquo;s point of view:</p>
|
||
<ul>
|
||
<li>Download&quot; defines transferring a file from the server to the client.</li>
|
||
<li>&ldquo;Upload&rdquo; transfers the file from the client to the server.</li>
|
||
</ul>
|
||
<p><a href="8688.Silent-file-upload-and-download-NAV-design-pattern.png"><img src="8688.Silent-file-upload-and-download-NAV-design-pattern.png" alt=" "></a></p>
|
||
<p>Sometimes, files must be transferred to or from known locations without triggering file-save or file-load dialogs.</p>
|
||
<p>In the following, both the historical and the recommended ways of silently transferring files are described. Since we keep both implementations possible for the sake of backward compatibility, we strongly recommend that you use the file-transfer API provided that is provided with the File Management codeunit (419).</p>
|
||
<p>The legacy API for file transfers [2]:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">[Ok<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span>]<span style="color:#f8f8f8;text-decoration:underline"> </span>UPLOAD<span style="color:#ce5c00;font-weight:bold">(</span>DialogTitle<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromFolder<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromFilter<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromFile<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ToFile<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span>[Ok<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span>]<span style="color:#f8f8f8;text-decoration:underline"> </span>DOWNLOAD<span style="color:#ce5c00;font-weight:bold">(</span>FromFile<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DialogTitle<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ToFolder<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ToFilter<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ToFile<span style="color:#ce5c00;font-weight:bold">)
|
||
</span></code></pre></div><p>As you can see, this historical API leaves no place for turning off the functionality for showing a dialog. Historically, NAV offered a remedy to this, namely by using the &ldquo;Magicpath&rdquo; string, which is the constant &lsquo;&lt;TEMP&gt;&rsquo;. Under this condition, the way to invoke silent file upload or download becomes:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">[Ok<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span>]<span style="color:#f8f8f8;text-decoration:underline"> </span>UPLOAD<span style="color:#ce5c00;font-weight:bold">(</span>DialogTitle<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Magicpath<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromFilter<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FromFile<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ToFile<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold">
|
||
</span><span style="color:#ce5c00;font-weight:bold"></span>[Ok<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span>]<span style="color:#f8f8f8;text-decoration:underline"> </span>DOWNLOAD<span style="color:#ce5c00;font-weight:bold">(</span>FromFile<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DialogTitle<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Magicpath<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ToFilter<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ToFile<span style="color:#ce5c00;font-weight:bold">)
|
||
</span></code></pre></div><p>This remedy introduced an issue: If we use &ldquo;Magicpath&rdquo; instead of <strong>FromFolder</strong> and <strong>ToFolder</strong> specifications, then where do we upload from and where do we download to? The answer is that they are uploaded to and downloaded from the NAV server&rsquo;s temporary folder. The path to the temporary file can be obtained when this file is created, by using the following function in <strong>File Management: &lt;tempFileName&gt; := ServerTempFileName(&lt;fileExtension&gt;)</strong>.</p>
|
||
<p>The new API for file transfers in the <strong>File Management</strong> codeunit:</p>
|
||
<p>[Text :=] UploadFileSilent(ClientFilePath)</p>
|
||
<p>[Text :=] DownloadTempFile(ServerFileName)</p>
|
||
<p>Using the API in the <strong>File Management</strong> codeunit instead of the historical API is recommended for all file transferring and file management in NAV implementations.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>The following describes a scenario for the silent file upload/download pattern, both from the user&rsquo;s point of view and from the NAV developer&rsquo;s point of view.</p>
|
||
<h3 id="the-nav-user">The NAV User</h3>
|
||
<p>The production manager at CRONUS needs an XML file in a specific format containing his latest product list with description, prices, and quantities. He wants to import the list into his web shop to keep product information updated with data in NAV.</p>
|
||
<p><a href="6428.Silent-File-download-design-pattern.png"><img src="6428.Silent-File-download-design-pattern.png" alt=" "></a></p>
|
||
<p>The production manager wants to have the file in a predefined location on his hard drive. The location has been defined in a NAV setup table.</p>
|
||
<h3 id="the-nav-developer">The NAV Developer</h3>
|
||
<p>The NAV developer has written a module to query the CRONUS database and to export the product list in the pre-described XML format required by the web shop. He saves the data in a temporary server file created with this code:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">ServerFileName<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>FileManagement<span style="color:#ce5c00;font-weight:bold">.</span>ServerTempFileName<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#39;xml&#39;</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>When the file has been populated with the latest product data, the NAV developer uses the following call to download the file from the temporary location on the server to the predefined location on the client:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">FileManagement<span style="color:#ce5c00;font-weight:bold">.</span>DownloadToFile<span style="color:#ce5c00;font-weight:bold">(</span>ServerFileName<span style="color:#000;font-weight:bold">,</span>ClientFileName<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>The call to <strong>DownloadToFile</strong> is part of the <strong>File Management</strong> codeunit, and it embeds the silent download offered by <strong>DownloadTempFile</strong>:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">PROCEDURE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DownloadToFile@<span style="color:#0000cf;font-weight:bold">13</span><span style="color:#ce5c00;font-weight:bold">(</span>ServerFileName@<span style="color:#0000cf;font-weight:bold">1002</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#000;font-weight:bold">;</span>ClientFileName@<span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">VAR</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempClientFileName@<span style="color:#0000cf;font-weight:bold">1001</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">Text</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ValidateFileNames<span style="color:#ce5c00;font-weight:bold">(</span>ServerFileName<span style="color:#000;font-weight:bold">,</span>ClientFileName<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span>TempClientFileName<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>DownloadTempFile<span style="color:#ce5c00;font-weight:bold">(</span>ServerFileName<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline"> </span>MoveFile<span style="color:#ce5c00;font-weight:bold">(</span>TempClientFileName<span style="color:#000;font-weight:bold">,</span>ClientFileName<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h2 id="consequences">Consequences</h2>
|
||
<ol>
|
||
<li>Even today, there is no fully silent up or download. The user will get a warning stating the system is trying to run a client side .NET component. However when dismissing this warning, the user can show to not see it again.</li>
|
||
<li>Due to client side .NET interop and of security concerns, silently downloading/uploading files on the web is disabled. Therefore, this pattern is recommended for implementation with Windows clients only.</li>
|
||
</ol></description></item><item><title>Docs: Singleton</title><link>https://alguidelines.dev/docs/navpatterns/patterns/singleton/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/singleton/</guid><description>
|
||
<p><em>By Bogdana Botez at Microsoft Development Center Copenhagen</em></p>
|
||
<p><a href="0535.Singleton.png"><img src="0535.Singleton.png" alt=" "></a></p>
|
||
<p><strong>Context:</strong> The pattern described in this article applies to Dynamics NAV only. For the general definition of the <strong>Singleton</strong> pattern, see for example <a href="https://en.wikipedia.org/wiki/Singleton_pattern">this link</a>.</p>
|
||
<p><strong>Problem</strong>: As a C/AL developer, you need to coordinate action (through a codeunit) or store information (in a table) that is unique across the system.</p>
|
||
<p><strong>Forces:</strong></p>
|
||
<ul>
|
||
<li><strong>Lost reference to centralizer:</strong> An instance of a relevant object could attempt to centralize control or data in the system. However, once this object is no longer in scope, the reference to it is lost and cannot be retrieved for later coordination</li>
|
||
<li><strong>Cannot rebuild the initial state:</strong> A new instance of the same object could be created, however the last known state of the lost instance cannot be known anymore.</li>
|
||
</ul>
|
||
<p><strong>Solution:</strong> create an object which resides in memory in a single copy (instance). Have a way to retrieve this unique object from code. This object can either be a <a href="https://alguidelines.dev/navpatterns/1-patterns/singleton/singleton-table/"><strong>Singleton Table</strong></a>, or a <a href="https://alguidelines.dev/navpatterns/1-patterns/singleton/singleton-codeunit/"><strong>Singleton Codeunit</strong></a>.</p>
|
||
<p>The implementation varies depending on the technology and language used. In object-oriented (OO) languages like C#, C++ or Java, the <strong>Singleton</strong> uses static classes and class members to instantiate. There is a mechanism to ensure only one instance of the object can exist. This mechanism is many times explicit (like in OO languages) and sometimes implicit as part of the compiler or platform (as it is in NAV).</p>
|
||
<p><strong>Benefits:</strong></p>
|
||
<ul>
|
||
<li><strong>Centralization</strong>: the setup information is stored in a single well-known place and easily retrievable from anywhere in the application code, by invoking a Record.GET. In case of a single-instance codeunit, any reference to it will retrieve the same instance, so the context will be preserved.</li>
|
||
<li><strong>Persistence</strong>: information remains even after the instance goes out of scope, because it continues to live in memory.</li>
|
||
</ul>
|
||
<p><strong>Limitation:</strong> The generic object-oriented <strong>Singleton</strong> pattern permits instantiation of a limited number n of objects (where usually n=1, but it can have other positive values too). However, in Dynamics NAV, the Singleton patterns are limited: n is always 1.</p></description></item><item><title>Docs: Standard Journal</title><link>https://alguidelines.dev/docs/navpatterns/patterns/standard-journal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/standard-journal/</guid><description>
|
||
<p><em>By Bogdana Botez, at Microsoft Development Center Copenhagen</em></p>
|
||
<p>Meet the <strong>Standard Journal</strong> pattern, which gives the NAV user the advantage of storing transaction details and reusing them multiple times at later dates. For example, this is how to pay a monthly bill.</p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>If the journal data can be reused later, the user has the possibility to save the current temporary transaction details. One example can be the case of monthly electricity payments. The user will manually enter the details for the first payment, of the current month. Next month, a part of the data will be the same, such as the vendor and transaction details. If the user has saved the initial monthly payment as a standard journal, then they can now reuse it to create the draft of the next monthly payment. Once the draft journal lines are created, they can be updated with the current month information.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>When a journal is created, the user can invoke the Save as Standard Journal action to save the current journal for later use. When saving the journal as a standard journal, the user is required to choose a code, which is later used to identify the saved journal. The journal lines are stored in a separate table. There can be one standard journal saved per journal type and code.</p>
|
||
<p>Later, the user can create new journal lines by using the Get Standard Journals action. This action restores the saved journal into the new journal lines.</p>
|
||
<h3 id="scenario">Scenario</h3>
|
||
<p><strong>Step 1</strong>: The data entered by the user through the Journal page is stored temporarily in the Journal Line table. The data is available for editing or deleting. The journal line data will be stored in this table until it is either deleted or posted.</p>
|
||
<p><strong>Step 2</strong>: The user decides to save the current journal line entries for later use. If this is the monthly rent, the user may want to use similar entries next month when a new payment is due. On the Journal page, the user invokes the Save as Standard Journal action. This triggers the Save as Standard Journal report, which copies the entries from the Journal Line table to the Standard Journal Line table. When saving, the user will be asked for an identifier, a code, which will be used to later uniquely identify the saved entries.</p>
|
||
<p><strong>Step 3</strong>: When the user invokes the Get Standard Journal action, a list of codes are presented to the user so that they can decide which standard journal to restore and copy in the Journal Line table.</p>
|
||
<p><a href="3201.NAVPatternStdJournal1.png"></a><a href="0820.Standard-Document-Pattern-1.png"><img src="0820.Standard-Document-Pattern-1.png" alt=" "></a></p>
|
||
<p><a href="0143.Standard-Document-Pattern-2.png"><img src="0143.Standard-Document-Pattern-2.png" alt=" "></a><a href="6521.NAVPatternStdJournal2.png"></a></p>
|
||
<p>The sequence flow of the three steps is described in the following diagram.</p>
|
||
<p><a href="5327.Standard-Document-Pattern-3.png"><img src="5327.Standard-Document-Pattern-3.png" alt=" "></a><a href="3618.Standard-Document-Pattern-3.png"></a><a href="1104.NAVPatternStdJournal3.png"></a></p>
|
||
<h2 id="nav-specific-example">NAV Specific Example</h2>
|
||
<p>In the standard version of NAV, the Standard Journal functionality is implemented in the following journals:</p>
|
||
<ul>
|
||
<li>Item Journal, which saves data to the Standard Item Journal</li>
|
||
<li>General Journal, which saves data to the Standard General Journal</li>
|
||
</ul>
|
||
<h3 id="general-journal">General Journal</h3>
|
||
<p>The user enters data in the General Journal page (39) and invokes the Save/Get actions as illustrated in the following screenshot:</p>
|
||
<p><a href="8585.NAVPatternStdJournal3.jpg"></a><a href="0456.Standard-Journal.png"><img src="0456.Standard-Journal.png" alt=" "></a></p>
|
||
<p>When saving the journal lines, the Save as Standard Gen. Journal report (750) is invoked. The report saves the entries in the Standard General Journal Line table (751).</p>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<ol>
|
||
<li>Standard General Journal</li>
|
||
<li>Standard Item Journal</li>
|
||
</ol>
|
||
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;">
|
||
<iframe src="https://www.youtube.com/embed/XeTKmO2Eqgw" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" allowfullscreen title="YouTube Video"></iframe>
|
||
</div></description></item><item><title>Docs: Temporary Dataset Report</title><link>https://alguidelines.dev/docs/navpatterns/patterns/temporary-dataset-report/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/temporary-dataset-report/</guid><description>
|
||
<p><em>Originally by Abhishek Ghosh, at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>This pattern generates the data to be displayed dynamically by combing/processing several data sources. It then displays the resulting dataset without writing to the database.</p>
|
||
<p><a href="0250.Temporary-Dataset-Report-1.png"><img src="0250.Temporary-Dataset-Report-1.png" alt=" "></a></p>
|
||
<h2 id="description">Description</h2>
|
||
<p>While writing reports in NAV, we have the luxury of using a built-in iterator. So, once we define the dataitem and the ordering, the runtime takes care of the iteration.</p>
|
||
<p>The iterator has one shortcoming: It can only run through records written into the database. There are situations, however, where we want to display temporary datasets created at runtime by processing data from different sources. That is where the Temporary Dataset Report pattern can be used.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>This pattern takes a two-step approach to displaying the data:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Parse the data sources to create a record buffer in a temporary record variable.</p>
|
||
</li>
|
||
<li>
|
||
<p>Iterate through a dataitem of the Integer table and display one record from the temporary recordset in each iteration.</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id="step-1-combining-data-sources-to-create-a-dataset">Step 1: Combining data sources to create a dataset</h4>
|
||
<p>In this step, we would process the existing data to create a temporary recordset. The three most common techniques to do this are discussed in the following paragraphs.</p>
|
||
<p>The first technique is mostly used when we want to build the report based on one or more source tables. A lot of processing is required, and we therefore want to store and display information from a temporary recordset. With this technique, we create a dataitem of the source record and then iterate through this dataitem to create the temporary recordset. An advantage of this technique is that it allows the user to perform additional filtering on the data source tables since they are added as additional dataitems and therefore will have their tabs on the request page by default.</p>
|
||
<p><a href="2376.Temporary-Dataset-Report-2.png"><img src="2376.Temporary-Dataset-Report-2.png" alt=" "></a></p>
|
||
<p>The second technique was made available with NAV 2013 when queries were introduced as a tool to help us combine data from different sources. Instead of writing data into a temporary record variable, we can create a query to combine the data from different sources. This offers better performance than the first technique in almost every situation. However, with a query, we sacrifice the luxury of getting a flexible filtering on the request page for the source dataitem.</p>
|
||
<p>The third technique is to write a function (or a codeunit, if the complexity demands so) that will crunch the data and create the temporary record variable. This function must be invoked from the OnPreReport trigger (or the OnPreDataItem trigger of the Integer dataitem).</p>
|
||
<p><a href="7607.Temporary-Dataset-Report-3.png"><img src="7607.Temporary-Dataset-Report-3.png" alt=" "></a></p>
|
||
<p>The following table summarizes when to use each of the three techniques:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Technique</th>
|
||
<th>When to Use</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Source Record DataItem</td>
|
||
<td>When it is important to offer flexible filtering possibilities on the source data.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Query</td>
|
||
<td>When performance is critical.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Populating temporary table in a function</td>
|
||
<td>Only when the source dataset is too complex to use either of the other techniques.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h4 id="step-2-iterating-through-the-integer-dataitem">Step 2: Iterating through the Integer dataitem</h4>
|
||
<p>When you have created the dataset as a temporary record variable or a query, the next step is to iterate through them to display the information. However, the report controller in NAV cannot iterate through temporary records or through the results of a query. This is where the Integer table comes into use.</p>
|
||
<p>The Integer table is a virtual table with only one field, Number, which is an integer field. For all practical purposes, we can assume that this table has pre-inserted records with value of Number, starting from 1 and ending with the highest integer value. So, if we keep iterating through this dataitem, the value of the Number field will be 1 for the first iteration and will keep increasing by 1 for every iteration.</p>
|
||
<p>There are two ways to use the Integer dataitem to iterate through the temporary recordset:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Loop for an indeterminate number of times until you reach the end of the recordset.</p>
|
||
</li>
|
||
<li>
|
||
<p>Calculate the number of records in the temporary recordset in advance and then iterate that many number of times.</p>
|
||
</li>
|
||
</ul>
|
||
<p>With the first approach, in the Integer-OnAfterGetRecord trigger, you must make the temporary record variable move to the next record, follow that up with a check if you have reached the end of the recordset, and then use CurrReport.BREAK if you have reached the end.</p>
|
||
<p>With the second approach, you must limit the number of times the report iterates through the Integer dataitem. The Number field in the Integer table will have a value of 1 in the first iteration and will increment automatically by 1 on every subsequent iteration. To ensure that the report iterates through the Integer dataitem &ldquo;n&rdquo; times, you must, therefore, filter the Integer dataitem on Number = 1..n. You must also move the temporary record variable to the next record in every iteration of the Integer-OnAfterGetRecord trigger. NOTE: This technique cannot be used if you use queries as the temporary data source, since queries do not (in NAV 2013) return the number of records.</p>
|
||
<h2 id="example">Example</h2>
|
||
<p><strong>Goal:</strong> To print a report that lists all contacts that have open documents (both sales and purchase) and displays those documents in chronological order</p>
|
||
<p>A contact can be connected to a vendor or a customer using the Create As Customer/Vendor function on the Contact Card. When a sales/purchase document is created for this customer/vendor, the Contact No. is stored in the Sell-to Contact No. or Buy-from Contact No. fields of the sales and purchase documents. The obvious choice would be to display the data directly from the Sales Header and Purchase Header records. However, the requirement is to display all of them together chronologically, which means they will need to be stored in, and be read from, one common dataset.</p>
|
||
<p><strong>Step 1: Design a new table that will hold the temporary dataset.</strong></p>
|
||
<p>The UI must display the Document Type, Document No., Document Date, Amount Incl. VAT and the name of the salesperson or purchaser. The table is designed as follows.</p>
|
||
<p><a href="6523.Temporary-Dataset-Report-4.jpg"><img src="6523.Temporary-Dataset-Report-4.jpg" alt=" "></a></p>
|
||
<p>Since this table is used to sort the data by Document Date, a &ldquo;Document Date&rdquo; key is added to the table.</p>
|
||
<p><a href="4118.Temporary-Dataset-Report-5.jpg"><img src="4118.Temporary-Dataset-Report-5.jpg" alt=" "></a></p>
|
||
<p>Some additional properties to note:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Sales Header dataitem should be linked to the Contact dataitem through the DataItemLink property &ndash; &ldquo;Sell-to Contact No.=FIELD(No.)&rdquo;</p>
|
||
</li>
|
||
<li>
|
||
<p>Purchase Header dataitem should be linked to the Contact dataitem through the DataItemLink property &ndash; &ldquo;Buy-from Contact No.=FIELD(No.)&rdquo;</p>
|
||
</li>
|
||
</ul>
|
||
<p><strong>Step 2: In the Sales Header</strong> &ndash; OnAfterGetRecord, write the following code to populate the data buffer:</p>
|
||
<p><a href="4010.Temporary-Dataset-Report-6.jpg"><img src="4010.Temporary-Dataset-Report-6.jpg" alt=" "></a></p>
|
||
<p><strong>Where:</strong></p>
|
||
<ul>
|
||
<li>
|
||
<p>ContactDocumentBuffer is a temporary global variable of the buffer table created.</p>
|
||
</li>
|
||
<li>
|
||
<p>SalesPerson is a local record variable for table 13.</p>
|
||
</li>
|
||
<li>
|
||
<p>SalesTxt is a text constant denoting &ldquo;Sales&rdquo; in ENU.</p>
|
||
</li>
|
||
</ul>
|
||
<p>Similar code must be written in Purchase Header &ndash; OnAfterGetRecord to store data from the purchase documents into the buffer.</p>
|
||
<p><strong>Step 3:</strong> Iterate through the temporary records in the Integer dataitem.</p>
|
||
<p>Since the requirement is to sort the data by Document Date, we must sort the ContactDocumentBuffer table by this key. Also, by the time the execution of Integer &ndash; OnPreDataItem begins, the number of records in the temporary buffer should be known already. Therefore, we can limit the number of times to repeat the Integer dataitem to the number of records in the buffer.</p>
|
||
<p>We meet both requirements with the following lines of code in Integer - OnPreDataItem:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">ContactDocumentBuffer<span style="color:#ce5c00;font-weight:bold">.</span>SETCURRENTKEY<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Document Date&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>Number<span style="color:#000;font-weight:bold">,</span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span>ContactDocumentBuffer<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">COUNT</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>Lastly, we must move the record pointer by 1 record every time we loop through the Integer dataitem. So, in Integer &ndash; OnAfterGetRecord, we add the following lines of code:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Number<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ContactDocumentBuffer<span style="color:#ce5c00;font-weight:bold">.</span>FINDFIRST<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">ELSE</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ContactDocumentBuffer<span style="color:#ce5c00;font-weight:bold">.</span>NEXT<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>Now, the only task that remains is to design the RDLC layout. (Not part of this application pattern description.)</p>
|
||
<p>NAV Usages</p>
|
||
<p>This is a commonly used pattern in several reports, such as:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Report 204 &ndash; Sales &ndash; Quote</p>
|
||
</li>
|
||
<li>
|
||
<p>Report 205 &ndash; Order Confirmation</p>
|
||
</li>
|
||
<li>
|
||
<p>Report 206 &ndash; Sales &ndash; Invoice</p>
|
||
</li>
|
||
</ul>
|
||
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;">
|
||
<iframe src="https://www.youtube.com/embed/QHn5oEOJv0Q" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" allowfullscreen title="YouTube Video"></iframe>
|
||
</div></description></item><item><title>Docs: Totals and Discounts on Subpages Sales and Purchases</title><link>https://alguidelines.dev/docs/navpatterns/patterns/totals-and-discounts-on-subpages-sales-and-purchases/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/totals-and-discounts-on-subpages-sales-and-purchases/</guid><description>
|
||
<p><em>By Nikola Kukrika at Microsoft Development Center Copenhagen</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>To increase discoverability and productivity, critical information, such as statistics, can be moved from separate pages onto the document where it is needed.</p>
|
||
<p>For example, documents should clearly display totals and discounts information to provide quick overview, make it easy to relate the amounts to the document currency, and to allow the user to see and apply discounts directly on the document.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>Before Microsoft Dynamics NAV 2015, totals and discount information was scattered between the document and the Statistics page, which made it less discover-able and less usable for new users. It was difficult to see the discount amounts, relate the amounts to the currency of the invoice, and it was not-intuitive that you had to update the Statistics page to see updates on the document. In addition, the result of the update was not visible on the main document, which added to the confusion.</p>
|
||
<p>Totals and discount information logically belongs on the document, as is the case on many competitor products.</p>
|
||
<p>The Statistics page contains too much information for most common scenarios, and only a part of the information is visible on the related document. See the following example for sales order statistics.</p>
|
||
<p><a href="4300.Fig-1.jpg"><img src="4300.Fig-1.jpg" alt=" "></a></p>
|
||
<p>With the pattern implemented, selected statistics fields are placed on the sales order, as in the following example.</p>
|
||
<p><a href="Fig-2.jpg"><img src="Fig-2.jpg" alt=" "></a></p>
|
||
<p>This new layout gives precise and complete information about totals and discounts, with discounts on the left side and totals on the right side. The currency is clearly shown, and the layout resembles a printed document. The values are always updated (with some exceptions that are explained in the next following sections), and the user can apply a discount directly on the document.</p>
|
||
<p>Options considered when deciding on the layout:</p>
|
||
<ul>
|
||
<li>A new FactBox</li>
|
||
<li>A new FastTab</li>
|
||
<li>On the Lines subpage</li>
|
||
</ul>
|
||
<p>The Lines subpage option was chosen because:</p>
|
||
<ul>
|
||
<li>Can be made with cleaner code</li>
|
||
<li>Is always visible, not collapsible, as opposed to FactBox and FastTab options</li>
|
||
<li>Less chrome in the UI</li>
|
||
</ul>
|
||
<h2 id="usages">Usages</h2>
|
||
<p>Concerning update of totals and discounts, the following were considered:</p>
|
||
<ul>
|
||
<li>All code should be in one place</li>
|
||
<li>Existing VAT, invoice discount calculation, etc. should be reused and not re-implemented.</li>
|
||
<li>The presentation layer should be separated from the logic.</li>
|
||
<li>Presentation layer should have simple (one liner) calls to the logic</li>
|
||
<li>System responsiveness should not be significantly affected</li>
|
||
<li>Totals and discounts should be updated &ldquo;on-the-fly&rdquo; on any change that affects amounts</li>
|
||
</ul>
|
||
<p>The following artifacts were implemented to achieve the desired functionality.</p>
|
||
<h3 id="flags-that-totals-are-not-updated">Flags That Totals Are Not Updated</h3>
|
||
<p>In order to always update the totals, the system must have a way to mark that a specific change should trigger a recalculation of the totals. To achieve this, the following was implemented.</p>
|
||
<ul>
|
||
<li>On the lines:
|
||
<ul>
|
||
<li>A new field, Recalculate Invoice Discount, was added and set to FALSE by default.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p>The <em>UpdateAmounts</em> function sets the new field to TRUE for any execution. This function was chosen as it is a central entry point for any amount-related change.</p>
|
||
<p><a href="Fig-3.jpg"><img src="Fig-3.jpg" alt=" "></a></p>
|
||
<ul>
|
||
<li>On the header:
|
||
<ul>
|
||
<li>A new FlowField, Recalculate Invoice Discount was added. This field is TRUE if at least one line (that relates to the header) has been marked as &ldquo;dirty&rdquo;, meaning that totals must be recalculated.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p><a href="6305.Fig-4.jpg"><img src="6305.Fig-4.jpg" alt=" "></a></p>
|
||
<p>Update diagram</p>
|
||
<p><a href="Fig-5.jpg"><img src="Fig-5.jpg" alt=" "></a></p>
|
||
<h3 id="total-calculation-and-update-logic">Total Calculation and Update Logic</h3>
|
||
<p>The following new codeunits were added:</p>
|
||
<ul>
|
||
<li>COD56 and COD66 (one for sales and one for purchase) are responsible for the &ldquo;heavy&rdquo; tasks of calculating/applying totals and discounts by calling into existing code, similarly to how the Statistics page works.</li>
|
||
<li>After recalculation, the flag field is reset on all the lines related to a specific header.</li>
|
||
<li>These calculations, in the existing implementation, are triggered ONLY in case of UI scenarios. Non-UI scenarios are not affected.</li>
|
||
</ul>
|
||
<p><strong>Note:</strong> In case of web-service implementations that do not use the existing pages, the total calculation and the invoice discount logic should be called specifically to display similar functionality.</p>
|
||
<h3 id="ui-related-updates">UI-Related Updates</h3>
|
||
<p>A new CU, COD57 has been added and it contains the logic used to update the fields that will, in the end, be displayed in the UI. Decision was to merge both the sales and purchase functionality into one place.</p>
|
||
<h3 id="update-controls">Update Controls</h3>
|
||
<p>The pattern is applied to both non-posted documents (orders, invoices, etc.) and posted documents (posted Invoice, etc.). Because the posted document is a document that does not change, the implementation is simplified as follows.</p>
|
||
<h4 id="subpage---non-posted-documents">Subpage - Non-posted documents</h4>
|
||
<p>The <em>OnAfterGetCurrRecord</em> function call is responsible for updating the totals- and discount-related controls.</p>
|
||
<p>To avoid duplicating lots of code in many places, a single function with more parameters &ldquo;pattern&rdquo; was chosen. The function returns all the controls updated in a single call, as follows.</p>
|
||
<p><a href="Fig-6.jpg"><img src="Fig-6.jpg" alt=" "></a></p>
|
||
<p>Manual invoice discount. One function call when applying a manual invoice discount, as follows.</p>
|
||
<p><a href="Fig-7.jpg"><img src="Fig-7.jpg" alt=" "></a></p>
|
||
<p><strong>Note:</strong> After applying the manual discount, the lines should be refreshed as they will be changed in batch mode.</p>
|
||
<p>The following &ldquo;decorators&rdquo; were added to recalculate amounts on the fly:</p>
|
||
<ul>
|
||
<li>Totals should always be updated as soon as the user leaves the field.</li>
|
||
</ul>
|
||
<p>Code should be added to the validate triggers of the controls that are changing the amounts in order to refresh the total controls.<a href="Fig-8.jpg"><img src="Fig-8.jpg" alt=" "></a></p>
|
||
<p><strong>Note:</strong> Amounts will not always be up to date because of the following:</p>
|
||
<ul>
|
||
<li>Performance. The update must be triggered manually if the number of lines is above 100. (100 was chosen because performance measurements have demonstrated that with more than 100 lines, the performance was worse than 0.5-1s in update time.)</li>
|
||
<li>Missed/customized triggers or header changes - cannot trigger lines update from header. Likewise, lines cannot trigger the header to update.</li>
|
||
<li>In the above cases, a link next to the totals will be displayed informing user that totals/discounts might not be updated and they can be updated by selecting the link</li>
|
||
</ul>
|
||
<h4 id="subpage----posted-documents">Subpage &ndash; Posted Documents</h4>
|
||
<p>Only the _OnAfterGetCurrRecord _function will have code because posted documents cannot be changed. Therefore, totals do not need to be updated.</p>
|
||
<p><a href="Fig-9.jpg"><img src="Fig-9.jpg" alt=" "></a></p>
|
||
<h3 id="ui----presentation-layer">UI &ndash; Presentation Layer:</h3>
|
||
<p>After Platform added support for this specific case, the layout is very simple, as follows.</p>
|
||
<p><a href="Fig-10.jpg"><img src="Fig-10.jpg" alt=" "></a></p>
|
||
<p>This will produce the layout we wanted:</p>
|
||
<p><a href="Fig-11.jpg"><img src="Fig-11.jpg" alt=" "></a></p>
|
||
<h3 id="ui----manual-totals-update">UI &ndash; Manual Totals Update</h3>
|
||
<p>As mentioned before, there are cases when the user is informed that totals/discounts might not be up to date and that it should select a link in order to get the updated values.</p>
|
||
<p>The link is part of the sub-part where totals and discounts are added. The visibility is controlled by actually controlling the text (message, or empty), because Platform does not support making only one visible/invisible (it must be a group). When the link is displayed, the styling is also changed for the total/discount controls, and the values are set to 0.</p>
|
||
<p><a href="Fig-12.jpg"><img src="Fig-12.jpg" alt=" "></a></p>
|
||
<h2 id="nav-usages">NAV Usages</h2>
|
||
<p>We have implemented these scenarios for sales and purchase documents (order, invoice, quote, credit memos, return orders, including posted documents). Note that the implementation in NAV 2015 is a bit different than the one in NAV 2014 C5 objects (1300 range). It was decided not to merge the two implementations, among other reasons because the NAV 2014 C5 implementation does not fit the full application.</p>
|
||
<p>The pattern can easily be extended to new sales and purchase documents. If the pattern is followed, it can also be extended to other types of documents, such as in services, jobs, etc.</p>
|
||
<p><strong>Note:</strong> This new pattern is not implemented in the North America and India versions. This is due to special local features in the two versions regions and the multitude of sales tax/vat options that would make the solution non-user friendly and not optimized for performance.</p>
|
||
<h2 id="ideas-for-improvement">Ideas for Improvement</h2>
|
||
<p>Platform support to be able to trigger full-page update from the lines. Support does exist today, but it is not programmatically controlled at design time. This means that it cannot be used in all cases.</p>
|
||
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;">
|
||
<iframe src="https://www.youtube.com/embed/U3noU-WT8Xk" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" allowfullscreen title="YouTube Video"></iframe>
|
||
</div></description></item><item><title>Docs: Transfer Custom Fields</title><link>https://alguidelines.dev/docs/navpatterns/patterns/transfer-custom-fields/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/transfer-custom-fields/</guid><description>
|
||
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;">
|
||
<iframe src="https://www.youtube.com/embed/cGaBqwfGCws" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border:0;" allowfullscreen title="YouTube Video"></iframe>
|
||
</div></description></item><item><title>Docs: Variant Facade</title><link>https://alguidelines.dev/docs/navpatterns/patterns/variant-facade/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/variant-facade/</guid><description>
|
||
<p><em>By Nikola Kukrika, waldo and Gary Winter</em></p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>The Variant façade provides a single interface that can take any Record, RecordRef or RecordID as an argument. With this pattern the code is encapsulated within the single object, with clear separation between common and table specific code.</p>
|
||
<p><a href="picture1.png"><img src="picture1.png" alt=" "></a></p>
|
||
<h2 id="problem">Problem</h2>
|
||
<p>Since NAV is strongly typed, developers often need to duplicate functionality in order to add support for a new table. The developer would typically start by duplicating the function, changing the record type and implement slight modifications to the code if needed.</p>
|
||
<p>The problem with this approach is that code duplication is one of the worst things in software development &ndash; it makes code harder to understand, maintain, extend and test.</p>
|
||
<p>One of the good examples of this approach and the resulting duplication is codeunit 229, Document-Print:</p>
|
||
<p><a href="Picture2.png"><img src="Picture2.png" alt=" "></a></p>
|
||
<p><a href="Picture3.png"><img src="Picture3.png" alt=" "></a></p>
|
||
<p>After reading the code from the two code snippets above, it is very hard to see the differences. The most of the code is duplicated (more than 95%). To make the matters worse the codeunit itself has 10 additional methods that are used to print different records, some are similar to the ones above while others are completely different.</p>
|
||
<p><a href="Picture4.png"><img src="Picture4.png" alt=" "></a></p>
|
||
<p><a href="Picture5.png"><img src="Picture5.png" alt=" "></a></p>
|
||
<p>Figure: the entire code of the codeunit 229, Document Print, 12 methods</p>
|
||
<p><a href="Picture6.png"><img src="Picture6.png" alt=" "></a></p>
|
||
<p>Figure: Visualization how it would look like with 20 methods</p>
|
||
<p>Problems arising from this way of implementing code are:</p>
|
||
<p><strong>Understanding of the code</strong> is very hard, since the developer needs to read blocks of code that look similar and try to understand what exactly the differences are.</p>
|
||
<p><strong>Maintaining and Extending</strong> the code is hard, since every fix or a new behavior that needs to be implemented multiple times (in this case probably 12 times).</p>
|
||
<p><strong>Upgradability is low</strong> &ndash; each conflict needs to be resolved many times. The hook pattern is hard to implement since it needs to be implemented for every function. Evening suffers the same problem - cannot use the evening easily since it needs to be raised from multiple places in the code.</p>
|
||
<p><strong>Testing the code</strong> is hard since the tests need to be replicated.</p>
|
||
<p><strong>Constant cost of adding support for new tables</strong> &ndash; when the new record type needs to be supported, it has a constant cost. Adding a support for a new record will increase the Maintenance tax and it will make the code harder to understand and extend.</p>
|
||
<p><strong>Conclusion</strong> - <strong>If the functionality needs to be used for many records the approach of duplicating the functions should be avoided.</strong></p>
|
||
<h2 id="solution">Solution</h2>
|
||
<p>The Variant façade pattern provides a single interface that would not need to be changed in the future. It will be able to take any record as a parameter. Common code should be kept separately from record specific code and both must be very visible so the developers can easily see what the differences are.</p>
|
||
<p>The Key components of the pattern are:</p>
|
||
<h3 id="signature">Signature</h3>
|
||
<p>Instead of hardcoding a record type a variant is used as an argument. A Variant Façade function can receive three types of data: Record, RecordID, or RecordRef. This way, it can be reused anywhere in the product and the code will still work.</p>
|
||
<p>A good practice is to combine this pattern with the Argument Table pattern to make sure that the signature does not change (Additional parameters can be added to the argument table without impacting existing code.). If the Argument Table is not needed, it should not be placed in the signature - it is always possible to add it at a latter point and have two public functions (one with and one without arguments).</p>
|
||
<p>Example - For codeunit 229, Document-Print all of the public methods can be simply replaced with a single public method like this:</p>
|
||
<p>With this approach the façade function can serve all of the record types and will not need to change in the future.</p>
|
||
<h3 id="casting-to-a-record-ref">Casting to a record ref</h3>
|
||
<p>After the signature it is necessary to decide if the function will support passing of the Record ID and the RecordRef. Code tends to be easier to understand and maintain if only the records are passed as the arguments, however in some cases it is needed to support the other two types.</p>
|
||
<ul>
|
||
<li><strong>Support for Record, Record ID and RecordRef:</strong></li>
|
||
</ul>
|
||
<p>After the signature if the function supports passing of the RecordID or RecordRef as a parameter it is a good practice to cast them to a RecordRef. Codeunit Data Type Management is used to do this:</p>
|
||
<p>DataTypeManagement.GetRecordRef(RecRelatedVariant,RecordRef)</p>
|
||
<ul>
|
||
<li><strong>Support Records only</strong> - If the function supports only passing in the record, it is a good practice to check if the variant is a record:</li>
|
||
</ul>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">IF</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">NOT</span><span style="color:#f8f8f8;text-decoration:underline"> </span>RecordVariant<span style="color:#ce5c00;font-weight:bold">.</span>ISRECORD<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">THEN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ERROR<span style="color:#ce5c00;font-weight:bold">(</span>NotARecordErr<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h3 id="using-the-variant">Using the variant</h3>
|
||
<p>The variant can be passed instead of record when calling the Page.RUN, Codeunit.RUN or Report.RUN statically:</p>
|
||
<p>For example:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">Page</span><span style="color:#ce5c00;font-weight:bold">.</span>RUN<span style="color:#ce5c00;font-weight:bold">(</span>PageID<span style="color:#000;font-weight:bold">,</span><span style="color:#204a87;font-weight:bold">Variant</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">Codeunit</span><span style="color:#ce5c00;font-weight:bold">.</span>RUN<span style="color:#ce5c00;font-weight:bold">(</span>CodeunitID<span style="color:#000;font-weight:bold">,</span><span style="color:#204a87;font-weight:bold">Variant</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">Report</span><span style="color:#ce5c00;font-weight:bold">.</span>RUN<span style="color:#ce5c00;font-weight:bold">(</span>ReportID<span style="color:#000;font-weight:bold">,</span><span style="color:#204a87;font-weight:bold">Variant</span><span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>These calls are identical to using an actual instance of the record, since the variant will be casted to the record automatically, with all filters, markings and values preserved.</p>
|
||
<p>In case the variant was casted to the RecordRef (by using DataTypeManagement.GetRecordRef(RecRelatedVariant,RecordRef)), it is still possible to invoke the functions statically.</p>
|
||
<p>The RecordRef simply needs to be casted into a variant and passed as a parameter, for example:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">VariantArgument<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">RecordRef</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">Page</span><span style="color:#ce5c00;font-weight:bold">.</span>RUN<span style="color:#ce5c00;font-weight:bold">(</span>PageID<span style="color:#000;font-weight:bold">,</span>VariantArgument<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>Variant can always casted back to the original record in the table specific code, exact process is described below.</p>
|
||
<h3 id="table-specific-code">Table specific code</h3>
|
||
<p>To do table-specific processing, it is necessary to get the RecordRef first, since NUMBER parameter will tell us which table it is. In the table-specific code, it is possible to cast the variant back to the original record type, so data is accessible and it is possible to invoke functions.</p>
|
||
<p>To do this, the best practice is to use the COPY function to preserve filters:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>COPY<span style="color:#ce5c00;font-weight:bold">(</span>RecordVariant<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>Assigning directly such as SalesHeader := RecordVariant, is possible, however all filters will be lost.</p>
|
||
<p>Example of table specific code:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">CASE</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">RecordRef</span><span style="color:#ce5c00;font-weight:bold">.</span>NUMBER<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">OF</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DATABASE</span><span style="color:#000;font-weight:bold">::</span>&#34;Sales Header&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>COPY<span style="color:#ce5c00;font-weight:bold">(</span>RecordVariant<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>PrintDocument<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DATABASE</span><span style="color:#000;font-weight:bold">::</span>&#34;Purchase Header&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>PurchaseHeader<span style="color:#ce5c00;font-weight:bold">.</span>COPY<span style="color:#ce5c00;font-weight:bold">(</span>RecordVariant<span style="color:#ce5c00;font-weight:bold">)
|
||
</span><span style="color:#ce5c00;font-weight:bold"> ...
|
||
</span><span style="color:#ce5c00;font-weight:bold"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">....
|
||
</span></code></pre></div><p>It is a good practice to try to avoid the table specific code if possible.</p>
|
||
<p>One of the issues with table specific code is that the CASE statement can easily explode when large number of records are supported.</p>
|
||
<p>There are two possible solutions:</p>
|
||
<ol>
|
||
<li>Move the calculations outside of the façade code unit and pass it in as part of the argument table.</li>
|
||
</ol>
|
||
<p>For example, instead of having a case like this within DocumentPrint codeunit:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">CASE</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">RecordRef</span><span style="color:#ce5c00;font-weight:bold">.</span>NUMBER<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">OF</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">DATABASE</span><span style="color:#000;font-weight:bold">::</span>&#34;Sales Header&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">BEGIN</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>COPY<span style="color:#ce5c00;font-weight:bold">(</span>RecordVariant<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">CASE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">OF</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>Quote<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>Usage<span style="color:#000;font-weight:bold">,</span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>Usage<span style="color:#000;font-weight:bold">::</span>&#34;S.Quote&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>&#34;Blanket Order&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>Usage<span style="color:#000;font-weight:bold">,</span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>Usage<span style="color:#000;font-weight:bold">::</span>&#34;S.Blanket&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span><span style="color:#204a87;font-weight:bold">Order</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>Usage<span style="color:#000;font-weight:bold">,</span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>Usage<span style="color:#000;font-weight:bold">::</span>&#34;S.Order&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>&#34;Return Order&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>Usage<span style="color:#000;font-weight:bold">,</span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>Usage<span style="color:#000;font-weight:bold">::</span>&#34;S.Return&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>Invoice<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>Usage<span style="color:#000;font-weight:bold">,</span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>Usage<span style="color:#000;font-weight:bold">::</span>&#34;S.Invoice&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>&#34;Credit Memo&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>Usage<span style="color:#000;font-weight:bold">,</span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>Usage<span style="color:#000;font-weight:bold">::</span>&#34;S.Cr.Memo&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">END</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>If the ReportSelections.Usage is simply passed into the function from outside, then the case statement is not needed at all. For example:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">PrintDocumentArguments<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Report Selection Usage&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>GetReportSelectionUsage<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>DocumentPrint<span style="color:#ce5c00;font-weight:bold">.</span>PrintDocument<span style="color:#ce5c00;font-weight:bold">(</span>SalesHeader<span style="color:#000;font-weight:bold">,</span>PrintDocumentArguments<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>Where GetReportSelection usage is coded like this:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al"><span style="color:#204a87;font-weight:bold">CASE</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">OF</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>Quote<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">(</span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>Usage<span style="color:#000;font-weight:bold">::</span>&#34;S.Quote&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>&#34;Blanket Order&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>Usage<span style="color:#000;font-weight:bold">::</span>&#34;S.Blanket&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span><span style="color:#204a87;font-weight:bold">Order</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>Usage<span style="color:#000;font-weight:bold">::</span>&#34;S.Order&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>&#34;Return Order&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>Usage<span style="color:#000;font-weight:bold">::</span>&#34;S.Return&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>Invoice<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>Usage<span style="color:#000;font-weight:bold">::</span>&#34;S.Invoice&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SalesHeader<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Document Type&#34;<span style="color:#000;font-weight:bold">::</span>&#34;Credit Memo&#34;<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">EXIT</span><span style="color:#ce5c00;font-weight:bold">(</span>ReportSelections<span style="color:#ce5c00;font-weight:bold">.</span>Usage<span style="color:#000;font-weight:bold">::</span>&#34;S.Cr.Memo&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>This way the code is much more reusable and simpler to read.</p>
|
||
<ol>
|
||
<li>Use Rules Table to replace the code with data-driven approach.</li>
|
||
</ol>
|
||
<p>Setup table would contain the list of the reports and their usages. Based on Table ID and usage it is possible to set filters on the setup table and run the object ID from the result.</p>
|
||
<p>For example:</p>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">ReportSelectionSetup<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Table ID&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">RecordRef</span><span style="color:#ce5c00;font-weight:bold">.</span>NUMBER<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>ReportSelectionSetup<span style="color:#ce5c00;font-weight:bold">.</span>SETRANGE<span style="color:#ce5c00;font-weight:bold">(</span>&#34;Usage Type&#34;<span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">RecordRef</span><span style="color:#ce5c00;font-weight:bold">.</span>FieldValue<span style="color:#ce5c00;font-weight:bold">(</span>ArgumentTable<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Usage Type&#34;<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>ReportSelectionSetup<span style="color:#ce5c00;font-weight:bold">.</span>FINDFIRST<span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">REPORT</span><span style="color:#ce5c00;font-weight:bold">.</span>RUN<span style="color:#ce5c00;font-weight:bold">(</span>ReportSelectionSetup<span style="color:#ce5c00;font-weight:bold">.</span>&#34;Report ID&#34;<span style="color:#000;font-weight:bold">,</span>VariantRecord<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h2 id="example">Example</h2>
|
||
<p>The following code illustrates how the Variant Façade pattern can be used to implement the Document-Print Codeunit.</p>
|
||
<p><a href="Picture7.png"><img src="Picture7.png" alt=" "></a></p>
|
||
<p><a href="Picture8.png"><img src="Picture8.png" alt=" "></a></p>
|
||
<p>From the PrintDocument signature it is clear that it will not need to be changed in the future.</p>
|
||
<p>Code duplication is avoided, specific code is isolated in the PrepareRecord function, there is clear extension point to add support for new records in the future. Since code is not duplicated and there is a single flow through the method, inserting hooks and events in the future will be straightforward.</p>
|
||
<p>When adding the support for new records in most cases it is not need to change any code within the method, thus the cost of extending the usage is minimal.</p>
|
||
<p>Note - PrepareRecord function is placed for the illustrational purposes. An improvement would be to move all of the code from the PrepareRecord function before calling the function. So for the SalesHeader and PurchaseHeaders discounts should be calculated before invoking the function. For passing of the argument it should be one of the fields in the Argument Table, thus the entire specific code would be eliminated.</p>
|
||
<h2 id="consequences">Consequences</h2>
|
||
<ul>
|
||
<li>Not needed if the functionality needs to support few tables. Don&rsquo;t use it as a hammer</li>
|
||
<li>Strongly typing the records has it benefits since it is easier to find usages, errors will be visible at the compilation time.</li>
|
||
<li>Code becomes harder to debug within the variant façade</li>
|
||
<li>Be careful with filters and marks, if the function needs to support multiple records. Test these cases thoughtfully because with bad placement of code the filters can easily be lost.</li>
|
||
<li>Case statements can explode if there are too many tables that require specific processing. Then it is a must to find a way to keep the number of options in the CASE statement low. The Rules Table pattern and adding specifics to the Argument Table before invoking the code could help with keep the list shorter.</li>
|
||
</ul>
|
||
<h2 id="nav-usages">NAV usages</h2>
|
||
<ul>
|
||
<li>Codeunit 452 - Report Distribution Management</li>
|
||
<li>Codeunit 700 - Page Management</li>
|
||
<li>Codeunit 701 - Data Type Management</li>
|
||
<li>Codeunit 1268 - Export Launcher</li>
|
||
<li>Codeunit 1410 - Doc. Exch. Service Mgt.</li>
|
||
<li>Codeunit 1501 - Workflow Management</li>
|
||
<li>Codeunit 1521 - Workflow Response Handling</li>
|
||
<li>Codeunit 1531 - Workflow Change Rec Mgt.</li>
|
||
<li>Codeunit 1535 - Approvals Mgmt.</li>
|
||
</ul>
|
||
<h2 id="related-topics">Related Topics</h2>
|
||
<p>OO Facade <a href="https://en.wikipedia.org/wiki/Facade_pattern">https://en.wikipedia.org/wiki/Facade_pattern</a></p>
|
||
<p>Argument Table pattern - <a href="https://alguidelines.dev/nav/w/designpatterns/245.argument-table-pattern">https://community.dynamics.com/nav/w/designpatterns/245.argument-table-pattern</a></p>
|
||
<p>Rules Table pattern</p></description></item></channel></rss> |