• Introduction
• Acknowledgements
• The Web is a different country, and things are done differently there…
• Web Browser/Server Interaction
• The Browser Interface is Limited...
• ... But not as Limited as you think
• Ajax/Web 2.0
• The Browser Interface has its own Navigation
• The Browser Interface is Stateless
• Sessions
• Parameters (Values)
• Cookies
  • Session ID Cookie Name
• Unique, Unchanging Keys
• A Moment in Time
• Threads
• Thread Pools
• Services
• Frames or Not
• TLS (formerly known as SSL)
• Template Overview
• WebServer Procedure
• WebHandler Procedure
• NetWeb Page
• Tags
• FrameSet Extension
• Web Border Extension
• Web Menu Extension
• NetWebSource Procedure Template
• Generic Pages
• Responsive Layouts
• Forms
• Browses
• Global Variables
• Deployment
• Multiple Data Sets
• Reports
• Dates
• Multi-DLL
• Using Browses and Forms on Static Pages
• HTTP Compression
• Anchors
• Translations
• Authentication
• Multi-Tab
• PHP
• Web Sockets
• IP Banning
• Request Filtering
• Host Variables
• Popup Animations
• Paths
• Guide to WebServer Examples
  • Basic Browse and Form
  • Basic with Menu
  • Basic with Login
  • Frame with Menu
  • Basic Combined Browse and Form
  • Basic SSL
  • Login Before Frame
  • Mixed SSL
  • Always SSL
  • Basic Graph
  • Send Email from a Browser
  • PDF Report (using Clarion 6 EE functionality)
  • PDF Report (using PDF-XChange from Tracker Software)
  • Select Item from a list, then filter on that selected item
  • Multi-DLL ABC example
  • Browse In Form example
  • Relational Update Example
  • Browse To Another Form
  • Form to Form
  • Parent Child Browse
  • File Upload / Hotfields / Logging
  • Frame with Task Panel
  • Buttons
  • Basic XML
  • Hyperlinks
  • Accounts
  • Error Page
  • Drop Filter
  • Calculator
  • Time Fields
  • HTML Editor
  • LegacyBasic
  • LegacyReportRequiresC6EE
  • Example of using Capesoft MessageBox in a Web Server
  • FileDownload
  • LegacyGraph
  • SOAPServer (requires xFiles version 2.86 or later)
  • AccessLevels
  • WScriptActiveX
  • Timers
  • Pages
  • Tagging
  • Locators
  • MultiRow
  • Validation
  • Excel
  • Services
  • Menus
  • Tabs
  • Php
  • MultiSite
  • CPCSReport

The goal of this document is to show you how to use the NetTalk NetWebServer class to create an interface in your program, that can be accessed by a user using a web browser. We have tried to write this from the point of view of a programmer who has never done web programming before. So some of these concepts may seem trivial to you.

Before you can begin writing a Web Server, there are some general ideas and concepts that are worth understanding. This document will cover the basics, as well as discuss some NetTalk specific conventions and features. Other documents will cover each of these items in more depth, the goal here is not to cover every possibility, but rather to get a good grounding in what is available.

The NetTalk Web Server is provided as two layers. The first layer is the NetTalk Web Server classes. These classes are the foundation of any NetTalk web server program.

The second layer is the template framework. I need to stress that this framework is not prescriptive in the sense that this is not the only way to build your web server. It is offered rather as a particular way you may want to build your server. We have found it very useful when coding our own web applications, however you will need to evaluate it carefully to see if it meets your needs.

The best way to learn the class layer in more detail, is probably to start by using the template framework layer. Once you are comfortable with that, and how that works, then you can experiment a bit with different approaches. One positive aspect of the template framework is that you can use all of it, some of it, or none of it, depending on what you prefer. You can also mix “hand-coded” pages with template pages without any problems.

There isn’t a lot of structure in this document, many different and varied topics are discussed. We recommend reading through this document as you would a book. If you’re not 100% sure about something then skip over it for now and keep reading. Later on, especially once you’ve built a couple applications of your own, much of it will make sense.

We recommend returning to this document from time to time as the understanding of it will grow as your experience grows.

There is no point in re-inventing all the really cool features that are currently available to web developers. What we’ve done is integrate the ones we really like into NetTalk. A full list of the scripts, their owners and licenses are included here. Our grateful thanks go out to all the authors involved in these projects.

If you find scripts that you think should be integrated into NetTalk Web Server, and if they are suitably licensed, then please let us know. No promises, but we’re always open to suggestions. 

There have been numerous dedicated web developers who have fed me more bug reports, and feature suggestions than I could possibly handle. You know who you are. My thanks to you all.

Traditionally in striving to make web development for Clarion programmers as simple as possible every attempt has been made to hide the differences (between Win32 programming and web programming) from the programmer. However for some of the other Clarion web options available in the past this has lead to inefficient models, which sooner or later result in programmer frustration. We hope to avoid this problem, and so at some times the differences between web and win32 become visible.

Thus understanding some of the crucial differences is important to understanding how the server works, which in turn leads to easier programming.

Before we start discussing how to build the web server using NetTalk, we’d like to take a moment to highlight some of the differences between a Win32 application, and a web application. We’ll also cover some basic web server/web browser concepts.  You’re probably aware of some of these, but they’re worth mentioning again.

Caveat: Some of the statements below are untrue. Like the way that saying "the world is round" is untrue. In some cases details that are unimportant to the point being discussed are either ignored or conveniently forgotten.

A web browser is an incredibly simple beast. A Server is even simpler.

Despite all the really fancy things you’ve seen web pages do, underneath the skin the Browser and Server follow very simple ideas. So simple in fact that most often people are left asking “is that all?”

A web browser can only do 3 things:

1.        GET a page from a server.

2.        POST information to a server, accepting whatever page the web browser sends in reply.

3.        Display the page.

On the other side all a server does is:

1.        Respond to a GET by loading that file off the disk and sending it to the browser.

2.        Respond to a POST by doing “something” and loading a file off the disk and sending it to the browser.

This is remarkably simple, yet at the same time remarkably powerful. But not, as it turns out, powerful enough.  In order to make it more powerful a small, subtle, change was added on the server side.

1.         Respond to a GET by loading that file off the disk, parsing it, and sending it to the browser.

2.         Respond to a POST by doing “something”, load a file off the disk, parse it, and send it to the browser. OR

3.         Respond to a GET or a POST by generating a page dynamically, and returning it to the browser.

The server-side power, sometimes called server-side-scripting is in the small Parse step above. Note that the client does not see the unparsed page. As far as the client is aware the page came off the disk just like that.

Of course for the parsing to be useful, the page needs to contain instructions that the server understands. Thus if your server is IIS you can use ASP instructions. If your server is Apache then PHP is ideal. The NetTalk web server uses its own special tags – and we’ll cover those in more depth in a moment.

This is the most obvious statement of all. The set of native controls available in a browser are quite poor. This is both a positive thing (you are forced to redesign your interface to reduce complexity) and a negative thing (you can get fancy, but only by using client-side tools, like JavaScript).

The immediate temptation is to spec your Browser interface to have all the bells and whistles of the Windows interface. Before you go too far down that road, I recommend making your first iteration of the site as “clean” as possible. Start by making the site work. Then work on making it slick. One big plus in using templates is that changing basic behavior on a global level is not too difficult.

Most customers, and most developers dismiss web programming as providing exceptionally poor performance and usability to the user. A decade of bad web apps have convinced developers that the fundamentals of the web itself do not allow for good quality applications. This belief is just wrong. The web is capable of highly interactive, highly responsive applications. It's not the same as the desktop, that's true, but the abilities of the web go far beyond what most web apps aspire to.

You may have heard much recently about the so-called Web 2.0. Or you may have heard of the term AJAX. You may also know that both of these items are very loosely defined, and seem to apply to a broad spectrum of functionality rather than any one specific thing.

The NetTalk Web Server uses AJAX techniques in many of the templates that are provided. However the mechanics of this are completely invisible to you the programmer. If asked, yes, your application uses AJAX.

Fancy though this may seem, it’s ideal if your client does not notice that your site employs the latest, greatest technology. Frankly he probably doesn’t care about the technical details. (And to some extent, neither should you.) AJAX techniques are not impressive to end users because they accomplish things that have been happening in Windows programs for over 10 years. Getting those effects in a browser may impress the techie in you, but don’t expect your customers to leap with wild unabandoned joy.

