STANDARD DATA DICTIONARY #18.13 -- WEB SERVER LOOKUP KEY FILE                                                     3/24/25    PAGE 1
STORED IN ^XOB(18.13,  (2 ENTRIES)   SITE: WWW.BMIRWIN.COM   UCI: VISTA,VISTA                                      (VERSION 1.0)   

DATA          NAME                  GLOBAL        DATA
ELEMENT       TITLE                 LOCATION      TYPE
-----------------------------------------------------------------------------------------------------------------------------------
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.  


              DD ACCESS: @
              RD ACCESS: @
              WR ACCESS: @
             DEL ACCESS: @
           LAYGO ACCESS: @
           AUDIT ACCESS: @

PRIMARY KEY:        A (#79)
  Uniqueness Index: PRIMARY (#885)
       File, Field: 1) KEY NAME (18.13,.01)

CROSS
REFERENCED BY: KEY NAME(B), ASSOCIATED WEB SERVER(WS)

INDEXED BY:    KEY NAME (PRIMARY)




18.13,.01     KEY NAME               0;1 FREE TEXT (Required) (Key field)

              INPUT TRANSFORM:  S X=$$UP^XLFSTR(X) K:$L(X)>30!($L(X)<3)!'(X'?1P.E) X
              LAST EDITED:      MAY 02, 2007 
              HELP-PROMPT:      Enter a unique lookup key value (3-30 characters) 
              DESCRIPTION:      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.  

              NOTES:            XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER

              CROSS-REFERENCE:  18.13^B 
                                1)= S ^XOB(18.13,"B",$E(X,1,30),DA)=""
                                2)= K ^XOB(18.13,"B",$E(X,1,30),DA)

              FIELD INDEX:      PRIMARY (#885)    REGULAR    IR    LOOKUP & SORTING
                   Unique for:  Key A (#79), File #18.13
                  Short Descr:  Uniqueness Index for Key 'A' of File #18.13
                    Set Logic:  S ^XOB(18.13,"PRIMARY",X,DA)=""
                   Kill Logic:  K ^XOB(18.13,"PRIMARY",X,DA)
                   Whole Kill:  K ^XOB(18.13,"PRIMARY")
                         X(1):  KEY NAME  (18.13,.01)  (Subscr 1)


18.13,.02     BRIEF DESCRIPTION      0;2 FREE TEXT

              INPUT TRANSFORM:  K:$L(X)>50!($L(X)<2) X
              LAST EDITED:      MAY 02, 2007 
              HELP-PROMPT:      Enter a brief description on the purpose of the key (2-50 characters) 
              DESCRIPTION:      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.  


18.13,.03     ASSOCIATED WEB SERVER  0;3 POINTER TO WEB SERVER FILE (#18.12)

              LAST EDITED:      MAY 02, 2007 
              HELP-PROMPT:      Enter the web server to be associated with the lookup key 
              DESCRIPTION:      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.  

              CROSS-REFERENCE:  18.13^WS 
                                1)= S ^XOB(18.13,"WS",$E(X,1,30),DA)=""
                                2)= K ^XOB(18.13,"WS",$E(X,1,30),DA)



      FILES POINTED TO                      FIELDS

WEB SERVER (#18.12)               ASSOCIATED WEB SERVER (#.03)



INPUT TEMPLATE(S):
XOBW WEB SERVER KEY SETUP     APR 09, 2007@09:17  USER #0    

PRINT TEMPLATE(S):

SORT TEMPLATE(S):

FORM(S)/BLOCK(S):