Home Package List Routine Alphabetical List Global Alphabetical List FileMan Files List FileMan Sub-Files List Package Component Lists Package-Namespace Mapping

Info | Desc | Accessed By FileMan Db Calls | Pointed To By FileMan Files | Pointer To FileMan Files | Fields | ICR | Found Entries | All

Print Page as PDF

Global: ^XOB(18.12

Package: Web Services Client

Global: ^XOB(18.12

Information

FileMan FileNo	FileMan Filename	Package
18.12	WEB SERVER	Web Services Client

Description

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.

Accessed By FileMan Db Calls, Total: 29

Pointed To By FileMan Files, Total: 1

Pointer To FileMan Files, Total: 1

Fields, Total: 14

Field #	Name	Loc	Type	Details
.01	NAME	0;1	FREE TEXT	**********************REQUIRED 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)`
.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.`
.04	SERVER	0;4	FREE TEXT	**********************REQUIRED FIELD********************** 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.`
.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.`
.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]`
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.`
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`
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`
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.`
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`
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.`
100	AUTHORIZED WEB SERVICES	100;0	POINTER Multiple #18.121	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.`
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`
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`

Found Entries, Total: 15

ICR, Total: 8

ICR LINK	Subscribing Package(s)	Fields Referenced	Description
ICR #5813	Pharmacy Data Management	AUTHORIZED WEB SERVICES (100). Access: Both R/W w/Fileman WEB SERVICE (.01). Access: Both R/W w/Fileman STATUS (.06). Access: Both R/W w/Fileman
ICR #5891	Pharmacy Data Management	NAME (.01). Access: Read w/Fileman SERVER (.04). Access: Read w/Fileman
ICR #6171	Scheduling Oncology	NAME (.01). Access: Both R/W w/Fileman PORT (.03). Access: Write w/Fileman SERVER (.04). Access: Write w/Fileman STATUS (.06). Access: Write w/Fileman DEFAULT HTTP TIMEOUT (.07). Access: Write w/Fileman LOGIN REQUIRED (1.01). Access: Write w/Fileman SSL ENABLED (3.01). Access: Write w/Fileman AUTHORIZED WEB SERVICES (100). Access: Write w/Fileman WEB SERVICE (.01). Access: Write w/Fileman STATUS (.06). Access: Write w/Fileman
ICR #6408	Master Patient Index VistA Master Patient Index VistA Kernel	NAME (.01). Access: Both R/W w/Fileman SERVER (.04). Access: Both R/W w/Fileman STATUS (.06). Access: Both R/W w/Fileman DEFAULT HTTP TIMEOUT (.07). Access: Both R/W w/Fileman LOGIN REQUIRED (1.01). Access: Both R/W w/Fileman SSL ENABLED (3.01). Access: Both R/W w/Fileman SSL CONFIGURATION (3.02). Access: Both R/W w/Fileman SSL PORT (3.03). Access: Both R/W w/Fileman USERNAME (200). Access: Both R/W w/Fileman PASSWORD (300). Access: Both R/W w/Fileman NAME (.01). Access: Both R/W w/Fileman STATUS (.06). Access: Both R/W w/Fileman	Used to retrieve the Internal Entry Number (IEN) of theMVI's Web Server entries.
ICR #7129	Order Entry Results Reporting	NAME (.01). Access: Write w/Fileman SERVER (.04). Access: Write w/Fileman STATUS (.06). Access: Write w/Fileman DEFAULT HTTP TIMEOUT (.07). Access: Write w/Fileman LOGIN REQUIRED (1.01). Access: Write w/Fileman SSL ENABLED (3.01). Access: Write w/Fileman SSL CONFIGURATION (3.02). Access: Write w/Fileman SSL PORT (3.03). Access: Write w/Fileman USERNAME (200). Access: Write w/Fileman PASSWORD (300). Access: Write w/Fileman NAME (.01). Access: Write w/Fileman STATUS (.06). Access: Write w/Fileman
ICR #7191	Registration	NAME (.01). Access: Both R/W w/Fileman SERVER (.04). Access: Write w/Fileman STATUS (.06). Access: Write w/Fileman DEFAULT HTTP TIMEOUT (.07). Access: Write w/Fileman LOGIN REQUIRED (1.01). Access: Write w/Fileman SSL ENABLED (3.01). Access: Write w/Fileman SSL CONFIGURATION (3.02). Access: Write w/Fileman SSL PORT (3.03). Access: Write w/Fileman USERNAME (200). Access: Write w/Fileman PASSWORD (300). Access: Write w/Fileman NAME (.01). Access: Write w/Fileman STATUS (.06). Access: Write w/Fileman
ICR #7204	Consult Request Tracking Text Integration Utility	NAME (.01). Access: Write w/Fileman PORT (.03). Access: Write w/Fileman SERVER (.04). Access: Write w/Fileman STATUS (.06). Access: Write w/Fileman DEFAULT HTTP TIMEOUT (.07). Access: Write w/Fileman LOGIN REQUIRED (1.01). Access: Write w/Fileman SSL ENABLED (3.01). Access: Write w/Fileman AUTHORIZED WEB SERVICES (100). Access: Write w/Fileman WEB SERVICE (.01). Access: Write w/Fileman STATUS (.06). Access: Write w/Fileman	"B" cross reference used for lookup to determine whetherto add or edit entry.Loop to see if service exists to determine whether toadd or edit.
ICR #7317	Registration

Info | Desc | Accessed By FileMan Db Calls | Pointed To By FileMan Files | Pointer To FileMan Files | Fields | ICR | Found Entries | All