Although the web browser “Back” and “Forward” buttons can be hidden, the user can still do these options by right-clicking on the page. When a user does this no request is sent to the server. The browser simply changes page without the server knowing. Thus for the server to attempt to know “where” the client is, is useless. The client browser may be literally anywhere in the program at any time.

To make matters worse, clients can “bookmark” a page and return there at any time in the future. They can type any URL into the address bar at any time. They can abandon a form, or indeed your whole site, without letting you know.

In short, the navigation around your web application is a lot more fluid than the fixed navigation around a Windows application. This has an effect on the way some things are constructed, and some items (which may seem strange at first) are designed to cope with this issue.

The most basic concept of a program that you have deep in your subconscious is that a program is stateful. By that I mean it not only always knows “where” you are, but if you depart (for example to a lookup) you can always return, and local variables will be as they were when you left them. Consider the following situation (in regular Windows programming):

1. You are on a menu, and you click on the Employee Browse button.
2. Up pops the employee browse.
3. You enter a locator and jump to the people starting with J.
4. Clicking a lookup button, you select the date range for when the employee was hired.
5. Returning from the date lookup, you notice the J employees are still located.
6. Highlighting an employee, you click on Update, change the phone number and click Ok,
7. and go back to the Browse.
8. The J’s are still located, and the date range is still as you left it.
9. This is all so normal you don’t even notice it.

This scenario can be drawn something like this:

The sequence shown above is so basic it’s almost the first thing you learned when you were programming. It’s so basic that you’ve forgotten it even exists. That’s simply how things are.

If you like, take a moment now to consider what you’d need to do if the following restriction was added to your programming language:

“Only 1 window can be open at a time – If you make a call to 1 procedure, you must at the same time, close the existing procedure.”

In web programming, specifically stateless web programming, that’s exactly the restriction that is added. Actually it’s slightly worse than that, but we’ll get to that in a minute.

The browser, as a client-side tool, has absolutely no idea where it is in the program. And the server sees each specific request (from the browser) in isolation. In the windows program above, the lookup, and form, knew to return to the browse when done. The range and filter set on the browse did not change simply because we went to the form.

Let’s consider the same set of actions as seen by a web server.

1. The user goes to the menu.
2. Clicks a button which goes to the Browse. (The menu closes.)
3. Enters a letter, and goes to the Browse (The original browse closes.)
4. Clicks the lookup-date-button and goes to the calendar screen. (The browse closes.)
5. Clicks the OK button and goes to the Browse. (The lookup closes.)
6. Clicks the update button and goes to the Form. (The browse closes.)
7. Clicks the OK button and goes to the Browse. (The form closes.)

Drawn, it looks like this.

Notice that in a web server program, you never go back. In the description and picture above you never go back to the browse. You always go forward to the next browse.

In a purely stateless world, the date lookup would clear the locator. The Form edit would clear the locator and the date filter. Not surprisingly programs written in a purely-stateless world are extremely limited (at least for what we’re trying to do.)

The solution to this issue always falls into one of the following 3 approaches;

1.         Store variables in the browser, as cookies. This works as long as the data being stored is very limited, and as long as the user has cookies turned on.

2.         Pass all the necessary variables from one page to the next on the “command line” ie as part of the page address. While workable, and infinitely scalable (from a number-of-servers point of view) there are limits to the length of the command line.

3.         Create a “session” on the server. Store all the variables inside this session. All you need to know is what Session belongs to the client (which is passed in a cookie), from this you can set appropriate default values onto pages being delivered. This is the primary approach taken by NetTalk.

Probably the closest equivalent is writing a program where there are only global variables, and procedure parameters, but no local variables.

Unfortunately with web programs there is one more wrinkle. There may be more than 1 user accessing the same program at the same time. Each user needs his own variable space. For this reason we use a Queue, and hence we talk about the SessionQueue.

[Aside: Later on we’ll see that this may not be a Queue at all, but that’s not important right now. Think of this big variable storage area as a Queue.]

The single biggest difference between a Windows program, and a Web-Program is the issue of persistence.  In a Windows program one person is running a copy of the program, and that copy belongs to them. When they’re done they close the program. With the web there’s only one program, being shared by many users at the same time.

This would be fine if each page was completely independent of each other. But in even simple programs this is not the case.

In order to maintain the state of all the server-side variables for each user, the idea of a Session is used. As long as the user keeps passing their session number with each request then the server is able to keep track of the user. In NetTalk the session ID is passed as a cookie with each request, so the mechanism for this is completely invisible to you.

Internally the settings (variables) are stored in a Queue, called the Session Queue. You can also use the Session Queue yourself to store your own variables for each user. There are methods to read and write values in the Queue.

When the Browser asks for a page, it is also possible for it to pass parameters to the server. If the request takes the form of a GET then the parameters appear in the URL. In the log you can see them here:

When the request takes the form of a POST can appear in the URL, or they can appear below the header. In the log they look like this:

Regardless of whether the request is a GET or a POST, all these values are automatically parsed for you and placed in the Value Queue.  If a value appears in both the POST section, and the URL then the URL value takes precedence. (If a cookie exists with the same name, these overwrite the cookie value in the Value Queue.)

You can use the method

value = p_web.GetValue('name')

to get the current value, and

p_web.SetValue('name','value')

to set the value to a specific value. To determine whether a value exists use

p_web.IfExistsValue('name')

These settings are only available during the course of this thread. They are not (by default) stored for use in other threads. If you do want to save them, then be sure to write them into the SessionQueue.

As we'll see later this is an important point. Indeed in most cases, should you need to work with a value directly, all you should be doing is storing it in the session queue. Then in all other places in your code you use only Session Queue data. The method to store a value is

p_web.StoreValue('name')

Warning: Some people turn the cookies functionality off for various reasons. NetTalk depends on the cookie mechanism to pass the Session ID with each request. The use of cookies though should be used sparingly. There are very few cases, outside the Session ID, and possibly login information, where cookies are actually required. Data should be stored on the server, not the client.

A Cookie is a value, sent by the browser. This value is attached to all GET's and POST's which you receive from the browser. Incoming cookies are automatically parsed for you, and added to the Value Queue.

In order to set a cookie in the Browser you use the

p_web.SetCookie('name','value')

method.

If used like this then the cookie will be valid in the browser for as long as the browser is open, but will then be discarded. To make the cookie more permanent you need to set the date, and optionally the time, when it will expire.

p_web.SetCookie('name','value',ExpiryDate,ExpiryTime)

