9.3.2 The list of the data transfer command

(a) Format

DWClient.batUPLOAD
   {{{-to email-address {-toname name }{-todivision division}}|#
     {-cc email-address {-ccname name }{-cc division name}}|#
     {-bcc email-address {-bccname name }{-bcc division name}}}|#
    {-destinationfile the path of the Destination File}}
    -file {file path {file path}}|{folder path {folder path}}...
   {-title title}
   {-message message | -messagefile message file}
   {-openpassword open password}
   {-resumestatus the folder which is stored the resumption information file}
   [-getdeliveryinfo the path of the delivary information file]
   -property the path of the Command Property File
   {-concurrenttimeout timeout time (second)}

#

Specify one or more options among these.

Important

Some options cannot be specified together. For details about the options, see (b) Argument.

(b) Argument

(c) Description

The details of the sending files command is as follows.

(i) Options which cannot be specified by the sending files command

The following options which are specified when the sending files command is executed cannot be used as arguments of executing. Delivery Rules and Delivery Policy which is determined by the sender and the address is applied as well as settings by Web.

(ii) Difference from sending files by Web

The sending files command has the following difference compared with the case of operating by Web.

• Cannot send the shortcut file.

• Cannot deliver the message only. It is necessary to send one or more files.

(iii) The user name such as Receiver's address which is described in the Delivery Notification email

When you send files without the name of address, the name which is registered in the system is applied.

(iv) When you send files to user who is not displayed in Address List

When all of the following condition is true, the sending file command ends with failure.

• You do not have the authority to send files to arbitrary email address.

• You send files to user who is not displayed in Address List.

At this time, it is recorded on the audit log as "ILLEGAL_INTERFACE_CALL".

(v) Sending files for inactivated users

You can also send files for inactivated users.

(d) The example for execution

DWClient.bat UPLOAD
 -to "user@mailaddress.com"
 -file "C:\send\file.txt"
 -title "title"
 -message "message"
 -resumestatus "C:\DWCLient\temp"
 -getdeliveryinfo C:\deliveryinfo.xml
-property "C:\DWCLient\property.xml"

(e) Destination File

When you use the -destinationfile option, use a CSV-formatted file to specify destinations. The destination file should contain one destination in a single row. Use UTF-8 (without BOM) as the character code when creating the file.

The table below shows the format of the destination file. Note that the information in the file is not case sensitive.

The sample of Destination File is shown below.

TO,testuser01@hitachi.co.jp,Test user 1, the 1st designing department
CC,testuser02@hitachi.co.jp,Test user 2, the 1st designing department
BCC,group01,,

You can specify recipients to the maximum number of the recipients set up by Data Highway - Server side in all. For more information about settings, refer to the manual JP1/Data Highway - Server Configuration and Administration Guide.

(a) Format

DWClient.bat DOWNLOAD
 -savedir the folder which is saved the download file
 -receivedlist file path of the Received List File
 { -makesubdir}
 { -notoverwrite}
 { -resumestatus the folder which is stored the resumption information file}
 { -getdeliveryinfo}
 { -newarrivalexitcode}
 { -deliveryid Delivery ID}
 { -reservetransferlimit}
 -property the path of the Command Property File
 {-concurrenttimeout timeout time (second)}

(b) Argument

(c) Description

The details of the receiving files command is as follows.

(i) The disk space which is temporarily used at receiving files

When the receiving file command is executed, all files are downloaded to the temporary disk space (the "work" folder which is located under the folder installed the data transfer command) first. Next, they are moved to the folder which is specified as an argument when you execute the command. So, when the receiving file command is executed, it is required the temporary disk space to receive these files.

In addition, when the receiving file command is suspended or is failed, the imperfect files may be remained in the temporary disk space. In this case, delete files in the temporary disk space.

(ii) Overwrite at the receiving the same name files

The download file is saved to the folder which is specified as an argument when you execute the command. When the same name file is existed, it is overwritten by the delivery data whose date is new.

This is also applied for the folder.

Note that the overwritten file or folder is also counted for the amount of downloads.

(iii) Delivery to receive

When -deliveryid option is specified:

Only the delivery specified by -deliveryid is received. It is also possible to receive the delivery received in the past.

When -deliveryid option is omitted:

Receive the new-arrival delivery (the delivery which is not described in the Received List File) only. The receiving file command cannot receive files received in the past.

(iv) Files which cannot be received because of its' download restriction

If a file cannot be received because the download limit per month is exceeded:

• When -reservetransferlimit option is specified:

  The delivery or file will not be put on the received delivery list file.

  If the user wants to download a file that is not on the list, the representative user eases the download limit, or the user needs to execute the reception command again after the download limit per month is cleared in the next month.

• When - reservetransferlimit option is omitted:

  The delivery or file will be put on the received delivery list file, and can no longer be downloaded even if the user executes the command to receive the file again later.

  To download such a file, the representative user eases the download limit, followed by the user who wants the file using the web window to download it.

(v) When you specify -makesubdir option

When the download is suspended and some of files cannot be downloaded, the operation of the re-download is as follows.

• When the file or folder of the delivery is different from last time

  This command creates folder per delivery, and download them.

• When the file or folder of the delivery is same at last time

  If the folder is not created per delivery when the download is suspended, the command creates new folder per delivery and download them. When the folder is already created per delivery, the command downloads them to the same folder.

