Please enable JavaScript to view this site.

CopiaFacts Reference Manual

Navigation: Standard CopiaFacts Scripts > Post-Receive Scripts

Variables in Standard Post Receive Scripts

Scroll Prev Top Next More

The variable names described below may or may not be present in the user profile associated with a fax mailbox. There is no harm in including variables that are not used by any of the tasks included in the task list. Certain tasks require certain variables and some variables will be included or removed based upon options selected by the administrator when creating/editing mailboxes in CFCLIENTADMIN.

The following variables are used in the Standard Post-Receive scripts:

PRV_EMAIL_RECIPSComma separated list of email recipients
PRV_THIS_EMAIL_RECIP*Currently selected email forwarding recipient
PRV_EMAIL_OPTSSemi-colon separated list of email option entries:
  1 – email attachment option
  2 – include thumbnail or not
  3 – override email subject
PRV_THIS_EMAIL_OPTS*Email forwarding options for currently selected email recipient
PRV_EMAIL_ATTACH_OPT*Extracted email attachment/link option:
   0 – no attachment or link
   1 – attach standard letter size PDF (pdf)
   2 – attach standard A4 PDF (PDF)
   3 – attach legal size PDF (pdF)
   4 – attach 8.5 width variable length PDF (Pdf – default)
   5 – attach A4 variable length PDF  (PDf)
   6 – attach received TIFF image
   7 – link converted PDF
   8 – link received TIFF image
PRV_EMAIL_THUMB_OPT*T(rue) to include thumbnail else F(alse)
PRV_EMAIL_SUBJECT_OPT*Override email subject for forwarding
PRV_EMAIL_TEXT3*Attachment/link method description for email text body
PRV_EMAIL_ATTAPP*Application type for $email attach command
PRV_PARENTFS*FS number of worker box FS file that starts chain
PRV_COLOGOOverride for company logo
PRV_TASKSComma separated list of post-receive tasks:
   PRI_Fax2Email – forward fax to email
   PRI_Save – save received fax as TIF or PDF
   PRI_Print – print received fax
   PRI_FTPUpload – upload received fax
   PRI_FaxNotify – fax receipt notification to fax sender
PRV_CONVPDF_FLAG*T(rue) to do preliminary PDF file conversion. Set this if you wish to save, email, or upload the incoming document as a PDF.
PRV_CONVPDF_FOLDERTarget folder for PDF conversion. Set this if you wish to save email, or upload the incoming document as a PDF.
PRV_CONVPDF_FILENAME*Converted PDF file. Set this if you wish to save email, or upload the incoming document as a PDF, and wish tro override the filename based on the MCF filename,
PRV_EMQUEUEQueue for post-receive process e-mail FS file. Until release 8.3.1.340, PRV_QUEUE was also used for this purposes, and it still is used if PRV_EMQUEUE is not defined.
PRV_PDF_NAME*Received fax image as PDF file (in message directory)
PRV_SAVEPDF_FLAGT (true) to save received fax as PDF else F (false). This assumes you have also configured the script to convert the incoming TIF to PDF.
PRV_SAVEPDF_FOLDERTarget folder for PDF save.  If this variable is undefined then the converted PDF file will be stored in the same folder as the received fax image (see PR_FAXPATH).
PRV_SAVETIF_FLAGT (true) to save received fax as TIFF else F (false)
PRV_SAVETIF_FOLDERTarget folder for saving received TIFF fax image
PRV_UPLDPDF_FLAGT (true) to upload received fax image as PDF to FTP else F (false)
PRV_UPLDTIF_FLAGT (true) to upload received TIFF image to FTP else F (false)
PRV_PRINTER_NAMEPrinter selected for printing received fax image
PRV_RUNSPEC*Run command and parameters for query script modules
PRV_FTP_OPTSCommand line options for FTP upload
PRV_FTP_SPECFTP specifications for FTP upload
PRV_QUEUEQueue for post-receive process worker box FS file
PRV_NOTIFYQUEUEQueue for post-receive notification FS files
PRV_NOTIFYCVRFax notification graphical cover sheet
PRV_FAXNUM*Fax number to use for notification
PRV_ALT_FAXNUM*Alternate fax number from ANI
PRV_DELETEFILES*T (true) to add a $delete_options command to delete the e-mail atachments after transmission.

Items with an asterisk (*) are temporary variables created during post-receive processing.