Sigma Web Framework API

Note that the information in this section may be subject to licensing restrictions, and may require additional licensing and Professional Services (PS) in order to implement. The notes of this section are applicable only to certain types of licenses available from BMC.

In the previous section, the use of simple scripting languages (in particular, Windows Batch files) was discussed. This section begins the discussion of how to use the Sigma Framework Application Program Interface (API) calls to construct programs in C / C++, other compiled languages.

  • Configuration Data Functions. The Sigma Framework contains various routines that permit the reading, writing, setting, and fetching of configuration data from files. This configuration data can be used as a global data store.
  • HTML Generation Functions. The Sigma Framework contains various routines that assist in the generation of HTML, including the ability to create encrypted URLs, Select Menus, and other markup code.
  • Miscellaneous Utility Functions. The Sigma Framework contains various routines that provide general utility in processing string text, acquiring directory lists, manipulating time values, and performing system housekeeping.

This section will mainly be useful to application developers, wishing to add new screens to the Sigma Framework. It is written as a brief command reference, where each function is identified in terms of its inputs, outputs, and return values.

Additional notes

  • The Sigma Framework provides the Sigma.dll, which resides in the "system" directory of the installation. This directory is always added to the search path of the program by the "web.exe" program, hence this DLL is available to all programs in the framework.
  • On selected systems, the "Sigma.lib" and include files are provided in the "sdk" directory of the installation, which permits C and C++ programmers to access framework functions needed to perform a variety of activities.
  • The Sigma Framework API contains components needed to read and process configuration data, generate HTML, and perform special utility functions for a programmer.
  • The Sigma Framework includes the "Sigcmd.exe" utility, which resides in the "system" directory of the installation. This utility provides functions that are useful to script programs, including Windows batch file scripts. This utility accepts as input the name of an API function, and displays the return value to standard output.
  • The Sigcmd.exe program provides the ability to encode URL components, access to the HTML macro replacement functions, and a variety of other functions that can accommodate simple and more sophisticated scripting applications
  • The Runsql.exe program provides a simple interface to permit SQL queries to be executed on ODBC compatible databases, including the ability to incorporate the results of these queries into web pages.
  • The Runsql.exe program requires a configuration file to be created by the user, which specifies the DSN name, the username, password, and other information. More information on this program and this configuration file is provided in Appendix B of this distribution.
  • The Sigma SDK is available on request, and is subject to additional licensing costs. Contact us for more information.

This section has provided only an overview of the API, which may be sufficient for most programmers to write their own application programs. Sigma is an open system, and other features of the API (not discussed here) Are available. On selected systems, the Sigma Framework SDK may include template files, additional documentation, and code stubs.

For more information on the Sigma API, contact the distributor.

This section contains the following topics:

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*