Saves an product to local disk and then invokes the StarBurst Multicast Command Line Interface to cause the product to be transmitted.Note: The StarBurst Multicast Daemon must be running on the same machine as PAM prior to any invocations of this DIM.
addressType[optional] Specifies the type of address that StarBurst will use to conduct the file transfer. Valid values are Multicast or Broadcast. The default is Multicast.
announceDuration
[optional] Defines the maximum number of minutes that the StarBurst Multicast server should allocate for the Announce/Registration phase before commencing file transfer. Note that file transfer starts as soon as all registrations have been received and acknowledged or the announce duration expires. The default duration is one minute. Note: StarBurst documentation recommends at least one minute of announce duration for every 15 MB of file size.
announcePeriod
[optional] Defines the number of seconds between each file transfer announcement.
announceIPAddress
Specifies the Class D (multicast) IP address to which the StarBurst Multicast server will send announce messages when the server is about to transfer a file. The default address is 224.0.1.88. Note: Each StarBurst Multicast client to which files may be sent must be configured to this announce address. Applicable only when addressType is defined as Multicast.
broadcastIPAddress
Specifies the broadcast IP address on which the StarBurst Multicast Server will transfer the file. The default value is 255.255.255.255. This variable is applicable only when addressType is defined as Broadcast.
commandLineOptions
[optional] This variable defines any command line options to be passed to commandProgram. The default is null. This configuration variable should not be used to specify the configuration file, group file, or description options to the Multicast application.
commandProgram
This variable points to the command script that performs the steps necessary to invoke the StarBurst Multicast Command Line Interface application. There is no default. A reference implementation of a command script is provided in 0supportdir/PutStarBurstCLI.
continuousAnnounce
[optional] By setting a value for this variable, a client will be allowed to join a file transfer while it is in progress. This variable specifies the frequency that the Multicast Server will transmit Announce messages after the file transfer is begun. The frequency can be specified in seconds or as a percentage of the transmitted file. If specified as a percentage, valid values are 1 to 50%. The default setting is "disabled". Example values include: disabled, 1, 7, 25, 1%, 7%, 25%.
groupType
Specifies the mode used by StarBurst Multicast in its handling of clients during the file transfer. There are three group types: Closed, Limited, and Unlimited.
Closed: The file is transferred only to those clients included in the group (as specified by targetn values).Limited: The file is transferred to any client that registers to receive the file until the maximum client limit is reached. The Multicast server will track client status during the transfer.
Unlimited: The file is transferred to any client that registers to receive the file until the maximum client limit is reached. The Multicast server will not store the identity of the participating clients. This mode should only be used if it is not important if particular clients receive the file successfully.
If Closed is specified, then you must provide values for numberOfTargets and targetn. The default groupType is Limited.
maxTransferTime
[optional] Places a limit on the time allowed for the file transfer to take place. The maximum transfer time is expressed as a percentage of the best case transfer time for single pass of the file. The default is 300.
numberOfFilePasses
[optional] Specifies the number of times the StarBurst Multicast Server is to send the complete file to clients before requesting client status. The default is one.
numberOfTargets
[required if group type is Closed; N/A otherwise] Specifies the number of client systems to which the multicast transmission is directed.
randcmBackoff
[optional] When this feature is enabled, clients will wait a random amount of time before sending response data back to the Multicast server. Valid values are true and false. The default setting is false. StarBurst recommends that this feature be enabled when transferring a file to an extremely large number (i.e., thousands) of clients.
receiveChanIPAddress
[optional] This parameter is used if you are using a split data channel configuration when communicating with clients. (e.g., a satellite network in which the server transmits file data to clients via satellite, and receives response data back from clients via a dial-up modem connection.) This parameter should be set to the IP address of the network interface over which the server is to receive response data back from clients. The default value is 0.0.0.0.
statusDelay
[optionsl] Specifies how long the StarBurst Multicast server waits for client responses to status queries. If the server receives no responses to its status query, it will query the clients again once the configured Status Delay has expired. If the server receives NAKs in response to its status query, it will begin the next file pass. The valid range of settings for this parameter is 1 to 60 seconds. The default setting is 2 seconds. The Status Delay setting should be increased in networks experiencing communication delays between clients and servers.
targetn
[required if group type is Closed; N/A otherwise] This attribute defines parameters for each target client system. The value ,n, ranges from 0 to (numberOfTargets -1). The parameters that can be specified are: Target IP Address, Client Name, Point of Contact, Phone #1, Phone #2. If a value contains multiple words, enclose the value in double quotes. The target IP address is the only mandatory parameter. An example target attribute definition is as follows: (target0 129.83.66.34 HOST1 "John Smith" 8888 555-1212) The IP address is a unicast IP address; it is not a Class D (multicast) address. The client name need not correspond to the client's DNS name; it must not contain any spaces.
localTargetDirectory
[optional] The directory on the client where the transferred file is to be saved. If not specified, the transferred file will be stored in StarBurst Multicast's default data directory (i.e., c:\\sburst\\sbdata). Note: The specified directory must exist on the client prior to attempting a file transfer to it.
Note: If the localTargetDirectory is for a system running a Microsoft Windows operating system, you must escape the '\' character by preceding it with a '\'; e.g., d:\\targetDir\\chan1.targetDescription
[optional] A text description that the StarBurst Multicast Server will use as part of the announcement of the file to be transferred. The default is "UNSPECIFIED".
transferIPAddress
Specifies the Class D (multicast) IP address on which the StarBurst Multicast Server will transfer the content. The default value is 224.0.2.88, which is the default used in StarBurst Multicast v3.04. Applicable only when addressType is defined as Multicast.
transferDataRate
[optional] Specifies the data rate, in kilobits per second (kbps) that the StarBurst Multicast server will use when it transfers the file. The default in 512kbps.
transmitChanIPAddress
[optional] This parameter is used if you are using a split data channel configuration when communicating with clients. (e.g., a satellite network in which the server transmits file data to clients via satellite, and receives response data back from clients via a dial-up modem connection.) This parameter should be set to the IP address of the network interface over which the server transmits data to clients. The server's transmit channel address should match the primary interface port configured for the MFTP daemon using the -i switch. See StarBurst Multicast documentation for details. The default value is 0.0.0.0.
sourcePath
Defaults to "0supportDir/ProductToDirectory". Files located in the sourcePath (such as supporting images for the makeIndex capability) will be copied when necessary to the target directory before the StarBurst CLI is invoked).
keepFiles
[optional] 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 no files kept.
alwaysCopySupportFiles
[optional] Defaults to false. If set to true causes all files in sourcePath to always be copied to the target path.
makeIndexPage
[optional] Defaults to false. Instructs DIM to create index page if one does not already exist.
nameOfIndexFile
[optional] Defaults to "index.html" If an input product to this DIM already has an index file (such as from a web copy) then thatindex 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.
The DIM takes an input product and performs the following operations:Calls the preSend() method which deletes the contents of the directory defined by targetSpec.
The doSend() method then checks to see if the target directory exists. If it does not exist it is created. If no target directory is specified, a temporary directory is used.
Send the product through AsFlatFileList in order to extract all the FileRefs
Save all the FileRefs to persistent storage. If a file with the same name already exists and overwrite is false then an incrementing number will be appended to the product file name until it is unique (i.e. name.txt => name0.txt => name1.txt => until unique). If a file with the same name already exists and overwrite is true then the existing file is deleted and replaced by the product file.
Calls the postSend() method which generates a configuration file and group file to be used by the StarBurst Multicast CLI. Then a command script that executes the StarBurst Multicast CLI is invoked.
Sample checkpoint definition:
(putStarBurstCLI SBCLI (enabled true)
(localTargetDirectory c:\\temp)
(overwrite true)
(commandProgram "e:\\PAM\\0supportdir\\PutStarBurstCLI\\sburstNT.bat")
(commandLineOptions "")
(addressType Multicast)
(groupType Closed)
(targetDescription "Logical Channel 1")
(transferDataRate 1024) (announceDuration 3)
(numberOfTargets 2)
(target0 129.129.35.36 Client1 "John Smith" x1000 x1020)
(target1 129.129.135.13 "AnotherClient" "Mrs. Jones" x400 555-1340))
First Available: Build 36
Last Modified: 12 Janurary 1999