The post-receive process consists of one or more discrete tasks, each of which is accomplished by creating a task worker box FS file that runs a script to perform the task. The post-receive process itself creates a primary (parent) worker box FS file which runs a script that creates the individual task FS files. All of these sub-tasks run concurrently so there must be no dependencies between them. When a particular task fails, it may be resubmitted just as any other FS file using the STATUS program. The entire post-receive process may be restarted by resubmitting the primary worker box FS file created by the post-receive command in the mailbox. Restarting the entire process will create new task FS files.
 | Because Post-Receive scripts are initiated from a fax receive channel, they are implemented with an initial worker-box FS file which will be written quickly (for processing on any free outbound or workerbox channel), thus allowing the fax receive channel to be immediately ready to receive a new inbound fax. You should never perform lengthy custom post-receive processing using the same channel that received the fax. |
There are five standard post-receive tasks:
•Forward a received fax as attachment or link to one or more email addresses
•Convert the received TIF to PDF if required
•Save received fax as PDF or TIFF to specified folder
•Print received fax to specific or default printer
•Upload received fax as PDF and/or TIFF to FTP site
•Fax receipt notification to fax sender
Tasks are selected along with appropriate options in CFCLIENTADMIN when mailboxes are created or modified. Variables that define the selected options and tasks that control post-receive processing are stored in the user profile (.USR) associated with the mailbox. Commonly used settings may be stored in special user profiles as named templates which may then be selected to create and edit mailboxes instead of entering data and selecting options for each task associated with a mailbox. Templates speed up the mailbox editing process and help reduce configuration errors.
Included Scripts
The post-receive tasks are performed by the following scripts:
•PRI_Init – initialization and launch. To use the standard scripts and their variables,you must start your Post-Receive infobox sequence with PRI_INIT.IIF,
•PRI_ADlookup – look up data in Active Directory using DNIS
•PRI_Fax2Email – forward received fax by e-mail
•PRI_FTPUpload – upload received fax to FTP
•PRI_Save – save received fax
•PRI_Print – print received fax
•PRI_FaxNotify – fax receipt notification to fax sender
Task scripts may consist of one or more modules. The first script module of the task will contain one or more $script commands. The first $script command should contain the text used to identify and select the script as one of the post-receive tasks. Additional $script commands may be used to provide further description of the task to help the administrator in selecting the task within the mailbox editing portion of client admin.
The standard CopiaFacts scripts depend upon options that may be set within the client admin program and stored as variable definitions in the mailbox user profile. User-written scripts may also be selected as post-receive tasks provided they contain the appropriate $script command in the first module. The client admin program CFCLIENTADMIN will allow the administrator to specify variables for user-written scripts. These variables will be written to the user profile associated with the mailbox being edited. Administrators will have the option of saving any mailbox user profile they edit as a template file for future use in creating/editing other mailboxes.
Post-receive processing tasks may be identified within the fax status program using the fax sender information included in the $fax_sender command in the task worker box FS files. Fax sender consists of the task name (same as first script module), the fax mailbox number, and optionally the word “Child”, which indicates an FS file created by the task itself to send an email or fax. All task FS files should include a variable name PRV_PARENTFS which identifies the primary FS file originally created by the initial post-receive process script PRI_Init. This variable provides a common link that identifies all of the FS files belonging to a particular post-receive process event.
