ECS/integrated email Online Help

XML Header & Footer

The structure of a typical XML document can be broken down into three primary sections, Header, Body and Footer. The Header and Footer sections normally contains static information which rarely varies between individual transactions. The Body section normally contains more volatile information relating to the individual business transaction.

The XML Header and Footer Maintenance is an optional configuration to assist in the development of Outbound mapping programs by allowing the maintenance of the Header and Footer sections. This aids development by allowing the configuration of the static information within ECS/integrating email, meaning that the Business Application based mapping program need only map the Body section of the XML Document.

The following example demonstrates how this principle works with a sample XML Order:

<?xml version ="1.0"?>

        <Document>
                <header>
                        <delivery>
                                <message>
                                        <messageID>XML_Order</messageID>
                                        <sent>2002-02-20T18:22:51+01:00</sent>
                                        <subject>XML Sample Order</subject>
                                </message>
                                <to>

<address>customer.services@xyz.com</address>

</to>
<from>

<address>purchasing@xxx.com</address>

</from>
</delivery>

</header>

<OrderType>Purchase Order</OrderType>
<OrderCurrency>

<Party>XYZ Supplies Ltd</Party>
<Address>

                               <AddressLine>Alphabet House</AddressLine>
                                <AddressLine>1 The Loop</AddressLine>
                                <City>Birmingham</City>
                                <State>Midlands</State>
                                <PostCode>B19 1DS</PostCode>
                       </Address>
                </Supplier>
                <Buyer>

<Party>ECS Limited</Party>
<Address>

                               <AddressLine>Commerce House</AddressLine>
                                <AddressLine>London Road</AddressLine>
                                <City>Horsham</City>
                                <State>West Sussex</State>
                                <PostCode>RH13 9WJ</PostCode>
                        </Address>
                </Buyer>
                <OrderLine>

The RED section represents the Header text which can be configured within the XML Event Header Maintenance.
The BLUE section represents the XML Document Body text which is generated by a user developed Business Application specific mapping program. .
The GREEN section represents the Footer text which can be configured within the XML Event Footer Maintenance.

The configuration of XML Event Header and Footer is optional. This information can be written with the same user developed Business Application Mapping program that writes the Body text, if preferred.

The Header and Footer can contain specific volatile information, such as Date, Time and retrieve certain key values from the ECS/XML Processor Control file. The insertion of these values is controlled by using the following special values which will be automatically replaced by the ECS/XML Processor when the XML document is generated:

Special Value	Replacement Value	Example
&YYYY	Current Year with Century	2003
&YY	Current Year	02
&MM	Current Month	12
&DD	Current Day	31
&HOUR	Current Hour	12
&MIN	Current Minute	59
&SEC	Current Second	59
&XCGUI	Unique Identifier from IEXC.XCGUI	021231125959001
&XCOGUI	Original Unique Identifier from IEXC.XCOGUI	021231125959001
&XCAREF	Application reference from IEXC.XCAREF	PO1001
&SID	Sender Id retrieved from XML Event	ECS
&RID	Receiver Id retrieved from XML Event	XYZ

Example: The previous XML Order example contained the following element in the Header (RED) section which requires the generation date, time and time zone:

This element would be defined within the XML Event Header definition as:

To configure an XML Element Translation, perform the following:

From the main "ECS/integrated email" panel click on the drop down menu "e-commerce", select "XML" then select "XML Event Maintenance" .
The "XML Event Maintenance" window will now be displayed, listing any previously defined XML Events.
"Edit" the required Outbound XML Event and click on the "Header" Command button.
The following empty window should be displayed:

Click the "Add" command button to add a new Header definition record.

The "XML Header/Footer Text Maintenance" window will now be displayed ready to accept the XML Header text, line by line or one element at a time.

A numeric Header/Footer Sequence Number is required, which should be added in increments of 10 to allow the insertion of future text lines.
The Text value refers to the actual text that will be inserted in the Header or Footer .

The following example displays the addition of the first Header Text line:

The following example displays the completed Header text according to the previous example:

The following example displays the completed Footer text according to the previous example:

<<<<< Back to ECS/XML Menu <<<<<

ECS/integrated email & ECS/ie are trademarks of Electronic Commerce Solutions, Ltd. Other brand names and product names used in this document are the trademarks and trade names of their respective holders and may be registered.