The ExpiryDate and ExpiryTime are standard Clarion Date and Time fields (ie LONG's). Note that the time and date are relative to GMT time, not the time of the browser, or the time of the server.

To delete a cookie currently being stored in the Browser use the DeleteCookie method

p_web.DeleteCookie('name')

Note that cookies can only be accessed by the site that "wrote" them. It is not possible to access the cookies placed in the site by another browser.

Example 7 contains an example of using cookies. In this example the LoginForm procedure saves the value of the login and password fields, for 30 days, so if the user returns to the site the login is "remembered".

There is no need for special functionality to "Read" the cookie. All the cookies that belong to a site are sent automatically by the browser with every single request. These are automatically placed in the Value queue for you so you can read them using the normal p_web.GetValue('CookieName') syntax.

Remember though, there are almost no cases where a cookie is the right solution to the problem. In almost every case where you think you might need a cookie, the Session Queue, or a User Data Table is a better place to store the data. 

Tip: Cookie names, like all HTML field names cannot contain a colon. However if the name contains a double-underscore, then that will be translated into a colon by GetValue. For example;

p_web.SetCookie('Loc__Login','NetTalk')
would be accessible using
p_web.GetValue('Loc:Login')

Session ID Cookie Name

Browsers understand 3 languages, and none of them are Clarion. ul>

HTML is the "Markup language" - this contains the Structure of the document. HTML is made up mostly of <tags> which describe the structure of the text being displayed.

CSS is the "Visual language" - this determines what the page looks like, and (some of) the page layout.

JavaScript (which is Not Java) is a programming language with variables, and loops, and things like that, which is able to manipulate both the HTML and the CSS on the page.

As a NetTalk developer you do not need to know any of these languages in order to get started. However you will find yourself picking up HTML as you go, and likely learning CSS as well. More advanced developers will also start using a line or two of JavaScript in strategic places.

Your NetTalk app will make use of all three languages, by generating HTML, and by including the default NetTalk CSS and JavaScript files.

NetTalk includes, the jQuery JavaScript library. jQuery contains some fantastic JavaScript code, which we use as a building-block, and also some UI components that improve the user interface of your NetTalk site. It also contains a "standard" theme, based on a system called ThemeRoller, which allows for easier changes to the CSS files. jQuery is also a "pluggable" system with a large number of plugins already available on the web.

With the NetTalk WebServer we’ve tried to place as few limits as possible on the programmer. We like flexibility ourselves, and we appreciate it in the tools we use. But every now and then we need to impose a condition simply because without it the system will not work.

As far as your tables goes, the NetTalk Web Server requires tables to have at least 1 unique, unchanging key. This is so that records that are used in one place, and have to be reloaded in another, can be properly identified.

Consider for example a Form. When a form is opened, so that a record can be changed, the record is read into memory, and displayed in the web page. Then that thread finishes. Later on the user clicks Save (after editing some data). At that point the original record is reloaded, the changes applied, and the record is saved. But the system needs to know which record was being edited in order to do this. If the user were allowed to edit the very field used to identify the record it could not then be reloaded.

If you had the luxury of going to University you’ll probably already have this key. Good database design courses teach this approach anyway as a pre-requisite to having a good database design.

If you don’t have a unique, unchanging key then you can add one to your tables. Set the key as AutoNumbered, and forget about it.

If you are using the CapeSoft Replicate product in your dictionary then you’ll already have a non-changing unique key in the GuidKey that Replicate requires. You can use this key as your unique key in NetTalk WebServer.

The Server interacts with the browser in a very specific way. The Browser makes a GET or a POST (as we saw above). The server responds by providing a web page. Once that’s done (typically taking a small fraction of a second) the server then forgets all about the request. During that time there may be instructions to copy items in, or out, the Session Queue, but once the page is delivered it is immediately forgotten.

Of course the Browser doesn’t forget. It displays the page to the user for as long as the user likes. The user then clicks a button, or a link, and another POST or GET is sent to the server. For another brief instant the server awakes, does some work, and forgets.

This is a very efficient approach because there are no resources (no RAM or CPU) on the server being used for the time the user spends staring at the screen. Thus supporting many users “at the same time” is not a big problem, because each request uses the server resources for a very brief period of time. Compare this to the WebBuilder, or Terminal Server approach of having a complete copy of the program, in memory, for every single connected user, for the duration of their entire session from start to finish.

I cannot stress this enough - There is no "connection" between the Browser and the Server. This is why it is impossible for the server to "push" information into the browser. The browser makes a request, gets a reply, and the connection is severed.

Every time the user does something (clicks a link, clicks a button, etc) a request is sent to the server. Each request processed by the server is done on its own thread. In other words;

a.         A request arrives at the server'

b.         A new thread is started to handle the request'

c.         The thread immediately performs any actions, and sends a page back to the browser'

d.         The thread ends.

Thus unlike a windows program, the lifespan of each thread is very short.

The Web Server is capable of managing multiple requests simultaneously.

By default each incoming thread is processed on its own thread. The request comes in and the WebServer starts a thread for the WebHandler. The WebHandler then processes the request, and returns the reply. The thread then ends.

In a normal application the "cost" of starting and ending the thread is very small. So this approach is both simple, fast and effective. However the time it takes to start the thread is proportional to the amount of global threaded data and objects that you have. The biggest part of the data is of course the number of THREADed tables in the dictionary.

Therefore in some apps the cost of starting and ending threads becomes significant. To overcome this problem a feature called "Thread Pooling" exists.

Please Note: Thread Pooling cannot be used in the Multi-Site host application. If an application is used as a DLL to the Host, then the thread-pooling features there will be ignored.

The idea is that instead of closing when the request completes, the thread hangs around for a bit. If another request comes in then the WebServer can pass the request to the existing thread, instead of having to create a new thread. If the thread is not used for some period of time then it quietly closes in the background.

To make use of thread Pooling virtual no changes need to be made to the app. All that has to be done is;
a) The creation of a WebHandlerPoolThread procedure and
b) The activation of the feature in the WebServer procedure

Create the WebHandlerPoolThread procedure

Activate Pooling in the WebServer procedure

IIn Windows a program usually runs only after a user has logged in. However if you are creating a Server program then typically you want it to run before a user logs in. (For many servers, no user logs in at all unless there are other tasks to perform.)

