ToXmlDoc (UserStatistics function): Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 12: | Line 12: | ||
<td>A <var>UserStatistics</var> object variable. </td></tr> | <td>A <var>UserStatistics</var> object variable. </td></tr> | ||
<tr><th><var>Zeros</var></th> | <tr><th><var>Zeros</var></th> | ||
<td>This <var>[[Methods#Named parameters|NameRequired]]</var> argument (<var>Zeros</var>) is a <var>[[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 <var>[[Methods#Named parameters|NameRequired]]</var> argument (<var>Zeros</var>) 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> | ||
<tr><th><var>AttributeValues</var></th> | <tr><th><var>AttributeValues</var></th> | ||
<td>This <var>NameRequired</var> argument (<var>AttributeValues</var>) 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 <var>NameRequired</var> argument (<var>AttributeValues</var>) 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: | ||
Revision as of 20:32, 24 May 2011
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, optionally, 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 NameRequired 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 | This NameRequired 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 | This NameRequired 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 "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 NameRequired argument (NamesToLower) 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.