LinkScan for Unix. Reference Manual.

Section 16

LinkScan Dispatch

[Not available in LinkScan Workstation]

LinkScan Dispatch may be used to create specific reports for each Owner in a Project. The reports may be formatted in either plain text or HTML. They may be saved to disk as static files or dispatched via electronic mail to selected addresses. Before using LinkScan Dispatch you must:

1. Configure the LinkScan to Email Interface if you wish to distribute any reports via email.

2. Ensure that you have appropriate document Ownership rules defined. Note that, in a default configuration, LinkScan will create and assign Owners based on the top-level directory names immediately beneath the website root. See also How to assign documents to Owners.

3. Ensure that you have configured Mailhost in linkscan.cfg. Note that, by default, e-mail reports are sent to Owner@Mailhost. Use the Mailalias command to map specific Owners to specific e-mail addresses. See How to assign documents to Owners.

4. Successfully complete a scan of the selected website.

5. Execute dispatch.pl to create the LinkScan Dispatch reports.

Note that LinkScan Dispatch supports the following command line options:

web:/usr/www/htdocs/linkscan> perl dispatch.pl -help     

LinkScan/Dispatch Version 12.1
Copyright 1997-2010 Electronic Software Publishing Corporation

USAGE: dispatch [{-help}] | [{-mail} {-test} {-project name}]
                [-type x {-repfile file} {-outfile file} {-format n}]

-help            Displays this message
-mail            Mails report to user versus storing in saved file
-project name    Specify project name
-test            Send mail to STDOUT -- no mail is sent
-type [xeskdbco] Select report type
-repfile file    Specify a filename with the reporting options
-outfile file    Output filename
-format n        1=Full HTML; 2=HTML; 3=Plain; 4=text
Report Types:
-type x = Project Summary Report
-type e = Problem Documents Report
-type s = Document Detail Report
-type k = Critical Errors Report
-type d = Detailed Errors Report
-type b = Changed Documents Report
-type c = Selected Status Codes Report
-type o = Orphaned Files Report

Detailed Help [Y/N]:

Examples

perl dispatch.pl -project myproj -type k -format 4 -mail

In the example above, Dispatch will create a Critical Errors Report for each Owner within Project myproj and deliver them via e-mail in TEXT format.

The following style of command-line options is also support for compatibility with pre-9.0 versions of LinkScan/Dispatch.

perl dispatch.pl -project myproj -errors 4 -mail 

In the example above, Dispatch will create a Detailed Report for each Owner within Project myproj and deliver them via e-mail in TEXT format.

Adding Custom Headers/Footers to LinkScan Dispatch Reports

When creating Dispatch Reports in plain text format, the following files are automatically inserted into the header and footer of each report:

mailhead.txt
mailfoot.txt

When creating Dispatch Reports in HTML format, the following files are automatically inserted into the header and footer of each report:

mailhead.html
mailfoot.html

LinkScan for Unix. Reference Manual. Section 16. LinkScan Dispatch
LinkScan Version 12.1
© Copyright 1997-2010 Electronic Software Publishing Corporation (Elsop)
LinkScan™ and Elsop™ are Trademarks of Electronic Software Publishing Corporation