Registry Values

Server Appliance Kit

There are many different types of Web elements that can be stored in the Web element database; however, they all use the same basic parameters. The following table shows the different types of elements and their specific different requirements.

Value Type Description
ElementID Key Unique name for this element.

The naming convention for this value is <container name><unique part>. Start with the container name and concatenate a string which will make a unique name.

BigGraphic REG_SZ The large graphic symbol used on the navigation pages.
CaptionRID REG_SZ Caption resource identifier.
Container REG_SZ Name of the container for this element.
ContextURL REG_SZ URL for the Help page associated with this item.
CopyrightRID REG_SZ Resource identifier for the copyright string.
DescriptionRID REG_SZ Description resource identifier.
ElementGraphic REG_SZ The small graphic symbol used on navigation pages.
IsEmbedded DWORD Flag which tells system to process the element as an embedded page.

This should be zero (0) for most pages.

LocalUIMsgCode DWORD The message code passed to the local display driver.
LogDirectory String Absolute path to the log file directory.
Logfile String Two cases apply:

Single file log-This value is the name of the log file.

Multiple file log-A regular expression representing the template for finding files in the LogDirectory.

LongDescriptionRID REG_SZ Resource identifier for the long description used on navigation pages.
Merit DWORD Integer indicating sort order in container. 0=no sorting. Items with lower merit values will be displayed before items with higher merit values.
ObjectClass REG_SZ Optional. WMI class name. Reserved for future use.
ObjectKey REG_SZ Optional. WMI instance key. Reserved for future use.
PageType REG_SZ Specifies the page type required for specific navigation pages.
PropertiesURL String Relative path (from Web root) to the property page .asp file for this log.
Source REG_SZ Name of resource DLL that contains the resources for this item.
URL REG_SZ Relative path from the Web root to the file.
VersionRID REG_SZ Resource identifier for the version string.
WindowFeatures REG_SZ Sets parameters for window of new task.
  • ElementID
    This value must be unique for all the Web elements. Some types of elements place other constraints on this value. The naming convention for this value is <container name><unique part>, that is, start with the container name and concatenate a string which will make a unique name.
  • BigGraphic
    The large graphic symbol used on the navigation page for this element.
  • CaptionRID
    This is the identifier of the resource from the source DLL that is the short name for this item. Depending on the type of element that is using this registry value, it displayed on the navigation bar and is the heading for the task on the associated navigation page. Required for all elements.
  • Container
    This is the bucket to which this element belongs. When the Web Element Manager is queried with this name, the Web Element Manager will return this element and any others that have the same container value. Required for all elements.
  • ContextURL
    URL for the Help page associated with this item.
  • CopyrightRID
    This is the identifier of the resource from the source DLL that is the copyright string for this item.
  • DescriptionRID
    This is the identifier of the resource from the source DLL that is the description for this item. Depending on the type of element that is using this registry value, it constitutes the body of the clickable task element on a major task page. Required for all elements, this value can be blank.
  • ElementGraphic
    This is the path to the graphic symbol that will be displayed on a navigation page. Required for all elements,this value can be blank.
  • IsEmbedded
    This value indicates that the page specified in the URL value should be executed using server.execute. This value is used for About box items. The value must be 0, unless otherwise specified. Required for all elements.
  • LocalUIMsgCode
    This value is the message code passed to the local display driver. The meaning of each message code is described in the table:
    Bit # Message text Description
    All zeroes   No state information.
    0 Ready Operating system is running.
    1 Shutting down The server is shutting down.
    2 Network error Simple networking service has detected a local area network (LAN) error that potentially stops client computer communication.
    3 Hardware error A service has detected a fatal hardware error that potentially stops client computer communication.
    4 Checking disks Autochk.exe or chkdsk.exe is running.
    5 Backing up disks The Server Appliance Kit backup service is backing up user partition.
    6 Replace tape The Server Appliance Kit backup service has detected that the tape needs to be replaced or inserted.
    7 Replace disk The Server Appliance Kit backup service has detected that the disk needs to be replaced or inserted.
    8 Starting The Server Appliance Kit Local UI framework component will call at startup with this code and bitmap.
    9 N/A Wide area network (WAN) connected.
    10 N/A WAN error - for example, no dial tone.
    11 N/A Disk error - for example, dirty bit is set.
    12 Running additional tasks Startup is taking longer because CHKDSK is running.
    13 General error The system has encountered a problem that may affect its normal operation. Microsoft recommends that you check the local and Web UIs for detailed information about the problem.
    14 - 31 N/A Reserved for future use by Microsoft.
  • LongDescriptionRID
    This is the identifier of the resource from the source DLL that is the long description for this item. Depending on the type of element that is using this registry value, it is displayed as hover text on the taskbar, and for the clickable task element on the navigation page.
  • Merit
    This determines the order in which the Web Element Manager returns this element. The lower the number, the closer it will be to the top of the list, that is, the closer it will be to the left end of the navigation bar. Required for all elements.
  • ObjectClass
    Reserved.
  • ObjectKey
    Reserved.
  • PageType
    This value specifies the type of page the ASP page file in the URL requires. It can have the values shown in the table.
    Value Description
    NORMAL Renders a page that does not require the FRAMESET value in the current window.

    Navigation, area, and Object/Task Selector pages do not require the FRAMESET value.

    FRAMESET Renders a page that does require the FRAMESET value in the current window.

    Property, multitabbed property, and wizard pages all require the FRAMESET value.

    NEW Renders a non-FRAMESET value page in a new window.
  • Source
    This is the name of the DLL that contains the resources needed by this element. Required for all elements**.**
  • URL
    This is the URL path for the item. Each type of Web element uses the URL differently. See Adding a Web Task and the associated topics for adding each type of Web element for details about how each uses this value. Required for all elements.
  • VersionRID
    This is the identifier of the resource from the source DLL that is the version string for this item.
  • WindowFeatures
    This is for items that need a new window. It sets the window parameters.

Related Topics

Page Graphic

Adding a Resource to the Status or Shutdown Page

Page Graphic

Adding a Web Task

Page Graphic

Containers

Page Graphic

Web Framework API Overview