![\"Web](\"https:\/\/syncimprov.com\/wp-content\/uploads\/2014\/02\/web-service-methods.png\")
<\/a><\/p>\nTo call a business process, you need to call one of the Process Document methods. In its simplest form, the Process Document method requires three parameters:<\/p>\n
- \n
- document: the string representation of the XML document. The document must be in Unicode (utf-16) format.<\/li>\n
- password: the E1 password of the user specified in the e1user attribute of the document.<\/li>\n
- attachmentSetID: the id of the attachment set (if attachments were submitted using the CreateAttachmentSet and AddAttachmentToSet methods)<\/li>\n<\/ol>\n
Creating the input document<\/h2>\n
You can create the input document using any of the XML creation methods (XmlDocument, XmlWriter etc.). However, there is an easier way to do it: use the XML Schema to create a typed class and serialize the object to create the XML document. You can use xsd.exe to create the typed class. I prefer to use a tool called Xsd2Code to create typed classes as it is integrated with the Visual Studio IDE. You can download it here<\/a>. <\/p>\n
Side notes on Xsd2Code (see screenshots below):<\/p>\n
- \n
- Make sure that you set the target framework to your framework level and the GenerateXmlAttributes property to True<\/li>\n
- You can auto-generate the code by setting the Custom Tool property of the schema file to Xsd2CodeCustomTool<\/li>\n<\/ul>\n
![\"Xsd2Code1\"](\"https:\/\/syncimprov.com\/wp-content\/uploads\/2014\/02\/xsd2code1.png\")
<\/a><\/p>\n![\"Xsd2Code2\"](\"https:\/\/syncimprov.com\/wp-content\/uploads\/2014\/02\/xsd2code2.png\")
<\/a><\/p>\nHere\u2019s a function to create a typed object for the business process ERP.EOne.Training1 (download the solution at the end of this post).<\/p>\n
[code language=”csharp”]<\/p>\n
static string CreateDocument()
\n {
\n \/\/ create the document using the typed class
\n BusinessDocument bd = new BusinessDocument();
\n bd.processsettings = new ProcessSettings();
\n \/\/ this tells lynX which business process to execute
\n bd.processsettings.aelliusrequestid = "ERP.EOne.Training1";
\n bd.processsettings.anonymous = false;
\n bd.processsettings.debug = false;
\n bd.processsettings.e1role = "*ALL";
\n bd.processsettings.e1user = "E1USER";
\n bd.processsettings.environment = "JDV910";
\n bd.processsettings.keeprepository = true;
\n bd.processsettings.lynxapp = "LynX App";
\n bd.processsettings.lynxuser = "E1USER";<\/p>\nbd.document = new Document();
\n bd.document.input = new Input();
\n bd.document.input.AddressName = "*Test*";<\/p>\n\/\/ serialize the XML
\n XmlSerializer xs = new XmlSerializer(bd.GetType());
\n StringBuilder sb = new StringBuilder();
\n XmlWriterSettings xws = new XmlWriterSettings() { Indent = true, Encoding = System.Text.Encoding.Unicode };
\n using (XmlWriter xw = XmlWriter.Create(sb, xws))
\n {
\n xs.Serialize(xw, bd);
\n }<\/p>\n\/\/ this is XML document that needs to be submitted
\n string document = sb.ToString();<\/p>\nreturn document;
\n }
\n[\/code]<\/p>\nThis function creates an XML document that looks like this:<\/p>\n
[code language=”xml”]
\n<?xml version="1.0" encoding="utf-16"?>
\n<aelliusconnector>
\n <processsettings
\n aelliusrequestid="ERP.EOne.Training1"
\n environment="JDV910"
\n debug="false"
\n processmode="object"
\n anonymous="false"
\n e1user="E1USER"
\n e1role="*ALL"
\n lynxapp="LynX App"
\n lynxuser="E1USER" \/>
\n <document>
\n <input>
\n <AddressName>*Test*<\/AddressName>
\n <\/input>
\n <output \/>
\n <\/document>
\n<\/aelliusconnector>
\n[\/code]<\/p>\nSubmitting the document<\/h2>\n
To call the web service, you can simply add a service reference or just reference LynXProxy, a class library that is part of the product.
\nHere is a function to submit the document to the web service:<\/p>\n[code language=”csharp”]
\n static void SubmitDocument(string document)
\n {
\n WebProxy wb = new WebProxy();<\/p>\n\/\/ set the url for the web service
\n wb.SetUrl("http:\/\/yourwebserice.com\/lynxweservice\/lynxwebservie.asmx");<\/p>\n\/\/ set the credentials to access the web serivce
\n \/\/ the web sevice supports windows integrated and
\n \/\/ basic authentication. these are not necessarily the
\n \/\/ crendentails to access E1.
\n \/\/ named parameters used for clarity
\n wb.SetCredentials(userName: "userid", password: "password", domain: "domain");<\/p>\n\/\/ login to E1 through the web service
\n \/\/ this is optional
\n wb.LoginUser(userID: "E1USER",
\n password: "e1password",
\n role: "*ALL", environment: "JDV910",
\n debug: false);<\/p>\n\/\/ submit the document
\n string output = wb.ProcessDocument(document: document, password: "e1password", attachmentsetID: 0);<\/p>\n\/\/ load the XML document – you can also deserialize it
\n \/\/ to a typed object
\n XmlDocument xml = new XmlDocument();
\n xml.PreserveWhitespace = true;
\n xml.LoadXml(output);<\/p>\n\/\/ check the status of the document
\n bool success = ((XmlElement)xml.DocumentElement.SelectSingleNode("document")).GetAttribute("status") == "true";<\/p>\n\/\/ get errors
\n if (!success)
\n {
\n Console.WriteLine("Document submission failed. Errors below.");<\/p>\nforeach (XmlElement error in xml.DocumentElement.SelectNodes("errors\/error"))
\n {
\n Console.WriteLine(error.GetAttribute("description"));
\n }
\n }
\n else
\n {
\n Console.WriteLine("Document submitted successfully!");
\n }
\n }
\n[\/code]<\/p>\nThat\u2019s it! As you can see, it is pretty straightforward to create the input and call the business process through the web service.
\nHere is the link to the Visual Studio (2010) solution.<\/p>\nLynXDemo<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
In this post, I’ll describe how to call a (LynX) business process through the web service. Note: This post assumes that you are calling the web service from .Net. The web service can be called by any external app that … Continue reading