Pats 0 Systems Management Guide

Introduction

The Patient Advocate Tracking System (PATS) provides a way of documenting, tracking and communicating patient-related issues.

The PATS Systems Management Guide gives a technical description of PATS for supporting and maintaining the application. The intended audience of this guide is IRM, HSI, Product Support, and PIMS.
PATS is a web based application. Both the PATS application and the database are maintained at the HSI Data Center in Martinsburg.

Chapter Descriptions and Roles

The guide is divided into the following sections:

Chapter	Chapter Name	Intended Audience
1	PATS Application	Java developers and System Admin
2	Java Enterprise Developer Workstation	Java developers and System Admin
3	Business Rules	Business layer developer at HSI, Maintenance and Product Support
4	Database – M VistA	IRM staff, Maintenance, and Product Support
5	Database – Oracle	DBA at the HSI, Maintenance, and Product Support
6	Business Objects XI	HSI, Maintenance, and Product Support
7	Troubleshooting PATS Reports	HSI and Product Support

This page is left blank intentionally

1.0 PATS Application

PATS is designed to run on a J2EE 1.3 compliant application server running on a 1.4 JVM.

1.1 Enterprise Archive

PATS deploys as a Java enterprise archive named PATS-APP-major.minor.revision.buildnumber.ear containing the following elements.

1.1.1 Application.xml

This file exists in the META-INF directory per the Java enterprise 1.3 specifications. The contents are the modules and logical security roles of the PATS application.


Context-root ‘/PATS’ in the META-INF/application.xml is the default context root specifier for the PATS application. This entry in the deployment descriptor can be updated appropriately based on the server context root requirements

1.1.2 Weblogic-application.xml

No special settings used in this deployment descriptor.

1.1.3 APP-INF

The classes directory contains configuration files updated at development time (see section 1.1.4.3 for a description):

• 
  application.properties
  
• 
  ApplicationResources.properties
  
• 
  buildnumber.properties
  
• 
  caipConfig.xml
  
• 
  commands.properties
  
• 
  pagenumber.properties
  
• 
  patsweb.properties
  
• 
  PersonLookupResources.properties
  
• 
  URL.properties
  

The lib directory contains jar files for the PATS enterprise application:

Directory Name	Description
boconfig.jar	BOEXI
CAIP.jar	CAIP archive
cecore.jar	BOEXI
celib.jar	BOEXI
ceplugins.jar	BOEXI
Directory Name	Description
cereports.jar	BOEXI
cHSIssion.jar	BOEXI
ceutils.jar	BOEXI
cexsd.jar	BOEXI
commons-beanutils.jar	Apache Jakarta Commons
commons-collections-3.0.jar	Apache Jakarta Commons
commons-digester.jar	Apache Jakarta Commons
commons-discovery.jar	Apache Jakarta Commons
commons-httpclient-2.0.1.jar	Apache Jakarta Commons
commons-logging-1.0.3.jar	Apache Jakarta Commons
commons-resources.jar	Apache Jakarta Commons
commons-validator.jar	Apache Jakarta Commons
CorbaIDL.jar	BOEXI
ebus405.jar	BOEXI
gov.va.med.pats.common.jar	PATS
gov.va.med.pats.dao.jar	PATS
gov.va.med.pats.delegate.jar	PATS
gov.va.med.pats.report.jar	PATS
hivemind-1.1.1.jar	Apache Jakarta HiveMind
hivemind-jmx-1.1.1.jar	Apache Jakarta HiveMind
hivemind-lib-1.1.1.jar	Apache Jakarta HiveMind
jakarta-oro-2.0.8.jar	Apache Jakarta ORO
Directory Name	Description
javassist-3.0.jar	JBoss
jrecom.jar	BOEXI
jtools.jar	BOEXI
NamingDirectoryService-client.jar	NDS
PatientServiceR2.jar	PSC
rasapp.jar	BOEXI
rascore.jar	BOEXI
ReportPrinter.jar	BOEXI
ReportTemplate.jar	BOEXI
rpoifs.jar	BOEXI
Serialization.jar	BOEXI
u211java.jar	BOEXI
URIUtil.jar	Apache Jakarta Commons HttpClient
vha-stddata-basic-18.0.jar	SDS
vha-stddata-client-18.0.jar	SDS
webi.jar	BOEXI
webreporting.jar	BOEXI
webreporting-core.jar	BOEXI

1.1.4 Web Application

The PATS enterprise archive contains the PATS web application. The root contents are virtual directories and the WEB-INF directory.

1.1.4.1 Virtual Directories

PATS has the following virtual directories underneath the web context root:

Directory Name	Description
crystalreportviewers10	contains the style sheets and images for viewing crystal reports
help	contains the help files for the SIT, SRCU and VU roles
javascript	contains common Javascript files used by the jsp pages
jsp	root virtual directory for the core PATS application
login	contains KAAJEE sub-component
META-INF	Web Application descriptor per the J2EE specifications
npohelp	NPO-user help files
plu	PSL sub-component
stylesheets	PSL stylesheets
WEB-INF	contains web application configuration per the J2EE specifications

1.1.4.2 Web.xml and Weblogic.xml

Web.xml is the main configuration file for the PATS web application. Web.xml contains:

