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 | Fields | ICR | Found Entries | All

Print Page as PDF

Global: ^XOB(18.02

Package: Web Services Client

Global: ^XOB(18.02

Information

FileMan FileNo	FileMan Filename	Package
18.02	WEB SERVICE	Web Services Client

Description

The entries in this file contain the connection related and proxy class information of remote web services. This information is required in order for the HealtheVet Web Services Client (HWSC) application to call remote web services.

Accessed By FileMan Db Calls, Total: 23

Pointed To By FileMan Files, Total: 1

Fields, Total: 7

Field #	Name	Loc	Type	Details
.01	NAME	0;1	FREE TEXT	**********************REQUIRED FIELD********************** INPUT TRANSFORM: `K:$L(X)>30!(X?.N)!($L(X)<3)!'(X'?1P.E) X` LAST EDITED: `APR 30, 2007` HELP-PROMPT: `Name must 3-30 characters in length and must be unique` DESCRIPTION: `User friendly name for the web service entry. The name should be prefixed with a package prefix (ex. XOBW TESTER WEB SERVICE).` `The value must be unique compared to the NAME field value of the other entries in this file.` CROSS-REFERENCE: `18.02^B` `1)= S ^XOB(18.02,"B",$E(X,1,30),DA)=""` `2)= K ^XOB(18.02,"B",$E(X,1,30),DA)` FIELD INDEX: `PRIMARY (#883) REGULAR IR LOOKUP & SORTING` `Unique for: Key A (#77), File #18.02` `Short Descr: Uniqueness Index for Key 'A' of File #18.02` `Set Logic: S ^XOB(18.02,"PRIMARY",X,DA)=""` `Kill Logic: K ^XOB(18.02,"PRIMARY",X,DA)` `Whole Kill: K ^XOB(18.02,"PRIMARY")` `X(1): NAME (18.02,.01) (Subscr 1)`
.02	TYPE	0;2	SET	**********************REQUIRED FIELD********************** '1' FOR SOAP; '2' FOR REST; LAST EDITED: `MAR 12, 2007` HELP-PROMPT: `Enter the type of web service [SOAP \| REST]`
.03	DATE REGISTERED	0;3	DATE	INPUT TRANSFORM: `S %DT="ESTXR" D ^%DT S X=Y K:X<1 X` LAST EDITED: `APR 30, 2007` HELP-PROMPT: `Enter the date and time to indicate when the service is registered` DESCRIPTION: `This field indicates the date the web service was registered into VistA, usually via the GENPORT^XOBWLIB or REGREST^XOBWLIB deployment time APIs.`
100	PROXY CLASS NAME	100;1	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>245!($L(X)<3) X` LAST EDITED: `MAY 30, 2007` HELP-PROMPT: `Name of CacheObject class for the web service client proxy` DESCRIPTION: `Name of the CacheObject class for the web service client proxy (i.e HTTP port class).` `This name should include package indicator. (Example: hwsc.TesterWebServiceHttpPort where 'hwsc' is the package indicator.)` `This field should only be entered via the API $$GENPORT^XOBWD(...).` `For an example of how to call the API, see the post-init for the HealtheVet Web Services Client (HWSC) install. (Routine XOBWPST and specifically the GENPORT tag.)`
200	CONTEXT ROOT	200;1	FREE TEXT	**********************REQUIRED FIELD********************** INPUT TRANSFORM: `K:$L(X)>245!($L(X)<1) X` LAST EDITED: `MAY 30, 2007` HELP-PROMPT: `Enter the context root of the web service` DESCRIPTION: `This field contains the web service context root.` `This field should only be entered via the API $$GENPORT^XOBWD(...). The value of this field is derived from the wsdl file. (The 'location' attribute of the 'wsdlsoap:address' element of the wsdl is the source.)` `For an example of how to call the API, see the post-init for the HealtheVet Web Services Client install. (Routine XOBWPST and specifically the GENPORT tag.)`
201	AVAILABILITY RESOURCE	201;1	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>245!($L(X)<1) X` LAST EDITED: `APR 19, 2007` HELP-PROMPT: `Enter URL portion following context root to check svc availability` DESCRIPTION: `Enter the portion of a URL to append following the service's context root, for availability testing. For SOAP web services this could be an additional portion of the URL to reach the service's WSDL document, e.g., '?wsdl'` `(without quotes); for REST web services this could the additional portion of the URL to reach a safe resource to perform an HTTP GET against for the purpose of checking service availability.`
300	WSDL	300;0	WORD-PROCESSING #18.022	LAST EDITED: `MAY 22, 2007`

Found Entries, Total: 17

ICR, Total: 4

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