Walk Through 2

Using the Web Service with .NET (Visual Studio)

Continuing from the previous walk-through save the WSDL generated by right clicking on WSDL Url link and save to a file.

Create a new Winform application in Visual Studio. Name the project WebServiceDemoClient.

Add a Web Reference to the project. In the URL specify the full path to the WSDL file that you saved in the previous step and in the Reference name enter SEF850 and press the Add Reference button.

You should see a Web References folder added to the project.

This step of adding a web reference is to generate and include the .NET class that represents the 850 SEF file which is defined by an Xml schema, that is embedded in the WSDL. The proxy functions defined in the WSDL are not to be called as they do nothing.

Next, we add another web reference to EDI web servic to http://www.edixmlonline.com/webservices/

You should see another web reference folder.

This step of adding a web reference is to generate and include the proxy class of the actual web service that will generate and translate EDI files.

Layout the mainform to look like the following. The SEF ID should be the id created for the SEF file you uploaded and wish to use in your application. And for this example it was one that was created under the "demo" user and happens to be b5c0771a-ace2-436c-bb9e-e8ff98b2b042 .

Let's start adding code to the MainForm. First, add the necessary imports at the top of the class file.

    using WebServiceDemoClient.com.edixmlonline.www;
    using WebServiceDemoClient.SEF850;
    using System.Xml.Serialization;
    using System.Xml;
    using System.IO;

