Sigma Web Framework files

./LICENSE.txt

The license file for Sigma, displayed via the "View License" button on the startup dialog. (Please read.)

./apache

The directory containing all Apache files on the system.

./apache/ApacheCore.dll

Required DLL for the Apache server.

./apache/htpasswd.exe

A command line utility, used to maintaining the Apache server passwords. This program is executed via the Sigma "Login" screen, and can also be executed manually by experienced administrators. Type "htpasswd.exe -?" form brief built in help.

./apache/httpd.pid

The Program ID for the currently executing Apache program. If this file does not exist, then the Apache server is not running. (However, existence of the file cannot be used to determine whether the server is actually running.)

./apache/passwords.dat

The encrypted passwords of the system, maintained by the "htpasswd.exe" program, and by the Sigma "Login" screen.

./apache/CO-apache.exe

This is the actual Sigma Apache server executable. This is a standard version of the server, but slightly hardened and cleaned up for the Sigma server. The server name is prefixed with "SG" so that it appears clearly in the Windows Task Manager.

./apache/Win9xConHook.dll

Required DLL for the Apache server.

./apache/conf

The directory that contains Apache server configuration files. This directory is required for proper operation of the server.

./apache/conf/access.conf

Apache configuration file, specifying the access and permissions to various functions and features. While these directives commonly exist as part of the httpd.conf file, the Sigma distribution splits these directives apart into this separate file.

./apache/conf/httpd.conf

Apache configuration file, specifying the server name, and port number, and containing pointers to other locations within the Apache system. This is the main configuration file for the apache server, and can be heavily customized by experienced developers.

./apache/conf/mime.types

Apache configuration file, specifying the mime types that are supported by the Sigma Apache server. This file contains a list of mime headers and file extensions, used by client programs to determine how to display non-HTML data. The file contains only a brief list, to enhance security. Developers may wish to load more mime types.

./apache/conf/README.txt

A README.txt file that explains the purposes of the files in this directory.

./apache/conf/srm.conf

Apache configuration file, specifying the system resources of Apache. In particular, this is the file that performs the mapping of virtual URL folders to the actual disk folders on the system. While these directives commonly exist as part of the httpd.conf file, the Sigma distribution splits these directives apart into this separate file.

./apache/install

Directory containing template configuration files, used in the installation process. These files should not be touched or modified by users. They exist only to support the CO-install.exe program.

./apache/install/access.conf

Template access.conf file, used only during installation.

./apache/install/htaccess.txt

Template htaccess.txt file, used only during installation.

./apache/install/httpd.conf

Template master httpd configuration file, used only during installation.

./apache/install/mime.types

Template mime.types file, used only during installation.

./apache/install/pass.cnf

Template Sigma password file, used only during installation.

./apache/install/passwords.dat

Template Apache password file, used only during installation.

./apache/install/README.txt

A README.txt file that explains the purposes of the files in this directory.

./apache/install/srm.conf

Template srm.conf file, used only during installation.

./apache/logs

This directory contains log files generated by the system, as configured in the Apache "httpd.conf" file. By default, this directory will contain files ONLY if the Apache server experiences an error (which will create the "error.log" file.) Users can edit the httpd.conf file to enable transfer logging, which logs the visit of all users to the website. Additional logging capability is also available.

./apache/logs/error.log

