User's Guide

SHIPFORM

Create shipping documentation and tape labels.

Function:

Creates a shipping form for an AVHRR archive tape. The shipping form is a record of which AVHRR archive images are located on an AVHRR archive tape. Individual scene ID summaries and tape labels may also be created.

Parameters:

TAPEID
Tape ID. Identification number of the tape that the shipping form is being created for.

OUTFORM
Output format. The format of the output tape for which the shipping form is being created.

 = LEVEL0:  Level 0
 = LEVEL1B: Level 1B

PROCOPT(FREE)
Processing option. Specifies the tape label format to print and determines if a shipping form is needed. The shipping form is always printed with the free format tape label and not printed with the library format tape label.

 = FREE: Free format label and
         shipping form
 = LIB:  Library format label

SCENEFLG(NO)
Scene print flag. A flag to specify if the scene summaries are to be printed.

= YES: Print out the individual
       scene summaries
= NO:  Do not print the scene
       summaries

PRINTER(OPS)
Printer. The printer used to print the shipping form.

TPLBLFLG(YES)
Tape label flag. Flag indicating if a tape label should be produced. This flag is only relevant for the PROCOPT(FREE) option.

 = YES: Create a tape label
 = NO:  Do not create a tape label

ADDRESS(--)
Shipping address. This address will be printed on the tape label and the shipping form.

INSTRUCT(--)
Special instructions. Special instructions to be printed on the shipping form.

ORDERNUM(--)
Order number. The order number for which the tape was created.

LOGFILE(--)
Log file. File where all of the processing messages will be logged. If defaulted, SHIPFORM;LOG in the ADAPSLOG directory will be used.

Examples:

  1. LAS> shipform tapeid=es0001 outform=level0 sceneflg=no

    The [.FORMS] subdirectory of ADAPSARC is searched for the file ES0001;LIST. If the file is found, a shipping form is created for the European Space Agency. If the file does not exist, an error message is printed. No individual scene summaries will be printed.

Description/Algorithm:

A shipping form is created to record which AVHRR archive images are on the tape indicated by TAPEID. The <xxxxx>;LIST tape summary file in the [.FORMS] subdirectory of ADAPSARC is read, and a shipping form is saved in the file(s) <xxxxx>.PAGE<y>;PRT, where <xxxxx> is TAPEID and <y> is a page number. The shipping form files are printed on PRINTER and deleted. If SCENEFLG is selected, the individual scene summaries will be printed for the scenes contained on the tape.

Nonfatal Error Messages:

  1. [shipform-lbl] Error printing tape label

    An error was encountered printing the tape label. Rerun the function if the tape label is required.

  2. [shipform-lprint] Error printing shipping form for <xxxxx>

    An error was encountered printing the shipping form files for tape ID <xxxxx>. These files are left in the [.FORMS] subdirectory of ADAPSARC and may be printed manually.

Fatal Error Messages:

  1. [shipform-alloc] Error allocating memory

    An error was encountered while dynamically allocating memory. If the error persists, contact the system administrator.

  2. [shipform-env] Error retrieving <xxxxx>

    SHIPFORM was unable to retrieve the value of the environment variable <xxxxx>. Ensure this variable is set and rerun the function.

  3. [shipform-fatal] Fatal error encountered

    A fatal error was encountered. The message displayed preceding this message is the error that was encountered. Processing terminates.

  4. [shipform-open] Error opening <xxxxx> file

    An error was encountered opening the <xxxxx> file. Ensure the file and directory permissions are set appropriately.

  5. [shipform-read] Error reading summary file

    Ensure the tape summary file is valid. If the file is corrupt, the processing messages in LOGFILE can be used to manually correct the errors. See the ANSISTACK Users Guide for a description of the tape summary file. Correct the summary file and rerun this function.

  6. [shipform-rparm] Error returning parameter to TAE

    Shipform encountered an error while attempting to retrieve information. Contact the system administrator.

User Notes:

  1. The tape summary files located in the [.FORMS] subdirectory of ADAPSARC are created by the ANSISTACK function.

  2. Related functions are ANSISTACK and AVHRRSTACK.