We will add a private instance variable to the form and initialize a few in the constructor of the form.

    
    public partial class Form1 : Form
    {

        EDIXMLOnlineService service = null;

        public Form1()
        {
            InitializeComponent();

            // Instantiate reference to service
            service = new EDIXMLOnlineService();
        }
    
    ...

The OnClick event for the "Login" button looks like

    private void btnLogin_Click(object sender, EventArgs e)
    {
        string sessionID = service.AuthenticateUser(txtUserName.Text, txtPassword.Text, "");

        if (sessionID.Equals(""))
        {
            txtSessionID.Text = "** login failed **";
        }
        else
        {
            txtSessionID.Text = sessionID;
        }
    }

The OnClick event for the "Generate EDI in code" button looks like

    
        private void btnGenerateEDI_Click(object sender, EventArgs e)
        {
            DateTime start = DateTime.Now;

            /*********************************
             * 
             * Define EDI document object
             * 
             *********************************/

            // Create EDI document type from proxy class generated from WSDL
            SEF850.EdiDocument ediDoc = new WebServiceDemoClient.SEF850.EdiDocument();

            // Define Interchange Header
            ediDoc.InterchangeControlHeader = new InterchangeControlHeaderISA();
            ediDoc.InterchangeControlHeader.AuthorizationInformationQualifier = "00";
            ediDoc.InterchangeControlHeader.AuthorizationInformation = "          ";
            ediDoc.InterchangeControlHeader.SecurityInformationQualifier = "00";
            ediDoc.InterchangeControlHeader.SecurityInformation = "          ";
            ediDoc.InterchangeControlHeader.InterchangeIDQualifier = "ZZ";
            ediDoc.InterchangeControlHeader.InterchangeSenderID = "SENDERISA      ";
            ediDoc.InterchangeControlHeader.InterchangeIDQualifier2 = "ZZ";
            ediDoc.InterchangeControlHeader.InterchangeReceiverID = "123456789012345";
            ediDoc.InterchangeControlHeader.InterchangeDate = DateTime.Today.ToString("YYMMDD");
            ediDoc.InterchangeControlHeader.InterchangeTime = DateTime.Now.ToString("HHMM");
            ediDoc.InterchangeControlHeader.InterchangeControlStandardsIdentifier = "U";
            ediDoc.InterchangeControlHeader.InterchangeControlVersionNumber = "00401";
            ediDoc.InterchangeControlHeader.InterchangeControlNumber = "000000020";
            ediDoc.InterchangeControlHeader.AcknowledgmentRequested = "0";
            ediDoc.InterchangeControlHeader.UsageIndicator = "T";
            ediDoc.InterchangeControlHeader.ComponentElementSeparator = @">";

            // Define Functional Group
            ediDoc.FunctionalGroupHeader = new FunctionalGroupHeaderGS();
            ediDoc.FunctionalGroupHeader.FunctionalIdentifierCode = "PO";
            ediDoc.FunctionalGroupHeader.ApplicationSendersCode = "SENDERGS";
            ediDoc.FunctionalGroupHeader.ApplicationReceiversCode = "007326879";
            ediDoc.FunctionalGroupHeader.Date = DateTime.Today.ToString("YYYYMMDD");
            ediDoc.FunctionalGroupHeader.Time = DateTime.Now.ToString("HHMM");
            ediDoc.FunctionalGroupHeader.GroupControlNumber = "000001";
            ediDoc.FunctionalGroupHeader.ResponsibleAgencyCode = "X";
            ediDoc.FunctionalGroupHeader.VersionOrReleaseOrIndustryIdentifierCode = "004010";

            // Define 1st "Purchase Order" transactionset
            ediDoc.TransactionSets = new PurchaseOrder[1];

            ediDoc.TransactionSets[0] = new PurchaseOrder();

            ediDoc.TransactionSets[0].TransactionSetHeader = new TransactionSetHeaderST();
            ediDoc.TransactionSets[0].TransactionSetHeader.TransactionSetIdentifierCode = "850";
            ediDoc.TransactionSets[0].TransactionSetHeader.TransactionSetControlNumber = "000000001";

            // Define BEG segment
            ediDoc.TransactionSets[0].BeginningSegmentforPurchaseOrder = new BeginningSegmentforPurchaseOrderBEG();
            ediDoc.TransactionSets[0].BeginningSegmentforPurchaseOrder.PurchaseOrderTypeCode = "SA";
            ediDoc.TransactionSets[0].BeginningSegmentforPurchaseOrder.PurchaseOrderNumber = "PO123";
            ediDoc.TransactionSets[0].BeginningSegmentforPurchaseOrder.TransactionSetPurposeCode = "00";
            ediDoc.TransactionSets[0].BeginningSegmentforPurchaseOrder.ReleaseNumber = "1";
            ediDoc.TransactionSets[0].BeginningSegmentforPurchaseOrder.Date = DateTime.Today.ToString("YYYYMMDD");
            ediDoc.TransactionSets[0].BeginningSegmentforPurchaseOrder.ContractNumber = "  ";

            ediDoc.TransactionSets[0].ReferenceIdentification = new ReferenceIdentificationREF[2];

            ediDoc.TransactionSets[0].ReferenceIdentification[0] = new ReferenceIdentificationREF();
            ediDoc.TransactionSets[0].ReferenceIdentification[0].ReferenceIdentificationQualifier = "VR";
            ediDoc.TransactionSets[0].ReferenceIdentification[0].ReferenceIdentification = "54321";

            ediDoc.TransactionSets[0].ReferenceIdentification[1] = new ReferenceIdentificationREF();
            ediDoc.TransactionSets[0].ReferenceIdentification[1].ReferenceIdentificationQualifier = "VR";
            ediDoc.TransactionSets[0].ReferenceIdentification[1].ReferenceIdentification = "12345";

            // Define PO1 "loop section" which is a collection of segments ...
            // ...declare 2 line items (segments)...
            ediDoc.TransactionSets[0].ArrayOfBaselineItemData = new BaselineItemData[2];

            // ... create 1st item ...
            BaselineItemData item = new BaselineItemData();

            // ... and define dataelements ...
            item.BaselineItemData1 = new BaselineItemDataPO1();

            item.BaselineItemData1.ProductOrServiceIDQualifier = "CB";
            item.BaselineItemData1.ProductOrServiceID = "000111111";
            item.BaselineItemData1.ProductOrServiceIDQualifier2 = "UA";
            item.BaselineItemData1.ProductOrServiceID2 = "002480022222";
            item.BaselineItemData1.AssignedIdentification = " ";
            item.BaselineItemData1.QuantityOrdered = 16;
            item.BaselineItemData1.UnitorBasisforMeasurementCode = "CA";
            item.BaselineItemData1.UnitPrice = 12;
            item.BaselineItemData1.BasisofUnitPriceCode = "  ";

            // ... NOTE: We add a nested loop segment of Pricing information for this (1st) item.
            item.ArrayOfPricingInformation = new PricingInformation[1];
            item.ArrayOfPricingInformation[0] = new PricingInformation();
            item.ArrayOfPricingInformation[0].PricingInformation1 = new PricingInformationCTP();
            item.ArrayOfPricingInformation[0].PricingInformation1.ClassofTradeCode = "AA";
            item.ArrayOfPricingInformation[0].Currency = new CurrencyCUR();
            item.ArrayOfPricingInformation[0].Currency.EntityIdentifierCode = "01";

            // ... add item to collection ...
            ediDoc.TransactionSets[0].ArrayOfBaselineItemData[0] = item;

            // ... create 2nd item ...
            BaselineItemData item2 = new BaselineItemData();
            item2.BaselineItemData1 = new BaselineItemDataPO1();

            // ... and define it's dataelements ...
            item2.BaselineItemData1.ProductOrServiceIDQualifier = "CX";
            item2.BaselineItemData1.ProductOrServiceID = "000111112";
            item2.BaselineItemData1.ProductOrServiceIDQualifier2 = "UA";
            item2.BaselineItemData1.ProductOrServiceID2 = "002480022223";
            item2.BaselineItemData1.AssignedIdentification = "";
            item2.BaselineItemData1.QuantityOrdered = 17;
            item2.BaselineItemData1.UnitorBasisforMeasurementCode = "CA";
            item2.BaselineItemData1.UnitPrice = 12;

            // ... add item to collection ...
            ediDoc.TransactionSets[0].ArrayOfBaselineItemData[1] = item2;

            // Define CTT segment
            TransactionTotalsCTT tt = new TransactionTotalsCTT();
            tt.NumberofLineItems = "7";

            // Define TransactionSet trailer (SE) information
            ediDoc.TransactionSets[0].TransactionSetTrailer = new TransactionSetTrailerSE();
            ediDoc.TransactionSets[0].TransactionSetTrailer.NumberofIncludedSegments = "0";
            ediDoc.TransactionSets[0].TransactionSetTrailer.TransactionSetControlNumber = "000000001";

            // Define FunctionalGroup trailer (GE) information
            ediDoc.FunctionalGroupTrailer = new FunctionalGroupTrailerGE();
            ediDoc.FunctionalGroupTrailer.NumberofTransactionSetsIncluded = "1";
            ediDoc.FunctionalGroupTrailer.GroupControlNumber = "000001";

            // Define Interchange trailer (IEA) information
            ediDoc.InterchangeControlTrailer = new InterchangeControlTrailerIEA();
            ediDoc.InterchangeControlTrailer.NumberofIncludedFunctionalGroups = "1";
            ediDoc.InterchangeControlTrailer.InterchangeControlNumber = "000000020";

            /************************************************************
             * 
             * Persist EDI document object to file and send it to the 
             * webservice for EDI generation and display the results in
             * the text box
             * 
             *************************************************************/

            txtEDIContent.Clear();

            // Declare Xml File 
            System.Xml.Serialization.XmlSerializer writer;
            string filename = @"C:\wstestclient.xml";
            StreamWriter file;

            writer = new System.Xml.Serialization.XmlSerializer(ediDoc.GetType());
            file = new StreamWriter(filename);


            // Prep. namespace
            XmlSerializerNamespaces ns = new XmlSerializerNamespaces();
            ns.Add("xsi", "http://www.w3.org/2001/XMLSchema-instance");
            ns.Add("xs", "http://www.w3.org/2001/XMLSchema");
            ns.Add("edvt", "http://www.edixmlonline.com");

            // Declare root namespace of document
            XmlRootAttribute rootAttr = new XmlRootAttribute();
            rootAttr.Namespace = "http://www.edixmlonline.com";


            // Serialize edidocument object to Xml file.
            XmlSerializer serializer = new XmlSerializer(typeof(EdiDocument), rootAttr);
            serializer.Serialize(file, ediDoc, ns);
            file.Close();


            // get the exact file name from the path
            String strFile = System.IO.Path.GetFileName(filename);

            // convert the file to a byte array
            byte[] data = null;
            // get the file information form the selected file
            FileInfo fInfo = new FileInfo(filename);

            // get the length of the file to see if it is possible
            long numBytes = fInfo.Length;
            FileStream fStream = new FileStream(filename, FileMode.Open, FileAccess.Read);
            BinaryReader br = new BinaryReader(fStream);
            try
            {
                // convert the file to a byte array
                data = br.ReadBytes((int)numBytes);
            }
            finally
            {
                br.Close();
                fStream.Close();
                fStream.Dispose();
            }
            // pass the byte array (file)
            com.edixmlonline.www.ReturnPacket pckt = service.Generate(data, txtSEFId.Text, txtSessionID.Text);

            // Reference the EDI contents (as a byte array)...
            byte[] ediData = pckt.Payload;

            System.Text.ASCIIEncoding encoding = new ASCIIEncoding();
            txtEDIContent.Text = encoding.GetString(ediData);


            MessageBox.Show("Done", DateTime.Now.Subtract(start).ToString());
        }

The OnClick event for the "Translate EDI Text (Serialized Xml)" button looks like

    
        private void btnTranslateFromEDIText_Click(object sender, EventArgs e)
        {
            ASCIIEncoding encoding = new ASCIIEncoding();
            byte[] ediInfo = encoding.GetBytes(txtEDIContent.Text);

            // pass the byte array (file) and file name to the web service
            com.edidev.edixmlonline.ReturnPacket pckt = service.Translate(ediInfo, txtSEFId.Text, txtSessionID.Text);
            // Reference the Xml contents as a bytearray
            byte[] xmlData = pckt.Payload;

            // Create an EDI document (referencing) object
            SEF850.EdiDocument ediDoc = new SEF850.EdiDocument();

            XmlSerializerNamespaces ns = new XmlSerializerNamespaces();
            ns.Add("xsi", "http://www.w3.org/2001/XMLSchema-instance");
            ns.Add("xs", "http://www.w3.org/2001/XMLSchema");
            ns.Add("edvt", "http://www.edixmlonline.com");

            XmlRootAttribute rootAttr = new XmlRootAttribute();
            rootAttr.Namespace = "http://www.edixmlonline.com";


            XmlSerializer serializer = new XmlSerializer(typeof(EdiDocument), rootAttr);

            // set up a memory stream and binary reader for the
            MemoryStream mStream = new MemoryStream(xmlData);
            try
            {
                // Deserialize the Xml string in memory into the EDI document object
                ediDoc = (SEF850.EdiDocument)serializer.Deserialize(mStream);
            }
            finally
            {
                mStream.Close();
                mStream.Dispose();
            }


            // Retrieve xml representation of proxy object through serialization
            mStream = new MemoryStream();
            try
            {
                // Serialize the Xml string to memory from the EDI document object
                serializer.Serialize(mStream, ediDoc, ns);

                // Display the xml
                UTF8Encoding utfencoding = new UTF8Encoding();
                txtXmlContents.Text = utfencoding.GetString(mStream.GetBuffer());

            }
            finally
            {
                mStream.Close();
                mStream.Dispose();
            }


            MessageBox.Show("Done");

        }

The OnClick event for the "Translate EDI File To XML" button looks like

        private void btnTranslateEDI_Click(object sender, EventArgs e)
        {
            DateTime start = DateTime.Now;

            string filename = txtEDIFileName.Text;

            // convert the file to a byte array
            byte[] data = null;
            // get the file information form the selected file
            FileInfo fInfo = new FileInfo(filename);

            // get the length of the file to see if it is possible
            long numBytes = fInfo.Length;
            FileStream fStream = new FileStream(filename, FileMode.Open, FileAccess.Read);
            BinaryReader br = new BinaryReader(fStream);
            try
            {
                // convert the file to a byte array
                data = br.ReadBytes((int)numBytes);
            }
            finally
            {
                br.Close();
                fStream.Close();
                fStream.Dispose();
            }

            // pass the byte array (file) and file name to the web service
            com.edixmlonline.www.ReturnPacket pckt = service.Translate(data, txtSEFId.Text, txtSessionID.Text);

            // Reference the Xml contents as a bytearray
            byte[] xmlData = pckt.Payload;


            MemoryStream ms = null;
            FileStream fs = null;
            ms = new MemoryStream(xmlData);
            try
            {
                // instance a filestream pointing to the
                // storage folder, use the original file name
                // to name the resulting file
                //FileStream fs = new FileStream(System.Web.Hosting.HostingEnvironment.MapPath("~/") + fileName, FileMode.Create);
                filename = @"C:\bigxmlNET.xml";
                fs = new FileStream(filename, FileMode.Create);
                // write the memory stream containing the original
                // file as a byte array to the filestream
                ms.WriteTo(fs);
            }
            finally
            {
                // clean up
                ms.Close();
                fs.Close();
                fs.Dispose();
             
            }

            // Read in the Xml file contents into textbox
            UTF8Encoding encoding = new UTF8Encoding();
            txtXmlContents.Text = encoding.GetString(xmlData);

            MessageBox.Show("Done", DateTime.Now.Subtract(start).ToString());
        }

The OnClick event for the "Generate From XML To EDI" button looks like

        private void btnGenerateFromXMLToEDI_Click(object sender, EventArgs e)
        {
            DateTime start = DateTime.Now;

            UTF8Encoding utfencoding = new UTF8Encoding();
            byte[] xmlData = utfencoding.GetBytes(txtXmlContents.Text);


            // Fill (Deserialize) proxy object with what may be only "basic" XML contents
            SEF850.EdiDocument ediDoc = new SEF850.EdiDocument();

            XmlSerializerNamespaces ns = new XmlSerializerNamespaces();
            ns.Add("xsi", "http://www.w3.org/2001/XMLSchema-instance");
            ns.Add("xs", "http://www.w3.org/2001/XMLSchema");
            ns.Add("edvt", "http://www.edixmlonline.com");

            XmlRootAttribute rootAttr = new XmlRootAttribute();
            rootAttr.Namespace = "http://www.edixmlonline.com";


            XmlSerializer serializer = new XmlSerializer(typeof(EdiDocument), rootAttr);
            MemoryStream mStream = new MemoryStream(xmlData);
            try
            {
                // Deserialize the Xml string in memory into the EDI document object
                ediDoc = (SEF850.EdiDocument)serializer.Deserialize(mStream);
            }
            finally
            {
                mStream.Close();
                mStream.Dispose();
            }


            // Serialize object back to Xml. 
            // ** NOTE** The Xml created is more informative for the service and is less prone to syntactical errors
            mStream = new MemoryStream();
            char[] buffer = null;
            try
            {
                // Serialize the Xml string to memory from the EDI document object
                serializer.Serialize(mStream, ediDoc, ns);

                // Retrieve the xml (there's got to be a shorter way to do this)
                utfencoding = new UTF8Encoding();
                buffer = new char[mStream.Length];
                buffer = utfencoding.GetChars(mStream.GetBuffer());
                xmlData = utfencoding.GetBytes(buffer, 0, (int)mStream.Length);
            }
            finally
            {
                mStream.Close();
                mStream.Dispose();
            }

            // Generate
            com.edixmlonline.www.ReturnPacket pckt = service.Generate(xmlData, txtSEFId.Text, txtSessionID.Text);
            byte[] ediData = pckt.Payload;

            ASCIIEncoding encoding = new ASCIIEncoding();
            txtEDIContent.Text = encoding.GetString(ediData);

            MessageBox.Show("Done", DateTime.Now.Subtract(start).ToString());

        }

The OnClick event for the "Validate EDI Text" button looks like

        private void btnValidateEDIText_Click(object sender, EventArgs e)
        {
            txtValidation.Text = "";
            ASCIIEncoding encoding = new ASCIIEncoding();
            byte[] ediInfo = encoding.GetBytes(txtEDIContent.Text);

            com.edixmlonline.www.ReturnPacket pckt = service.ValidateEDI(ediInfo, txtSEFId.Text, txtSessionID.Text);

            if (pckt.HasWarnings)
            {
                foreach (com.edixmlonline.www.Warning warning in pckt.Warnings)
                {
                    txtValidation.AppendText(warning.Description + System.Environment.NewLine);
                }
            }

            MessageBox.Show("Done");

        }

The OnClick event for the "Validate XML Text" button looks like the one for the EDI except that it calls the "ValidateXml" service operation.

Run the Application

Note

You will find that the raw Xml from the Translation service will not validate as well as the Xml created from a serialized proxy object. This is because the serialized xml is more complete and is dictated by the proxy class that was created based on the rules defined in the schema information found in the WSDL. Whereas, the translation service forumlates its xml reply based on the EDI payload and the rules defined by the SEF file.

So, the raw xml file from the translation service is not an accurate representation of EDI payload, you must deserialize it into a proxy object and interrogate the properties of the object.

EDIXMLOnline

Using the Web Service with .NET (Visual Studio)

Note

Register for an account and start programming with the EDIXMLOnline web service. We provide you with a few SEF files in your account for you to use.