Description of the Release ZIP file
Monday, March 20, 2006
Copyright
2006, R. James Holton, All Rights Reserved
The purpose of this document is to describe the ZIP file
that comes with each new Expense Submittal System (ESS) release. The name of the release ZIP file for ESS
3.1.6 is ess_3_1_6.zip. Names of the
ZIP files for other releases follow the convention “ess” plus release number
plus dot zip.
With each new version of ESS, Adisoft releases a ZIP file
that contains:
1.
All the HTML, CSS,
JavaScript, JSP and Java Class files necessary to run ESS.
2.
JAR Libraries for managing XML and DOM
structures, as well as, a JAR for a database connection to MySQL. You need to provide your own database
connection JARs for MS SQL Server and Oracle.
3.
Configuration templates to support MySQL, MS SQL
Server, Oracle, and ODBC FoxPro environments.
4.
SQL files to build databases for MySQL, MS SQL
Server, and Oracle. There are also
free-standing tables for FoxPro.
5.
Source code for the Java Class files.
6.
The Readme.txt file with information on
ESS. This document contains some
troubleshooting tips and information on the database drivers.
The ZIP is used for the following purposes:
- Manually
install ESS if you cannot use one of the installers. We always encourage users to use one of
our installers for the Windows and Linux operating systems. However, since ESS is platform
independent, you can install it on other platforms, such a Solaris. Consult the “Manual Installation
Procedures” for more information on manually installing ESS.
- Upgrading
an existing ESS installation with the lasted release. Most upgrades can be accomplished by
simply copying the contents of the ess
and ess-app folders. For more information on upgrading,
consult the “Upgrading to a New Release” document.
- Debugging
problems with source code.
- Using
current JAVA files as examples for writing your own feeds. You can write your own feeds and add
them to the end-of-day process by following the ESS feed interface. Consult the “Creating a New Feed” for
more information.
Here are the important folders found in the release ZIP
file:
- configuration
– This contains standard configuration files for each database. Many folders in this section contain the
database setup for a specific database. In these folders, there will be
one subfolder called xmls, which
contains the system.xml, schema.xml, and edit.xml files. These files tend to be database
specific. The folders also contain
the web.xml file which contains
the database connection information for each database.
- deprecated
– Contains old files. Use under
advice from Adisoft, Inc. support.
- eod
– Empty, used by automated installers.
- foxpro
– Contains database setup for Foxpro.
- jsp
– Contain JSP for generating
JavaScript profiles. Generic
version of AuditProfile.jsp and
ESSProfile.jsp are included,
while database specific versions of Company.jsp
are required.
- mysql
– database setup for MySQL.
- oracle
– database setup for Oracle.
- shared
– Contains configuration files that are common across all databases.
- sqlserver
– database setup for MS SQL Server.
- xmlr
– Empty, used by automated installers.
- xmlu
– Empty, used by automated installers.
- database
– Contains the SQL files necessary to create an ESS database. The three database folders, mysql, oracle, and sqlserver
contain the MASTER.SQL and DROPT.SQL files. These files are used for creating the
ESS database. Here are the
subfolders:
- foxpro
– Contains the DBF files for a free-standing FoxPro database. The utilities
subfolder contains batch files and EXEs, written in Clipper, to manage
the DBF tables. Note: As of January 1, 2006, Adisoft will no
longer be maintaining these utilities.
The utilities are:
i.
ctables.bat –
ii.
DBF2SQL.BAT – Converts a DBF file to a SQL file
that can be used to create a table in a database.
iii.
DBF2SQLX.BAT – Converts a DBF file to a SQL file
that can be used to create a table in a database.
iv.
DBF_PACK.EXE
– Packs all the DBF tables.
v.
ESSCDX2.EXE –
Reindexes all the DBF tables.
vi.
packALL.bat – Batch file to run DBF_PACK.EXE
against all the DBF tables.
- js_profiles
– contains default JavaScript profiles.
Normally the JavaScript profiles are generated for site specific
tables and databases, however, these are shipped with ESS to allow for a
“quick” start.
- mysql
– Contains files to create the ESS database under MySQL.
- oracle
– Contains files to create the ESS database under Oracle.
- sqlserver
– Contains files to create the ESS database under MS SQL Server.
- ess –
Contains all the HTML, JavaScript, style sheets, and image files for the
ESS system.
- ess-app
– Contains the JSP for the ESS system.
A subfolder, WEB-INF, contains the JAVA Classes in the classes subfolder and the library JAR files in the lib subfolder.
- source
– contains the source for the ESS Java Classes.
###