This section describes the .NET Framework library provided by with the HxGN EAM Web Services Toolkit.
To use this library, a reference to the assembly "Datastream.EWS.dll" must be added from a .NET project. Additionally, some of the components in the library are designed to work with the Visual Studio Form Designer and should be added to the Visual Studio Toolbox. Once added, they can be dragged and dropped onto a Windows Form and have their properties set through the Property Editor.
The library components are designed to assist using the HxGN EAM Web Services. Some classes will be more useful than others depending on the usage scenario. Below are some common scenarios.
-
When importing one or more WSDLs, you will be working with the classes that are generated by the import process. Aside from the Session class used in all scenarios, some of the utility classes, such as SoapExceptionHelper to help parse soap exception messages and ObjectFieldLinkProvider to map object fields and controls, may be useful.
-
When retrieving data from grid web services, the lowest level class is the Grid class. This class is responsible for retrieving data using the grid web services. The data is returned in an instance of the GridData class. The GridData in turn contains an instance of GridToolbar and various pieces of information in instances of NameValuePairList.
-
When retrieving data from grid web services to be displayed using standard controls, the EWSGridDisplayManager component should be used. This component provides the most flexibility for control placement and appearance. It handles retrieving the data and displaying it in controls that have been associated with it. The component uses the Grid class internally and so it is useful to have familiarity with the same classes mentioned in scenario 2.
-
When retrieving data from grid web services to be displayed WITHOUT using standard controls, the EWSGridDisplayControl should be used. This component is the fastest method to set up due to the controls being provided. However, it is limited when it comes to control placement and appearance. It handles retrieving the data and displaying it in controls that are a built in to EWSGridDisplayControl. The control uses the Grid class internally and so it is useful to have familiarity with the same classes mentioned in scenario 2.
All scenarios should use the Session class, which is required by all web service calls to set security, session, and web service URL details.