View System Documentation - Files

Directory Structure and Overview

This page describes the basic file directory structures and lists special non site specific files. Dynamically generated or site specific content type files are not documented but the directory structure describes the types of files that are stored within. This directory structure is based on a starting path of the Java application server's "webapps" directory. Contained within this "webapps" directory are all the applications that exist for that app server. In the case of the IBIS-PH View application/system this is typically "ibisph-view".

Naming Convention

The Naming Conventions page shows a more detailed definition of all conventions. Below is a quick file overview. User defined data files which are generated by or maintained by content managers are in the xml directory and are of the "MixedCase.xml" form. All other files and directory names are considered "system" files with most being of the "lower_case.ext" form. Exceptions to this rule are Java class files as the Java language standard dictates this, the Javascript files, XSLTs, and some CSS files. The WEB-INF and META-INF directory names are also mandated by the Java Web Application standard. The intent of this naming standard is to provide content managers a clue as to the files they can/should maintain. The system files that are all lower case are named this way to help when deploying the app to case sensitive operating systems like Unix/Linux.

Note that the site specific XSLT files are lower case and that the CSS files have some files lower and some mixed. This is by design again to provide some insight on what that file contains and its intended usage. Even though these files are site specific they typically do not change and should be maintained by a web designer and not a typical content manager type user.

[Java App Server dir]/webapps/ibisph-view

WEB-INF

Standard webapp directory which contains all the IBIS-PH View Java Class files, dependent Java library archives (JAR files), property and Spring configuration XML files.
WEB-INF

config

Contains the "site_specific properties" file and the Spring bean XML configuration files.
config

xml

Container for all XML data files. See the XML Model page for more information.
xml
IBIS-PH Community of Practice, Utah Department of Health, Salt Lake City, UT 84114-2101, Telephone: 801-538-9191, Fax: 801-538-9346
The information provided above is from the Utah Department of Health's Center for Health Data IBIS-PH web site (http://ibis.health.utah.gov). The information published on this website may be reproduced without permission. Please use the following citation: "Retrieved Sat, 07 November 2009 11:04:49 from Utah Department of Health, Center for Health Data, Indicator-Based Information System for Public Health Web site: http://ibis.health.utah.gov".

Content updated: Tue, 19 Aug 2008 18:10:15 MDT