Columbia
Escutcheon Columbia University Libraries Digital Program
Advanced Papyrological Information System (APIS)


          Path: Digital Library Projects  : APIS  :  Tools  :  Translator  :  Design  :  I/O
  

3.2.1 Input:

  • The Translator Application requires only one of two input parameters. Either a -n (number of records) or a -s (single record) is required.
    e.g. translator.pl -n 1000 or translator.pl -s 6012

3.2.2 Options:

  • -n [positive integer or 'all'], allows for the validation of a single file
    e.g. translator.pl -n all
  • -i [institution], takes an institution name, and returns only the records for that institution *Currently not implemented
    e.g. translator.pl -n all -i columbia
  • -h [output dir/file header], takes a path and a file header
    e.g. translator.pl -n all -h /outputDir/intakeFileName
  • -s [record id], takes an object id as the param
    e.g. translator.pl -s 6013
  • -c [clob directory], directory to store the clobs in
    e.g. translator.pl -n all -c ./clobs/
  • -r [report name], status report listing number of records processed, where the the processed records reside and where the clobs reside.
    e.g. translator.pl -n all -r ./reports/report001.txt
  • -m [object id of record], continues translating the records starting at this parameter and finishing when the records are exhausted
    e.g. translator.pl -m 18400 -h outputDIr/intakeFileName
  • -d , debug flag to turn on displaying debug information
    e.g. translator.pl -n all -d

3.2.3 Output

  • intrake file - every record that is processed will generate an intake file that contains all of that records data.
    e.g. intake_1926.txt
  • clob file - For db fields that store large files, the data will be saved as a separate clob file and linked to the intake file
    e.g. cu_12201_122312.clob
  • status report - Report from running the program. It contains the number of records processed, where the the processed records (intake files) reside and where the clobs reside.
    e.g. status_20021022_33801.txt

3.2.4 Data File Input:

  • definition file - file to describe the database and how it maps into tags
    e.g. APIStranslations.dat


 


Columbia Libraries    Digital Program
Last revision: 09/25/03
© Columbia University
Last revision: 09/25/03
© Columbia University Libraries