The Hyper.Net Framework SDK in Detail
We begin by presenting the primary architecture of the HNFSDK, a set of integrated data access tools that combine to create a ready-to-use n-tier application architecture that provides object-oriented access to Hyper.Net content. This information will help you determine how to best use the HNFSDK’s varying tools and services to meet your business needs.
Figure 1 – HNFSDK Architecture
Figure 1 depicts the HNFSDK architecture, which, as can be seen, has as a backbone forming the “common tools.” From bottom to top you can find:
| |
1. |
FTP Tool. This component provides additional FTP functionality that enables the Hyper.Net Framework to support FTP protocol for content transfer. This component can be found in the assembly Hyper.Net.Framework.Microsoft.Ftp.dll.
|
| |
2. |
SGML to XML Converter. This component allows the framework to convert any HTML document into a valid XML or XHTML document. This component can be found in the assembly Hyper.Net.Framework.Microsoft.Sgml.dll.
|
| |
3. |
Common Tools. This key component inside the HNFSDK infrastructure contains many classes and functions shared between all other components. This component can be found in the assembly Hyper.Net.Framework.Common.dll.
|
| |
4. |
DAL COM+ (Data Access Layer). This component is in charge of managing the connection and resources associated with accessing the Hypermedia Data Storage database (HNHDS). It’s the foundation for all other components upwards in the Figure. It is built into a COM+ component in order to gain all the inherited benefits of a COM+ application. This component can be found in the assembly Hyper.Net.Framework.DAL.dll.
|
| |
5. |
DBL (Data Business Layer). This component is responsible for transforming information coming from the DAL into representations needed by the upper levels of the Common Tools. The DBL encapsulates all stored procedure names and parameters, as well as the knowledge needed to transform database responses into meaningful XML documents. This component can be found in the assembly Hyper.Net.Framework.DBL.dll.
|
| |
6. |
BOM (Business Object Model). This object-oriented component encapsulates all classes that represent the information of a document after transformation by the DBL. The result of accessing Hyper.Net content at the BOM level is an object-oriented representation of publications, topics, metadata, and associated components of published documents that allows you to build applications that transparently access content without understanding the data model in the HDS. This component can be found in the assembly Hyper.Net.Framework.BOM.dll.
|
| |
7. |
The following picture depicts the high-level class organization within the BOM. For a complete reference to the HNFSDK please refer to the help found in the HNFSDK installation folder.
|
| |
8. |
|
| |
9. |
Figure 2 – BOM Class Organization
|
| |
10. |
Web.UI. This component is one of the most powerful components the HNFSDK offers. It is a set of .Net Web Server Controls that encapsulate almost all the logic behind controls needed to create a typically web application. It thus eliminates almost all of the effort needed to communicate directly with the BOM or the database directly, and provides you with a way to quickly create web applications using drag-drop components. You will learn how to use this component, as well as the BOM classes, later on this document. This component can be found in the assembly Hyper.Net.Framework.Web.UI.dll.
|
| |
11. |
AppControls. This component is also a set of web server controls used for less-common tasks required when building Hyper.Net web applications. It represents higher levels of logic, and for this reason is considered within the HNFSDK as application controls. This component can be found in the assembly Hyper.Net.Framework.Web.UI.AppControls.dll.
|
| |
12. |
XML SOAP Web Service. This w3C compliant component allows any other application to connect remotely to Hyper.Net transformed data, and also provides access to the same data to applications built on non-Microsoft technologies. This component encapsulates all logic from the BOM and exposes it through an HTTP SOAP Interface. This component can be found in the virtual directory Hyper.Net.Framework.Web.Services, and the associated assembly Hyper.Net.Framework.Web.Services.dll.
|
| |
13. |
Search XML Converter. This component makes it possible to pass an XML document as parameter to a web method from the XML SOAP WS component, and to transform this document into a valid Hyper.Net Object Oriented Search Definition (HOOSD). This component can be found in the assembly Hyper.Net.Framework.XmlSearch.dll.
|
| |
14. |
Web.Services.BOM. This component is based on the Hyper.Net web service interface. It encapsulates all calls to the server, and instantiates an object oriented class framework to retrieve data, constructs an XML result document, and returns it to the calling application, similar to the BOM explained above. This component can be found in the assembly Hyper.Net.Framework.Web.Services.BOM.dll.
|
| |
a. |
Cache Cleaner. This application is in charge of cleaning up all unused and old entries in the Hyper.Net Advanced Cache System (HACS). The HACS is normally a temporary folder on disk used for fast rendition of content in any Hyper.Net web application.
|
| |
b. |
Hyper.Net XML Search Definition Tool. This application provides an easy way to build compliant and well-formed Hyper.Net XML Files that represent object-oriented searches. The files are fed to the web method of the XML SOAP WS to obtain search results.
|
| |
c. |
Log Viewer. This application allows you to visualize and browse the log files the Hyper.Net Framework tracks while monitoring milestones within the execution of threads.
|
The HNFSDK provides you with a comprehensive set of tools that allows you to rapidly build any kind of application for knowledge-share using the Hyper.Net infrastructure for document transformation.
In the following sections we will go a little more deeply into HNFSDK application development concepts, and describe how to do some quick tricks to achieve the fantastic results.
Before you start, it's a good idea to install and configure Hyper.Net, and then publish a few documents into the Hypermedia Data Store with it. Once done, you’ll have a little data in your HDS the HNFSDK can access. Refer to the Hyper.Net Installation and Configuration Guides to do this. After you have published content, you can start to follow this guide and develop custom web solutions in accelerated time.