Services can be made in Clarion 5.5 and earlier, but they are not reliable and cannot be multi-threaded. Which means they’re pretty useless in the real world. In Clarion 6 you can turn any program into a service, either by using the Windows 32 API, or (if you’re lazy like me) by using a template. Not surprisingly we recommend SelfService (http://www.capesoft.com/accessories/selfservicesp.htm) for making services./p>

One of the first decisions you’ll need to make is if the site is going to use Frames or not. This is a key starting point, because this will determine the way you build the site.

It is of course possible to make a site that works using both Frames or No-Frames, but that is extra work, so start with one approach, and add the other approach necessary if you want to.

Frames allow you to divide the visible window (in the browser) into different “panes”. Each pane can then be updated individually, and one pane can change another.

The primary disadvantage with frames is two-fold.

a.         Search Engines struggle with them, and

b.         The address bar in the browser stops working when you have frames.

If your site is designed to be used as a program, with a login and then the ability to do stuff then Frames are good.  If your site is going to be a public site, and you want Google to search it then don’t use frames.

Sites without frames however are also a bit more flexible when it comes to layout, and give the programmer somewhat greater freedom when it comes to doing stuff. Personally I've moved away from using frames to building apps that do not use frames.

In the web world there are 2 kinds of servers. Secure servers, and non-secure servers. If you are transferring information between the server and the client that you want to protect (and almost all web apps fall into this category) then you want your server to be secured using TLS.

This is a topic that is very simple on one hand, but also can get bogged down in details very quickly. NetTalk allows you to build Secure servers, non-secure servers, and servers which do a combination of both.  This is discussed in detail in the document Building Secure Web Sites.

A very quick overview of a typical NetTalk app is useful here. Each of these parts is discussed in more detail in a moment.

1. Each web server app has a WebServer procedure and a WebHandler procedure. These handle the incoming responses.

2. The app may contain static htm pages stored on the disk.

3. The app may contain one or more NetWebPage procedures, which generate a complete HTM page on demand. You cannot embed one Page inside another Page.

4. The app may contain one or more "Control" procedures. These are things like browses and forms. They can be embedded on a page, or they can be called directly as a page.

5. The app may contain one or more "Source" procedures. These can be embedded on a page, but not called directly as a page.

     

Each WebServer you create will listen on a specific port. The default port for web servers is 80, but only one server can be listening on a single port at a time. If you are making a general purpose site, one aimed at the whole internet community then of course you will need to run on port 80.  If you are making a non-internet server (for example, you’re just making a way to access your program across the network) then you can use your own port number. Port numbers above 1000 are generally considered to be “open”.

The default port for Secure servers is 443. However any port can be secure.

An app may contain multiple web servers. Each Web server listens on a single port, but as a whole the app is listening on multiple ports.

The WebServer procedure is the procedure that listens to the open port. In the examples it’s always called WebServer, but the name is not fixed – you can call it anything you like. Obviously if you have more than one then they need unique names.

The WebServer procedure consists of a Window procedure, to which is added one or more NetTalk Objects. These objects are set to the NetWebServer base class. Some settings for the server will appear on the settings tab. The details of each setting is discussed in the reference document.

The WebServer procedure listens for incoming requests. For each request the WebHandler procedure is called, on a new thread. The name of the WebHandler procedure for this web server is set on the Settings tab.

In NetTalk the multi-site Host application was introduced. This allows a single server to share port 80 between multiple apps. For more information see the document here.

The WebHandler procedure is based on the NetWebHandleRequest procedure template. When adding this procedure it is recommended to use the NetWebHandleRequest Default .

 

The WebHandler procedure will become a good place to embed some code later on, but for now there’s no hand-code necessary here. There are also no template settings of any note in this procedure.

Each web app will contain at least 1 WebServer procedure, and at least 1 WebHandler procedure.

Many WebServer procedures can share the same WebHandler procedure.

Many NetWebServer objects can share the same WebHandler procedure, even if some of the NetWebServer objects are secure, and others are not.

Legacy Templates In order for all the Web Server features to work correctly, you need to make sure that the Smart Generate feature in the Web Handler procedure is turned on. Web Hander procedure, Extensions, NetTalk or NetSimple Object Extension, Class Tab, Smart Generate option.

A NetWebPage is the basic structure that starts each web page. On this page you can place your own HTML code, menus, Browses, Forms and so on.

To Create a new page use the NetWebPage Procedure Default.

Each page has a number of settings which are described in the Reference document.

To a Web Page procedure you can attach one or more extensions. These extensions include:

NetWebFrame - Frame Extension

NetWebBoder - Border Extension

NetWebMenu - Menu Extension

Each of these extensions will be discussed in more detail in a moment.

Using HTML you can describe the content of the page, including other NetWeb controls (such as Browses and Forms.)  You can also embed custom HTML source, from other procedures in your app (procedures based on the NetWebSource procedure template.)

It should be noted that you cannot embed another page on this page.

An example of a simple NetWebPage can be found in example 1.

In this example the IndexPage procedure contains the following HTML;

<!-- Net:PageHeaderTag -->
<!-- Net:MailboxesBrowseControl -->
<!-- Net:PageFooterTag -->

Essentially this page is made up of 3 parts. Each part is constructed by a separate procedure in the app.  Using the NetTalk tag system procedures can be embedding on the page.

 

A NetTalk Tag is basically a wrapper around some variable, or procedure, that you want to include at this point in the page.  It takes the form

<!--Net:Something -->

In this case that Something are procedures, so the HTML generated by those procedures are included on the page.

If the Something is not a procedure, then it might be a session variable. For example you might have a session variable and you can include that on the page. You’ll see a lot of this happening as you progress through the examples.

Static pages (usually .htm pages on disk) that contain tags have to be parsed by the server. If you use a static page on the disk these tags can still be used. However in that case the first line of the page must be

<!-- NetWebServer -->

It's important to note that you can put any tag you like into your web page, as long as you handle it in the ProcessTag method in the WebHandler procedure. However there are some built-in Tags which you can use without having to add code to the WebHandler procedure.

1. <!-- Net:FunctionName -->
   
   This tag will call the specified function in that point in the code. This can be a function based on any of the NetWeb procedures. (Note: Not all the procedures make sense at every point though.

2. <!-- Net:s:SessionVariable -->
   
   This will embed the current contents of the session variable on the web page. If the variable should be formatted (for example a DATE field) then make sure the Picture parameter of the session variable is set using either
   p_web.SetSessionValue('name','value','pic') or
   p_web.SetSessionPicture('name','pic')
    

3. <!-- Net:v:Variable -->
   
   This will display the current contents of a Parameter at this point in the web page. In other words the same as (2) above, but uses the Value queue, not the Session queue.
    

4. <!-- Net:f:FileName -->
   
   Includes a (html) file at this point of the web page. Similar to the Clarion "INCLUDE" command. Use this to include static bits of HTML, stored in static files on the disk, inside dynamic web pages.
   Tip: If the file contains raw text, not formatted HTML, then you can wrap the tag with the <pre> Html tags. For example
   
   <pre>
   <!-- Net:f:disclaimer.txt -->
   </pre>
   
   The file itself should be placed in the Web folder. It can be in a sub folder, but then the filename should contain a web-relative path. for example;
   
   <!-- Net:f:/loggedin/header.htm -->
   
   The encoding of the files can be complicated. Assuming your site is serving pages as utf-8 (which it should be doing) then ideally your files are also encoded as utf-8. Unfortunately there is no way to reliably detect if a file is encoded as ANSI, UTF-8 or UTF-16. Therefore NetTalk has to guess the format (to determine if conversion is necessary.) There are however techniques which you can use to make the guessing more accurate. The order of the assessment is as follows;
   
   A. If the file has a byte-order-mark then that will be used to know is is already in utf-8 or utf-16 format.
   B. If the file starts with the text;  <!-- utf-8 --> , then it is assumed to be in utf-8 format.
   C. If the file starts with the text;  <!-- utf-16 --> , then it is assumed to be in utf-16 format.
   D. If the file contains the text <meta charset="UTF-8"> then it is assumed to be in utf-8 format.
   E. If the file contains the text <meta charset="UTF-16"> then it is assumed to be in utf-16 format.
   F. If the second, and fourth characters in the file are CHR(0) then it is assumed the file is in utf-16 format.
   G. If all the above are not true then the file is assumed to be in ANSI format.
   
5. <!-- Net:x:SessionVariable -->
   
   This is exactly the same as a session variable, except that the contents of the variable will not be xml encoded. Use this when you expect the session value to contain actual HTML code (which you want the browser to see as actual HTML code.) In this case however you are required to make sure the contents are actually xHTML compliant.
6. <!-- Net:h:HostVariable -->
   
   Host variables are like session variables except that they are "global" to all sessions. For more information on host variables see Host Variables.
7. <!-- Net:d:something --> Tags
   
   The d: tag allows you to access various current date and time values and include them in html.  The following identifiers are recognised;
   

   tag	meaning
   <!-- Net:d:today-->	Display today's date, format using  p_web.site.datepicture.
   <!-- Net:d:clock-->	Display the current time, using @T4 as the format picture.
   <!-- Net:d:day-->	Display the day number in the month
   <!-- Net:d:month-->	Display the number of the current month in the year
   <!-- Net:d:monthname-->	Display the name of the current month (January, Feburary and so on)
   <!-- Net:d:year-->	Display the current year value.
   <!-- Net:d:dow-->	Display the day number in the week, (Sunday=0, Monday=1 etc.)
   <!-- Net:d:weekday-->	Display the week day name, Monday, Tuesday and so on.
   <!-- Net:d:dayname-->	Display the name of the day of the month, eg 1st, 2nd, 3rd, 4th and so on.
   <!-- Net:d:hour-->	Display the current "hour" part of the time.
   <!-- Net:d:minute-->	Display the current "Minute" part of the time.
   <!-- Net:d:second-->	Display the current "second" part of the time.

A good example of embedding browses and forms in static pages is the appropriately named Pages (47) example.

See also

 Host Variables

The Frameset extension allows you to create the frames that your app will run in.

Before making use of the FrameSet extension you need to decide if your site will be using Frames or not. See the section above entitled Frames for more information on making this decision.

A good example of the use of Frames is Example number 4 – “Frame with Menu”.

Frames, as an HTML concept, are both simple, and complex. There is no easy way to give you the power in Clarion, without also giving you some complexity, so this is by far the least intuitive of the extension templates. Taking a moment to understand frames is a good idea if you want to use them.

A FrameSet is an HTML term that denotes the breaking up of the window into multiple pieces. Each of these pieces in turn can contain either another Frameset, or a Frame. Thus it is a somewhat recursive process which can make it confusing.

To make matters worse, the manner of breaking up the window is also flexible. You can break the window into multiple rows, or multiple columns, or multiple rows and multiple columns.

Let’s use the Example 4 Frameset procedure as an example. Here’s the result as seen in the browser:

In this case the window is split initially into 2 rows. The top row becomes the Header of the eventual site. The bottom row is split into 2 columns. The left column is where we’ll put the Menu for the site. The right side of the bottom row is where the rest of the site will appear.

It’s important to note that each part of the above window is ultimately a Frame. And each Frame has a name (which you set.) By using this name (also known as the “target”) you can determine what pages appear in which frame.

The Framset page itself does not contain any HTML of its own. It just provides the “container” into which other pages, based on NetWebPage, will appear.

One way of making pages look better is by placing a border around them. NetTalk has an extension template that simplifies this for you.

All the examples use this extension in the PageHeaderTag and PageFoorterTag procedures.

The border extension includes different style possibilities, as well as allowing you to specify the HTML contents to appear inside the border.

You can use the Web Border extension on NetWebPage procedures, as well as NetWebSource procedures.

Borders are cosmetic in nature – not functional.

Menus are an important part of any app, and the Web is no different. However unlike Windows there are no standards as to how menus are implemented, or how they behave. NetTalk Web Server includes in-the-box support for 5 menu styles.  You can of course implement any menu system you like if you have a sufficient knowledge of JavaScript and HTML.

 

The first supported menu is the Chrome menu. This is a horizontal menu bar, with drop-down menu items.

The second menu style is the Accordion style. This is a vertical menu and works well in both Framed, and unframed pages. The key thing to note about the accordion style is that only one section can be open at a time. As a section is opened, the other sections are closed automatically.

The third menu style is called the Double-Drop menu. Similar to the Chrome style this menu is horizontal in nature. However the Double-Drop menu supports menus within menus, and also uses the ThemeRoller styles.

The fourth menu is the XP-Panel menu, which in NetTalk 4 was called the XP-TaskPanel menu. It is similar to an Accordion menu, except that multiple sections may be open at the same time. It is styled to be similar to a Taskpanel in Windows XP.

the TaskPanel menu is similar to the XP-PAnel. However like the Double-Drop menu, it supports both menus-inside-menus and Themeroller styles.

A procedure template called NetWebSource exists. This allows you to create HTML “snippets” that can be included in other pages. These could contain anything you like, however “Browses” and “Forms are better handled using those specific templates.

A good example of using the Source procedure in the Examples are the PageHeader, and Page Footer tags. Since the header of each page is common to all pages, this can be defined in one place (in the NetWebSource procedure) and then “embedded” onto multiple pages.

Sometimes it’s possible that you want to use a Browse, Form procedure as a page in it’s own right. NetTalk makes this possible through the concept of a generic page. If you use a control procedure (i.e. a Form, Browse) in a place where you would usually use a Page, then NetTalk will wrap the control up as a page and serve it.

It’s likely that you may have either a common header, or common footer, (or both) for these pages. In the first 3 examples you can see this in action via the PageHeaderTag and PageFooterTag procedures. These 2 source code procedures include HTML that you want included at the top, and bottom, of every generic page.

The name of the two tags are set in the WebServer procedure, under the Settings. The generic header tag is

'<!-- Net:PageHeaderTag -->'

and the generic footer tag is

'<!-- Net:PageFooterTag -->'

Notice the standard wrapping for a NetTalk tag

<!-- Net:Something -->

The use of a procedure name in a tag means that that procedure will get called and the HTML from that procedure will get generated into the page at that point.

The generic header and footer do not apply to NetWebPage pages. In example 3 the procedure IndexPage contains the following HTML – explicitly including the header and footer if we want them.

<!-- Net:PageHeaderTag -->

<!-- Net:PageFooterTag -->

In the beginning we all had desktop computers, with large screens (circa 12 inches to 17 inches) and life was easy. As time progressed though the size of screens changed dramatically - from 4 inches on the low end to 30 inches on the high end, and everything in between.

Web apps had to evolve to handle this range of sizes. They became more responsive, able to respond to different screen sizes by adopting different layouts, hiding or unhiding extra information, and so on.

A Responsive Web App is thus an app which Responds to screen size.

As the web has evolved, so NetTalk has evolved, but with the added proviso that backward compatibility is ever important.

The primary way the web evolved was to move from layout based HTML <tables> to layout based on HTML <div>'s. This change, coupled with extra power added to the CSS language allows for a much for flexible layout - one which is able to best respond to the user.

NetTalk 10 added support for DIV mode. In DIV mode all <tables> (on browses, forms and child-layouts) can be switched to <divs>. In NetTalk 10 the default is still Table layout, however in future NetTalk releases this will change to default to <div> layout. If you have an existing app you will need to switch the app manually from TABLE mode to DIV mode. This is done in the WebServer procedure, Settings / Defaults tab - on the Browse and Form tabs.

It is likely you will see some differences in your application after making this switch. In some cases the shipping CSS can be extended to better support the switch, but there are some differences you will need to understand.

Browse Width

Browse Cells

A form is a good example of the difference between a Web app, and a Windows app.

In a windows App the form procedure starts, and remains running until the user closes the window. The act of loading the record, displaying the form, validating the input, and saving to disk all takes place in one place. Importantly one single procedure drives all this functionality.

In a Web app the form behavior is split over several separate threads. When the user clicks on a link that opens the form, a thread starts which loads the record, and constructs the Html. This Html (this “page”) is passed to the browser and the thread closes.

When the Save button on a form is pressed then a second thread starts. This thread will validate the record, and save it to disk.

In a NetTalk app it is convenient though to keep all the code related to a single form in one procedure. This makes things more organized and easier to keep track of. However this one procedure performs a few different functions. Each function should be considered as distinct from the others. Local variables in the form procedure are NOT preserved between calls.  The library ends up calling the Form procedure many times. A parameter to the procedure determines which part of the process the Form procedure must now perform.

So far I’ve described the form as a Page. And that is not strictly accurate. The form is more like a Control. It can exist on a page all by itself, but it’s more likely to be just one part of a more complex page.  A web form procedure in your app is thus Not a page, but just a control to be included on other pages.

In the App a form is created using the NetWebForm procedure template default.

The specific options for the form are covered in the Reference document.

Advanced

Forms can be dynamic. In other words when the user Selects, or Accepts any of the fields, then one or more items on the form can be updated. This is done asynchronously (in the background) and allows you to make your forms highly interactive.

Some of the interactivity is already built in for you. For example if you have a lookup field, and you've entered the code and description fields of the remote table on the Lookup Settings tab, then your lookup field is already dynamic. Try typing in the code rather than looking it up. Notice the way the description changes? That's the sort of thing I'm talking about here.
Example 21, UpdateInvoices procedure, has a good example of this when selecting a customer.

Aside: Try typing in the description into the entry field and see what happens.

Adding your own interactivity to a form is a 2 step process.

First identify what needs to be changed, and when it needs to be changed. Each row of the form consists of 3 parts, the Prompt, the Value, and the Comment. Each part can be updated, and any number of parts on the screen can be updated on any event. You can also update Prompts, Values and Comments for other fields when this field changes.

The second part is embedding the correct code (in the right place) to calculate the item you want to display.

For example, let's say you want to update a Comment Field when a Value is entered. To keep it simple let's assume you're going to validate an Email field to make sure it contains both a @ and a .

So, step 1, identify (and set) the fields that need to be updated. This is done on the Client-Side tab. For the email field set Refresh: Comment on.

Then step 2. In some cases you won't need to do a step 2 because the templates are already doing it for you.

In other cases the code you've entered into the comment field may be sufficient. Like here

(In this case you've made your own function, called EmailCheck, which is doing the validation for you and returning an appropriate comment. Notice the SessionValue is always used - the whole comment field looks like this
EmailCheck(p_web.GetSessionValue('Cus:Email'))

But in some cases you'll need to embed code in the routine that generates this comment (or prompt, or value).

Remember each prompt, value, or comment field can be updated, and for each of these cells a routine has been generated called either prompt::field, value::field or comment::field where field is the name of the field. For example, in this case the entry field is cus:email, and we're looking to set the comment, so use the embeditor to find the comment::cus:email routine. In this routine is an embed point, and here you can set loc:comment to be what it needs to be. For example;

If Instring ('@',p_web.GetSessionValue('cus:email'),1,1) > 0 and |
  Instring('.',p_web.GetSessionValue('cus:email'),1,1) > 0
    loc:Comment = 'Email ok'
Else
  loc:Comment = 'Email not ok'
End

In the prompt embed point you would set loc:prompt and in the value embed point you would set the Sessionvalue of the field, using p_web.SetSessionValue('fieldname',value).

Debugging Tips

It can be quite hard to debug this asynchronous updating when it's not working. Since there are different parts involved it's hard to know where to look, and which part of the process isn't working. Here's one process you can use to help identify the source of the problem.

1) Do a Regenerate All. If the code you are adding hasn't been correctly generated into the WebHandler (by the template) then that's the easiest possible problem to fix.

2) First thing to determine is if the event on the browser is triggering an event to the server as expected. You can do this by watching the Web Server window. Click on the Clear button to clear the log, then change a value. You should see and item appear in the GET part of the log. Like this:

Note that the request included the Event (Event:Accepted = 1) and also the new value for the field that changed. You can also see the request was asynchronous because of the XMLHttpRequest item in the header.

3) So the request is being generated, but the response is not making it to the browser. Or perhaps it is, it's just not the response you're expecting. The most likely place for an error is in the embed code you may have added. (Don't worry, it's normal to make errors when writing code. This isn't about blame, it's about correctly identifying the source of the problem so it can be fixed.) What I usually do in this case is comment out my embed code entirely, and replace it with a simple bit of code, that doesn't have a bug, and which makes a visible impact in the browser. For me that's

