ToXmlDoc (UserStatistics function): Difference between revisions
m (→Syntax terms) |
mNo edit summary |
||
| (5 intermediate revisions by 2 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. | <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. | ||
==Syntax== | ==Syntax== | ||
| Line 8: | Line 8: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%doc</th> | <tr><th>%doc</th> | ||
<td>An XmlDoc object variable to contain the listing of the values of the statistics. </td></tr> | <td>An <var>XmlDoc</var> object variable to contain the listing of the values of the statistics. </td></tr> | ||
<tr><th>userStatistics</th> | <tr><th>userStatistics</th> | ||
<td>A <var>UserStatistics</var> object variable. </td></tr> | <td>A <var>UserStatistics</var> object variable. </td></tr> | ||
<tr><th>Zeros</th> | |||
<td>This | <tr><th><var>Zeros</var></th> | ||
<tr><th>AttributeValues</th> | <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> | ||
<td>This | |||
< | <tr><th><var>AttributeValues</var></th> | ||
<tr><th>AttributeNames</th> | <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: | ||
<td>This | <code><DKRD>1107</DKRD></code> is text format, and <code><DKRD value="1107"/></code> is attribute value format. | ||
< | <p> | ||
<tr><th>NamesToLower</th> | The default value is <var>False</var>, which produces text format.</p></td></tr> | ||
<td>This | |||
<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: | |||
<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> | |||
<p> | |||
The default value is <var>False</var>, which produces element-name format. </p></td></tr> | |||
<tr><th><var>NamesToLower</var></th> | |||
<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> | |||
</table> | </table> | ||
==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: | |||
<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 | ||
| Line 64: | Line 74: | ||
</UserStatistics> | </UserStatistics> | ||
</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. | |||
==See also== | ==See also== | ||
<ul> | <ul> | ||
<li><var>[[DifferenceToXmlDoc (UserStatistics function)|DifferenceToXmlDoc]]</var> returns, to an <var>XmlDoc</var> object, the difference in values between the | <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> | </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:
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.