ToXmlDoc (UserStatistics function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 8: Line 8:
{{Template:UserStatistics:ToXmlDoc syntax}}
{{Template:UserStatistics:ToXmlDoc syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt><i>%doc</i>
<tr><th><i>%doc</i></th>
<dd>An XmlDoc object variable to contain the listing of the values of the
<td>An XmlDoc object variable to contain the listing of the values of the statistics. </td></tr>
statistics.
<tr><th><i>%ustat</i></th>
<dt><i>%ustat</i>
<td>A UserStatistics object variable. </td></tr>
<dd>A UserStatistics object variable.
<tr><th><b>Zeros= </b><i>bool</i></th>
<dt><b>Zeros= </b><i>bool</i>
<td>This name required argument (<tt>Zeros</tt>) 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 <tt>False</tt>, which results in the inclusion of only statistics with non-zero values. </td></tr>
<dd>This name required argument (<tt>Zeros</tt>) is a boolean value
<tr><th><b>AttributeValues= </b><i>bool</i></th>
that indicates whether statistics with a zero value should be included
<td>This name required argument (<tt>AttributeValues</tt>) 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, <tt><DKRD>1107</DKRD></tt> is text format, and <tt><DKRD value="1107"/></tt> is attribute value format.  The default value is <tt>False</tt>, which produces text format. </td></tr>
in the returned data.
<tr><th><b>AttributeNames= </b><i>bool</i></th>
Zeros is an optional argument that defaults to <tt>False</tt>, which
<td>This name required argument (<tt>AttributeNames</tt>) 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 &amp;amp;ldquo;name&amp;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. </td></tr>
results in the inclusion of only statistics with non-zero values.
<tr><th><b>NamesToLower= </b><i>bool</i></th>
<dt><b>AttributeValues= </b><i>bool</i>
<td>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>.</td></tr>
<dd>This name required argument (<tt>AttributeValues</tt>) is a boolean value
</table>
that indicates whether
statistic values are to be displayed as text or as value attributes within
their XML document elements.
   
For example, <tt><DKRD>1107</DKRD></tt> is text format,
and <tt><DKRD value="1107"/></tt> is attribute value format.
   
The default value is <tt>False</tt>, which produces text format.
<dt><b>AttributeNames= </b><i>bool</i>
<dd>This name required argument (<tt>AttributeNames</tt>) 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 &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==
==Usage notes==
<ul>
<ul>

Revision as of 20:42, 14 March 2011

Export the UserStatistics values to Xml (UserStatistics class)


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

%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.
%ustat A UserStatistics object variable.
Zeros= bool This name required argument (Zeros) 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= bool This name required argument (AttributeValues) 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= bool This name required argument (AttributeNames) 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 &amp;ldquo;name&amp;rdquo; 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= bool This name required argument (NamesToLower) is a boolean value that indicates whether statistic names are to be displayed in lowercase characters. The default value is False.

Usage notes

  • The DifferenceToXmlDoc function returns to an XmlDoc object the difference in values between one UserStatistics object and another for the Login statistics.

Examples

The display of non-zero Login and Request statistics below 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>

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

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=ToXmlDoc_(UserStatistics_function)&oldid=13639"