148 lines
No EOL
11 KiB
XML
148 lines
No EOL
11 KiB
XML
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>alguidelines.dev - Business Central Design Patterns – Singleton Table</title><link>https://alguidelines.dev/docs/navpatterns/patterns/singleton/singleton-table/</link><description>Recent content in Singleton Table on alguidelines.dev - Business Central Design Patterns</description><generator>Hugo -- gohugo.io</generator><language>en</language><atom:link href="https://alguidelines.dev/docs/navpatterns/patterns/singleton/singleton-table/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: Cue Table</title><link>https://alguidelines.dev/docs/navpatterns/patterns/singleton/singleton-table/cue-table/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/singleton/singleton-table/cue-table/</guid><description>
|
||
<p><em>By Bogdana Botez at Microsoft Development Center Copenhagen</em></p>
|
||
<p><a href="Cue-Table.png"><img src="Cue-Table.png" alt=" "></a></p>
|
||
<p>Cues are the second usual application of the <a href="https://alguidelines.dev/navpatterns/1-patterns/singleton/singleton-table/"><strong>Singleton Table</strong></a> pattern in Dynamics NAV, after <a href="https://alguidelines.dev/navpatterns/1-patterns/singleton/singleton-table/setup-table/"><strong>Setup Tables</strong></a>.</p>
|
||
<p><strong>Context</strong>: The user gets overview information about the business on the Dynamics NAV Role Center page.</p>
|
||
<p>Figure 1 - Cue information in Dynamics NAV shows cue information seen by the user on the <strong>Sales Order Processor</strong> role center.</p>
|
||
<p><a href="Cue-Table-Figure-1.JPG"><img src="Cue-Table-Figure-1.JPG" alt=" "></a></p>
|
||
<p>The overview information consists of summed-up numbers, calculated from business data, like for example how many sales orders are still open, how many shipments are ready to go, or partially shipped, how many documents are waiting for approval etc.</p>
|
||
<p><strong>Problem</strong>: NAV stores data in tables. By definition, a table is a repetitive structure containing multiple lines, each line having a different piece of the information. But sometimes this repetitive information needs to be summed-up or otherwise synthetized, and presented as an overview.</p>
|
||
<p><strong>Solution:</strong> Store overview information in a singleton table.</p>
|
||
<p>There are two ways of calculating overview information in NAV.</p>
|
||
<ol>
|
||
<li>
|
||
<p>By using a FlowField. This applies for simpler calculations, like filtered or unfiltered counts, sums etc.</p>
|
||
</li>
|
||
<li>
|
||
<p>By writing C/AL code to perform custom calculations. Use this when:</p>
|
||
<ul>
|
||
<li>The way to calculate the overview is too complex for flow fields, or</li>
|
||
<li>The data needs to be pulled from an external system (like Dynamics CRM, QuickBooks or any external integration).</li>
|
||
</ul>
|
||
</li>
|
||
</ol>
|
||
<p>The implementation of Cues is already described in detail on MSDN, in <a href="https://msdn.microsoft.com/en-us/library/dn789553(v=nav.90).aspx">Creating and Customizing Cues</a> and in <a href="https://msdn.microsoft.com/en-us/library/ff477101(v=nav.90).aspx">Walkthrough: Creating a Cue Based on a FlowField</a>.</p>
|
||
<p><strong>NAV Usages</strong></p>
|
||
<p><em>Table 1 - Cue tables in Dynamics NAV</em> shows some examples of singleton tables used for creating Cues.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Table ID</th>
|
||
<th>Table Name</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>1313</td>
|
||
<td>Activities Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>5370</td>
|
||
<td>CRM Synch. Job Status Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9042</td>
|
||
<td>Team Member Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9050</td>
|
||
<td>Warehouse Basic Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9051</td>
|
||
<td>Warehouse WMS Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9052</td>
|
||
<td>Service Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9053</td>
|
||
<td>Sales Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9054</td>
|
||
<td>Finance Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9055</td>
|
||
<td>Purchase Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9056</td>
|
||
<td>Manufacturing Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9057</td>
|
||
<td>Job Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9058</td>
|
||
<td>Warehouse Worker WMS Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9059</td>
|
||
<td>Administration Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9060</td>
|
||
<td>SB Owner Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9061</td>
|
||
<td>RapidStart Services Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9063</td>
|
||
<td>Relationship Mgmt. Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9069</td>
|
||
<td>O365 Sales Cue</td>
|
||
</tr>
|
||
<tr>
|
||
<td>9070</td>
|
||
<td>Accounting Services Cue</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Table 1 - Cue tables in Dynamics NAV</p></description></item><item><title>Docs: Setup Table</title><link>https://alguidelines.dev/docs/navpatterns/patterns/singleton/singleton-table/setup-table/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/navpatterns/patterns/singleton/singleton-table/setup-table/</guid><description>
|
||
<p><em>By Abhishek Ghosh, at Microsoft Development Center Copenhagen</em></p>
|
||
<p><a href="Setup-Table.png"><img src="Setup-Table.png" alt=" "></a></p>
|
||
<p>This is the first and most well-known of the two usual applications of the <strong>Singleton Table</strong> pattern in Dynamics NAV.</p>
|
||
<p><strong>Problem:</strong> the developer needs to store information about the operating setup or environment in the database, in a way that can be persisted across sessions.</p>
|
||
<p><strong>Solution:</strong> The information is stored in a table with one record only. The user is subsequently able to modify, but not add or delete records in the table.</p>
|
||
<p>The implementation of the pattern involves several considerations:</p>
|
||
<ul>
|
||
<li>Suffixing the table name with Setup (ex: General Ledger Setup).</li>
|
||
<li>Defining a suitable primary key</li>
|
||
<li>Creating a page where the user can view and edit a record, but not add new records or delete an existing one</li>
|
||
<li>Optionally, updating the Company - Initialize codeunit.</li>
|
||
</ul>
|
||
<p><strong>Defining a Primary Key</strong></p>
|
||
<p>Since this kind of tables is a collection of several environment or setup parameters, the primary key does not refer to any business attributes for this kind of tables. However, for maintaining the integrity of the database, it is necessary to define a primary key.</p>
|
||
<p>So, the most common implementation is to have a field &ldquo;Primary Key&rdquo; of Code[10]. This is populated with a blank value when the record is inserted. This field is not added to the page, so that the user cannot be modify it later.</p>
|
||
<p><strong>Creating a Page</strong></p>
|
||
<p>The <strong>CardPage</strong> type is most suitable for representing this kind of tables. In addition, the <strong>InsertAllowed</strong> and <strong>DeleteAllowed</strong> properties in the page should be set to false to prevent the user from adding or deleting records in the table.</p>
|
||
<p>In the <strong>OnOpenPage</strong> trigger, the following code should be added to insert a record when the user opens the page for the first time, if a record does not exist already.</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="display:flex;"><span>OnOpenPage<span style="color:#ce5c00;font-weight:bold">()
|
||
</span></span></span><span style="display:flex;"><span><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></span><span style="display:flex;"><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>GET<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></span><span style="display:flex;"><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></span><span style="display:flex;"><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></span><span style="display:flex;"><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></span></code></pre></div><p>The following diagram describes the flow of the program, once the user tries to access the setup information. The user opens the page. If the record containing setup information already exists, then the page opens on the existing record. Else, a new empty record is created and the page opens on it.</p>
|
||
<p><a href="6675.NAVSetupTablePattern2.png"><img src="6675.NAVSetupTablePattern2.png" alt=" "></a></p>
|
||
<p><strong>Company-Initialize Codeunit</strong></p>
|
||
<p>The Company-Initialize codeunit (codeunit 2) is executed when a new company is created. We recommended that you add records to the single-record tables in this codeunit. If some of the fields are expected to have default values, they can also be populated here.</p>
|
||
<p><strong>NAV Usages</strong></p>
|
||
<p>Several Setup tables in NAV implement this pattern. Some of those are:</p>
|
||
<ul>
|
||
<li>Table 98 General Ledger Setup</li>
|
||
<li>Table 311 Sales &amp; Receivables Setup</li>
|
||
<li>Table 312 Purchases &amp; Payables Setup</li>
|
||
<li>Table 313 Inventory Setup</li>
|
||
<li>Table 242 Source Code Setup</li>
|
||
</ul>
|
||
<p><strong>Variation:</strong> While most tables just insert a record with empty primary key in codeunit 2, table 242 (&ldquo;Source Code Setup&rdquo;) offers an example of inserting default values into all fields of the table (method &ldquo;InitSourceCodeSetup&rdquo;). This practice, wherever feasible, is likely to reduce the effort during implementation.</p>
|
||
<p><strong>Related resources:</strong> <a href="http://www.klemmensen.ca/Blog/Post/35/Initialize-Setup-Tables">Considerations on optimizing the Singleton Table, by Søren Klemmensen</a>.</p></description></item></channel></rss> |