Limited supportBMC provides limited support for this version of the product. As a result, BMC no longer accepts comments in this space. If you encounter problems with the product version or the space, contact BMC Support.BMC recommends upgrading to the latest version of the product. To see documentation for that version, see BMC AMI Command Center for Security 6.2.

Using Sigma Web Framework macros in HTML files

The Macro function uses a straightforward substitution, where any text string within the HTML document, delimited by @@ characters, is replaced by another value. This value can be an environmental variable value, or can be a text string contained in a configuration file.

The configuration file can be dynamically generated, or can be static to simplify maintenance of the program. The specific operation of this facility is described below:

  1. If a .zcnf file, with the same name as the specified file, resides in the directory with an HTML file, that file is opened and read by the web.exe program. The .zcnf file must contain a list of tokens followed by text and a new line.
  2. The first token in the configuration file must consist of a word with letters, numbers, underscores, dashes, but no spaces. The first non-space character following the token is taken as the start of the value, until the end of the line. Examples of valid configuration files, which implement this format, can be found in the installationDirectory/config directory of the installation. Replace installationDirectory with the directory in which you installed the product. The default directory is C:\Program Files\BMC Software\BMC Defender.
  3. As the HTML file is scanned, any occurrence of @@ characters in the HTML file are immediately replaced by the value of the token (if any) read from the configuration file. The @@ is eliminated, and immediately replaced with the macro value before the HTML is displayed.

For example, a web page named sigma-web/001_Myfile.html may have an accompanying file sigma-web/001_Myfile.zcnf, which contains a list of macro names and values. When the Myfile tab is clicked, the web page is displayed, and any macro definitions in web page (delimited by @@ characters) will be substituted with the values contained in 001_Myfile.zcnf.

The above facility permits a general sort of simple dynamic HTML to be implemented, where specific HTML documents can contain variable fields. The .zcnf files can be maintained as part of the framework, and can be dynamically generated (such as using the Sigma Scheduler facility, mentioned in a previous section.) This provides a very simple and straightforward way of making dynamic web pages without any strenuous programming required.

Note that these macro files are currently limited to only one line of content, without any ability to span multiple lines. (Each line of the macro file is necessarily delimited by a new line character, hence cannot span multiple lines of text.) Each macro name is limited to 50 characters, and the replacement text is limited to 500 characters.

Finally, note that the actual content of the 001_Myfile.zcnf will not otherwise be visible to the user (since the .zcnf extension is not supported by Sigma, hence no tab will be created for this file.)

Related topics

Using

Using-Sigma-Web-Framework


 

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