STANDARD DATA DICTIONARY #18.12 -- WEB SERVER FILE 3/24/25 PAGE 1
STORED IN ^XOB(18.12, (14 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 1.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file contains the web server(s) and associated information required for HealtheVet Web Service Client (HWSC) to communicate
with the server using SOAP and REST web services over HTTP.
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
PRIMARY KEY: A (#78)
Uniqueness Index: PRIMARY (#884)
File, Field: 1) NAME (18.12,.01)
POINTED TO BY: ASSOCIATED WEB SERVER field (#.03) of the WEB SERVER LOOKUP KEY File (#18.13)
CROSS
REFERENCED BY: WEB SERVICE(AB), NAME(B)
INDEXED BY: NAME (PRIMARY)
18.12,.01 NAME 0;1 FREE TEXT (Required) (Key field)
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3)!'(X'?1P.E) X
LAST EDITED: APR 30, 2007
HELP-PROMPT: Name must be 3-30 characters and must be unique
DESCRIPTION: This field indicates the user friendly name of the web services server defined by this entry.
The value must be unique compared to the NAME field value of the other entries in this file.
CROSS-REFERENCE: 18.12^B
1)= S ^XOB(18.12,"B",$E(X,1,30),DA)=""
2)= K ^XOB(18.12,"B",$E(X,1,30),DA)
FIELD INDEX: PRIMARY (#884) REGULAR IR LOOKUP & SORTING
Unique for: Key A (#78), File #18.12
Short Descr: Uniqueness Index for Key 'A' of File #18.12
Set Logic: S ^XOB(18.12,"PRIMARY",X,DA)=""
Kill Logic: K ^XOB(18.12,"PRIMARY",X,DA)
Whole Kill: K ^XOB(18.12,"PRIMARY")
X(1): NAME (18.12,.01) (Subscr 1)
18.12,.03 PORT 0;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>64000)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: APR 18, 2007
HELP-PROMPT: Enter a port number between 1 and 64000
DESCRIPTION:
This field indicates the port for the web service.
18.12,.04 SERVER 0;4 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>60!($L(X)<3) X
LAST EDITED: APR 16, 2007
HELP-PROMPT: Enter ip address or domain name of the web server
DESCRIPTION: This field indicates the ip address or domain name of the web server.
If the SSL ENABLED (#3.01) field is TRUE, this SERVER field may need to be a domain name.
As part of the Cache SSL configuration setup, if SSL/TLS peer (server) verification is required,
you must enter the Domain Name of the server in this SERVER field.
The verification will fail if an ip address is specified because the server's certificate common
name [CN] value will not match.
Note: This 'Peer certificate verification level' is specified
during SSL configuration setup when using Cache's System
Management Portal.
18.12,.06 STATUS 0;6 SET
'1' FOR ENABLED;
'0' FOR DISABLED;
LAST EDITED: JUL 17, 2006
HELP-PROMPT: Is the web service server available?
DESCRIPTION: This field indicates whether or not the web service server is available for use (ENABLED) using
this entry.
18.12,.07 DEFAULT HTTP TIMEOUT 0;7 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>7200)!(X<5)!(X?.E1"."1.N) X
LAST EDITED: MAY 17, 2007
HELP-PROMPT: Enter the default HTTP timeout in seconds from 5 to 7200
DESCRIPTION: This field indicates the number of seconds to use as the default HTTP timeout for requests to the
web server.
[Default: 30 seconds]
18.12,1.01 LOGIN REQUIRED 1;1 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: FEB 12, 2007
HELP-PROMPT: Is login required for this web server
DESCRIPTION:
This field indicates whether or not login is required for the web server.
18.12,1.02 Want to edit PASSWORD (Y/N) 1;2 FREE TEXT
INPUT TRANSFORM: DO EDIT^XOBWPWD
LAST EDITED: FEB 12, 2007
HELP-PROMPT: Enter 'Y' if you wish to edit at this time, 'N' otherwise.
DESCRIPTION: Entering YES to this field calls the routine for entering a PASSWORD. No data is stored for this
field.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
18.12,1.03 DATE PASSWORD LAST CHANGED 1;3 DATE
INPUT TRANSFORM: S %DT="ESTX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: FEB 12, 2007
HELP-PROMPT: (No range limit on date)
DESCRIPTION: This field is triggered by a change in the PASSWORD.
The purpose of the field is to track the last time the PASSWORD was changed.
WRITE AUTHORITY: ^
UNEDITABLE
NOTES: TRIGGERED by the PASSWORD field of the WEB SERVER File
18.12,3.01 SSL ENABLED 3;1 SET
'0' FOR FALSE;
'1' FOR TRUE;
LAST EDITED: APR 16, 2007
HELP-PROMPT: Is SSL enabled for this web server
DESCRIPTION: This field indicates whether SSL is enabled for this server.
As part of the Cache SSL configuration setup, if SSL/TLS peer (server) verification is required,
you must enter the Domain Name of the server in field SERVER (#.04).
The verification will fail if an ip address is specified because the server's certificate common
name [CN] value will not match.
Note: This 'Peer certificate verification level' is specified
during SSL configuration setup when using Cache's System
Management Portal.
18.12,3.02 SSL CONFIGURATION 3;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>40!($L(X)<1) X IF $DATA(X),'$$CHKNAME^XOBWSSL(X) KILL X
LAST EDITED: MAY 22, 2007
HELP-PROMPT: Name of SSL configuration to use for this web server
DESCRIPTION: This field contains the name of the Cache SSL configuration associated with the web server.
The Cache SSL configurations are defined as part of Cache's System Management Portal.
EXECUTABLE HELP: DO DISPLAY^XOBWSSL
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
18.12,3.03 SSL PORT 3;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>64000)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAY 22, 2007
HELP-PROMPT: SSL port number to use for this web server
DESCRIPTION:
This field contains the port number for SSL connectivity.
18.12,100 AUTHORIZED WEB SERVICES 100;0 POINTER Multiple #18.121
LAST EDITED: MAR 15, 2007
DESCRIPTION: This multiple contains the list of web services that the web server is authorized to contact in
order to a issue request.
18.121,.01 WEB SERVICE 0;1 POINTER TO WEB SERVICE FILE (#18.02) (Multiply asked)
LAST EDITED: APR 30, 2007
DESCRIPTION: This field contains the name (pointer) of a web service that the web server is authorized to
contact in order to a issue request.
CROSS-REFERENCE: 18.121^B
1)= S ^XOB(18.12,DA(1),100,"B",$E(X,1,30),DA)=""
2)= K ^XOB(18.12,DA(1),100,"B",$E(X,1,30),DA)
CROSS-REFERENCE: 18.12^AB
1)= S ^XOB(18.12,"AB",$E(X,1,30),DA(1),DA)=""
2)= K ^XOB(18.12,"AB",$E(X,1,30),DA(1),DA)
facilitated deletion of entries when the web service itself is deleted.
18.121,.06 STATUS 0;6 SET
'1' FOR ENABLED;
'0' FOR DISABLED;
LAST EDITED: APR 30, 2007
HELP-PROMPT: Is the web service available for use on server?
DESCRIPTION: This field indicates whether or not the web service is available for use (ENABLED) for the
server.
18.12,200 USERNAME 200;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>50!($L(X)<3) X
LAST EDITED: FEB 12, 2007
HELP-PROMPT: Name of the authorized user in the security realm on the web server.
DESCRIPTION: Name of a user in the security realm on server that is authorized to call the web server.
The user usually is required to be in a 'role' as defined by the web.xml.
Examples of relevant sections of the web.xml:
These are the roles who have access
XOBW_Tester_Users
...
XOBW Tester User
XOBW_Tester_Users
18.12,300 PASSWORD 300;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>50!($L(X)<1) X
OUTPUT TRANSFORM: SET Y(0)=Y,Y=""
LAST EDITED: FEB 12, 2007
HELP-PROMPT: Password for server.
DESCRIPTION: The password associated with the user indicated in the USERNAME (#200) field.
This password is encrypted/decrypted and stored in the M account. Currently, Advanced Encryption
Standard (AES) is being used for the encryption algorithm.
UNEDITABLE
CROSS-REFERENCE: ^^TRIGGER^18.12^1.03
1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^XOB(18.12,D0,1)):^(1),1:"") S X=$P(Y(1),U,3),X=X S
DIU=X K Y S X=DIV S %=$P($H,",",2),X=DT_(%\60#60/100+(%\3600)+(%#60/10000)/100) X ^DD(18.12,300,1,1
,1.4)
1.4)= S DIH=$G(^XOB(18.12,DIV(0),1)),DIV=X S $P(^(1),U,3)=DIV,DIH=18.12,DIG=1.03 D ^DICR
2)= Q
CREATE VALUE)= NOW
DELETE VALUE)= NO EFFECT
FIELD)= DATE PASSWORD LAST CHANGED
FILES POINTED TO FIELDS
WEB SERVICE (#18.02) AUTHORIZED WEB SERVICES:WEB SERVICE (#.01)
INPUT TEMPLATE(S):
XOBW WEB SERVER SETUP MAY 31, 2007@07:23 USER #0
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):