New Page 1

Switch XML Setup

1.1 Focus

This instruction is specific to the Switch application. The Switch is capable of sending XML style packets to a TCP device to provide acknowledgement advise on the delivery of messages through the MDS system.

1.2 Overview

The acknowledgement advise is available only for messages delivered by the SMTP application clients. These applications have a unique message id associated witch is passed to the Switch application. When the Switch delivers the message the XML return packet contains the unique id called a message hash and details on the delivery of the message.

1.3 XML Setup

The only setup parameters for the Switch are the TCP address and port settings for the XML Server and are located in the registry. The diagram below indicates the location of the registry and an example of the settings. Note the IP can also be a host name.

1.4 XML Packet Structure

The acknowledgement packet from the Switch has the following XML style structure.

<MessageReceipt xmlns="PagerMessageSchema.xsd">

<PagerPin>120001</PagerPin>

<MachineName>ESCAD05</MachineName>

<TimeRequested>2006-07-03 15:45:31</TimeRequested>

<MessageHash>Hash</MessageHash>

<DeliveredSuccess>False</DeliveredSuccess>

<DeliveredDateTime>1899-12-30 00:00:00</DeliveredDateTime>

<DeliveredStatus>Error 1002: Message Failed. Contact support ASAP</DeliveredStatus>

</MessageReceipt>

The "TimeRequested" field is the time from the XML PagerMessage "TimeRequested" field.

The "DeliveredDateTime" field is the time the Switch has either successfully delivered the message to the carrier or the time when the Switch or Output Client deems to have failed to deliver a message. In either case the "DeliveredStatus" field will give the error number and a message to indicate to the user what action to take.

1.5 Message Status Database

The Switch delivers messages to the output clients which in turn send status information back to the Switch on the message progress.

The status is presented close to real time in the Queue tab in the MStatus field. On completion of the message a final status is posted to the log and indicates the result of the delivery. This same status is also the status sent in the XML Acknowledgement packet back to the VisiCAD.

A list of these status codes and their meaning is shown below along with the status message sent to the VisiCAD log. This information is stored in the MDS as table MDSMStatus. The DStatus field is information displayed in the Queue tab on the Switch client.

The status field in the XML packet is a conjunction of the DescriptNo and the VCDescription field from the MDSMStatus table.

The XML field for error 1001 above becomes

<DeliveredStatus>Error 1001: Messagefailed. Contact suport ASAP</DeliveredStatus>

1.6 Message Acknowledgement Timer

The Switch will hold up to 50 acknowledgment XML packets. Each has an inertia timer set for one minute. Once the timer expires the acknowledgment packet will be removed.