Procedures

Accessing a Millennium SDK Web Service

You can access a Millennium SDK Web Service and check its availability by entering its URL in a web browser.  The following example shows the steps for accessing the ClientNameList Web Service.

1. Open a web browser and access the Millennium SDK's URL:

http://<ServerName>/MillenniumSDK/MillenniumSDK.asmx

A list of web services displays.

2. Looking through the list of services, you will see "ClientNameList".

3. Now, access the following URL:

http://<ServerName>/MillenniumSDK/MillenniumSDK.asmx?op=ClientNameList

If the service is running, you will see a message that you have accessed a web service but you will need more information before you can use the web service.

4. Change the URL to:

http://<ServerName>/MillenniumSDK/MillenniumSDK.asmx?wsdl

The WSDL that displays has all of the information necessary to access and use the web service.  You can save the file or access it when you need it directly from the web service.

Generating Client Code

Using the WSDL as input, a developer can develop applications that access RPC-based web services.  Several different development environments allow this generation of clients.  IBM, Sun, and Borland use Java to access web services; Microsoft uses .Net.  In both of these languages, the generated code handles the connection to the web service - allowing the programmer to concentrate on providing the data for the request and interpreting the responses returned.

If you use the Millennium SDK SOAP Client, then you do not need to generate any client code since the client is responsible for accessing the Millennium SDK Web Service.

Resources

You can find more information on web services at the following web sites:

• The World Wide Web Consortium
• Microsoft Developer Network
• Java.Sun.Com
• IBM Developerworks
• X Methods

Configuring the Millennium SDK

You can configure the data that the Millennium SDK accesses by editing settings in the web.config file.  The web.config file resides in the folder where you installed the Millennium SDK.

To change these settings navigate to the Millennium SDK folder and open the web.config file.  Next, locate and modify the following settings as necessary.

The MillenniumDIR key indicates the Millennium directory that the SDK accesses.  The SessionTimeOut key indicates how long each session will remain active during periods of inactivity.

Examples

The following examples show how you can utilize the Millennium SDK SOAP client to connect to the Millennium SDK Web Service, search for a client, and retrieve client formulas.

• Visual Basic.NET

   

  '  Declare and Create Millennium.SDK SOAP Client Dim SoapClient As New Millennium.SDK.Client.SoapClient   '  Initialize the SOAP Client '  SoapClient.Init([Location of Millennium.SDK webservice] AS String, [Millennium.SDK GUID] AS String) SoapClient.Init("http://<ServerIp>/MillenniumSDK/MillenniumSDK.asmx", [GUID])   '  LogOn to SoapClient (Only required one time) '  SoapClient.LogOn([LoginId] AS String, [Password] AS String) SoapClient.Logon("test", "test")   '  Get Client Listing '  SoapClient.GetClientListing([Search String] AS String, IncludeDeleted AS Boolean, IncludeInactive AS Boolean) Dim strXml As String = SoapClient.GetClientListing("[Search String]", False, False)   '  Create XML Document and Load XML into document Dim docXml As New System.Xml.XmlDocument docXml.LoadXml(strXml)   'Extract the Client Ids from the XML and populate a new XML string. Dim nlIId As XmlNodeList = docXml.GetElementsByTagName("iid") Dim strXmlIds As New System.Text.StringBuilder("<getClientFormulas>") Dim ienum As IEnumerator = nlIId.GetEnumerator() While iENum.MoveNext Dim j As XmlElement = iENum.Current strXmlIds.Append("<Ids><Id>" & j.InnerText & "</Id></Ids>") End While strXmlIds.Append("</getClientFormulas>")   '  Get formulas for the selected clients and append to docXml2 '  SoapClient.GetClientFormulas(XMLIds AS String) Dim strXml2 As String = SoapClient.GetClientFormulas(strXmlIds.ToString()) Dim docXml2 As New XmlDocument docXml2.LoadXml(strXml2)

   

• Visual FoxPro

   

  && Declare and Initialize Variables LOCAL loSoapClient AS Millennium.SDK.Client.SoapClient, lcReturnXML, lcClientIdsXML lcReturnXML = ""   && Create Millennium.SDK SOAP Client loSoapClient = CREATEOBJECT("Millennium.SDK.Client.SoapClient")   && Initialize the SOAP Client && loSoapClient.Init([Location of Millennium.SDK webservice] AS String, [Millennium.SDK GUID] AS String) loSoapClient.Init("http://<ServerIp>/MillenniumSDK/MillenniumSDK.asmx", [GUID])   && LogOn to SoapClient (Only required one time) && loSoapClient.LogOn([LoginId] AS String, [Password] AS String) loSoapClient.LogOn("test","test")   && Get Client Listing && loSoapClient.GetClientListing([Search String] AS String, IncludeDeleted AS Boolean, IncludeInactive AS Boolean) lcReturnXML = loSoapClient.GetClientListing("Search String",.F.,.F.) IF !EMPTY(lcReturnXML) && The Millennium.SDK webservice returned data.  Attempt to parse XML. XMLTOCURSOR(lcReturnXML,"cursClientListing") IF RECCOUNT("cursClientListing") > 0 && Client records were returned.  Extract client ids from list. SELECT iId AS ID FROM cursClientListing INTO CURSOR cursClientIds && Convert cursor to XML CURSORTOXML("cursClientIds","lcClientIdsXML",1,32,0,"") lcReturnXML = "" && Get formulas for the selected clients. && loSoapClient.GetClientFormulas(XMLIds AS String) lcReturnXML = loSoapClient.GetClientFormulas(lcClientIdsXML) && Convert XML to cursor XMLTOCURSOR(lcReturnXML, "cursClientFormulas") && Display the data to the screen SELECT cursClientFormulas BROWSE ENDIF ENDIF

   

Important:  The LogOn method also returns a SOAP Header that contains the Session Id you need to use for all subsequent calls to the Millennium SDK Web service.  This session will expire after the specified time of inactivity.  Each request to the Millennium SDK must send the Millennium GUID information along with the request.  If this data is missing or incorrect, the Millennium SDK will not process the request.  The SOAP Header includes the Millennium GUID information so you only need to set up the SOAP Header once, since each subsequent call will use the existing SOAP Header and send this Information to the Central Office SDK.

If you are using the Central Office SDK SOAP client, you can use the Init() method to set up the SOAP Header.