loc:comment = Random(1,1000)

If this works then I examine the embed code a bit at a time to see which part isn't working as expected.

Tip: Remember that this little routine is being called asynchronously and none of the rest of the Form has necessarily run. So if you need to access other data tables, then you will need to open and close them appropriately. Also you should always use Session variables rather than file variables for the actual form fields. That's why in the example code above I used p_web.GetSessionValue('cus:email') and not just cus:email.

4) But what if the simple use of Random suggested above doesn't work? Well then the most likely reason is you missed out step 1. But what if it still doesn't work? Well then the next step is to examine the packet that is being sent to the browser. You can do this by adding

NETSHOWSEND=>1

to your project, in your app, as a Project Define. Then use the free DebugView program (available from SysInternals) to monitor the outgoing packets.

The browse is the root of many applications. It allows you to display data on the screen in a tabular format. In many way the browses provided by NetTalk WebServer are similar to the browses you are already familiar with in Clarion.

A browse can have many different settings. These are covered in more depth in the Reference document.

Browses can be page-loaded, or file-loaded. They can be sorted by clicking on the header. They can have locators.

In most cases a browse is simply a tabular list of data, something that will be instantly recognizable to any Clarion developer.

However tabular data can be displayed in many creative ways, some of which don't look like a browse at all. The following are two browses, one on the left, and a child on the right.

