DifferenceToXmlDoc (UserStatistics function): Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:UserStatistics:DifferenceToXmlDoc subtitle}} | |||
This method returns to an XML document the difference in values between one | This method returns to an XML document the difference in values between one | ||
| Line 12: | Line 6: | ||
See the description of [[UserStatistics class#login|login statistics]]. | See the description of [[UserStatistics class#login|login statistics]]. | ||
==Syntax== | |||
{{Template:UserStatistics:DifferenceToXmlDoc syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<dl> | <dl> | ||
| Line 48: | Line 38: | ||
that indicates whether statistic names are to be displayed | that indicates whether statistic names are to be displayed | ||
within their XML document elements | within their XML document elements | ||
as the element name or as the value of a “name” attribute. | as the element name or as the value of a &ldquo;name&rdquo; attribute. | ||
For example, <tt><DKRD>1107</DKRD></tt> is element-name format, | For example, <tt><DKRD>1107</DKRD></tt> is element-name format, | ||
| Line 66: | Line 56: | ||
</dl> | </dl> | ||
==Usage notes== | |||
<ul> | <ul> | ||
<li>The [[Difference (UserStatistics function)|Difference]] function returns the value | <li>The [[Difference (UserStatistics function)|Difference]] function returns the value | ||
| Line 74: | Line 64: | ||
</ul> | </ul> | ||
==Examples== | |||
The display of non-zero difference statistics below is produced | The display of non-zero difference statistics below is produced | ||
| Line 99: | Line 89: | ||
statement would | statement would | ||
return all the statistics, including those with a <code>0</code> value. | return all the statistics, including those with a <code>0</code> value. | ||
==See also== | |||
{{Template:UserStatistics:DifferenceToXmlDoc footer}} | |||
Revision as of 20:42, 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 “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= 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.
- AttributeNames= bool
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.