metridoc.ezproxy.job.readme.txt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of metridoc-ezproxy Show documentation

performs penn specific ezproxy loading

There is a newer version: 0.7

====
    Copyright 2010 Trustees of the University of Pennsylvania Licensed under the
    Educational Community License, Version 2.0 (the "License"); you may
    not use this file except in compliance with the License. You may
    obtain a copy of the License at

    http://www.osedu.org/licenses/ECL-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an "AS IS"
    BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
    or implied. See the License for the specific language governing
    permissions and limitations under the License.
====


Overview:
	The Ezproxy job files are an implementation corresponding to the phases described in the "Ezproxy Normalization" document found on google docs: "ezproxy normalization.pdf". The job files are written in the groovy programming language and typically executed from the command line or run as a scheduled job(s) in Hudson or Jenkins. There are eleven files in all; three configuration files and eight executable files - two for each job.


Configuration files:
	metridoc.properties - database connection attributes
	datafarm.properties - 3rd party location attributes and route specifications
	ezproxy.properties - log file attributes and route specifications

Executable files:
       EzPull.groovy - job definition for accessing remote ezproxy log files.
       pullFile.groovy - command file to execute EzPull.
       EzLoad.groovy - job definition for loading ezproxy log files into a database.
       loadFile.groovy - command file to execute EzLoad.
       EzFarm.groovy - job definition for loading 3rd party data into a database.
       farmData.groovy - command file to execute EzFarm.
       EzNorm.groovy - job definition for normalizing loaded log data in database.
       normData.groovy - command file to execute EzNorm.

Prerequisites:
	Metridoc MUST be installed. 
	Accessability to remote files and databases specified in .properties files.

Execution:
	Step 1 - Setup configuration files and place them in the Metridoc folder.

	Step 2 - Execute EzPull
	
		    eg.  groovy EzPull.groovy

	Step 3 - When files have been downloaded execute EzLoad

		    eg.  groovy EzLoad.groovy

	Step 4 - Extract any 3rd party data. Note that the 3rd party data extraction may be run at any point prior to the Normalization in Step 5. 

		    eg.  groovy EzFarm.groovy

	Step 5 - Perform the normalization.

		    eg.  groovy EzNorm.groovy