One big difference between a Web app and a Windows app is the concept of global variables. In a Windows app one user is using the program. Multiple copies of the program may be running, but each copy belongs to only one user. So you can set global variables which implicitly belong to just that user.

A web app can be serving multiple users (at the same time) from one single exe. So you can't assign a global variable to a single user. All users can see all the globals all the time. (At least that's how your program would behave if you used globals.)

In NetTalk you use Session Variables to assign values to a user. we discussed Sessions earlier. Each user has a single, unique, session number which they keep for the duration that they are in the browser. If you need to store a variable you do it by writing the value into the Session Queue. And you can fetch it from the Queue when you need it. For example;

After the user logs in we want to store their name. So we go to the place where their login is validated (ValidateUpdate Routine) and we add some code;

p_web.SetSessionValue('LoginName',clip(loc:login))

Later on we can get this value, and put it in a local variable by doing

loc:login = p_web.GetSessionValue('LoginName')

if you wanted to embed this session variable inside an HTML page then you can put, inside your HTML,

<!-- Net:s:LoginName -->

The default deployment folder structure looks something like this;

HTML files are placed in the web folder. The WebServer is limited (by default) to supplying files in, and below, this folder. Default is appPath\web where appPath is the location of the Exe.

You can set the web folder on the NetTalk settings on the WebServer Window.

Below this folder are a number of folders. You can override these as well, but by default they are:

Scripts (contain .js files)

Styles  (contain .css files)

Log (contain Log files if logging-to-disk is turned on)

If these folders do not exist they will be created for you.

In addition it is recommended that images are placed in an “images” directory. However this is not a requirement, just a suggestion.

You need to deploy your program (exe, dlls, tps files whatever) as normal.

NetTalk web server does not require any additional programs on the machine. (i.e. no IIS or Apache etc.)

You need to deploy your web folder onto the server machine as well.

For more information on program deployment see the Deployment doc.

It is occasionally desirable to identify the user, and then direct them to a specific data set. The same program will be running, but the user will be using one set of data (and potentially a different web folder) to other users of the server.

The multiple-data-set approach works well for both TPS and SQL data stores.

To implement multiple data sets you need to

1. Set the dictionary correctly
2. Identify the user on each request
3. Set the filenames or owner strings for the tables appropriately.

Setup Dictionary

Identify the User

Set File Names / Owners

There are various way to approaching printing in a WebServer application.

Firstly it should be remembered that the printing is a function of the browser. Which means that any page your application delivers is intrinsically a report. The user can click on the browser print option at any time. By careful design, and attention to the information you are presenting, you can make many "reports" obsolete.

There are times though where a specifically formatted document is necessary. In these cases HTML doesn't necessarily offer the degree of control that you need. The best option in this situation is to create a PDF file, and have the browser display this.

Since Clarion 6 Enterprise Edition contains a Report-To-PDF extension, this seems like a good place to start. You can take existing report procedures in your application, and with minor additions make it generate a PDF file, and also allow the NetTalk WebServer to send the PDF file to the browser. PDF makes an excellent format for this sort of thing because most browsers already know how to display a PDF (via the Adobe plugin) and you have 100% control over how the page will be displayed, and importantly 100% control over how it will look when printed.

If you don't have Clarion 6 EE, then there are other 3rd party tools that can be purchased that do a similar thing. NetTalk 4 includes examples of using the Clarion 6 EE functionality, as well as examples from other vendors.

There are 2 examples included with NetTalk which demonstrate the technique used to use existing report procedures in your web site. In each example there are 2 reports, one simple one, and one more complex one that makes use of an "Options" window, and the ABC Pause button.

Example 13 (PDF Report - requires C6EE) requires, as the name suggests, Clarion 6 Enterprise Edition (or alternatively the Clarion 6 Professional Edition, with the optional PDF Report Generator).
Example 14 (PDF Report - requires PDF-Tools) is the same example, but uses the PDF-Tools product from Tracker Software Products to convert the reports to PDF. PDF-Tools is available for Clarion 5.5, 6,7 and 8 so this example works in all of those.

Steps to use an existing report procedure in a Web application

1. If you've not already done so, add either the SoftVelocity PDF Global Extension, or the PDF-Tools Report Global extension to your application.
   
2. If you've not already done so add the two Global extensions required by NetTalk (Activate CapeSoft's NetTalk, and Activate NetTalk Web Server.)
   
   Tip: If this is a multi-dll system, you can still add these two extensions, even if this is not the actual web Server app. See the section on Multi-DLL for more information.
   
3. Set the Prototype, and Parameters, of the report procedure to
   
   (<NetWebServerWorker p_web>)
   
4. Add the NetTalk Extension to ABC Report to the Extensions list for this procedure.
   
5. This step is optional, and is only required if you have a "Report Options" window, or if you have additional parameters passed to the Report.
   
   When called in "Web mode" the report will not be able to stop and ask the user for options. If options are necessary you will need to gather these using a NetWebForm procedure, or alternatively have the options stored in the Session Queue. An embed point is included at the correct place where you should prime these optiions. The embed point is called
   Prime Report Options
   
   In the supplied examples a NetWebForm procedure is created, which contains 2 variables, FromSize and ToSize. The Report procedure is dependant on 2 options, also called FromSize and ToSize. In the embed point the following embed code is included:
   
   fromsize = p_web.GetValue('FromSize')
   tosize = p_web.GetValue('ToSize')

Advanced

Date formats are a little tricky to handle. In Clarion you're probably used to selecting date formats all over the place, using one of the built-in date pictures (like @D1 or @D2 etc.). However at the browser these values are meaningless, so a suitable method for selecting dates must be available.

With NetTalk, the date-selector popup is the one offered by jQuery. This supports all Clarion date pictures up to (and including) @D16. Note that D17 and D18 are not supported.

In order to allow you to select the format globally, rather than just on a form-by-form basis, there is a setting on the WebServer procedure, Extensions, NetTalkWebServer, Settings called Date Picture. This should be entered without quotes.

On Browses you can set the picture of a specific column to anything you like. If you would like to set it to say D6 then you would enter '@D6' . If you would like to set it to the global default then use p_web.RequestData.Webserver.DatePicture .

If you have, or are making, a Multi-DLL system (ie one comprised of many APP files) then you may want to use procedures in one other other DLL's in your NetWeb application.  For example, if you have a report, or graph, in an external DLL, it would be ideal if this procedure could be used in the Web interface as well.

First a quick note about normal Clarion Source procedures. These can be used already in the normal way. Remember your web app is a Clarion program, and Clarion already has templates in place to allow you to use External procedures in an application. So using normal source procedures is no problem.

The problem occurs when you are exporting procedures with NetWeb extensions. For example a NetWebReport, or NetwebBrowse and so on. If you wish to use these procedures in the main NetWeb app then you need to tell the WebHandler to include these procedures. To do this:

