NACS POS/Back Office Interface Guidelines XML Data Interchange
XML ImportExport Interface UniFLOWHelix_V1.4
-
Upload
gil-pereira -
Category
Documents
-
view
160 -
download
4
Transcript of XML ImportExport Interface UniFLOWHelix_V1.4
// XML Import/Export Interface for HelixPW and uniFLOW
White Paper
Version no: 1.4
Date: 02.01.2012
Version 5.x
Version 2.x
I / White Paper - XML Import/Export Interface for HelixPW and uniFLOW
Table of Contents
Foreword 0
1 Versioning Information 1
2 Introduction 1
3 XML Structure 2
4 Fundamentals 2
24.1 Example 1
44.2 Example 2
54.3 Building of the XML data records
......................................................................................................................................................... 54.3.1 XML MOMIO Element
......................................................................................................................................................... 74.3.2 XML USER Element
......................................................................................................................................................... 94.3.3 XML USER-BUDGET Element......................................................................................................................................................... 114.3.4 XML COSTCENTER Element......................................................................................................................................................... 134.3.5 XML COSTCENTER-BUDGET Element......................................................................................................................................................... 154.3.6 XML GROUP Element......................................................................................................................................................... 164.3.7 XML GROUP-BUDGET Element......................................................................................................................................................... 184.3.8 DTD for Basic Objects
194.4 XML for Statistic Export
......................................................................................................................................................... 204.4.1 Description of the single XML Elements
......................................................................................................................................................... 224.4.2 DTD for Statistic Export
White Paper - XML Import/Export Interface for HelixPW and uniFLOW / II
Index 0
1 / White Paper - XML Import/Export Interface for HelixPW and uniFLOW
1 Versioning Information
Versioning Information
Version: 1.4
Date: 02.01.2012
First Draw-up Date: 08.04.2009
Author: Karsten Huster
Revision history: Version: Revision date:
1.0 08.04.2009
1.1 27.10.2009
1.2 05.11.2010
1.3 19.12.2011
1.4 02.01.2012
Technologies concerned: Helix Production Workflow and
uniFLOW
Reviewer: Felix Schlick Karsten Huster
File name: momxml.pdf
The information and technology in this White Paper refers to the date it was written orrevised. We do our best to keep the content as up to date as possible.
2 Introduction
This document describes the import and export formats of the the two systems: uniFLOWand HelixPW. The import and export is essentially based on XML, therefore the XMLprogramming language serves for the coding of all individual information. In principle,HelixPW and uniFLOW support two kinds of data export: the export of Base Data and theexport of Statistical Data.
White Paper - XML Import/Export Interface for HelixPW and uniFLOW / 2
3 XML Structure
For the definition of the XML structure, we took great care to not only build a static interfacefor data import and export, but also to create an interactive interface for modifying ordeleting data. All master data (user, groups and cost centers) are delivered as a singleXML file. Both the parser on the HelixPW / uniFLOW side as well as the parser on the userside, are able to filter out the desired data.
4 Fundamentals
All records in the HelixPW / uniFLOW system are guided by a so-called GUID (GloballyUnique Identifier). GUIDs make it possible to identifiy a record independently of thecreating workstation. A GUID is invisible for the user. In general GUIDs are structured asfollows:
{475A965B-1714-42A4-9B35-698AB6506420}
If a record is referenced in an XML, it is best to use the GUID field. However, the XMLlanguage also allows the use of a different field as an identifier, for example to exchange arecord with a specific login.
Building XML data for basic objects
In the following you can find a description of the structure of an XML file for the HelixPW /uniFLOW system.
4.1 Example 1
Example 1:
(Sample can also be found under: http://www.nt-ware.com/xml/mombsample.xml)
<MOMIO> <USER action="add"> <NAME>Dagobert Duck</NAME> <ADDRESSONE>Street 12</ADDRESSONE> <ADDRESSTWO/> <ZIP>12345</ZIP> <CITY>DuckCity</CITY> <PHONE>123-132415</PHONE> <FAX>123-451515</FAX> <LOGIN>DagobertD</LOGIN> <TERMINALID /> <STDGROUP>{475A965B-1714-42A4-9B35-698AB6506420}</STDGROUP> <STDCOSTCENTER>{ACF6E6A2-055B-4D87-AF54-A08B0512FE30}</
3 / White Paper - XML Import/Export Interface for HelixPW and uniFLOW
STDCOSTCENTER> </USER> <USER action="add" lookupkey="NAME" lookupvalue="DonaldDuck"> <NAME>Donald Duck</NAME> <ADDRESSONE>Street 12</ADDRESSONE> <ADDRESSTWO>(second floor)</ADDRESSTWO> <ZIP>12345</ZIP> <CITY>DuckCity</CITY> <LOGIN>DonaldD</LOGIN> <TERMINALID>3312</TERMINALID> <STDGROUP/> <STDCOSTCENTER/> <BUDGET enabled="true"> <INITIALBALANCE>10.0000</INITIALBALANCE> <WARNINGBALANCE>2.0000</WARNINGBALANCE> <EXCEEDBEHAVIOUR>WarnOnly</EXCEEDBEHAVIOUR> <RESETTYPE>Overwrite</RESETTYPE> <RESETINTERVAL>Monthly</RESETINTERVAL> <NOTIFICATIONMETHOD>WebPopup</NOTIFICATIONMETHOD> </BUDGET> </USER> <USER action="remove" id="{B810A19CE-7641-42B9-8265-9E5D48C248C3}"/> <USER action="change" id="{8AFC938C-4652-489E-83C8-A3457FF3CE62}"> <NAME>Robert Frost</NAME> </USER> <USER action="remove" lookupkey="LOGIN"lookupvalue="KarstenH"/> <USER action="change" lookupkey="NAME" lookupvalue="RobertFrost"> <LOGIN>RFrost</LOGIN> </USER> <COSTCENTER action="add"> <NAME>0 100 000</NAME> <DESCRIPTION>Technical Department, Drawings</DESCRIPTION> <TERMINALID>1234</TERMINALID> </COSTCENTER> <GROUP action="add"> <NAME>Students</NAME> <DESCRIPTION>Students, who also print on Sundays</DESCRIPTION> <TERMINALID>5547</TERMINALID> <STDCOSTCENTER>{ACF6E6A2-055B-4D87-AF54-A08B0512FE30}</STDCOSTCENTER> </GROUP></MOMIO>
White Paper - XML Import/Export Interface for HelixPW and uniFLOW / 4
The XML file carries out the following tasks:
adding a user (“Dagobert Duck“)
changing and adding a user (“Donald Duck”), search criteria is the name;
This user also has a budget monitoring.
deleting a user with a certain ID
changing the name of a user with a certain ID
deleting a user with a certain login-name
changing the login-name of a certain user, searched by name
adding a cost center
adding a group
4.2 Example 2
Example 2:
In the following you’ll find another example with a meaningful configuration.
<MOMIO> <COSTCENTER action="add" id="{ACF6E6A2-055B-4D87-AF54-A08B0512FE30}"> <NAME>0 100 000</NAME> <DESCRIPTION>Technical Department, Drawings</DESCRIPTION> <TERMINALID>1234</TERMINALID> </COSTCENTER> <GROUP action="add" id="{475A965B-1714-42A4-9B35-698AB6506420}"> <NAME>Students</NAME> <DESCRIPTION>Students, who also print on Sundays</DESCRIPTION> <TERMINALID>5547</TERMINALID> <STDCOSTCENTER>{ACF6E6A2-055B-4D87-AF54-A08B0512FE30}</STDCOSTCENTER> </GROUP> <USER action="add" id="{8AFC938C-4652-489E-83C8-A3457FF3CE62}"> <NAME>Dagobert Duck</NAME> <ADDRESSONE>Strasse 12</ADDRESSONE> <ADDRESSTWO/> <ZIP>12345</ZIP> <CITY>DuckCity</CITY> <PHONE>123-132415</PHONE> <FAX>123-451515</FAX> <LOGIN>DagobertD</LOGIN> <TERMINALID />
5 / White Paper - XML Import/Export Interface for HelixPW and uniFLOW
<BUDGET enabled="true"> <INITIALBALANCE>10.0000</INITIALBALANCE> <WARNINGBALANCE>2.0000</WARNINGBALANCE> <EXCEEDBEHAVIOUR>WarnOnly</EXCEEDBEHAVIOUR> <RESETTYPE>Overwrite</RESETTYPE> <RESETINTERVAL>Monthly</RESETINTERVAL> <NOTIFICATIONMETHOD>WebPopup</NOTIFICATIONMETHOD> </BUDGET> <STDGROUP>{475A965B-1714-42A4-9B35-698AB6506420}</STDGROUP> <STDCOSTCENTER>{ACF6E6A2-055B-4D87-AF54-A08B0512FE30}</STDCOSTCENTER> </USER> <USER action="add"> <NAME>Robert Frost</NAME> <LOGIN>RFrost</LOGIN> </USER> <USER action="remove" lookupkey="LOGIN"lookupvalue="KarstenH"/></MOMIO>
4.3 Building of the XML data records
The following tables show the format of the XML data records in detail:
4.3.1 XML MOMIO Element
Name Type Description
syncUsers Attribute Set user handling. Only when importing
true deletes all user accounts in HelixPW/ uniFLOW if they are not part of this XML file
false adds all users from this XML file toHelixPW / uniFLOW without deleting knownHelixPW / uniFLOW accounts (default)
syncGroups Attribute Set group handling. Only when importing
true deletes all group accounts inHelixPW / uniFLOW if they are not part of thisXML file
false adds all groups from this XML file toHelixPW / uniFLOW without deleting knownHelixPW / uniFLOW accounts (default)
White Paper - XML Import/Export Interface for HelixPW and uniFLOW / 6
syncCostCenters Attribute Set cost center handling. Only when importing
true deletes all cost centers accounts inHelixPW / uniFLOW if they are not part of thisXML file
false adds all cost centers from this XMLfile to HelixPW / uniFLOW without deletingknown HelixPW / uniFLOW accounts (default)
7 / White Paper - XML Import/Export Interface for HelixPW and uniFLOW
4.3.2 XML USER Element
Name Type Description
action Attribute Shows the action. Only when importing
add adding or changing a record (default)
remove deleting a record
change changing a record
Id Attribute Shows the GUID of the record when changing,deleting or exporting
lookupkey Attribute Shows the data base field according to which arecord should be selected. Only when importing.
lookupvalue Attribute Shows the value of a data base field according towhich a record should be selected. Only whenimporting.
removeothers Attribute Determines, whether existing identities will bedeleted on import. Only when importing.
yes all identities attached to the user account willbe deleted.
no – identities attached to the user account will bepreserved, new identities will be added
type Attribute Specifies the identity type used in the IDENTITYelement. Can have the following values:
SMTPMailAddressLDAPLoginHostLoginCardNumberPINCodeIMEINumberTICInternetGatewayLogin
default Attribute Determines, whether the identity specified in theIDENTITY element will be the default identity afterimport.
yes|no
IDENTITIES* Element Identity section, can contain one or more IDENTITYelements.
IDENTITY* Element Specifies one identity of the user.
White Paper - XML Import/Export Interface for HelixPW and uniFLOW / 8
NAME Element Name of the user
ADDRESSONE Element Address 1 of the user
ADDRESSTWO Element Address 2 of the user
ZIP Element Zip code
CITY Element City
PHONE Element Telephone number
FAX Element Fax number
LOGIN Element Login name
TERMINALID Element Chipcard number
STDGROUP Element ID of the standard group
STDCOSTCENTER Element ID of the standard cost center
EMAIL Element Email address of the user
SAPNAME Element Special field for the SAP username
PERSONALFOLDER Element Used for the SMTP Email gateway to send to apersonal folder. Works just with an XML import andcannot be exported.
TIMESTAMP Element The timestamp contains the time when HelixPW /uniFLOW wrote the descriptor file, as the time of theactual scan is unknown to HelixPW / uniFLOW.HelixPW / uniFLOW only knows when the iR sent thescan. The TIMESTAMP uses the following format:
"yyyymmddhhmmss".
PIN Element PIN Code of the user.
Works with an XML import only and cannot beexported.
* From uniFLOW V. 5.1 and Helix V. 2.1 onwards
9 / White Paper - XML Import/Export Interface for HelixPW and uniFLOW
4.3.3 XML USER-BUDGET Element
Name Type Description
enabled Attribute true enable the budget monitoring
false disable the budget monitoring
WARNINGBALANCE Element
INITIALBALANCE Element The “start” balance, and also the updatedbalance value, if the RESETINTERVAL is not setto “None”.
EXCEEDBEHAVIOUR Element The behavior on exceeding the balance
None Nothing happens
WarnOnly The user gets a warninginformation, but the print job will be printed
Block The user gets a warning, that his printjob will be deleted
BlockColorOnly The user gets a warning,that his print/copy job will be deleted, if the jobincludes color.
RESETTYPE Element The Reload Behavior
Add - Adds the INITIALBALANCE after theRESETINTERVAL to the CURRENTBALANCEOverwrite – Reset the CURRENTBALANCE tothe INITIALBALANCE after theRESETINTERVAL
RESETINTERVAL Element Sets the reload interval for the balance update
Never never
Daily – daily update
Weekly weekly update
Monthly monthly update
Quarterly quarterly update
Yearly yearly update
NOTIFICATIONMETHOD Element Set the notification method for theEXCEEDBEHAVIOUR.
None no notification
Email notification via email
White Paper - XML Import/Export Interface for HelixPW and uniFLOW / 10
WebPopup notification via web popup
Log only protocol entry
CURRENTBALANCE Element The current balance. Only for export.
VALUE Element To set or influence a budget.
Use the following syntax:
<VALUE action="add">12.50</VALUE>
Attribute action
The following values for the attribute ‘action’ arepossible:
add - simply adds the given amount to the currentbudget reset - Sets the budget back to '0.00', the valueis ignored new - Sets the budget to the value given ignore - does nothing
11 / White Paper - XML Import/Export Interface for HelixPW and uniFLOW
4.3.4 XML COSTCENTER Element
Name Type Description
action Attribute Shows the action. Only when importing
add adding and changing a record (default)
remove deleting a record
change changing a record
Id Attribute Shows the GUID of the record when changing,deleting or exporting
lookupkey Attribute Shows the data base field according to which arecord should be selected. Only when importing.
lookupvalue Attribute Shows the value of a data base field according towhich a record should be selected. Only whenimporting.
removeothers Attribute Determines, whether existing identities will bedeleted on import. Only when importing.
yes all identities attached to the user account willbe deleted.
no – identities attached to the cost center will bepreserved, new identities will be added
type Attribute Specifies the identity type used in the IDENTITYelement. Can have the following values:
SMTPMailAddressLDAPLoginHostLoginCardNumberPINCodeIMEINumberTICInternetGatewayLogin
default Attribute Determines, whether the identity specified in theIDENTITY element will be the default identity afterimport.
yes|no
IDENTITIES* Element Identity section, can contain one or more IDENTITYelements.
IDENTITY* Element Specifies one identity of the cost center
White Paper - XML Import/Export Interface for HelixPW and uniFLOW / 12
NAME Element Name of the cost center
DESCRIPTION Element Description of the cost center
TERMINALID Element Number of the cost center at the PayCon (keyboardentry) or on a chip card.
PARENT** Element Configure a linked parent cost center via a key/value lookup or via the GUID: <PARENT lookupkey="key" lookupvalue="value">{guid}</PARENT>
HIERARCHYLEVEL** Element Configure an unlinked cost center. Enter digits 1 - 9to specify the hierarchy level:<HIERARCHYLEVEL>2</HIERARCHYLEVEL>
* From uniFLOW V. 5.1 and Helix V. 2.1 onwards
** Within one <COSTCENTER> element, either <PARENT> or <HIERARCHYLEVEL> canbe used, never both.
13 / White Paper - XML Import/Export Interface for HelixPW and uniFLOW
4.3.5 XML COSTCENTER-BUDGET Element
Name Type Description
enabled Attribute true enable the budget monitoring
false disable the budget monitoring
action Attribute The following values for the attribute ‘action’ arepossible:
add - Simply adds the given amount to thecurrent budget.reset - Sets the budget back to '0.00', the valueis ignored.d - Sets the budget to the value given.ignore - Does nothing.
WARNINGBALANCE Element
INITIALBALANCE Element The “start” balance, and also the updatedbalance value, if the RESETINTERVAL is not setto “None”.
EXCEEDBEHAVIOUR Element The behaviour on exceeding the balance
None Nothing happens
WarnOnly The user gets a warninginformation but the print job will be printed
Block The user gets a warning that his printjob will be delete
BlockColorOnly The user gets a warningthat his print/copy job will be deleted, if the jobincludes color
RESETTYPE Element The Reload Behaviour
Add - Adds the INITIALBALANCE after theRESETINTERVAL to the CURRENTBALANCEOverwrite – Reset the CURRENTBALANCE tothe INITIALBALANCE after theRESETINTERVAL
RESETINTERVAL Element Set the reload interval for the balance update
Never never
Daily daily update
Weekly weekly update
White Paper - XML Import/Export Interface for HelixPW and uniFLOW / 14
Monthly monthly update
Quarterly quarterly update
Yearly yearly update
NOTIFICATIONMETHOD Element Set the notification method forEXCEEDBEHAVIOUR.
None no notification
Email notification via email
WebPopup notification via web popup
Log only protocol entry
CURRENTBALANCE Element The current balance. Only for export.
VALUE Element To set or influence a budget.
Use the following syntax:
<VALUE action="add">12.50</VALUE>
15 / White Paper - XML Import/Export Interface for HelixPW and uniFLOW
4.3.6 XML GROUP Element
Name Type Description
Action Attribute Shows the action. Only when importing.
add adding and changing a record (default)
remove deleting a record
change changing a record
Id Attribute Shows the GUID of the record when changing,deleting or exporting
Lookupkey Attribute Shows the data base field according to whicha record should be selected. Only whenimporting.
Lookupvalue Attribute Shows the value of a data base fieldaccording to which a record should beselected. Only when importing.
NAME Element Name of the group.
DESCRIPTION Element Description of the group.
STDCOSTCENTER Element ID of the standard cost center.
TERMINALID Element Number of the group at the PayCon (keyboardentry) or on a chip card.
White Paper - XML Import/Export Interface for HelixPW and uniFLOW / 16
4.3.7 XML GROUP-BUDGET Element
Name Type Description
enabled Attribute true enable the budget monitoring
false disable the budget monitoring
action Attribute The following values for the attribute ‘action’ arepossible:
add - simply adds the given amount to the currentbudget reset - Sets the budget back to '0.00', the valueis ignored new - Sets the budget to the value given ignore - does nothing
WARNINGBALANCE Element
INITIALBALANCE Element The “start” balance, and also the updatedbalance value, if the RESETINTERVAL is not setto “None”.
EXCEEDBEHAVIOUR Element The behavior on exceeding the balance
None Nothing happens
WarnOnly The user gets a warninginformation but the print job will be printed
Block The user gets a warning that his printjob will be deleted
BlockColorOnly The user gets a warningthat his print/copy job will be deleted, if the jobincludes color
RESETTYPE Element The Reload Behavior.
Add - Adds the INITIALBALANCE after theRESETINTERVAL to the CURRENTBALANCE
Overwrite Reset the CURRENTBALANCE to theINITIALBALANCE after the RESETINTERVAL
RESETINTERVAL Element Set the reload interval for the balance update.
Never never
Daily daily update
Weekly weekly update
17 / White Paper - XML Import/Export Interface for HelixPW and uniFLOW
Monthly monthly update
Quarterly quarterly update
Yearly yearly update
NOTIFICATIONMETHOD Element Set the notification method forEXCEEDBEHAVIOUR.
None no notification
Email notification via email
WebPopup notification via web popup
Log only protocol entry
CURRENTBALANCE Element The current balance. Only for export.
VALUE Element To set or influence a budget.
Use the following syntax:
<VALUE action="add">12.50</VALUE>
White Paper - XML Import/Export Interface for HelixPW and uniFLOW / 18
4.3.8 DTD for Basic Objects
The following DTD can be used for validating the XML I/O language: (copy available underhttp://www.nt-ware.com/xml/momobjio.dtd)
<!DOCTYPE MOMIO [<!ELEMENT MOMIO (COSTCENTER*, GROUP*,USER*) ><!ELEMENT USER (NAME?,ADDRESSONE?,ADDRESSTWO?,ZIP?,CITY?,PHONE?,FAX?,LOGIN?,TERMINALID?,STDGROUP?,STDCOSTCENTER?) ><!ELEMENT COSTCENTER (NAME?,DESCRIPTION?,TERMINALID?,PARENT?,HIERARCHYLEVEL?) ><!ELEMENT GROUP (NAME?,DESCRIPTION?,TERMINALID?,STDCOSTCENTER?) >
<!ATTLIST USER action CDATA ""id CDATA ""lookupvalue CDATA ""lookupkey CDATA "" >
<!ATTLIST COSTCENTER action CDATA ""id CDATA ""lookupvalue CDATA ""lookupkey CDATA "" >
<!ATTLIST GROUP action CDATA ""id CDATA ""lookupvalue CDATA ""lookupkey CDATA "" >
<!ELEMENT NAME (#PCDATA) ><!ELEMENT ADDRESSONE (#PCDATA) ><!ELEMENT ADDRESSTWO (#PCDATA) ><!ELEMENT ZIP (#PCDATA) ><!ELEMENT CITY (#PCDATA) ><!ELEMENT PHONE (#PCDATA) ><!ELEMENT FAX (#PCDATA) ><!ELEMENT LOGIN (#PCDATA) ><!ELEMENT TERMINALID (#PCDATA) ><!ELEMENT STDGROUP (#PCDATA) ><!ELEMENT STDCOSTCENTER (#PCDATA) ><!ELEMENT DESCRIPTION (#PCDATA) >]>
19 / White Paper - XML Import/Export Interface for HelixPW and uniFLOW
4.4 XML for Statistic Export
In the following the structure of the XML interface for data export is described: (alsoavailable under http://www.nt-ware.com/xml/momsample.xml)
<?xml version = "1.0" standalone="yes" ?>
<MOMSTAT> <STATENTRY id="{4597E5C5-BE71-4584-B6B8-A136CB123AAD}"> <SERVICE id="{BFB52142-D1AE-11D4-8F1D-0010A4A4E1AA}"type="196609">Druck DIN A4</SERVICE> <USER id="{57890D70-D1D3-11D4-8F1F-0010A4A4E1AA}">KarstenH</USER> <PRINTER id="{59DADAD6-8191-4586-BEFD-118691D5C4E1}">Canon CLC 1000</PRINTER> <GROUP id="{475A965B-1714-42A4-9B35-698AB6506420}">Employee</GROUP> <COSTCENTER id="{94C34CA8-9C69-4390-A69E-EE9062D88FF5}">0 100 000</COSTCENTER> <CARDINALITY>12</CARDINALITY> <PRICE>1.30</PRICE> <CARDNUMBER/> <TIMEBEGIN>2001/05/24 12:30:00</TIMEBEGIN> <TIMEEND>2001/05/24 12:31:02</TIMEEND> <SUBSERVICE id="{1319A3A6-2D53-49D9-9F8F-E9C18FDED4DB}"type="524291"> <NAME>HolePunching</NAME> <PDLNAME>*FinisherOptPunch</PDLNAME> <CARDINALITY>12</CARDINALITY> <PRICE>0.00</PRICE> </SUBSERVICE> <SUBSERVICE id="{F154A632-336F-4F7D-987D-3FCF7CB12DF7}"type="524292"> <NAME>Stapling</NAME> <PDLNAME>*EFOptionSorter</PDLNAME> <CARDINALITY>12</CARDINALITY> <PRICE>0.00</PRICE> </SUBSERVICE> </STATENTRY></MOMSTAT>
The general structure follows the rules described below:
Each single statistical entry is a STATENTRY element.
Within the STATENTRY elements, the linked users, groups and cost centers are stated.
For further attributes, for example stapling or hole punching, SUBSERVICE elements areinserted.
White Paper - XML Import/Export Interface for HelixPW and uniFLOW / 20
All elements are listed with their GUID, if existing in the data structure. By the GUID or thename a link can be created in other applications.
4.4.1 Description of the single XML Elements
Name Type Format Description
SERVICE Element - Shows the type of service for a statistical entry.Here you can find the paper size and kind of job,for example copy A4, print A4, etc. The type canbe either parsed from the name or on the basis ofthe attribute ‘Type’ and the table below.
USER Element - Shows the user for a statistical entry. The name,as well as the GUID in the attribute ID will bedisplayed.
PRINTER Element - Shows the printer for a statistical entry. Thename, as well as the GUID in the attribute ID willbe displayed.
GROUP Element - Shows the user group for a statistical entry. Thename as well as the GUID in the attribute ID willbe displayed.
COSTCENTER Element - Shows the cost center for a statistical entry. Thename as well as the GUID in the attribute ID willbe displayed.
CARDINALITY Element - Shows the number of pages / copies.
PRICE Element XXXX.XX
Shows the price. Use a point for decimalseparation.
TIMEBEGIN Element JJJJ/MM/TTHH:MM:SS
Shows the time, when the entry has started, forexample when the print job has reached thespooler.
TIMEEND Element JJJJ/MM/TTHH:MM:SS
Shows the time, when the entry has beenfinished, for example when the print job has beentaken out of the spooler.
SUBSERVICE Element Further options for a print job, for examplestapling, hole punching, sorting etc.CARDINALITY and PRICE element show howoften the option has been used; attribute type orelement NAME show the kind of option taken.
21 / White Paper - XML Import/Export Interface for HelixPW and uniFLOW
The following table can be used to determine the types:
Description Type HEX Type Decimal
None / empty 0 0
General 0xFFFFFFFF -1
copy DIN A4 0x00010001 65537
copy DIN A3 0x00010002 65538
copy DIN B4 0x00010003 65539
copy DIN B3 0x00010004 65540
copy colour DIN A4 0x00020001 131073
copy colour DIN A3 0x00020002 131074
copy colour DIN B4 0x00020003 131075
Copy colour DIN B3 0x00020004 131076
print DIN A4 0x00030001 196609
print DIN A3 0x00030002 196610
print DIN B4 0x00030003 196611
print DIN B3 0x00030004 196612
print colour DIN A4 0x00040001 262145
print colour DIN A3 0x00040002 262146
print colour DIN B4 0x00040003 262147
print colour DIN B3 0x00040004 262148
finishing option Cutter 0x00080001 524289
Finishing option Sorter 0x00080002 524290
Finishing option HolePunching
0x00080003 524291
Finishing option Stapling 0x00080004 524292
White Paper - XML Import/Export Interface for HelixPW and uniFLOW / 22
Finishing option Binding 0x00080005 524293
(others on request)
4.4.2 DTD for Statistic Export
The following DTD validates the statistic export:
(also available under http://www.nt-ware.com/xml/MOMSTAT.dtd)
<!DOCTYPE MOMSTAT [<!ELEMENT MOMSTAT (STATENTRY*) ><!ELEMENT STATENTRY (SERVICE,USER,PRINTER,GROUP,COSTCENTER, CARDINALITY,PRICE,CARDNUMBER?, TIMEBEGIN,TIMEEND,SUBSERVICE*) >
<!ELEMENT SERVICE (#PCDATA) ><!ELEMENT USER (#PCDATA) ><!ELEMENT PRINTER (#PCDATA) ><!ELEMENT GROUP (#PCDATA) ><!ELEMENT COSTCENTER (#PCDATA) ><!ELEMENT CARDINALITY (#PCDATA) ><!ELEMENT PRICE (#PCDATA) ><!ELEMENT CARDNUMBER (#PCDATA) ><!ELEMENT TIMEBEGIN (#PCDATA) ><!ELEMENT TIMEEND (#PCDATA) >
<!ELEMENT SUBSERVICE (NAME,PDLNAME,CARDINALITY,PRICE) ><!ELEMENT NAME (#PCDATA) ><!ELEMENT PDLNAME (#PCDATA) >
<!ATTLIST SERVICE id CDATA "" type CDATA "" >
<!ATTLIST STATENTRY id CDATA "" ><!ATTLIST USER id CDATA "" ><!ATTLIST PRINTER id CDATA "" ><!ATTLIST GROUP id CDATA "" ><!ATTLIST COSTCENTER id CDATA "" ><!ATTLIST SUBSERVICE
id CDATA "" type CDATA "" >
]>