User's Guide

FAXTRANS

Transfer facsimile images to a remote computer

Function:

Transfers facsimile images from the current computer to a remote computer.

Parameters:

FAXOPT(FAC)
Facsimile option. Distinguishes between facsimiles created in normal ADAPS processing, named FAC*;IMG, and manually created facsimiles, named FAX*;IMG. See User Note 1.

  = FAC: Transfer facsimiles matching FAC*;IMG
  = FAX: Transfer facsimiles matching FAX*;IMG

INDIR(--)
Input directory. Directory where the facsimiles are located. The default is ADAPSFAX.

OUTSYS("VAXA")
Output system. Remote computer system where the facsimiles will be transferred to.

DSTDIR(PRO:[AVHRR.FAX])
Destination directory. Directory on the remote computer where the facsimiles will be placed.

LOGFILE(--)
Log file. Name of the log file to which processing messages will be appended. The default is FAXTRANS;LOG in ADAPSLOG.

Examples:

  1. LAS> faxtrans

    FAXTRANS will continually search the directory ADAPSFAX for facsimile images matching "FAC*;IMG" and transfer them to the PRO:[AVHRR.FAX] directory on the remote computer VAXA. All processing messages will be written to the log file "FAXTRANS;LOG" in the ADAPSLOG directory.

  2. LAS> faxtrans faxopt=fax indir=[smith.fax] outsys=sgs4 dstdir=[smith.fax] logfile=[smith.logs]mylog

    FAXTRANS will search the directory [SMITH.FAX] for facsimile images matching "FAX*;IMG" and transfer them to the [SMITH.FAX] directory on the remote computer SGS4. When no facsimiles are found, FAXTRANS will complete successfully. All processing messages will be written to the log file "[SMITH.LOGS]MYLOG;LOG".

Description/Algorithm:

FAXTRANS will transfer facsimile images from the current computer to a remote computer. When FAXOPT=FAC, FAXTRANS continually searches INDIR for facsimile images matching "FAC*;IMG" and transfers them to the remote computer. When FAXOPT=FAX, facsimile images matching "FAX*;IMG" are transferred from INDIR to the remote computer until all facsimiles have been transferred. The user may specify the directory from which facsimiles are to be transferred, to which computer they will be transferred, the remote directory where they will be placed, and a log file for all of the processing messages. The default values will continually transfer all of the facsimiles that are automatically generated by the AVHRR Data Acquisition and Processing System (ADAPS) to the system used for printing facsimiles.

Upon successful transfer to the remote computer, the facsimile images are deleted from INDIR. If an error is encountered while transferring a facsimile, it will be moved into the ADAPSERR directory.

Nonfatal Error Messages:

  1. [faxtrans-del] Error deleting facsimile <xxxxx>

    The facsimile image was not deleted from the current computer system. This facsimile should be deleted.

  2. [faxtrans-unlock] Error unlocking facsimile <xxxxx>

    The specified facsimile image was not unlocked properly. The file "<xxxxx>;lock" should be deleted from the directory INDIR.

Fatal Error Messages:

  1. [faxtrans-dir] Invalid specification of <xxxxx>

    Parameter <xxxxx> was specified incorrectly. Both INDIR and DSTDIR must be directory paths without a file name. Correct any mistakes in the directory specification.

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

    FAXTRANS was unable to retrieve the value of the environment or logical variable <xxxxx>. Ensure the variable is set appropriately.

  3. [faxtrans-fatal] Fatal error encountered

    A fatal error was encountered. The error displayed before this one is the specific error that was encountered.

  4. [faxtrans-imgncp] Error transferring <xxxxx>

    An error was encountered while using IMGNCP to transfer the facsimile image <xxxxx>. Refer to the user's guide for IMGNCP for the appropriate action.

  5. [faxtrans-key] Error retrieving facsimile key

    An error occurred while retrieving a log file key for the facsimile image. Contact the system administrator.

  6. [faxtrans-lock] Error locking facsimile image

    An error occurred locking a facsimile image. Ensure INDIR has write permission for the user.

  7. [faxtrans-setup] Error setting up for facsimile transfer

    An error occurred setting up for transferring facsimiles. This may include finding the location of the facsimiles or setting up the log file. Contact the system administrator if this error occurs.

  8. [faxtrans-wait] Error waiting for images

    An error was returned by the system while FAXTRANS was suspended waiting for facsimile images. The user most likely terminated FAXTRANS.

User Notes:

  1. When FAXOPT=FAC, FAXTRANS will enter an infinite loop transferring facsimile images to the remote computer. To terminate the function the user should run ADAPSTOP-FUNC with FUNCNAM=FAXTRANS. When FAXOPT=FAX, FAXTRANS will transfer facsimiles to the remote computer until it does not find a facsimile in INDIR matching "FAX*;IMG".

  2. FAXTRANS calls the LAS function IMGNCP to transfer facsimile images. If IMGNCP fails, an attempt will be made to remove any portion of the image that did get copied to the remote system, unless FAXTRANS is transferring files from a VMS system to a UNIX system. In that case, a message will be issued indicating which file(s) should be manually removed by the user. In order to ensure cleanup of files, DSTDIR should contain the complete path name (and disk if on a VMS system).