1. Open the application that contains the WebHandler procedure.
2. Go to the Global Extensions, to the Activate NetTalk Web Server extension.
3. Go to the Multi-DLL tab.
4. Enter the name of the remote APP file here.

Now all the NetWeb procedure in that remote APP file will be included correctly in the Web Handler procedure.

In the remote app you will need to add the Activate NetTalk Global extension, Activate Net Web Server Global extension as normal (although you don't need to fill in anything on the Multi-DLL tab).
Your procedures in the remote APP will need to be EXPORTED in the normal Clarion way.
In the WEBHANDLER app you will need to link in the remote procedures in the normal Clarion way.

So to summarize:

1.  Make the apps just as you would in any normal Multi-DLL Clarion system.
2. In the WebHandler App, add the "External Apps" to the External Apps list on the NetTalk Global Extension.

Possible Errors:

1. Compiling the WebServer application you get an error;
   Link Error: Unresolved External BrowseSomething@
   
   This means you probably haven't EXPORTED the procedure in the app where it is declared. Go to that app, go to that procedure, and make sure Export Procedure is ticked on.
2. Compiling the WebServer application you get an error;
   (someapp_ni.clw) Syntax error: Unknown Function label
   and when you go to the line in question you see a call to one of the web procedures - possibly something like this;
   UpdateCustomers(self,Net:Web:Div)
   
   This means you have not included that procedure (in this example, UpdateCustomers) as an external procedure in the WebServer app. Add it as an external procedure (with the correct Prototype) in the normal Clarion way.
3. Compiling the WebServer application you get an error;
   (someapp_ni.clw) Syntax Error : No matching Prototype available
   
   This means you've added the procedure, as an external, to the WebServer app, but you've not set the Prototype correctly for that procedure. The best approach is to go to the app where it is declared, and copy the prototype from there, so they match.
4. When you run your application, and go from one procedure to another, say from a browse to a form, and it does not seem to work, then make sure all the external apps are added to the Global Extension in the WebServer app. Adding the LIB's is not sufficient, you need to add any apps with web procedures to the global extension.

By embedding a couple of tags on your web page, it is possible to generate fully functional browses and forms which appear inside your static pages.

Basic support needed on the page

1. The first line of the page must be
   <!-- NetWebServer -->
   

2. Inside the <head> of your page you must put
   <!-- Net:c:Head -->
   

3. Just before the </body> tag of your static page add
   <!-- Net:c:BodyEnd --> 

4. The NetTalk styles, and scripts, should be in folders called Styles and Scripts respectively, and these folders should be inside the same folder as your HTML pages. In other words, the pages will reference styles/netweb.css.

Embedding a Browse on the Page

You can embed a browse on the page simply by using a NetTalk tag. For example
<!-- Net:BrowseCustomers -->
will embed the BrowseCustomers procedure at that point on the page.

Embedding a Form on a page

If you have embedded a browse on a page, then chances are you will also want to embed the form on a page.
In this case simply
a) Insert the tag into the page as normal. For example
<!-- Net:UpdateCustomers -->
and
b) Tell the browse procedure, in your app, to call your static page on an update, rather than go directly to the form. You can do this by going to the NetWebBrowse settings, to the Form tab, clear the Form Control Procedure field, click on the Advanced button, and enter the name of your static form page.

Embedding the Popup, and Message on a page

The validation on the form can generate an automatic Message (which appears on the window) and/or an automatic Popup (which appears as the form is refreshed).  If you create a static page as a container for the form, then you'll want to embed these onto that static page as well.

Use <!--Net:Message--> to embed the message. I recommend putting this just before the tag which includes the form.

Use <!-- Net:Popup--> To include the popup. I recommend placing this at the bottom of the page, after all the visible components of the page have been done

Most browsers allow the data passed from the server to be compressed using the GZIP format. Using this technique it is possible to improve performance, by reducing the bandwidth requirements for a site.

Graphics

If you are using PNG, GIF or JPG files for your graphics, then the graphics are already compressed. No additional compression is necessary, or recommended.

Static Page Pre-Compression

The most efficient way to compress am unchanging text file, such as a static HTM file, a JS file, or a CSS, file is to store a compressed copy of the file on the disk, in the same folder as the original file. Because the file is already compressed there is no additional CPU load on the server, and the minimum bandwidth is required to get the file to the browser.

NetTalk supports this pre-compression by looking first for filename.gz before looking for filename. So if you have a file, called say whatever.css, then you can use the Gzip utility to compress this to whatever.css.gz. and store this on the server along with whatever.css. However you want to leave the whatever.Css file there as well for the benefit of those browsers that don't support compressed files.

You can disable the automatic serving of pre-compressed files on the Settings/Advanced tab of the NetTalk Extension in the WebServer procedure.

Dynamic Compression

NetTalk 7 introduced the concept of dynamic-page compression as well. This is on by default, but can also be turned off on Settings/Advanced tab of the NetTalk Extension in the WebServer procedure.

Traditional Web Pages make use of Anchors to hyperlink not just to a page, but into the page as well, taking the user to a specific part of the page. While this feature would be nice to do in a dynamic web app, there are some complications.

A normal anchor comes after the URL, and is separated from the URL by a # character. For example in http://www.capesoft.com/downloads#nettalk10 the nettalk10 part would be considered to be the anchor part.
Note that the anchor part, after the # sign is not passed to the server. Thus when the user uses an anchor in the URL, the server does not know that they have done so, nor does the anchor get passed to the server.

The most likely place where you would want to use an anchor, on a dynamic page, is on a browse. And the browse template has an option for putting one, or more, anchors on the browse itself. For example the dynamically-generated Downloads page on the CapeSoft site contains the product name for each row of the browse.
So http://www.capesoft.com/downloads#nettalk10 takes you to the downloads page, and then straight to the NetTalk 9 product on that page.

This approach works very well for file-loaded browses. Since all the data rows are always on the page, if the anchor exists then the browser will navigate to it. For page loaded browses however the approach fails because the server does not see the anchor, and hence does not know to generate the specific page that contains that specific anchor.

NetTalk has two approaches to solving this problem. By necessity these are not web standards, however they may be useful. The first approach is to use a normal URL parameter (a) in the name, and the second is to use a slightly modified URL. You can use either, or both approaches in your application.

The parameter approach is somewhat more standard in that passing parameters is a well established web technique. The name of the parameter is use is simply a. For example;
http://www.capesoft.com/downloads?a=nettalk10
As you can see the # has simply been replaced with ?a=
More completely the URL should be
http://www.capesoft.com/downloads?a=nettalk10#nettalk10 
But since the browse is page-loaded, all the records will (hopefully) be visible so the last part is unnecessary.

The second approach is slightly neater, but also somewhat more outside the web norms.
http://www.capesoft.com/downloads!nettalk10
In this case the # symbol is replaced with a ! symbol. This is passed to the server, which then removes the name after the ! and attempts to find the record identified by that anchor in the browse.

Whichever approach you use it should be pointed out that anchors are not suitable for all browses, at least not without a little bit of hand-coding. In order to position to the browse to contain the record, the table is searched to find a record with a matching anchor. This is not a key or index based operation, so can result in the reading of a lot of records on large tables. For tables with more than a few thousand records it is suggested that the anchor be chosen to match a key value, and that some embed code is added to optimize the search based on the knowledge that the value can be located via a key.

Server-Side translations

Client-Side Translations

When a client program (like a browser) access the server then a session is created. In many cases it is desirable for the client to "log in" to the server in order to perform some actions. This process of identifying the user is known as Authentication. There are a number of approaches that the client can take.

• Enter the login and password on a Form
• Using HTTP Basic or Digest Authentication
• Pass the login and password values as Cookies as part of the header

Because there is this variety of methods, and because you don't want to duplicate code more than is necessary there are best-practice places for you to write the necessary code.

WebHandler Procedure; Authenticate method

WebHandler Procedure ; SetSessionLoggedIn method

WebHandler Procedure ; GetPassword method

Users can, and sometimes do, open your web app in multiple tabs in their browser at the same time. Because all tabs share a Session cookie, the server is unable to tell when a request comes from one tab, or from some other tab, and hence activities on one tab can influence the "state" of the app in another tab. This influence is usually unwelcome and can lead to strange behaviors, or in extreme cases data corruption.

NetTalk 8.22 introduced Multi-Tab support which can be enabled in the WebServer procedure, Performance Tab settings.

