xcmHrDevAlertHelpReference

A key into a help reference.  This key is intended for machine 
usage as either a key into a database or as part of a path name 
to additional information.
              
Usage:  This string may be used by a management station to 
construct the complete URL or pathname of a file which may be 
stored on the management station, the managed device, a 
customer's server or a Xerox web server.  The mechanism by which 
the URL or pathname should be constructed, including any 
requested localization, is product- and application- dependent.
              
For example, if the device returns a string containing two path
components <product-name>/<info-path>, a host-based management
application might construct either the pathname 
'<install-dir>/<product-name>/<info-path>.<locale>' or 
'<install-dir>/<locale>/<product-name>/<info-path>' depending
on how the author wanted to organize and distribute help files
for various products and locales.  A web-based application with 
knowledge of the managed device's embedded web server might be 
able to construct the URL 
'http://<device-address>/alert-info/<product-name>/<info-path>'
and request a specific localization via the HTTP 'accept-
language' and 'accept-charset' headers.
              
Usage:  Implementors SHALL use only the US-ASCII alphanumeric 
characters 'A'-'Z', 'a'-'z', '0'-'9' and the punctuation marks 
underscore ('_'), hyphen ('-'), and forward slash ('/').  The
first and last characters must be alphanumeric.
              
Implementors should note that some hosts distinguish between
upper- and lower-case letters in pathnames and others don't.
              
              
Therefore, different help paths should differ by more than just
letter case, and product documentation MUST accurately reflect
the strings returned in 'xcmHrDevAlertHelpReference', including
letter case.
              
Rationale:  Limiting the character set in this way ensures that 
the string can be used to construct a valid pathname or URL on   
the widest variety of host systems.  Note that the file name is  
not localized (although the contents may be) and not generally   
displayed for users, so there is little need to support 
characters outside of this basic US-ASCII set.

MIB

XEROX-HOST-RESOURCES-EXT-MIB

OID

.1.3.6.1.4.1.253.8.53.17.2.1.11

Type

column

Access

readonly

Status

current

Parent

xcmHrDevAlertEntry

Table

xcmHrDevAlertTable

Siblings

14