All ICR List

Package: Web Services Client ICR List

IA # Name Type Custodial Package Date Created DBIC Approval Status Status Usage File # General Description Remote Procedure Routine Date Activated
IA # Name Type Custodial Package Date Created DBIC Approval Status Status Usage File # General Description Remote Procedure Routine Date Activated
5420 XOBWLIB1 Routine WEB SERVICES CLIENT 2009/03/20 APPROVED Active Private
$$IMPORT^XOBWLIB1 allows a package's pre-init routine
to automatically import a Cache Object from an XML host file, without the
package needing to resort to Cache-specific code in its pre-init routine.
Pharmacy Re-engineering was a very early adopter of HWSC whose early preview
documentation recommended a style of XML parsing that requires the application
to provide (and therefore export and install) Cache Objects.
XOBWLIB1 2009/06/17
5421 XOBWLIB Routine WEB SERVICES CLIENT 2009/03/20 Under Revision Supported
Public APIs for the HWSC package.
XOBWLIB 2009/06/16
5458 xobw.RestRequest Other WEB SERVICES CLIENT 2009/06/10 APPROVED Active Supported
This class is used to make REST-type requests to an
external web service.
The class extends Cache's %Net.HttpRequest class. As such, all methods in the
parent class are avialable in this one as well.
2009/06/17
5459 xobw.error.BasicError Other WEB SERVICES CLIENT 2009/06/10 APPROVED Active Supported
class xobw.error.BasicError extends
xobw.error.AbstractError
Error class used by the HWSC error processing sub-system when a basic M/Cache
error occurs.
5460 xobw.error.DialogError Other WEB SERVICES CLIENT 2009/06/10 APPROVED Active Supported
class xobw.error.DialogError extends
xobw.error.AbstractError
Class for errors associated with DIALOG file (#.84) entries and used by the
HWSC error processing sub-system
The Kernel API EZBLD^DIALOG should be used to produce the 'text' property
value and the ien of the DIALOG file entry should be the 'code' property
value.
5461 xobw.error.HttpError Other WEB SERVICES CLIENT 2009/06/10 APPROVED Active Supported
class xobw.error.HttpError extends
xobw.error.AbstractError
Error class used by the HWSC error processing sub-system when an HTTP error
occurs.
5462 xobw.error.ObjectError Other WEB SERVICES CLIENT 2009/06/10 APPROVED Active Supported
class xobw.error.ObjectError extends
xobw.error.AbstractError
Error class used by the HWSC error processing sub-system when a CacheObject
error occurs.
5463 xobw.error.SoapError Other WEB SERVICES CLIENT 2009/06/10 APPROVED Active Supported
class xobw.error.SoapError extends
xobw.error.AbstractError
Error class used by the HWSC error processing sub-system when a SOAP fault is
returned.
2009/06/17
5813 Add Availability Resource to WEB SERVER File (#18.12) File WEB SERVICES CLIENT 2012/06/14 APPROVED Active Private 18.12
Pharmacy Data Management needs FILEMAN read/write
access for AUTHORIZED WEB SERVICES sub-file (#100) for WEB SERVER FILE
(#18.12). This includes the "B" cross-reference.
2012/09/06
5814 Read access for WEB SERVICE FILE (#18.02) File WEB SERVICES CLIENT 2012/06/15 APPROVED Active Private 18.02
Pharmacy Data Management needs FILEMAN read access for
WEB SERVICE FILE (#18.02).
2012/09/06
5891 WEB SERVER File (#18.12) access File WEB SERVICES CLIENT 2013/01/03 APPROVED Active Private 18.12
This agreement allows read-only access to the WEB
SERVER File (#18.12).
2014/05/30
6171 READ WRITE ACCESS TO WEB SERVER FILE File WEB SERVICES CLIENT 2015/03/03 APPROVED Retired Controlled Subscription 18.12
This request is for a one time use in patch SD*5.3*603
post installation processing.
Scheduling (PCMM Web) requests read and write access to the WEB SERVER
(#18.12) file. The post-install routine checks if the server record exists,
then either creates or updates the record using either the UPDATE^DIE or
FILE^DIE FileMan API calls, respectively. In addition it adds an entry (if it
doesn't exist) to the AUTHORIZED WEB SERVICES (#100) multiple, WEB SERVICE
(#.01) field using the UPDATE^DIE FileMan API.
This processing is done programmatically to avoid having sites manually
configure HWSC using the Web Server Manager.
Revision History:
- 3/18/24, effective with Kernel patch XU*8*802 which was released to support
WEB SERVER, EXPIRATION DATE of ICR reflects JAN 7,2025.
- 8/21/24, effective with patch SD*5.3*884 the Scheduling application is
requesting a one-time use in the SD*5.3*884 patch post installation processing
to create 2 new entries in the WEB SERVER (#18.12) file. The post-install
routine SDES884P will add two entries to the WEB SERVER (#18.12) file using
UPDATE^DIE: 1. To connect SD VVS WEB SERVER TEST to the VVS system from
VistA Test accounts. 2. To connect SD VVS WEB SERVER to the VVS system
from VistA Production accounts.
This processing is done programmatically to avoid having sites manually
configure the VVS interface manually using the Web Server Manager.
GLOBAL REFERENCE:
^XOB(18.12,D0
.01 NAME 0;1 Write w/Fileman
.04 SERVER 0;4 Write w/Fileman
.06 STATUS 0;6 Write w/Fileman
.07 DEFAULT HTTP TIMEOUT 0;7 Write w/Fileman
3.01 SSL ENABLED 3;1 Write w/Fileman
3.02 SSL CONFIGURATION 3;2 Write w/Fileman
3.03 SSL PORT 3;3 Write w/Fileman
100 AUTHORIZED WEB SERVICES multiple 100;0
.01 WEB SERVICE 0;1 Write w/Fileman
.06 STATUS 0;6 Write w/Fileman
2015/03/13
6172 WRITE ACCESS TO WEB SERVER LOOKUP KEY FILE File WEB SERVICES CLIENT 2015/03/03 APPROVED Active Private 18.13
This request is for a one time use in patch SD*5.3*603
post installation processing.
Scheduling (PCMM Web) requests write access to the WEB SERVER LOOKUP KEY
(#18.13) file. The post-install routine creates the lookup key record using
the supported $$SKEYADD^XOBWLIB API, and then updates the 18.13 record,
ASSOCIATED WEB SERVER (#.03) field using the FILE^DIE FileMan API call.
This processing is done programmatically to avoid having sites manually
configure HWSC using the Web Server Manager.
2015/03/13
6173 READ ACCESS TO THE WEB SERVICE FILE File WEB SERVICES CLIENT 2015/03/03 APPROVED Active Private 18.02
This request is for a one time use in patch SD*5.3*603
post installation processing.
Scheduling (PCMM Web) requests read access to the WEB SERVICE (#18.02) file.
The post-install routine creates a WEB SERVICE record using the supported
REGREST^XOBWLIB API, then reads the WEB SERVICE file with the $$FIND1^DIC
FileMan API to get the IEN of the WEB SERVICE record. Then in further
processing (reference ICR-6171) updates the WEB SERVER (#18.12) file,
AUTHORIZED WEB SERVICES (#100) multiple.
This processing is done programmatically to avoid having sites manually
configure HWSC using the Web Server Manager.
2015/03/13
6408 ADD/UPDATE RESOURCE ON WEB SERVER FILE (#18.12) File WEB SERVICES CLIENT 2016/05/18 APPROVED Active Private 18.12
The Master Veteran Index (MVI) team requests read/write
access to the WEB SERVER (#18.12) file to add a new entry during a
post-install process. The post-install routine process will create the new
server record entry using FILE^DICN and will also create a new entry to the
AUTHORIZED WEB SERVICES (#100) multiple, WEB SERVICE (#.01) field using the
FILE^DICN API.
In addition, the MVI team will require read/write access to the WEB SERVER
(#18.12) file to update the entry through the remote procedure (RPC) [MPI
VISTA HWS CONFIG] using FILE^DIE when needed/required.
NOTE: This processing is done programmatically to avoid having sites manually
configure HWSC using the Web Server Manager. This will ensure all sites have
the same configuration installed correctly.
2021/11/23
7129 WRITE ACCESS TO WEB SERVER FILE File WEB SERVICES CLIENT 2020/02/19 APPROVED Active Private 18.12
The CPRS (ORDER ENTRY/RESULTS REPORTING) team requests
read/write access to the WEB SERVER (#18.12) file to add a new entry during
the OR*3*519 post-install process. The post-install routine process will
create the new server record entry using UPDATE^DIE and will also create a new
entry to the AUTHORIZED WEB SERVICES (#100) multiple, WEB SERVICE (#.01)
field.
NOTE: This processing is done programmatically to avoid having sites manually
configure HWSC using the Web Server Manager. This will ensure all sites have
the same configuration installed correctly.
2020/03/20
7190 READ ACCESS TO THE WEB SERVICE FILE 18.02 File WEB SERVICES CLIENT 2020/08/05 APPROVED Active Private 18.02
This request is for a one time use in patch DG*5.3*1014
post installation processing.
Registration requests read access to the WEB SERVICE (#18.02) file. The
post-install routine creates a WEB SERVICE record using the supported
REGREST^XOBWLIB API, then reads the WEB SERVICE file with the $$GET1^DIQ
FileMan API to get the IEN of the WEB SERVICE record. Then in further
processing (reference pending ICR-7191) updates the WEB SERVER (#18.12) file,
AUTHORIZED WEB SERVICES (#100) multiple.
This processing is done programmatically to avoid having sites manually
configure HWSC using the Web Server Manager.
2020/10/19
7191 READ/WRITE ACCESS TO WEB SERVER FILE 18.12 File WEB SERVICES CLIENT 2020/08/05 APPROVED Active Private 18.12
The VistA REE (Registration, Eligibility and
Enrollment) team requests read/write access to the WEB SERVER (#18.12) file
to add a new entry during the DG*5.3*1014 post-install process. The
post-install routine process will create the new server record entry using
UPDATE^DIE and will also create a new entry to the AUTHORIZED WEB SERVICES
(#100) multiple, WEB SERVICE (#.01) field.
NOTE: This processing is done programmatically to avoid having sites manually
configure HWSC using the Web Server Manager. This will ensure all sites have
the same configuration installed correctly.
2020/10/19
7204 READ WRITE ACCESS TO WEB SERVER FILE File WEB SERVICES CLIENT 2020/10/01 APPROVED Active Controlled Subscription 18.12
This request is for a one time use in patch
GMRC*3.0*124 post installation processing.
GMRC (Consults Decision Support Tool) requests read and write access to the
WEB SERVER (#18.12) file. The post-install routine checks if the server
record exists, then either creates or updates the record using either the
UPDATE^DIE or FILE^DIE FileMan API calls, respectively. In addition it adds
an entry (if it doesn't exist) to the AUTHORIZED WEB SERVICES (#100) multiple,
WEB SERVICE (#.01) field using the UPDATE^DIE FileMan API.
This processing is done programmatically to avoid having sites manually
configure.
Revision History:
- Added 3/20/25 - This request is for a one time write access in patch
DVBA*2.7*255 post installation processing.
CAPRI (Compensation and Pension Record Interchange) requests read and write
access to the WEB SERVER (#18.12) file. The post-install routine checks if
the server record exists, then creates the record using the FILE^DICN FileMan
API call. In addition it adds an entry (if it doesn't exist) to the AUTHORIZED
WEB SERVICES (#100) multiple, WEB SERVICE (#.01) field using the UPDATE^DIE
FileMan API.
This processing is done programmatically to avoid having sites manually
configure.
The CAPRI routine that uses the HealtheVet Web Service Client uses
FIND1^DIC FileMan API to check the web server was installed before
proceeding.
2023/11/20
7205 READ WRITE ACCESS TO THE WEB SERVICE FILE File WEB SERVICES CLIENT 2020/10/01 APPROVED Active Controlled Subscription 18.02
This request is for a one time use in patch
GMRC*3.0*124 post installation processing.
GMRC (Consult Decision Support Tool) requests read and write access to the WEB
SERVICE (#18.02) file. The post-install routine creates a WEB SERVICE record.
Then in further processing (reference ICR-7204) updates the WEB SERVER
(#18.12) file, AUTHORIZED WEB SERVICES (#100) multiple.
This processing is done programmatically to avoid having sites manually
configure.
Revision History:
- Added 3/20/25:
This request is for a one time write access in patch DVBA*2.7*255 post
installation processing. CAPRI (Compensation and Pension Record Interchange)
requests read and write access to the WEB SERVICE (#18.02) file. The
post-install routine creates a WEB SERVICE record. Then in further processing
(reference ICR- 7204) updates the WEB SERVER (#18.12) file, AUTHORIZED WEB
SERVICES (#100) multiple.
This processing is done programmatically to avoid having sites manually
configure.
The CAPRI routine that uses the HealtheVet Web Service Client uses
FIND1^DIC FileMan API to check the web service was installed before
proceeding.
2023/11/21
7317 ADD ENTRY TO WEB SERVER FILE (#18.12) File WEB SERVICES CLIENT 2021/12/16 APPROVED Active Private
The Registration VAS team requests read/write access to the WEB
SERVER (#18.12) file to add a new entry during the DG*5.3*964
post-install process. The post-install routine process will create the
new server record entry using UPDATE^DIE and will also create a new entry
to the AUTHORIZED WEB SERVICES (#100) multiple, WEB SERVICE (#.01) field.
NOTE: This processing is done programmatically to avoid having sites
manually configure HWSC using the Web Server Manager. This will ensure
all sites have the same configuration installed correctly.
^XOB(18.12,D0
.01 NAME 0;1 Both R/W w/Fileman
.04 SERVER 0;4 Both R/W w/Fileman
.06 STATUS 0;6 Both R/W w/Fileman
.07 DEFAULT HTTP TIMEOUT 0;7 Both R/W w/Fileman
1.01 LOGIN REQUIRED 1;1 Both R/W w/Fileman
3.01 SSL ENABLED 3;1 Both R/W w/Fileman
3.02 SSL CONFIGURATION 3;2 Both R/W w/Fileman
3.03 SSL PORT 3;3 Both R/W w/Fileman
200 USERNAME 200;1 Both R/W w/Fileman
300 PASSWORD 300;1 Both R/W w/Fileman
^XOB(18.12,D0,100,D1
.01 NAME 0;1 Both R/W w/Fileman
.06 STATUS 0;6 Both R/W w/Fileman
2022/02/04
7414 WEB SERVER File (#18.12) access File WEB SERVICES CLIENT 2023/01/20 APPROVED Active Private 18.12 2023/01/24