• 
  context parameters
  
• 
  servlets
  
• 
  servlet mappings
  
• 
  filters
  
• 
  filter mappings
  
• 
  ejb local references
  
• 
  security roles
  

• 
  security constraints
  
• 
  login configuration
  
• 
  taglib declarations
  
• 
  welcome files
  
• 
  error pages
  
• 
  mime mappings
  
• 
  listeners
  

Weblogic.xml contains the mapping of the logical Java enterprise role to the physical WebLogic security realm.

1.1.4.3 Other Configuration Files

WEB-INF contains the KAAJEE configuration file kaajeeConfig.xml as well as PSL’s struts-config-plu.xml.

PATS uses an internal MVC framework. The files for administering the PATS MVC framework are contained in the APP-INF\classes folder of the enterprise application. These files are:

• 
  commands.properties – contains the mapping of URL actions to PATS action classes in the package gov.va.med.pats.ui.command.
  
• 
  pagenumber.properties – each JSP page has a page number property specified in this file.
  
• 
  patsweb.properties – contains the user interface version number, plu security setting, and return row count property for the number of rows to display in list screens, and page sensitive help settings. Also contains the list of authorized IP addresses for the PAD SOAP web service, and switch for the PAD development tools.
  
• 
  URL.properties – contains the mapping of PATS events to physical JSP files.
  
• 
  Note: Other property files in the APP-INF\classes folder are used by the service dependencies.
  

1.1.4.4 Stylesheets

The main PATS stylesheet is the file named style.css in the virtual directory /jsp/css. This stylesheet provides a consistent look and feel throughout PATS.

The files located in the /jsp/css/aqua virtual directory are stylesheets used by the pop-up calendar to aid in date selection.

1.1.4.5 Libraries

The PATS web application contains the following libraries in the WEB-INF/lib directory:

File Name	Description
commons-httpclient-2.0.1.jar	Apache Jakarta Commons
File Name	Description
jakarta-regexp-1.3.jar	Jakarta
kaajee-1.0.1.003.jar	KAAJEE
keycodeDecoder.jar	BOEXI
LongList.jar	PSL
MetafileRenderer.jar	BOEXI
pslWeb_4.0.4.3.jar	PSL
struts.jar	Apache Jakarta Struts

1.1.4.6 Classes

The class files for the PATS web application are located in the WEB-INF/classes directory. The class packages are described in the following table.

Package Name	Description
gov.va.med.pats.ui.bean	Used for storing data during posts to the server and subsequent responses from the server
gov.va.med.pats.ui.bean.helper	Called by filter classes to populate a form bean before passing it to the requested page
gov.va.med.pats.ui.command	Contains the ControllerServlet which is the central class where all server requests made by the client are routed to the responding Commands
gov.va.med.pats.ui.command.maintenance	Contains table maintenance functionality
gov.va.med.pats.ui.command.report	Contains reports functionality
gov.va.med.pats.ui.command.roc	Contains ROC functionality
gov.va.med.pats.ui.command.roc.notification	Contains notifications functionality
gov.va.med.pats.ui.command.user	Contains user maintenance functionality
gov.va.med.pats.ui.common	Contains searching and sorting functionality
gov.va.med.pats.ui.filter	Filters to Verify a User, Add/Edit ROCs, and View/Update Notifications
gov.va.med.pats.ui.filter.exception	Used when a user attempts to view a notification not intended for the
gov.va.med.pats.ui.taglib.maintenance	JSP tags to generate dynamic content on the table maintenance pages
gov.va.med.pats.ui.taglib.roc	JSP tags to generate dynamic content on the Add/Edit ROC pages
gov.va.med.pats.ui.taglib.support	JSP tags to generate dynamic content in general areas within the application
Package Name	Description
gov.va.med.pats.ui.util	General utilities for the user interface
jsp_servlet	WebLogic adds compiled JSP pages under this directory tree
gov.va.med.pats.pad	Contains PAD web service automatic ROC creation functionality
gov.va.med.pats.pad.tools	Contains mock SOAP implementations to use in local development/testing for PAD SOAP web service

1.1.5 Ejb-jar Archive

PATS business layer is packaged as an ejb jar with deployment descriptors located in the META-INF directory and classes in the EJB JAR file.

PATS deploys the following local and remote ejbs:

• 
  NationalMaintenance –business subsystem for NPO users
  
• 
  NotificationFacade - notifications business subsystem
  
• 
  PATSFacade –core PATS business subsystem
  
• 
  VISNMaintenance –business subsystem for VISN-level users
  

The Ejb-jar archive contains the following descriptors under the /META-INF directory:

• 
  Ejb-jar.xml contains the following elements:
  

• 
  Session beans: All PATS ejbs are stateless session beans. EJB is primarily used for declarative method security.
  
• 
  Security roles
  
• 
  Method permissions
  
• 
  Container transactions: supported
  

• 
  Weblogic-ejb-jar.xml contains:
  

• 
  Weblogic enterprise beans: Important for the JNDI address of each bean
  
• 
  Weblogic security roles: The mapping of logical Java enterprise roles to physical WebLogic security roles.
  

• 
  Hivemodule.xml contains service points for PATS data access objects.