This is the standard error log for Apache. It may or may not exist, depending upon whether the Apache server has experienced any error. Note that the existence of this file does not indicate a critical problem. (All errors, including accessing invalid URLs by users, are logged, and the messages may merely be informative rather than actual error conditions.

./apache/logs/README.txt

A README.txt file that explains the purpose of the files in this directory.

./config

This is the main configuration folder for the Sigma system. By default, the directory contains only those files needed to support the login mechanism, the scheduler function, and system parameters. Application programs may add their own unique files to this directory.

./config/pass.cnf

File containing the encrypted passwords for Sigma logins.

./config/sched.cnf

File containing the scheduler commands, read by the persistently running CO-svc.exe program, used to launch processes on startup, shutdown, or at scheduled intervals.

./config/sparms.cnf

File containing the system parameters of the system, maintained by the Sigma "Parms" screen.

./s-cgi

This folder corresponds to the /s-cgi URL, and the contents of this folder consists of programs that can be executed by users. Special care should be taken to prevent unauthorized access to this folder, since malicious users could exploit this directory by copying in their own programs for remote execution.

./s-cgi/htaccess.txt

File containing the access permissions to this folder. This file is required in order to get a login prompt. The file name is configured in the "srm.conf" file, and the file contains directives that prompt a user for login before accessing any file in the directory in which it resides. Users can copy this exact htaccess.txt file to any other location in Sigma to force a login prompt.

/s-cgi/web.cnf

This configuration file is used by the "web.exe" CGI program, and specifies some miscellaneous details regarding the web display, such as the size of the tab buttons, and the default tab colors, as well as certain path locations. Users should generally not modify this file. If it becomes corrupt, the user can delete the file and the "web.exe" program will recreate it, with defaults, the next time the program is executed. For more information, see web.cnf configuration filelater in this topic.

./s-cgi/web.exe

This is the central CGI executable program, referenced each time a file is accessed within Sigma. The program creates the navigation tabs, and manages the execution of other programs.

./s-doc

This directory contains miscellaneous documentation. It is viewable via the Web interface, as configured in the srm.conf file. (You can access this URL via the "/s-doc" URL.)

./s-doc/FW-MANUAL.pdf
(version 5.9.01)

The Sigma Framework Users Manual, in Adobe PDF format. This manual can be accessed via the Welcome screen.

(version 5.9.02) See Sigma-Web-Framework.

./s-doc/HEADER.html

A header file, which puts a banner at the top of the screen when the directory is viewed directly at the /s-doc URL. (This file exists many for aesthetics.) See the srm.conf file.

./s-doc/LICENSE.pdf

The Sigma Framework Licensing Agreement, in Adobe PDF format. This is identical to the LICENSE.txt file in the root directory of Sigma.

./s-html

This directory contains HTML files, in particular error html files, but also the main index for the web browser. This directory corresponds to the /s-html URL, as configured in the apache/conf/srm.conf file.

./s-html/error-access.html

HTML file, displayed to a client whenever an access error occurs, i.e. if a "guest" login tries to access a screen that requires and "admin" login.

./s-html/error-auth.html

HTML file, displayed to a client whenever an authentication error occurs, where the user fails multiple times to login to Sigma. This file is accessed directly by the Apache server, as configured in the apache/conf/srm.conf file. (This is a 401 error.)

./s-html/error-disabled.html

HTML file, displayed to a client whenever a disabled user logs into the system.

./s-html/error-empty.html

HTML file, displayed to a client when a tab is accessed, and the tab corresponds to a directory in the sigma-web folder that contains no files. (The administrator should probably delete that directory.)

./s-html/error-file.html

HTML file, displayed to a client whenever an attempt is made to access a file directly by a URL, and the file does not exist. This file is accessed directly by the Apache server, as configured in the apache/conf/srm.conf file (This is a 404 error.)

./s-html/index.html

The main index file for the Sigma implementation of the Apache server. This is the first file accessed whenever a user hits the server. The file simply redirects a user to the "/s-cgi/web.exe" program, which causes a prompt for a login. This file can be tailored by a developer, such as to add links to other locations of interest, including the login screen.

./s-html/s-footer.html

HTML file, displayed at the bottom of each screen by the web.exe program after all other programs are launched. This provides a way to customize the display with certain links, a copyright notice, etc.

./s-html/s-header.html

HTML file, displayed at the top of each screen by the web.exe program prior to generating any other output. This is an important file, because it can include JavaScript, resources, select style sheets, as well as display a banner image and hyperlinks. The generic implementation is quite simple, and can be customized extensively.

./s-html/helplinks.html

HTML file, displayed to the right of the top-level navigation links. This file runs the "More" tab in the BMC Defender Server system, but can be modified to display other links, images, or arbitrary HTML.

./s-html/styles.css

The Sigma "Cascading Style Sheet", specified in the "s-header.html" file. This is a simple file that can be expanded upon by a developer to change the look and feel of the program, including fonts, colors, borders, and special effects.

./s-html/images

This directory contains image files used by the system. This directory corresponds to the /s-html URL, as configured in the apache/conf/srm.conf file. The directory is viewable at the "/s-html/images" URL. (The administrator or a developer may wish to place an index file in this directory to hide it from prying eyes, if that is a concern.)

./s-html/images/HEADER.html

A header file, which puts a banner at the top of the screen when the directory is viewed directly at the /s-html/images URL. (See the srm.conf file.)

./s-html/images/folder.gif

A small image of a folder, used in directory listings.

./s-html/images/note.gif

A small image of a note, used in directory listings.

./s-html/images/sig-logo.gif

A logo file for the Sigma system.

./s-html/images/sxii.jpg

The banner for the corporate website.

./sigma-web

This is the all-significant sigma-web directory, which is the root directory used by the web.exe program. Within this directory you will find folders and files that follow a specific naming convention, used to create tabs and provide automatic navigation features. For more information, see Using-Sigma-Web-Framework. Note that this directory is not visible directly with a web browser, that is, the /sigma-web URL should yield a 404 Page not found" error.

./sigma-web/100_Home.html

This is the welcome screen, which is the very first screen viewed upon successful login to the system.

./sigma-web/900_System.dir

This directory corresponds to the "System" tab, displayed at the top of the screen to the right of the "Welcome" tab.

./sigma-web/900_System.dir/100_Logins.exe

This is the "Logins" screen, which is the first screen viewed upon clicking the "System" tab. The program permits users to add, modify, and delete logins from the system.

./sigma-web/900_System.dir/150_ODBC.exe

This is the "ODBC" screen, which permits the user to configure Windows DSN (Data Source Name) values such as usernames and passwords. The screen also permits the user to run simple SQL statements.

./sigma-web/900_System.dir/200_Parms.exe

This is the "Parms" screen, displayed to the right of the "Logins" tab. The program permits users to edit parameters contained in the "./config/sparms.cnf" file of the system.

./sigma-web/900_System.dir/300_Schedule.exe

This is the "Schedule" screen, displayed to the right of the "Parms" tab. The program permits users to specify programs that are started, stopped, and which are run at periodic intervals by the CO-svc.exe program. The program edits the "config/sched.cnf" file of the system.

./sigma-web/Util

This directory contains miscellaneous utilities that are launched by the other web programs. These utilities generally create a single tab, nested in the screen, and are launched by command line arguments.

./sigma-web/Util/wusys.exe

This is the "System Info" utility, launched via a hyperlink at the bottom of the "Parms" screen, which displays information on the current system configuration.

./system

This directory contains executable programs, and system components. This directory is in the search path of all programs launched by the "web.exe" program, hence is a useful location to put programs that are required by a user application. (That way, the developer does not have to specify the full path to the application program.)

./system/CO-install.exe

The Sigma installer program. This program is launched automatically after extracting Sigma files. It can be run after installation to reset configuration data and reconfigure the Apache server. For more information, see Installing-Sigma-Web-Framework.

./system/CO-svc.exe

The Sigma Service Manager / Scheduler program. This program is directly controlled by the Windows Service Manager entry, and is responsible for scheduling activities on the system, including starting and stopping the Sigma service. The program reads the "config/sched.cnf" file, which is edited by the "Schedule" program available under the "System" tab.

./system/CO-svc.log

The log file for the CO-svc.exe program above, containing any errors encountered by the system, and a list of processes that have been started. The file is overwritten each time the program starts (so does not require administrative maintenance.) It is provided mainly for system debug.

./system/CO-uninst.exe

The Sigma uninstaller program. This program is launched by the Windows "Add/Remove Programs" facility. It can be run manually to remove the registry items for Sigma, and uninstall the Sigma Framework Service. The program does not delete any files. For more installation, see Uninstalling-the-Sigma-Web-Framework.

./system/sigcmd.exe

A utility for outputting encrypted URLs, and performing other activities.

./system/sigma.dll

The Sigma DLL. This program is not actually required or used by any process in the core Sigma Framework system. (The core processes are statically linked) It is provided to complete the Sigma Framework API, used by developers to add their own applications to the system.

./temp

A temporary directory, required for the proper operation of Sigma. This directory MUST exist, and permit programs to write to the directory. Otherwise, side effects such as being unable to post arguments, will occur. For more information, see Troubleshooting-Sigma-Web-Framework-issues.

COLOR.BG_ON 

This directive provides the default color of active tabs. The default value of 000000 (black) is used if no other color information is available. This value is usually overridden by other elements of the program.

COLOR.BG_OFF

This directive provides the default color of non-active tabs. The default value of EEEEEE (gray) is used if no other color information is available. This value is usually overridden by other elements of the program.

COLOR.BORDER

This directive provides the default color of border frames. The default value of 999999 (dark gray) is used if no other color information is available. This value is usually overridden by other elements of the program.

COLOR.TEXT_ON

This directive provides the default color of text used in active tabs. The default value of FFFFFF (white) is used if no other color information is available. The value is usually overridden by other elements of the program.

COLOR.TEXT_OFF 

This directive provides the default color of text used in non-active tabs. The default value of 555555 (dark gray) is used if no other color information is available. The value is usually overridden by other elements of the program.

FONT.FACE 

This directive provides the default font face used in the program. The default value of "Helvetica" is used if no other font information is available. The value is usually overridden by other elements of the program.

FONT.SIZE 

This directive provides the default font size used in the program. The default value of 2 is used if no other font size information is available. The value is usually overridden by other elements of the program.

PATH.CGI_EXEC

This directive specifies the URL pathname used to find the main program, by default "/s-cgi/web.exe" This value has multiple arcane purposes, such as to redirect frames and borders when applying the program within an IFRAME, or some other framed system. The value should generally not be modified without consulting support and professional services.

PATH.START_URL 

This directive specifies the URL pathname used to find the tabbed programs and tab structure, by default the pathname "/sigma-web/". (A trailing slash is required for this value.) This value permits alternate systems of navigation tabs to be specified. The value should generally not be modified without consulting support and professional services.

PATH.HTML_URL

This directive specifies the URL pathname used to find general HTML documents, by default the pathname "/s-html/:. (A trailing slash is required for this value.) This value permits alternate systems of HTML documents to be specified. The value should generally not be modified without consulting support and professional services.

PATH.FOOTER

This directive specifies the disk pathname used to find the footer file, displayed at the bottom of screens. The default path "/s-html/s-footer.html" can be modified to point to some other footer value. The footer file is usually an HTML snippet that includes finalizing HTML information, including the closing </html> tag.

PATH.HEADER 

This directive specifies the disk pathname used to find the header file, displayed at the top of screens. The default path "/s-html/s-header.html" can be modified to point to some other header value. The header file is usually an HTML snippet that includes initial HTML, a banner, and other markup information, including the starting <html> tag.

PATH.START_DIR 

This directive specifies the disk pathname used to find tab programs, by default the path "../sigma-web". This value usually (but not necessarily) agrees with the "PATH.START_URL" value. (The "START_DIR" value specifies a disk path, whereas the "START_URL" value specifies a URL path.)

PATH.HTML_DIR

This directive specifies the disk pathname used to find html, by default the path "../s-html". This value usually (but not necessarily) agrees with the "PATH.HTML_URL" value. (The "HTML_DIR" value specifies a disk path, whereas the "HTML_URL" value specifies a URL path.)

PATH.SIDE_BAR

This directive, if included in the web.cnf file, specifies the disk pathname used to find an HTML file that is used with a side bar. The directive can be used to change the entire navigation scheme of the program, so that a side bar is used instead of nested tabs. The value should point to an existing HTML file snippet (without <html> or </html> directives) that is displayed to the left of the main window. See more information below. If the directive is specified, its value must point to a valid HTML file on the system.

SIZE.BUTTON

This directive specifies the minimum width of buttons on the system. The default value of "100" is used if no other sizing information is available. The value is usually overridden by other elements of the program.

SIZE.HTML_PAD

This directive specifies the size of an arbitrary textual pad that is placed between the tabs and the main HTML, used to render the tabs quickly on some browsers. The default value of 5000 characters generally affects only Mozilla type browsers, and is useful for rendering the tabs in advance of other data. (This is a characteristic of Firefox and a few other browsers, placed here only to modify the aesthetics of the browser rendering engine, and otherwise having no purpose.)