If this support is on then each tab is given a unique identifier, and requests from that tab include the identifier. In this way the app can identify which tab is making a request, and hence keep the state in one tab different to the state in another tab.

If this feature is on, then setting a session value in one tab will not set that value in other tabs (See below for how to create cross-tab values).

However the session itself is shared. The following states are stored in the session itself, and NOT in the session data queue. If any of these states change in one tab they will therefore change in all tabs.

1. LoggedIn (yes or no).
   The details of who is logged in are usually stored in the SessionData, and that SesisonData will not change. However the overall state (logged in / not logged in) will be consistent across all the tabs. If the user wishes to Login as 2 different users at the same time, in different tabs, then they would need to login on one tab, open a new tab and login again with different credentials. As the programmer, you should record _who_ is logged in in SessionData and use the SessionData where applicable. Because each tab has distinct session data the user will effectively be logged in twice. If they logout _in any tab_ they will be logged out in all tabs.
   
   If you are logging login's and logouts by embedding code in the SetSessionLoggedIn, ValidateLogin and/or NotifyDeleteSession then you need to be aware that you'll only get one call to these methods, but in effect multiple logout's may be occurring at this point.
2.  Security Level
   This is also at the SessionLevel, not the SessionDataLevel, so changing the level in one tab will change the level in all tabs.
3. Last Activity
   Every time the user performs some activity, which results in a call to the server, the session timeout period is reset. This remains at the session level, not the Tab level, so if the user performs an activity in any one tab, they extend the session, and hence all tabs are extended.

Cross-Tab Session Values

Web sockets allow a connection to be made between the browser and the server, and to remain open. Fundamentally this means that information can be pushed to the browser, something not possible with the request/response nature of HTTP.

Requirements

Sessions

Activate WebSockets Support

NetWebSource (including Header and Footer)

NetWebForm

NetTalk has the ability to serve PHP pages. It does this by having the ability to call the Pgp-cgi.Exe program, feeding it the necessary information it needs, and trapping the output. The primary purpose is to allow easier integration to existing web sites.

Note: In order to support PHP from your web server, you will require OddJob and StringTheory.

Example: A good example of using PHP in an app is example 58 (cunningly called PHP).

In order for your application to support PHP pages, you need to do the following three steps;

a) Add the OddJob, and StringTheory global extensions to your application. If you are building a multi-dll application then add this to the Data Dll.

b) Copy the PHP folder from the Example 58 folders. This contains the Exe and DLL's and other support files that PHP requires. This folder should be a sub folder of your application folder.

c) Make sure when you deploy, that the path name to the application does not include any bracket characters. The example is in a folder called "php (58)" and this WILL NOT WORK. You must rename the folder to say "PhpExample" in order for it to work.

There is a property, called phpPath which contains the path to the Php folder. If you wish to relocate the Php folder for some reason, then set the property in the WebHandler procedure, ProcessLink method, to the actual location. For example;
self.site.phpPath = 'c:\php'

Note that one of the files in the Php folder is the Php.Ini file which contains details that the Php exe uses. Since this file can change from time to time (and can be changed internally by the web server) it is not recommended to have the Php folder in the c:\program Files path. Under Windows writing to this folder is forbidden.

Occasionally a client behaves badly when connecting to a server. You'll occasionally see this in a web server when a server is subject to an unsolicited penetration test. All NetSimple servers (and hence WebServers) in NetTalk 9 have the ability to Ban an IP address. When an address is banned then all existing connections to that address are closed and no further connections from that IP address will be accepted.

IP Banning is implemented at the NetSimple level, so any NetSimple server can ban clients. The most common usage is for the WebServer, but Banning is not limited to the web server.

A maximum of 10 IP addresses can be banned at any one time. If additional addresses are banned then the oldest banning is dropped and the latest one added. If this limit becomes a problem it can be expanded, but typically banning is unusual and not many addresses need to banned at once.

Banning is not the same as Rate Limiting, which simply applies a standard of "fair use", Rate Limiting will be discussed elsewhere.

Methods

Apply to WebServer

It's possible to add request filtering to the server. This is a check for specific patterns of "bad" behavior which can help minimize the time spent on requests which are obviously not valid for this site.

That said, checks on incoming requests apply to all requests, so effectively slow down all legitimate requests. So there's a balance here between aggressive filtering and improved overall performance.

If a request comes in, it is received by the WebServer procedure. This does very little to inspect the incoming request, doing just enough to understand when the request has been completed. Once the request has completely arrived it is handed onto a separate thread for processing.

This processing thread first checks the request to see if it matches any of the procedures (browses, forms, pages etc). If it does not then it checks the filename for obvious problems (in the ValidateFileName method) and then looks for the file on disk. If not found then it returns a 404 error.

Errant requests cannot cause harm to the system. If someone asks for a PHP page that does not exist they simply get a 404. If you run a server on the internet you'll quickly see items appear in the log asking for pages or URL's which are known flaws in say PHP or IIS or whatever. These don't do any harm to the NetTalk system other than using up a few CPU cycles.

That said, it is possible to add extra filtering to the WebServer procedure, and the WebHandler procedure if you wish to do so. For example, if none of your pages use a .php suffix, and you don't support PHP, then you can filter out PHP pages earlier in the process.

WebServer

WebHandler

ValidateFileName

As mentioned earlier a later test is done using the ValidateFileName method. This method takes a filename as a parameter and returns  Net:Ok if the file is ok. It returns either Net:Blank (-1) if the file is blank, or Net:Abort (-2) if the file is known to be bad. If the method returns anything other than Net:Ok then it sends the browser a 400 Error (Bad Request)' and closes the connection.

Host variables are like Session variables, but they are common to all users. So a host variable written by one user can be read by another user.
Host variables can be set from a processing thread by using p_web, but they can also be used from the web server procedure using s_web. So p_web.SetHostValue(name,value) can be used in WebHandler, Browses, Forms and so on. In the WebServer procedure though you can also set them using s_web.SetHostValue(name,value).

Host variables exist outside of sessions and so are not cleared by the deletion of a session. Internally they are stored in the same queue as the SessionData, so they will reflect as SessionData on the Performance tab of the server. This means that it's possible to have SessionData exist, even if the number of sessions is set to 0.

Because the variables exist across sessions they are useful for sharing information between users. They are useful for broadcasting information to either all users, or a subset of users using WebSockets.

Tags

Methods

Support for animations for the opening and closing of popup windows has been added. These animations can be set globally (On the various Default tabs of the WebServer procedure) or locally for each procedure type.

Animations are provided by the jQuery UI framework. animations consist of an effect name, and a duration time. The duration time is in thousandths of a second. A list of possible effects can be found at https://jqueryui.com/effect/.

Examples;

'effect: "slide",duration: 500'

'effect: "transfer",duration: 300'

By default your web server is installed in a directory (the AppPath) and below this hang the Web folder, Log folder, Web\Uploads folder and so on. However in some situations you may prefer to rename some of these folders.

Log Folder

Default is AppPath\Log
This can be problematic under Windows if you have installed your program into the \Program Files folder. If you've done this then the LogPath breaks Windows' rules. Setting the LogPath to the AppData folder is probably preferable in these circumstances.

To set the logpath, in the WebServer procedure, in the NetTalk object before Init Section embed point, add some code such as the following;

ThisWebServer.LogPath = 'c:\logs'

Web Folder, and Web Uploads folder

Defaults are AppPath\Web and AppPath\web\uploads respectively. However the same Windows problem that affects the Log path applies here as well. If your program accepts uploads, then writing them into the \Program Files folder can be a problem.

You have 2 choices when moving the Uploads folder. Either move the Web folder completely (by adjusting the WebFolderPath AND UploadsPath properties) or just move the Uploads folder.

Remember that static files can only be served if they are under the web folder, so the real question is whether you want your uploaded files to be available for download. If yes, then you need to move the whole web folder, if no, then you can afford to just move the Uploads folder.

Because both the WebFolder, and Uploads folder are site specific, you need to alter their properties in the _SitesQueue property of the WebServer. For example;

Get(ThisWebServer._SitesQueue,1)
ThisWebServer._SitesQueue.Defaults.WebFolderPath = 'c:\web'
ThisWebServer._SitesQueue.Defaults.UploadsPath = 'c:\web\uploads'
Put(ThisWebServer._SitesQueue)

The best place to do this is in the Init method of the web server procedure.