JAL: add category

2018-04-23T18:54:35Z

add category

← Older revision		Revision as of 18:54, 23 April 2018
Line 48:		Line 48:
	wants to save the XML format of the <var class="product">SirTune</var> reports for later processing.		wants to save the XML format of the <var class="product">SirTune</var> reports for later processing.
	</ul>		</ul>

			[[Category:Dataset methods]]

JAL2: Created page with "This function reads the records in a dataset and produces a `SirTune` report from it. Obviously, the dataset processed by the `SirtuneReport` me..."

2011-05-20T16:52:22Z

Created page with "This function reads the records in a dataset and produces a <var class="product">SirTune</var> report from it. Obviously, the dataset processed by the <var>SirtuneReport</var> me..."

New page

This function reads the records in a dataset and produces a <var class="product">SirTune</var>
report from it.
Obviously, the dataset processed by the <var>SirtuneReport</var> method must be
a <var class="product">SirTune</var> sample dataset.
==SirtuneReport syntax==
<p class="pre"> %outdoc = %dataset:sirtuneReport(%indoc)
</p>
===Syntax terms===
<table class="syntaxTable">
<tr><th>%outdoc</th>
<td>An <var>[[XmlDoc class|XmlDoc]]</var> object variable that will be set to reference an <var>XmlDoc</var>
that contains the <var class="product">SirTune</var> “report”.
The report is really an <var>XmlDoc</var> whose nodes describe the data in the sample
dataset and, possibly, has error messages indicating any problems processing
the sample dataset.
</td></tr>
<tr><th>%dataset</th>
<td>A reference to an instance of a <var>Dataset</var> object.
</td></tr>
<tr><th>%indoc</th>
<td>An <var>XmlDoc</var> object that indicates which reports are to be produced.

</td></tr></table>
==Usage Notes==
<ul>
<li>A site must be authorized for <var class="product">SirTune</var> to use the <var>SirtuneReport</var> method.
<li>The dataset must be open but not have any records read from it.
If the dataset is not open, the request is cancelled.
If the dataset is not a <var class="product">SirTune</var> sample dataset or has had records read from
it, the output document will contain an error message.
<li>The document (outermost) element for the input <var>XmlDoc</var> must
be <var>SirtuneInput</var>.
Anything else results in request cancellation.
Other errors in input document content result in error messages in the output
<var>XmlDoc</var>.

The document (outermost) element for the output <var>XmlDoc</var> will always
be <var>SirtuneReport</var>.

For more information about the format of the input and output <var>XmlDocs</var> for
<var>SirtuneReport</var>, see the [http://sirius-software.com/manlist/tunr.pdf |SirTune Reference Manual].
<li><var class="product">SirTune</var> provides pre-packaged
<var class="product">User Language</var> that invokes the <var>SirtuneReport</var> method
and produces <var class="product">SirTune</var> reports in various formats, without requiring any additional
programming.
The <var>SirtuneReport</var> method is available to be used directly, however, for any site
that wants more complete control over the output format or
wants to save the XML format of the <var class="product">SirTune</var> reports for later processing.
</ul>

SirtuneReport (Dataset function) - Revision history

JAL: add category

JAL2: Created page with "This function reads the records in a dataset and produces a SirTune report from it. Obviously, the dataset processed by the SirtuneReport me..."

JAL2: Created page with "This function reads the records in a dataset and produces a `SirTune` report from it. Obviously, the dataset processed by the `SirtuneReport` me..."