EagleML Root Node Overview and Examples

The <EagleML> root node is responsible for recognizing the message as an EagleML message. It is built to contain several constant attributes and two variables depending on the type of the message you are sending.

The following table lists the root node attributes.

Attribute

Valid Values

Required

Comment

Attribute

Valid Values

Required

Comment

xmlns

http://www.eagleinvsys.com/2011/EagleML-2-0

Y

Represents the EagleML namespace. Constant value.

xmlns:xsi

http://www.w3.org/2001/XMLSchema-instance

Y

Represents the standard W3C namespace. Constant value.

eaglemlVersion

2-0

Y

EagleML version. Constant value.

eaglemlType

EntityTransactionMessage, AccountingTransactionMessage, ReferenceTransactionMessage, WarehouseTransactionMessage, Acknowledgement, Exception, CorrectableRequestMessage, NonCorrectableRequestMessage, RequestTaskStatus, RunTaskRequest, TaskAcknowledgement, TaskStatusRequest, TaskStatusResponse, TaskAlert

Y

Variable. Should correlate with the type of the message you are sending and match the xsi:type attribute.

xsi:schemaLocation

http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd

Y

Path to the main EagleML XSD file. Constant value.

xsi:type

EntityTransactionMessage, AccountingTransactionMessage, ReferenceTransactionMessage, WarehouseTransactionMessage, Acknowledgement, Exception, CorrectableRequestMessage, NonCorrectableRequestMessage, RequestTaskStatus, RunTaskRequest, TaskAcknowledgement, TaskStatusRequest, TaskStatusResponse, TaskAlert

Y

Variable. Should correlate with the type of the message you are sending and match the eaglemlType attribute.

eaglemlRevision

a number: 199, 200, 201, 202 etc

 

An optional informational attribute, not required in the incoming message. This attribute is added when you perform an extract. Represents the EagleML revision at the moment of extraction.

EagleML Root Node Examples for Data Objects

Root Node for Accounting Data Objects

<EagleML xmlns="http://www.eagleinvsys.com/2011/EagleML-2-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" eaglemlVersion="2-0" eaglemlType="AccountingTransactionMessage" xsi:schemaLocation="http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd" xsi:type="AccountingTransactionMessage">

Root Node for Entity Data Objects

<EagleML xmlns="http://www.eagleinvsys.com/2011/EagleML-2-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" eaglemlVersion="2-0" eaglemlType="EntityTransactionMessage" xsi:schemaLocation="http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd" xsi:type="EntityTransactionMessage">

Root Node for Reference Data Objects and SMF Data Objects

<EagleML  xmlns="http://www.eagleinvsys.com/2011/EagleML-2-0"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  eaglemlVersion="2-0"  eaglemlType="ReferenceTransactionMessage"  xsi:schemaLocation="http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd"  xsi:type="ReferenceTransactionMessage">

Root Node for Warehouse Data Objects

<EagleML xmlns="http://www.eagleinvsys.com/2011/EagleML-2-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" eaglemlVersion="2-0" eaglemlType="WarehouseTransactionMessage" xsi:schemaLocation="http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd" xsi:type="WarehouseTransactionMessage">

EagleML Root Node Examples for Control Messages

Root Node for Run Task Request (RTR) Messages

<EagleML xmlns="http://www.eagleinvsys.com/2011/EagleML-2-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" eaglemlVersion="2-0" eaglemlType="RunTaskRequest" xsi:SchemaLocation="http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd" xsi:type="RunTaskRequest">

Root Node for ACK Messages

<EagleML xmlns="http://www.eagleinvsys.com/2011/EagleML-2-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" eaglemlVersion="2-0" eaglemlType="TaskAcknowledgement" xsi:SchemaLocation="http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd" xsi:type="TaskAcknowledgement">

Root Node for TSR Messages

<EagleML xmlns="http://www.eagleinvsys.com/2011/EagleML-2-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" eaglemlVersion="2-0" eaglemlType="TaskStatusResponse" xsi:SchemaLocation="http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd" xsi:type="TaskStatusResponse">

Root Node for Alert Messages

<EagleML xmlns="http://www.eagleinvsys.com/2011/EagleML-2-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" eaglemlVersion="2-0" eaglemlType="TaskAlert" xsi:SchemaLocation="http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd" xsi:type="TaskAlert">

Â