TECSys Development ConsoleWorks Version 1.5.0, Installation Manual

Page: 23 / 42

corresponding template file is used for the help file. When Help ( ? ) is selected in the web browser the contents
of the applicable template file are displayed. Once the Event, Console or User is modified, a separate *.info
(where * is the name of the Event, Console or User) file is created for that specific Event, Console or User and is
stored in the Config subdirectory under the installation directory for the server. The next time the help (
? ) is se-
lected, the *.info file is displayed.
The default versions of these templates are located in the Config sub-directory of the Console
Works root direc-
tory and are called: CONSOLE.TEMPLATE , EVENT_COMMON.TEMPLATE, EVENT.TEMPLATE and USER.TEMPLATE .
The User and the Console templates files are text only files. The Event template text file can also include HTML
tags. The templates created during installation can be edited once installed using a standard text editor.
Once the templates are edited, all subsequent *.info files that are created will contain the modified versions of
the template files. This is often a convenience if particular information, such as company contacts or refer-
ences are desired to be in all of the help files.
Event Template Files
Console Works supports each Event with a specific help file for each Event. Initially, the text displayed in the
help window will be the text and/or HTML tags contained in the EVENT.TEMPLATE file. The text in the file can be
edited and can include HTML tags. The file is used in a web browser environment where the HTML references
can be clicked on to jump to another document. The HTML tags can point to any online documentation re-
trievable to the Console
Works NT client via HTTP (the client's access may not be the same access as the Con-
sole Works server's access).
♦
note: When the link is clicked on, the requested file is shown in the target window specified. Accordingly, it
is recommended that a new target window be specified unless the requested link will display well
within the Console
Works Event info box containing the link.
Each event help window can be edited to contain whatever information is deemed necessary, some sugges-
tions are:
site and/or event specific procedures,
explanations to the Console
Works user responding to the event what the event means,
provide a URL to other web documents or vendor documentation.
Event Template Files
Console Works supports each Event with a specific help file for each Event. Additionally, information that is
considered common to all events can also be displayed. The text displayed in the topside of the help window
will be the text and/or HTML tags contained in the
EVENT.TEMPLATE file. The text displayed at the bottom of
the help window will be the text and/or HTML tags contained in the EVENT_COMMON.TEMPLATE file.
The text in the
EVENT_COMMON.TEMPLATE file can be edited and can include HTML tags. The file is used in a
web browser environment where the HTML references can be clicked on to jump to another document. The
HTML tags can point to any online documentation retrievable to the Console
Works client via HTTP (the client's
access may not be the same access as the Console Works server's access).
♦
note: When the link is clicked on, the requested file is shown in the target window specified. Accordingly, it
is recommended that a new target window be specified unless the requested link will display well
within the Console
Works Event info box containing the link.
Event information common to all events can be posted in to the
EVENT_COMMON.TEMPLATE
file to contain whatever information is deemed necessary, some suggestions are:
site or company specific procedures, and to
provide a URL to other web documents or vendor documentation.
Console Template
Console Works supports each Console with a specific help file for the Console. Initially, the text displayed in the
19