Files > WEB SERVER LOOKUP KEY

name

WEB SERVER LOOKUP KEY

number

18.13

location

^XOB(18.13,

description

This file contains lookup key names that are mapped to WEB SERVER file entries. These key-to-server mappings allow application developers to code using key names and call the appropriate HWSC API at run-time to resolve the server using the key name as input to the API. There is also a deployment time API that can be use to registered the key name during the installation of application.

Fields

#	Name	Location	Type	Details	Index	Description
.01	key name(+)	0;1	FREE TEXT		B	This field contains the lookup key value. This value is often entered by an application during the post-init process using the SKEYADD^XOBWLIB() API. At run-time, the application will use the SNAME4KY^XOBWLIB() API to retrieve the name of the server the site has associated with the key. The value must be unique compared to the KEY NAME field value of the other entries in this file. The value will be forced to all uppercase if it is not already all uppercase when entered.
.02	brief description	0;2	FREE TEXT			This field contains a brief description that explains the purpose of the lookup key. This description is displayed in various screens and reports related to lookup keys.
.03	associated web server	0;3	POINTER	18.12	WS	This field contains the WEB SERVER (#18.12) file entry associated with this lookup key. The SNAME4KY^XOBWLIB() API will return the NAME (#.01) field of this WEB SERVER entry.