Output - putLocalPublisher

 

Description

Saves an product to local disk and then publishes the channel using the specified publishing tool. This is a genral output agent that was written initially as an interface to Castanet.

Configuration Variables

localTargetDirectory
The directory where the product files are to be saved. A value must be defined for this variable because there is no default.

commandProgram

This variable points to the publishing program (ex,"publish.exe" for Castanet).  There is no default.

sourcePath

Defaults to "0supportDir/ProductToDirectory". Files located in the sourcePath (such as Castanet applets and supporting images) will be copied when necessary to the target directory before the local publisher, such as Castanet, is invoked).

commandLineOptions

This variable defines any command line options to be passed to commandProgram.  The default is null if there are no options.

keepFiles

Identifies a list of files that should not be deleted in the target directory. This is used, for example, so as not to delete the "properties.txt" file that is created and maintained by Castanet. Multiple files should be separated by "," However, source files are simply compared to a the keepFiles string looking to see if the filename in question matches a subset of the input string. This may result in erroneous matching if files have no extension. (But this works with the initial use of this DIM for Castanet). The default is "properties.txt"

alwaysCopySupportFiles

Defaults to false. If set to true causes all files in sourcePath to always be copied to the target path. When false files are only copied for non-self-indexing products. Self-indexing products are products such as from getOnePage which already have a pre-built main index page. FTP directory lists on the other hand are not self indexing. They will have support files copied regardless of the setting on this attribute.

nameOfIndexFile

Defaults to "index.html" If an input product to this DIM already has an index file (such as from a web copy) then that index file is renamed to this name. If this attribute is empty and an index file already exists it will keep its name. If an HTML index file is created for products that have no index file this name issued.

nameOfURLListFile

Defaults to "" which means that no URL list file will be created. If a name is supplied a file is created that lists URLs and files that are written into the target directory. The format isin Java Properties output format so that the list can be easily parsed by a Castanet applet for example. This format consists of comment lines beginning with "#" and noncomments lines of the form "attributeString=valueString" Using this format a human attribute string is output followed by a value String which is a valid URL or relative file reference.

makeIndexPage

Defaults to true. Instructs DIM to create index page if one does not already exist.

How it works

Sample checkpoint definition:

(putLocalPublisher "Castanet Publish" (enabledtrue)
     (localTargetDirectory c:\\Marimba\\channels\\myChannel)(overwrite true)
     (commandProgram "c:\\Program Files\\Marimba\\CastanetPublisher\\command\\publish.exe")
     (commandLineOptions "-transmitter localhost:5282"))

Note:  This DIM was designed to work with channels that had already been created using the Castanet Publish program.  It is not designed to dynamically create/add new channels. Note:  The directory pointed to by localTargetDirectory must be the directory of the Castanet channel that you want to publish. For additional help in understanding what the channel directory is and what all the commandLineOptions are, please consult the Castanet documentation.

 

First Available: Build 29

Last Modified: 12 Januray 1999