Fax-on-Demand Delivery Agent (FOD DA) is a new mechanism for updating FOD documents. Previously, document updates required manual intervention, or need a specially scripted list for automatic updates. FOD DA allows end users to set up a broadcast list with a special address to control document updates.
Future enhancements to FOD DA will include a User Interface to create/modify lists and to submit broadcasts utilizing the delivery agent to maintain documents stored on our FOD servers. Currently, customers can utilize FOD DA via custom parsers or modification of broadcast lists via the web. This document covers the latter, using special addressing in a broadcast list to add, update, replace or delete FOD site documents.
Using FOD DA, one of four (4) actions can be requested.
Add (A) - adds a new document to the FOD site that does not currently exist there; if a document of the same number already exists, this action will fail (e.g. cancelled job).
Update (U) - updates an existing document on the FOD site; if no document of the same number exists, this action will fail (e.g. cancelled job).
Replace (R) - adds or replaces a document on the FOD site - this is probably going to be the most common action taken since it does not care about the existent of the document number
Delete (D) - removes the document from the FOD site.
For a typical FOD site, create a list for each document on the site. Name the list with the document number and the action to be performed. For example, to replace document 110, name the list "110replace". To delete an existing document 120, name the list "120delete".
Most lists will have single "destination" entry. For the two examples above, those list entries would look like this:
List 110replace
Type | Addr |
fod | Action=R; Applic=1234; Group=001; Doc=110; Descrip=document name for reports |
List 120delete
Type | Addr |
fod | Action=D; Applic=1234; Group=001; Doc=120 |
For documents that are time-sensitive, activation and expiration options
can be used to control when the document is available on the FOD site. If
the new version of document 110 is to become available at 8:00am ET, the
list entry would look like:
Type | Addr |
fod | Action=U; Applic=1234; Group=001; Doc=110; Descrip=document name for reports; Activates= 08:00:00 ET |
The address (addr) field for the entries consists of a combination of items separated by semi-colons. Not all items need to be used, but a few are mandatory: Action, Applic, Group and Doc.
For the full range of options available, refer to the List Field Reference Table at the end of this document.
List Field Reference Table
Field Name | Ref |
Description | Item reference; should be unique within list |
Value | Any 7 bit Latin ISO characters (ASCII) |
Mandatory | No |
Field Name | Type |
Description | Fax On Demand Delivery Agent |
Value | fod |
Mandatory | Yes |
Field Name | Addr | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description | FOD address comprised of multiple "addr" items separated by semi-colons | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Value | There are 8 possible items as defined below:
|