XML Transaction Control

XML Transaction Control allows you to display the list of inbound and Outbound XML Transactions, with the option to drill down to view the detail of each XML Transaction. 

The primary use of XML Transaction Control is to view the status of XML Transactions and to reset transactions in Error following the resolution of the original reason for XML Processing failure. 

To display the XML Transaction Control, perform the following:

• From the main "ECS/integrated email" panel click on the drop down menu "e-commerce",  select "XML" then select "XML Transaction Control" .

• The "XML Transaction Control" window will now be displayed, listing all XML Transactions:

       

• The options for Event Filter and Status Filter enables the user to configure which XML Transactions are listed. Clicking on the Event Filter drop down prompt will display all the XML Events that have been previously defined. Clicking on the Status Filter drop down prompt will display all the possible Status codes. Selecting "*ALL" will display all records .  

• Selecting an individual Transaction and clicking Delete will physically delete the Transaction Control record (File: IEXC) and all associated XML transaction detail records (File: IEXT)

• Selecting an individual Transaction and clicking Reset will reset the status of the transaction in error to change the Status to "RDY".  Note: Only Transactions in an Error status (ERR) can be reset. 

•  Clicking the Refresh button will update the XML Transaction Control Panel with any changes.  

• Selecting an individual Transaction and clicking Display will display the detail of the XML Transaction Control record. The following panel should be displayed: 

• The XML Transaction Control Detail panel is an information panel, displaying the full details of the individual transaction control record:

• Transaction Ref is the Unique transaction identifier that is automatically assigned by the ECS/XML Processor. The format is the processing date/time stamp followed by a sequential counter (YYMMDDHHMMSSxxx)

• Direction can be Inbound or Outbound.

• Event Id is the associated XML Event Id that this Transaction relates to.

• The Trading Partner name relates to the XML Event Id linked to this Transaction.

• The Sender Id contains the Trading Partner Identifier of the sender of the XML Document. The Sender Id is a mandatory entry and may be required by the Business Application when mapping XML data.  

• The Receiver Id contains the Trading Partner Identifier of the receiver of the XML Document. The Receiver Id is a mandatory entry and may be required by the Business Application when mapping XML data.   

• The Protocol contains the form of communications used for sending Outbound XML Transactions. This is a required entry for Outbound Events which is not used by ECS/integrated email. The Protocol is used by external communications applications  to determine how the XML document should be transmitted to the Trading Partner if ECS/integrated email is not being used to deliver the XML Documents. 

• The Input Path is only used for Inbound Transactions and contains the full path of where the input XML document was selected from.

• The Output Path is used for Inbound and Outbound Transactions and contains the full path of where the XML document was placed following processing. 

• The Application Reference can be populated by the Outbound Application Mapping program (ie. Order or Invoice number) to provide a user friendly link between the XML Documents and Business Application data. Application Reference is only used for Outbound Transactions. The field XCAREF on IEXC (50AN) requires populating by the relevant application integration mapping program for this to be displayed.

• The Original Transaction Reference is used for Outbound XML Transactions only and stores the original application transaction reference generated by the Business Application mapping program. The original Transaction Reference is automatically replaced with the unique Identifier conforming to the ECS/XML Processor standards.

• The Last update User, Date and Time of the related XML Transaction Control record is displayed. 

• The XML Transaction Control Status can be one three possible options, RDY, ERR or FIN. The definition of the status codes differs according to the transaction direction: 

  • Inbound  Transactions:

    • RDY - The ECS/XML Processor has successfully processed the Inbound XML document and the data is ready to be mapped to the Business Application. This status code is assigned by the ECS/XML Processor.

    • ERR - The ECS/XML Processor has failed to process the Inbound XML transaction and has emailed an Error report to the designated XML Event Administrator. This status code is normally assigned by the ECS/XML Processor but can also be used by the custom mapping program to report application integration issues.

    • FIN - The data has been successfully mapped to the Business Application. The update of this status code is the responsibility of the custom business application mapping program. 

  • Outbound Transactions:

    • RDY - The data has been successfully mapped from the Business Application by the custom mapping program to the ECS/XML Transaction database. (Files: IEXC & IEXT). The Transaction is ready for the ECS/XML Processor convert the data to an XML Document. The update of the status code to "RDY"  is the responsibility of the custom business application mapping program.

    • ERR - The ECS/XML Processor has failed to process the Outbound XML transaction and has emailed an Error report to the designated XML Event Administrator. This status code is normally assigned by the ECS/XML Processor but can also be used by the custom mapping program to report application integration issues.

    • FIN -  The ECS/XML Processor has successfully generated the Outbound XML document and placed the file in the located indicated within the Outbound Path. This status code is assigned by the ECS/XML Processor.

XML Transaction - Error Reset 

The ECS/XML Processor uses the Microsoft XML Parser to validate the structure and content of received Inbound XML Documents and generated Outbound XML Documents. XML Transactions will be placed into an Error Status ("ERR") if there is a problem with XML Document and the error report will be automatically emailed to the designated XML Event Administrator. Once the reason for the error has been rectified it is normal to attempt to reprocess the transaction in Error. This can be performed within the  XML Transaction control detail panel.

The following is an example of the detail view of a transaction in Error, note the Error Reset command button in the bottom left hand corner, which is only displayed for XML Transactions in Error.

Clicking the Error Reset command will change the status of the XML Transaction record to "RDY", which will result in the ECS/XML Processor attempting to generate an XML Document for Outbound Transactions and the related Business Application mapping control processing the Inbound Transaction. 

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

Copyright © 1998-2003 Electronic Commerce Solutions All rights reserved.

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.