• When you specify the preservation folder different from first time at re-downloading

  When all of the following condition is true, the command creates new folder per delivery to the preservation folder which is specified at re-downloading and download them.

  - The download is suspended in the same delivery.

  - Specify the preservation folder different from first time at re-downloading.

  In this case, files in the same delivery are saved to different preservation folder separately.

When the file whose name is same as the Delivery ID in the preservation folder is existed, the command occur an error because the same folder cannot be created.

Specify the preservation folder path including folder which is created per delivery whose length is less than 261 characters. When the preservation folder path is over 260 characters, the download fails.

(vi) Operation when the user is inactivated during the command execution

When the user who executes the receiving file command is invalid during the command execution, the operation of receiving is continued and is received files normally. And, after that, the operation is continued and is acquired all of the delivery. When the receiving file command is executed next time, the user cannot receive all of the delivery.

(vii) Warning log about delivery which is described on the Received List File

When the delivery which was successfully received before and is described on the Received List File is changed to the following status, the warning log is outputted when the receiving file command is executed again.

• When the sender of the delivery is deleted or inactivated

• There is no valid the Delivery Rules.

• The delivery is deleted during the receiving file command executing

• The approver who approves the delivery is deleted.

(viii) When you specify -getdeliveryinfo option

The format of the delivery information file which is outputted when you specify -getdeliveryinfo option is specified is as follows.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
    <delivery id="123" send-date=" 2012/11/20 02:25" subject="About meeting">
        <sender email="user1@domain1.co.jp">
            <files>
                <file id="27" type="file" name="Meeting materials.txt" size="1024524"/>
                <file id="28" type=" file " name="ResearchResult.doc" size="3134562"/>
            </files>
        </sender>
        <message>the sender's message</message>
    </delivery>
</data>

Important

• The information at the time of the sending is outputted to the delivery information file. So, when the sender changes the email address after the sending was completed, the email address before being changed is outputted.

• When the sender is deleted after the sending was completed, files which were sent are deleted together. So, the delivery information file is not outputted.

• When you are going to receive the delivery in which the storage expiry date has expired, the receiving file is ended and return code 4 (end with warning). And then, the error message "DWCO1065_W Cannot receive the delivery because it expired." is displayed.

The meanings of the elements which are outputted to the delivery information file are as follows.

(d) The example for execution

DWClient.bat DOWNLOAD
 -savedir "C:\receive"
 -receivedlist "C:\DWCLient\receivedlist.txt"
 -makesubdir
 -getdeliveryinfo
 -resumestatus "C:\DWCLient\temp"
 -newarrivalexitcode
 -property "C:\DWCLient\property.xml"

(a) Format

DWClient.bat RESUME
   -property the path of the Command Property File
   -resumestatus the folder which is stored the resumption information file

(b) Argument

(c) Description

(i) When the suspended cannot be resumed

• When the Compress Method of Delivery Policy is "Standard", the delivery cannot be resumed. When the Compress Method of Delivery Policy is "Extended", or when the Compress Method of Delivery Policy cannot be chosen, the delivery can be delivered.

• When you specify the file which has setting that the Compress Level of Delivery Policy is except "No compression", the delivery cannot be resumed.

• When the state of the reception of the file transfer function for Data Highway - Server is "Refusal state of the reception", the command outputs the return code 3 (Refusal state of the reception is ended) and ends.

(ii) When you resume the sending files

• When the file which is resumed the sending was deleted from the Client PC after suspending, the resumption command of the file transfer which is under suspending ends abnormally.

• When the Compress Method of Delivery Policy is "Standard", the sending cannot be resumed. When the Compress Method of Delivery Policy is "Extended", or when the Compress Method of Delivery Policy cannot be chosen, the delivery can be sent.

• When you specify the file and folder which has setting that the Compress Level of Delivery Policy is except "No compression", the sending cannot be resumed.

• When the file name or file size or updated date-time of the sending file is changed, the command cannot send.

• When the file transfer of un-transmitted file is resumed, if the file name or file size is changed, the command cannot send.

(iii) When you resume the receiving files

• When the specified file is deleted on the Data Highway - Server because the expiration date of the delivery which is specified by the representation user expires, the receiving file is skipped. And, the file which is being received and the resumption information file are deleted. The command outputs the return code 4 (end with warning) and ends.

• When the specified delivery has already deleted on the Data Highway - Server and has already received, the receiving file is skipped. The command outputs the return code 4 (end with warning) and ends.

• For the options which are not specified to receive, the options which were specified by the receiving file command last time are applied.

• When {-deliveryid} option is being omitted by the reception to resume and when the file which is received newly after the suspended is existed, the command downloads them together.

• When the resumption of the suspended is failure, the download of the file transfer which is delivered after the suspended is not executed. In this case, the resumption information file is not overwritten.

• When the Compress Method of Delivery Policy is "Standard"

  - When you resume the receiving file which has setting that the Compress Level of Delivery Policy is "No compression", the receiving is resumed from the continuation of the last receiving.

  - When you specify the file and folder which has setting that the Compress Level of Delivery Policy is except "No compression", start to receive newly as well as the receiving command because the delivery which is being receiving cannot be resumed.

• When the Compress Method of Delivery Policy is "Extended", or when the Compress Method of Delivery Policy cannot be chosen.

  - When the receiving file or folder is resumed with the settings that the Compress Level of Delivery Policy is "STRONG" or "MIDDLE" or "WEAK", the receiving is resumed from the start of the last receiving file.

(d) The example for execution

DWClient.bat RESUME
 -property "C:\DWCLient\property.xml"
 -resumestatus "C:\DWCLient\temp"