Skip to content

Commit c6b86ce

Browse files
committed
Docs updates
1 parent 68d7c8c commit c6b86ce

20 files changed

+240
-43
lines changed

docs/_site/api/DataWarehouseAutomation.DataObjectMappingList.html

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,40 @@ <h2 class="section" id="properties">Properties
162162
</h2>
163163

164164

165+
<a id="DataWarehouseAutomation_DataObjectMappingList_Classifications_" data-uid="DataWarehouseAutomation.DataObjectMappingList.Classifications*"></a>
166+
167+
<h3 id="DataWarehouseAutomation_DataObjectMappingList_Classifications" data-uid="DataWarehouseAutomation.DataObjectMappingList.Classifications">
168+
Classifications
169+
170+
</h3>
171+
172+
<div class="markdown level1 summary"><p>Free-form and optional classification for the mapping for use in data logistics generation logic.</p>
173+
</div>
174+
<div class="markdown level1 conceptual"></div>
175+
176+
<div class="codewrapper">
177+
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;classifications&quot;)]
178+
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
179+
public List&lt;DataClassification&gt;? Classifications { get; set; }</code></pre>
180+
</div>
181+
182+
183+
184+
185+
186+
<h4 class="section">Property Value</h4>
187+
<dl class="parameters">
188+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="DataWarehouseAutomation.DataClassification.html">DataClassification</a>&gt;</dt>
189+
<dd></dd>
190+
</dl>
191+
192+
193+
194+
195+
196+
197+
198+
165199
<a id="DataWarehouseAutomation_DataObjectMappingList_DataObjectMappings_" data-uid="DataWarehouseAutomation.DataObjectMappingList.DataObjectMappings*"></a>
166200

167201
<h3 id="DataWarehouseAutomation_DataObjectMappingList_DataObjectMappings" data-uid="DataWarehouseAutomation.DataObjectMappingList.DataObjectMappings">
@@ -195,6 +229,75 @@ <h4 class="section">Property Value</h4>
195229

196230

197231

232+
<a id="DataWarehouseAutomation_DataObjectMappingList_Extensions_" data-uid="DataWarehouseAutomation.DataObjectMappingList.Extensions*"></a>
233+
234+
<h3 id="DataWarehouseAutomation_DataObjectMappingList_Extensions" data-uid="DataWarehouseAutomation.DataObjectMappingList.Extensions">
235+
Extensions
236+
237+
</h3>
238+
239+
<div class="markdown level1 summary"><p>The collection of extension Key/Value pairs.</p>
240+
</div>
241+
<div class="markdown level1 conceptual"></div>
242+
243+
<div class="codewrapper">
244+
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;extensions&quot;)]
245+
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
246+
public List&lt;Extension&gt;? Extensions { get; set; }</code></pre>
247+
</div>
248+
249+
250+
251+
252+
253+
<h4 class="section">Property Value</h4>
254+
<dl class="parameters">
255+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="DataWarehouseAutomation.Extension.html">Extension</a>&gt;</dt>
256+
<dd></dd>
257+
</dl>
258+
259+
260+
261+
262+
263+
264+
265+
266+
<a id="DataWarehouseAutomation_DataObjectMappingList_Name_" data-uid="DataWarehouseAutomation.DataObjectMappingList.Name*"></a>
267+
268+
<h3 id="DataWarehouseAutomation_DataObjectMappingList_Name" data-uid="DataWarehouseAutomation.DataObjectMappingList.Name">
269+
Name
270+
271+
</h3>
272+
273+
<div class="markdown level1 summary"><p>The name of the Data Object Mapping List. This is typically provided by one of the data object mappings in the list.
274+
It has been added to allow easy identification of the objects in case a list contains many mappings.</p>
275+
</div>
276+
<div class="markdown level1 conceptual"></div>
277+
278+
<div class="codewrapper">
279+
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;name&quot;)]
280+
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
281+
public string? Name { get; set; }</code></pre>
282+
</div>
283+
284+
285+
286+
287+
288+
<h4 class="section">Property Value</h4>
289+
<dl class="parameters">
290+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
291+
<dd></dd>
292+
</dl>
293+
294+
295+
296+
297+
298+
299+
300+
198301

199302
</article>
200303

