Class WebHandler
Version 1.0
Modified 15-JAN-2025 13:23:34.00
WebHandler objektet definierar en hemsida för en ProviewR nod.

Förekomsten av ett WebHandler objekt gör att en server process (GdhServer)
startas, vilken förser graf-applets och frames med information från realtids-
databasen.

Med 'Generate website' funktionen i Ge är det möjligt att producera html-filer
för hemsidan, innehållande in meny-fram och en applet-frame. Länkarna in menyn
bestämms av de WebGraph och WebLink objekt som är barn till WebHandler objektet.

Om EnableLogin attributet är satt, kommer ett login fönster att kunna öppnas
från menyn, vilket gör det möjligt att logga in som en ProviewR användare, och
erhålla privilegier att ändra i databasen.


RtBody attributes pwr_sClass_WebHandler
String80 Description   Optional description.
Int32 MaxConnections   Max antal samtidiga uppkopplingar till GdhServer processen.
Int32 CurrentConnections   Number of current connection to the GdhServer process
String80 FileName   Namn på html-filen för start-sidan.
String80 Title   Titel i meny ramen.
String80 Text   Text i meny ramen.
Boolean EnableLanguage   Obsolete since V5.4.
Boolean EnableLogin   Ett login entry placeras i menyn, från vilken man kan logga in som en
ProviewR användare, och erhålla privilegier för att ändra i databasen.
Boolean EnableAlarmList   Ett menyentry för larmlistan placeras i menyn.
Boolean EnableEventLog   Obsolete since V5.4.
Boolean EnableNavigator   Ett menyentry för runtime navigatorn placeras i menyn.
Boolean DisableHelp   Obsolete since V5.4.
Boolean DisableProview   Obsolete since V5.4.
Objid UserObject   User objekt för konfigurering av larm- och händelselistan.
LanguageEnum Language   Obsolete since V5.4.
String80 StyleSheet   css-fil (Cascading Style Sheets) som används av genererade html-filer.
String80 StartURL   URL som kommer att visas i huvud-ramen när websidan öppnas.
String256 LoadArchives   Obsolete since V5.4.
String80 PwrHost   Obsolete since V5.4.
String80 AppletSignature   Obsolete since V5.4.
Array of String80 EventSelectList   A message created by an ASup or DSup object gets the
same identity as the supervised object. Messages
produced in an application by means of mh_ApplMessage
(see ProviewR Programmer's Reference Manual) get an
identity according to the calling parameter EventName.

SelectList specifies the hierarchies from which
messages are to be sent to the user. Up to 20 different
hierarchies can be specified. If messages from e.g. a
Watchdog object in a node will be received, then the
name of the node will be specified.

Note! If the SelectList is left blank no message at all is
sent to the user.
EventTypeMask EventSelectType   Specifies the type of events that are sent to the user.
If no type is specified, all types av events are sent.
UInt32 MaxNoOfAlarms   Specifies the maximum number of contemporary alarms in
the user's alarm list.
The number should exceed the maximum number of
concurrent alarms in the system.
If the limit is exceeded, alarms might be lost.
UInt32 MaxNoOfEvents   Specifies the maximum number of contemporary events in
the user's event list, i.e. the skyline of the events.
When the number of events exceeds MaxNoOfEvents the
oldest event disappears from the list.
To this list events are sent from the message handler
in respective node. In each node the message handler
has its own skyline of events (also named MaxNoOfEvents)
defined by a MessageHandler object. In principle, the
User object's skyline of events should be selected as å
MaxNoOfEvents, added up over MaxNoOfEvents in the
MessageHandler objects in all nodes throughout the
ProviewR system, or make it simple and assign the
attribute e.g. 200.
Boolean AppUseWebDir   Obsolete since V5.4.


Template Object
FileName index.html
MaxConnections 50
MaxNoOfAlarms 200
MaxNoOfEvents 500
AppUseWebDir 1


Attributes detail


Description Attribute
Klass Attribute
Typ String80
Flags
Kropp RtBody
 Optional description.

MaxConnections Attribute
Klass Attribute
Typ Int32
Flags
Kropp RtBody
Max antal samtidiga uppkopplingar till GdhServer processen.
Varje applet som visas, öppnar en länk till GdhServer processen. Om 
MaxConnections överskrids, kommer uppkopplingen att refuseras.

CurrentConnections Attribute
Klass Attribute
Typ Int32
Flags STATE | INVISIBLE
Kropp RtBody
 Number of current connections to the GdhSever process.
 Every graph-applet opens a link to the GdhServer process. The current
 number of links is displayed in this attribute.

FileName Attribute
Klass Attribute
Typ String80
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
Namn på html-filen för start-sidan.

Title Attribute
Klass Attribute
Typ String80
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
Titel i meny ramen.

Text Attribute
Klass Attribute
Typ String80
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
Text i meny ramen.

EnableLanguage Attribute
Klass Attribute
Typ Boolean
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
 Obsolete since V5.4.

EnableLogin Attribute
Klass Attribute
Typ Boolean
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
Ett login entry placeras i menyn, från vilken man kan logga in som en
ProviewR användare, och erhålla privilegier för att ändra i databasen.

EnableAlarmList Attribute
Klass Attribute
Typ Boolean
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
Ett menyentry för larmlistan placeras i menyn.

EnableEventLog Attribute
Klass Attribute
Typ Boolean
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
 Obsolete since V5.4.

EnableNavigator Attribute
Klass Attribute
Typ Boolean
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
Ett menyentry för runtime navigatorn placeras i menyn.

DisableHelp Attribute
Klass Attribute
Typ Boolean
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
 Obsolete since V5.4.

DisableProview Attribute
Klass Attribute
Typ Boolean
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
 Obsolete since V5.4.

UserObject Attribute
Klass Attribute
Typ Objid
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
User objekt för konfigurering av larm- och händelselistan.

Language Attribute
Klass Attribute
Typ LanguageEnum
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
 Obsolete since V5.4.

StyleSheet Attribute
Klass Attribute
Typ String80
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
css-fil (Cascading Style Sheets) som används av genererade html-filer.

StartURL Attribute
Klass Attribute
Typ String80
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
URL som kommer att visas i huvud-ramen när websidan öppnas.

LoadArchives Attribute
Klass Attribute
Typ String256
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
 Obsolete since V5.4.

PwrHost Attribute
Klass Attribute
Typ String80
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
 Obsolete since V5.4.

AppletSignature Attribute
Klass Attribute
Typ String80
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
 Obsolete since V5.4.

EventSelectList Attribute
Klass Attribute
Typ Array of String80
Flags ARRAY
Elements 40
Kropp RtBody
 A message created by an ASup or DSup object gets the
 same identity as the supervised object. Messages
 produced in an application by means of mh_ApplMessage
 (see ProviewR Programmer's Reference Manual) get an
 identity according to the calling parameter EventName.

 SelectList specifies the hierarchies from which
 messages are to be sent to the user. Up to 20 different
 hierarchies can be specified. If messages from e.g. a
 Watchdog object in a node will be received, then the
 name of the node will be specified.

 Note! If the SelectList is left blank no message at all is
 sent to the user.

EventSelectType Attribute
Klass Attribute
Typ EventTypeMask
Flags
Kropp RtBody
 Specifies the type of events that are sent to the user.
 If no type is specified, all types av events are sent.

MaxNoOfAlarms Attribute
Klass Attribute
Typ UInt32
Flags
Kropp RtBody
 Specifies the maximum number of contemporary alarms in
 the user's alarm list.
 The number should exceed the maximum number of
 concurrent alarms in the system.
 If the limit is exceeded, alarms might be lost.

MaxNoOfEvents Attribute
Klass Attribute
Typ UInt32
Flags
Kropp RtBody
 Specifies the maximum number of contemporary events in
 the user's event list, i.e. the skyline of the events.
 When the number of events exceeds MaxNoOfEvents the
 oldest event disappears from the list.
 To this list events are sent from the message handler
 in respective node. In each node the message handler
 has its own skyline of events (also named MaxNoOfEvents)
 defined by a MessageHandler object. In principle, the
 User object's skyline of events should be selected as å
 MaxNoOfEvents, added up over MaxNoOfEvents in the
 MessageHandler objects in all nodes throughout the
 ProviewR system, or make it simple and assign the
 attribute e.g. 200.

AppUseWebDir Attribute
Klass Attribute
Typ Boolean
Flags STATE | INVISIBLE | RTHIDE
Kropp RtBody
 Obsolete since V5.4.