Skip directly to searchSkip directly to the site navigationSkip directly to the page's main content

Data Admin System Documentation - Files

Directory Structure and Overview

This page describes the basic file directory structures and lists special non site specific files. 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 Data Admin application/system this is typically "ibisph-admin".

[Java App Server dir]/webapps/ibisph-adminApplication's directory structure - rootcss HTML Cascading Style Sheet (CSS) files image All static images used by the site. The root of this directory contains general images like the header graphic, site URL icons etc. menu Graphical menu related images. This includes the left navigation tab and top menu tabs. query Query IBIS-Q interface page icons. js All Javascript files used by the site. Each file is named according to the type of object definition contained within. The IBIS-PH View script files are not a collection of generic functions. This functionality is incorporated into an object. jsp Container for all XSLT (XML Stylesheet) files. See the XSLT Design Documentation page for more information. _footer.jspbase footer HTML code for all pagesjavascript:return(false);_head.jspHTML HEAD element code for all pagesjavascript:return(false);_header.jspbase header HTML code for all pagesjavascript:return(false);_hidden.jspbase hidden input fields needed for posted save request and page view request. Again for all pages. javascript:return(false);_menu.jspbase menu dynamic HTML JSP code for all pages. This JSP generates menu selections according to the users privs which are stored in the user's session. javascript:return(false);http_test.jspSystem information/test JSP.javascript:return(false);admin Admin menu option JSPs. categorized_index List, detail, published confirmation JSPs. . . . One directory for every type of database table set to maintain. Most have a list then detail page. META-INF Standard webapp directory. This directory can contain a "context.xml" file which will add approp context definitions thus not requiring an IT system admin to have to manually set any context elements in the app server. This folder can also optionally contain a "MANIFEST.MF" file which specifies additional meta information for the JAR. See MANIFEST.MF file. For example, MANIFEST.MF can be used to extend the CLASSPATH used by the EJB module see Accessing the Stubs JAR from the EJB Module. This directory is not served/accessible by clients. The contents are visible to servlet code via the getResource() and getResourceAsStream() calls on the ServletContext.

See: http://java.sun.com/j2se/1.4.2/docs/guide/jar/jar.html WEB-INF Standard webapp directory which contains all the IBIS-PH Admin Java Class files, dependent Java library archives (JAR files), and property files. web.xml Standard web app config file. Contains servlet mapping, filter mapping, HTTP error handling, mime type configuration and more. javascript:return(false);global.properties Contains IBIS-PH View URL property, sys admin email address, the admin and view app's IP address used to filter/ID the requester for security reasons, and the logger control/levels. javascript:return(false);lib Contains the dependent Java object libraries (jar files) dom4j*.jar Package that is used when creating and working with XML elements. This code simplifies creating and manipulating the XML document elements and facilitates Xpath selections. javascript:return(false);ibisph-admin-v*.jar IBIS-PH Java objects. admin/control/Overview.htmljaxen*.jar XPath engine required/used by the dom4j code. javascript:return(false);xml Container for all temp previewed indicator and view XML files.