docs/_site/handlebars/extension_exists.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,10 @@ <h1 id="exists">{{exists}}</h1>
9393
<p>The helper can target specific segments in the metadata, and evaluates if either the segment exists at all (without specifying an optional search value) or if the provided optional search value exists in that segment.</p>
9494
<p>Only the <em>multiActiveKey</em> and <em>targetDataItem</em> properties are currently supported.</p>
9595
<h2 id="usage">Usage</h2>
96-
<pre><code class="lang-json">{{#exists &quot;&lt;category / json segment&gt;&quot; &quot;&lt;optional value&gt;&quot;}}
96+
<pre><code class="lang-handlebars">{{#exists &quot;&lt;category / json segment&gt;&quot; &quot;&lt;optional value&gt;&quot;}}
9797
</code></pre>
9898
<h2 id="example">Example</h2>
99-
<pre><code class="lang-json">{{#exists multiActiveKey}}There is a multi-active key!{{else}}No multi-active key is found in this data object mapping.{{/exists}}
99+
<pre><code class="lang-handlebars">{{#exists multiActiveKey}}There is a multi-active key!{{else}}No multi-active key is found in this data object mapping.{{/exists}}
100100
{{#exists multiActiveKey &quot;DATE_OF_BIRTH&quot;}}There is a multi-active key which is not DATE_OF_BIRTH{{else}}No multi-active key with DATE_OF_BIRTH is found in this data object mapping.{{/exists}}
101101
{{#exists targetDataItem}}There is a target data item in this mapping!{{else}}No target data items are defined in this mapping.{{/exists}}
102102
</code></pre>

docs/_site/handlebars/extension_lookupextension.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,10 @@ <h1 id="lookupextension">{{lookupExtension}}</h1>
9393
<p>The lookupExtension helper allows a lookup of an extension by key value.</p>
9494
<p>Pass in the extensions list and the string key value.</p>
9595
<h2 id="usage">Usage</h2>
96-
<pre><code class="lang-json">{{lookupExtension &lt;extension list&gt; &quot;&lt;string value&gt;&quot;}}
96+
<pre><code class="lang-handlebars">{{lookupExtension &lt;extension list&gt; &quot;&lt;string value&gt;&quot;}}
9797
</code></pre>
9898
<h2 id="example">Example</h2>
99-
<pre><code class="lang-json">The lookup value for the 'type' extension is '{{lookupExtension sourceDataObjects.0.extensions &quot;type&quot;}}'.
99+
<pre><code class="lang-handlebars">The lookup value for the 'type' extension is '{{lookupExtension sourceDataObjects.0.extensions &quot;type&quot;}}'.
100100
</code></pre>
101101
<p>Depending on the metadata, this may result in:</p>
102102
<pre><code class="lang-dotnetcli">The lookup value for the 'type' extension is 'procedure'.

docs/_site/handlebars/extension_now.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,10 @@ <h1 id="now">{{now}}</h1>
9191

9292
<p>Get the date and time at the moment of execution.</p>
9393
<h2 id="usage">Usage</h2>
94-
<pre><code class="lang-json">{{now}}
94+
<pre><code class="lang-handlebars">{{now}}
9595
</code></pre>
9696
<h2 id="example">Example</h2>
97-
<pre><code class="lang-json">The time is {{now}}.
97+
<pre><code class="lang-handlebars">The time is {{now}}.
9898
</code></pre>
9999
<p>This returns the date/time at present.</p>
100100
</article>

docs/_site/handlebars/extension_randomdate.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,10 @@ <h1 id="randomdate">{{randomdate}}</h1>
9292
<p>Generate a random date somewhere higher than the provided characters as four-digit integer (year) input.</p>
9393
<p>This was originally added to generate test data, and is used for referential-integrity testing purposes.</p>
9494
<h2 id="usage">Usage</h2>
95-
<pre><code class="lang-json">{{randomdate 2020}}
95+
<pre><code class="lang-handlebars">{{randomdate 2020}}
9696
</code></pre>
9797
<h2 id="example">Example</h2>
98-
<pre><code class="lang-json">Here is a random date: {{randomdate 2020}}.
98+
<pre><code class="lang-handlebars">Here is a random date: {{randomdate 2020}}.
9999
</code></pre>
100100
<p>This may return:</p>
101101
<pre><code class="lang-dotnetcli">2022-08-03T00:00:00.000000

docs/_site/handlebars/extension_randomnumber.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,10 @@ <h1 id="randomnumber">{{randomnumber}}</h1>
9292
<p>Generate a random number with the numeric positions provided as input integer.</p>
9393
<p>This was originally added to generate test data, and is used for referential-integrity testing purposes.</p>
9494
<h2 id="usage">Usage</h2>
95-
<pre><code class="lang-json">{{randomnumber 5}}
95+
<pre><code class="lang-handlebars">{{randomnumber 5}}
9696
</code></pre>
9797
<h2 id="example">Example</h2>
98-
<pre><code class="lang-json">And here is a random string: {{randomnumber 5}}.
98+
<pre><code class="lang-handlebars">And here is a random string: {{randomnumber 5}}.
9999
</code></pre>
100100
<p>This may return:</p>
101101
<pre><code class="lang-dotnetcli">1346

docs/_site/handlebars/extension_randomstring.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,10 @@ <h1 id="randomstring">{{randomstring}}</h1>
9191

9292
<p>Generate a random string no longer than the provided characters as integer input.</p>
9393
<h2 id="usage">Usage</h2>
94-
<pre><code class="lang-json">{{randomstring 10}}
94+
<pre><code class="lang-handlebars">{{randomstring 10}}
9595
</code></pre>
9696
<h2 id="example">Example</h2>
97-
<pre><code class="lang-json">And here is a random string: {{randomstring 10}}.
97+
<pre><code class="lang-handlebars">And here is a random string: {{randomstring 10}}.
9898
</code></pre>
9999
<p>This returns:</p>
100100
<pre><code class="lang-dotnetcli">Cg8uKuBFS5

docs/_site/handlebars/extension_replicate.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,10 @@ <h1 id="replicate">{{replicate}}</h1>
9292
<p>Returns the input string value a number of times, as specified by the input integer.</p>
9393
<p>This is often used to generate test data.</p>
9494
<h2 id="usage">Usage</h2>
95-
<pre><code class="lang-json">{{#replicate 10}}
95+
<pre><code class="lang-handlebars">{{#replicate 10}}
9696
</code></pre>
9797
<h2 id="example">Example</h2>
98-
<pre><code class="lang-json">{{#replicate 3}}
98+
<pre><code class="lang-handlebars">{{#replicate 3}}
9999
This value is replicated 3 times!
100100
{{/replicate}}
101101
</code></pre>

docs/_site/handlebars/extension_space.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,10 @@ <h1 id="space">{{space}}</h1>
9191

9292
<p>Space will space out (!?) the name of the input value to 30 characters using tabs for alignment, indentation.</p>
9393
<h2 id="usage">Usage</h2>
94-
<pre><code class="lang-json">{{space &quot;&lt;value&gt;&quot;}}
94+
<pre><code class="lang-handlebars">{{space &quot;&lt;value&gt;&quot;}}
9595
</code></pre>
9696
<h2 id="example">Example</h2>
97-
<pre><code class="lang-json">This is {{space &quot;Hello World&quot;}} ...spaced out.
97+
<pre><code class="lang-handlebars">This is {{space &quot;Hello World&quot;}} ...spaced out.
9898
</code></pre>
9999
<p>This results in:</p>
100100
<pre><code class="lang-dotnetcli">This is Hello World ...spaced out.

docs/_site/handlebars/extension_stringcompare.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,10 @@ <h1 id="stringcompare">{{stringcompare}}</h1>
9191

9292
<p>Block helper to evaluate if the input matches a specified string. Also optionally supports an {{else}} block.</p>
9393
<h2 id="usage">Usage</h2>
94-
<pre><code class="lang-json">{{#stringcompare string1 string2}} do something {{else}} do something else {{/stringcompare}}
94+
<pre><code class="lang-handlebars">{{#stringcompare string1 string2}} do something {{else}} do something else {{/stringcompare}}
9595
</code></pre>
9696
<h2 id="example">Example</h2>
97-
<pre><code class="lang-json">A and B {{#stringcompare &quot;A&quot; &quot;B&quot;}}are the same. {{else}}are not the same. {{/stringcompare}}
97+
<pre><code class="lang-handlebars">A and B {{#stringcompare &quot;A&quot; &quot;B&quot;}}are the same. {{else}}are not the same. {{/stringcompare}}
9898
</code></pre>
9999
<p>This results in:</p>
100100
<pre><code class="lang-dotnetcli">A and B are not the same.

0 commit comments

Comments
 (0)