DifferenceToXmlDoc (UserStatistics function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 9: Line 9:
{{Template:UserStatistics:DifferenceToXmlDoc syntax}}
{{Template:UserStatistics:DifferenceToXmlDoc syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt><i>%doc</i>
<tr><th><i>%doc</i></th>
<dd>A [[Janus SOAP]] XmlDoc object variable to contain the listing of the difference
<td>A [[Janus SOAP]] XmlDoc object variable to contain the listing of the difference values of the Login statistics. </td></tr>
values of the Login 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><i>%ustatOld</i></th>
<dt><i>%ustatOld</i>
<td>An older UserStatistics object variable for the same user login as ''%ustat''. </td></tr>
<dd>An older UserStatistics object variable for the same user login
<tr><th><b>Zeros= </b><i>bool</i></th>
as ''%ustat''.
<td>This name required argument (<tt>Zeros</tt>) is a boolean value that indicates whether differences 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 non-zero values only being included. </td></tr>
<dt><b>Zeros= </b><i>bool</i>
<tr><th><b>AttributeValues= </b><i>bool</i></th>
<dd>This name required argument (<tt>Zeros</tt>) is a boolean value
<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>
that indicates whether differences with a zero value should be included
<tr><th><b>AttributeNames= </b><i>bool</i></th>
in the returned data.
<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"><nowiki><stat name="DKRD">    1107 </stat> </nowiki></p>  The default value is <tt>False</tt>, which produces element-name format. </td></tr>
Zeros is an optional argument that defaults to <tt>False</tt>, which
<tr><th><b>NamesToLower= </b><i>bool</i></th>
results in non-zero values only being included.
<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>
<dt><b>AttributeValues= </b><i>bool</i>
</table>
<dd>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.
<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"><nowiki><stat name="DKRD">
   1107
</stat>
</nowiki></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==

Revision as of 20:45, 14 March 2011

Login timestamps difference in xml format (UserStatistics class)


This method returns to an XML document the difference in values between one UserStatistics object and another for all Login statistics with non-zero values (by default) or for all Login statistics (as an option).

See the description of login statistics.

Syntax

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

Syntax terms

%doc A Janus SOAP XmlDoc object variable to contain the listing of the difference values of the Login statistics.
%ustat A UserStatistics object variable.
%ustatOld An older UserStatistics object variable for the same user login as %ustat.
Zeros= bool This name required argument (Zeros) is a boolean value that indicates whether differences with a zero value should be included in the returned data. Zeros is an optional argument that defaults to False, which results in non-zero values only being included.
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 Difference function returns the value differences between two UserStatistics objects for the Login statistic you specify. The DifferenceToString function returns to a longstring the value differences for all, or all non-zero, Login statistics.

Examples

The display of non-zero difference statistics below is produced by a sequence of statements like the following:

%doc is object xmldoc %statStart is object userstatistics %statEnd is object userstatistics . . . %doc = %statEnd:differencetoXmlDoc(%statStart, zeros=false) %doc:Print

The following are sample results:

<UserStatisticsDifferences time="20080903121750819" userNumber="20" loginTime="20080903115821710" baseTime="20080903121750818"> <SQWR>2</SQWR> <MOVE>2</MOVE> <DKAR>2</DKAR> </UserStatisticsDifferences>

A %doc = %statEnd:differencetoXmlDoc(%statStart) statement would return all the statistics, including those with a 0 value.

See also

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