ToXmlDoc (UserStatistics function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:UserStatistics:ToXmlDoc subtitle}}
{{Template:UserStatistics:ToXmlDoc subtitle}}
<var>ToXmlDoc</var> returns in a <var class="product">[[Janus SOAP]]</var> <var>[[XmlDoc_class|XmlDoc]]</var> object the values of the statistics in the method <var>UserStatistics</var> object. By default, it will only return those statistics with non-zero values; but, as an option, it may return all (including zero) statistics.
This method returns in a [[Janus SOAP]] XmlDoc object the values of the statistics
 
in the method UserStatistics object.
It returns all statistics with non-zero values (by default), or it returns
all statistics (as an option).
==Syntax==
==Syntax==
{{Template:UserStatistics:ToXmlDoc syntax}}
{{Template:UserStatistics:ToXmlDoc syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt><i>%doc</i>
<tr><th>%doc</th>
<dd>An XmlDoc object variable to contain the listing of the values of the
<td>An <var>XmlDoc</var> object variable to contain the listing of the values of the statistics. </td></tr>
statistics.
 
<dt><i>%ustat</i>
<tr><th>userStatistics</th>
<dd>A UserStatistics object variable.
<td>A <var>UserStatistics</var> object variable. </td></tr>
<dt><b>Zeros= </b><i>bool</i>
 
<dd>This name required argument (<tt>Zeros</tt>) is a boolean value
<tr><th><var>Zeros</var></th>
that indicates whether statistics with a zero value should be included
<td>This [[Notation conventions for methods#Named parameters|name required]] argument is a <var>[[Enumerations#Using Boolean enumerations|Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values. </td></tr>
in the returned data.
 
Zeros is an optional argument that defaults to <tt>False</tt>, which
<tr><th><var>AttributeValues</var></th>
results in the inclusion of only statistics with non-zero values.
<td>This name required argument is a <var>Boolean</var> value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example:
<dt><b>AttributeValues= </b><i>bool</i>
<code><DKRD>1107</DKRD></code> is text format, and <code><DKRD value="1107"/></code> is attribute value format.  
<dd>This name required argument (<tt>AttributeValues</tt>) is a boolean value
<p>
that indicates whether
The default value is <var>False</var>, which produces text format.</p></td></tr>
statistic values are to be displayed as text or as value attributes within
 
their XML document elements.
<tr><th><var>AttributeNames</var></th>
<td>This name required argument is a <var>Boolean</var> value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a "name" attribute. For example:
For example, <tt><DKRD>1107</DKRD></tt> is text format,
<code><DKRD>1107</DKRD></code> is element-name format, and the following is name-as-attribute format: <p class="code"><stat name="DKRD"> 1107 </stat></p>  
and <tt><DKRD value="1107"/></tt> is attribute value format.
 
<p>
The default value is <tt>False</tt>, which produces text format.
The default value is <var>False</var>, which produces element-name format. </p></td></tr>
<dt><b>AttributeNames= </b><i>bool</i>
 
<dd>This name required argument (<tt>AttributeNames</tt>) is a boolean value
<tr><th><var>NamesToLower</var></th>
that indicates whether statistic names are to be displayed
<td>This name required argument is a <var>Boolean</var> value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <var>False</var>.</td></tr>
within their XML document elements
</table>
as the element name or as the value of a &amp;ldquo;name&amp;rdquo; attribute.
 
For example, <tt><DKRD>1107</DKRD></tt> is element-name format,
and the following is name-as-attribute format:
<p class="code"><stat name="DKRD">
1107
</stat>
</p>
The default value is <tt>False</tt>, which produces element-name format.
<dt><b>NamesToLower= </b><i>bool</i>
<dd>This name required argument (<tt>NamesToLower</tt>) is a boolean value
that indicates whether statistic names are to be displayed in lowercase
characters.
The default value is <tt>False</tt>.
</dl>
==Usage notes==
<ul>
<li>The [[DifferenceToXmlDoc (UserStatistics function)|DifferenceToXmlDoc]] function returns
to an XmlDoc object the difference in values between one
UserStatistics object and another for the Login statistics.
</ul>
==Examples==
==Examples==
The following display of non-zero [[UserStatistics_class#login|Login]] and [[UserStatistics_class#request|Request]] statistics is produced by a sequence of statements like the following:
The display of non-zero Login and Request statistics below is produced
by a sequence of statements like the following:
<p class="code">%doc is object xmldoc
<p class="code">%doc is object xmldoc
%ustat is object userstatistics
%ustat is object userstatistics
   . . .
   ...
%doc = %ustat:ToXmlDoc
%doc = %ustat:ToXmlDoc
%doc:Print
%doc:print
</p>
</p>
The following are sample results:
The following are sample results:
<p class="code"><nowiki><UserStatistics id="40" time=20080902203110278
<p class="output"><UserStatistics id="40" time=20080902203110278
  userNumber="6" loginTime="20080902094309010">
  userNumber="6" loginTime="20080902094309010">
   <login>
   <login>
Line 100: Line 73:
   </request>
   </request>
</UserStatistics>
</UserStatistics>
</nowiki></p>
</p>
Using a <code>%doc = %ustat:ToXmlDoc(Zeros=true)</code> statement would return all the statistics, including those with a <code>0</code> value.
A <code>%doc = %ustat:ToXmlDoc(Zeros=true)</code> statement would
 
return all the statistics, including those with a <code>0</code> value.
==See also==
==See also==
<ul>
<li><var>[[DifferenceToXmlDoc (UserStatistics function)|DifferenceToXmlDoc]]</var> returns, to an <var>XmlDoc</var> object, the difference in values between the Login statistics in one <var>UserStatistics</var> object and another.
</ul>
{{Template:UserStatistics:ToXmlDoc footer}}
{{Template:UserStatistics:ToXmlDoc footer}}

Latest revision as of 22:15, 20 November 2012

Export the UserStatistics values to Xml (UserStatistics class)

ToXmlDoc returns in a Janus SOAP XmlDoc object the values of the statistics in the method UserStatistics object. By default, it will only return those statistics with non-zero values; but, as an option, it may return all (including zero) statistics.

Syntax

%doc = userStatistics:ToXmlDoc[( [Zeros= boolean], - [AttributeValues= boolean], - [AttributeNames= boolean], - [NamesToLower= boolean])]

Syntax terms

%doc An XmlDoc object variable to contain the listing of the values of the statistics.
userStatistics A UserStatistics object variable.
Zeros This name required argument is a Boolean value that indicates whether statistics with a zero value should be included in the returned data. Zeros is an optional argument that defaults to False, which results in the inclusion of only statistics with non-zero values.
AttributeValues This name required argument is a Boolean value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example:

<DKRD>1107</DKRD> is text format, and <DKRD value="1107"/> is attribute value format.

The default value is False, which produces text format.

AttributeNames This name required argument is a Boolean value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a "name" attribute. For example: <DKRD>1107</DKRD> is element-name format, and the following is name-as-attribute format:

<stat name="DKRD"> 1107 </stat>

The default value is False, which produces element-name format.

NamesToLower This name required argument is a Boolean value that indicates whether statistic names are to be displayed in lowercase characters. The default value is False.

Examples

The following display of non-zero Login and Request statistics is produced by a sequence of statements like the following:

%doc is object xmldoc %ustat is object userstatistics ... %doc = %ustat:ToXmlDoc %doc:print

The following are sample results:

<UserStatistics id="40" time=20080902203110278 userNumber="6" loginTime="20080902094309010"> <login> <CNCT>38881</CNCT> <DKRD>7</DKRD> <DKWR>102</DKWR> <SQRD>79</SQRD> <SQWR>353</SQWR> <SGMTI>598</SGMTI> <SVRD>2</SVRD> <SVWR>2</SVWR> <CPU>27</CPU> <REQ>13</REQ> <MOVE>284</MOVE> <AUDIT>136</AUDIT> <WAIT>286</WAIT> <DKAR>173</DKAR> <DKPR>421</DKPR> <SMPLS>1595</SMPLS> <BLKI>1000</BLKI> <SCREENS>54</SCREENS> <SVPAGES>172</SVPAGES> </login> <request> <NTBL>8</NTBL> <QTBL>32</QTBL> <STBL>3776</STBL> <VTBL>177</VTBL> <PDL>168</PDL> </request> </UserStatistics>

Using a %doc = %ustat:ToXmlDoc(Zeros=true) statement would return all the statistics, including those with a 0 value.

See also

  • DifferenceToXmlDoc returns, to an XmlDoc object, the difference in values between the Login statistics in one UserStatistics object and another.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=ToXmlDoc_(UserStatistics_function)&oldid=13648"