7.3.2 The list of the data transfer command
The list of the data transfer command is as follows. In addition, in the case of Linux, read the extension "bat" of a command name as "sh".
No |
Function |
Command |
Explanation |
Refer to |
---|---|---|---|---|
1 |
The sending and receiving files |
DWClient.batUPLOAD |
Send files. |
|
2 |
DWClient.batDOWNLOAD |
Receive files. |
||
3 |
Resumption of the file transfer which is under suspending |
DWClient.batRESUME |
Resume the file transfer which is under suspending. |
7.3.2(3) Resumption of the file transfer which is under suspending |
|
- Organization of this subsection
(1) The sending files
Send files.
(a) Format
DWClient.batUPLOAD [[[-toemail address [-toname name ][-todivision division]]|# [-ccemail address [-ccname name ][-ccdivision division]]|# [-bccemail address [-bccname name ][-bccdivision division]]]|# [-destinationfilethe path of the Destination File]] -file[file path [file path]]|[folder path [folder path]]... [-titletitle] [-messagemessage | -messagefilemessage file] [-openpasswordopen password] [-resumestatusthe folder which is stored the resumption information file] -propertythe path of the Command Property File [-concurrenttimeouttimeout time (second)]
- #
-
Specify one or more options among these.
(b) Argument
No |
Option |
Explanation |
---|---|---|
1 |
-to |
Specify the address to send by to. You can specify the email address or the group name (English). Do not distinguish a capital letter and a small letter. When @ (atmark) is not contained in this value, it is registered as a group name. When you specify two or more addresses, divide them with a colon (:). You can specify to, cc, and bcc to the maximum number of the recipients set up by Data Highway - Server side in all. For more information about settings of the maximum number, refer to the manual Job Management Partner 1/Data Highway - Server Configuration and Administration Guide. You can also specify the email address and the group name together. |
2 |
-toname |
Specify the address name which is specified to -to option with colon (:) division. You can specify to the number which is specified to -to option. When the specified arguments are less than the number of -to option, it is considered that the specification was omitted. When you specify the group name as the address, this option is ignored. |
3 |
-todivision |
Specify the address division which is specified to -to option with colon (:) division. You can specify to the number which is specified to -to option. When the specified arguments are less than the number of -to option, it is considered that the specification was omitted. In addition, you cannot include the colon (:) to the division. When you specify the group name as the address, this option is ignored. |
4 |
-cc |
Specify the address to send by cc. You can specify the email address or the group name (English). The specification method is the same as that of -to option. |
5 |
-ccname |
Specify the address name which is specified to -cc option with colon (:) division. You can specify to the number which is specified to -cc option. When the specified arguments are less than the number of -cc option, it is considered that the specification was omitted. |
6 |
-ccdivision |
Specify the address division which is specified to -cc option with colon (:) division. You can specify to the number which is specified to -cc option. When the specified arguments are less than the number of -cc option, it is considered that the specification was omitted. In addition, you cannot include the colon (:) to the division. |
7 |
-bcc |
Specify the address to send by bcc. You can specify the email address or the group name (English). The specification method is the same as that of -to option. |
8 |
-bccname |
Specify the address name which is specified to -bcc option with colon (:) division. You can specify to the number which is specified to -bcc option. When the specified arguments are less than the number of -bcc option, it is considered that the specification was omitted. |
9 |
-bccdivision |
Specify the address division which is specified to -bcc option with colon (:) division. You can specify to the number which is specified to -bcc option. When the specified arguments are less than the number of -bcc option, it is considered that the specification was omitted. In addition, you cannot include the colon (:) to the division. |
10 |
-destinationfile |
It is used when specifying recipients by CSV form file. Specify the path of the Destination File which indicated recipients. It cannot specify simultaneously with other recipients specification options shown below.
For more information about Destination File see (e) Destination File. If the version of Data Highway - Server is 10-50 or later, this option can be used. When this option to less than 10-50 Data Highway - Server version is specified, an error of "DWCO1913_E The server returned an error. Server does not support this command. " occurs. |
11 |
-file |
Specify the path of sending files or folders. When you specify two or more files or folders, divide them by a half space (). You can specify to ten at the maximum. But when the maximum of the number of files is specified as less than ten by the delivery policy, it can be specified to the number. |
12 |
-title |
Specify the subject. You can specify to a hundred characters at the maximum. When this option is omitted, the subject is a blank. But the subject of the email is applied the system default subject. |
13 |
-message |
Specify the messages which are described on the email. You can specify to 256 characters at the maximum. When this option is omitted, the message is a blank. Cannot specify the newline. |
14 |
-messagefile |
Specify the path of the text file which is described message to write to the email. The character code of the text file must be described with UTF-8. If the text file is not described with UTF-8, it may be displayed incorrectly. In addition, BOM and the newline code are not cared about their existence. You can specify to 4,096 characters at the maximum. But when the file is attached BOM, you can specify to 4,095 characters at the maximum. The newline is treated as one character. When this option is omitted, the message is a blank. When this option is specified with -message option, the command ends with an error. |
15 |
-openpassword |
Specify the open password for sending to the unregistered address. When this option is omitted, the open password is a blank. But the command ends with an error because the open password is indispensable for sending to the unregistered address. When you specify the open password for sending to the registered address, it is not used and ignored. An open password must be between 6 and 32 letters, include two or more kinds of characters (numbers, small letters, big letters, symbols). You can use the following symbols. !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ In addition, when the open password is surrounded by " (double quote), the inner character is considered as the password. For example, if the specified password is "Password01", then Password01 is the open password. |
16 |
-resumestatus |
Specify the folder path which is stored the information to resume sending. When the sending is suspended by the demand of the suspended from Data Highway - Server, the resumption information file is saved to the path which is specified by this option. If the resumption information file is already existed in the specified folder, the file is overwritten. In addition, even if you specify this option, the command cannot send in the following case.
When the file transfer ended normally or the file transfer is cancelled by the demand of the cancellation from Data Highway - Server, the resumption information file is deleted. |
17 |
-property |
Refer to 7.3.1(2) Common options. |
18 |
-concurrenttimeout |
(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" -property "C:\DWCLient\property.xml"
(e) Destination File
It is used when specifying recipients by CSV form file.
Please describe one recipient in one line. The character code of the file must be described with UTF-8.
No |
Items |
Explanation |
---|---|---|
1 |
ADDRESS_TYPE(the type of recipients) |
Specify the type of mail that sends to recipients. Specify one from [TO], [CC], or [BCC]. This setting item does not distinguish a capital letter and a small letter. This setting item is mandatory. |
2 |
DESTINATION(recipients) |
Specify of recipients the email address or the group name. The character which can be specified is the same as [-to][-cc][-bcc] option. This setting item is mandatory. |
3 |
NAME(the name of recipients) |
Specify the name of recipients. The character which can be specified is the same as [-toname][-ccname][-bccname] option. When you specify the group name as [DESTINATION], this option is ignored. This setting item is not mandatory. |
4 |
DIVISION(the division of recipients) |
Specify the division of recipients. The character which can be specified is the same as [-todivision][-ccdivision][-bccdivision] option. When you specify the group name as [DESTINATION], this option is ignored. This setting item is not mandatory. |
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 Job Management Partner 1/Data Highway - Server Configuration and Administration Guide.
(2) The receiving files
Receive files or folders of the delivery which are not described on the Received List File.
In addition, you cannot receive sending to the unregistered user in the system by the receiving file command.
(a) Format
DWClient.batDOWNLOAD -savedirthe folder which is saved the download file -receivedlistfile path of the Received List File [-makesubdir] [-notoverwrite] [-resumestatusthe folder which is stored the resumption information file] [-getdeliveryinfo] [-newarrivalexitcode] [-deliveryidDelivery ID] -propertythe path of the Command Property File [-concurrenttimeouttimeout time (second)]
(b) Argument
No |
Option |
Explanation |
---|---|---|
1 |
-savedir |
Specify the folder path which is saved the download file. Specify the existing folder. When the specified folder is not existed, the command ends with an error. |
2 |
-receivedlist |
Specify the path of the Received List File. When the specified file is not existed, it is created automatically. |
3 |
-makesubdir |
When you specify this option, the folder (Delivery ID sub-folder) is created per delivery (Delivery ID) under the folder which is specified as -savedir option, and files are divided and saved per delivery. So, if the delivery is different, you can save the same name file or folder. The folder name which is created per delivery consists of the number maximum of 19 digits like Delivery ID. When all of the following condition is true, it is overwritten and saved by the file or folder which has new File ID.
When this option is omitted, the file or folder is downloaded to the specified folder as -savedir option. |
4 |
-notoverwrite |
When this option is specified, if the same name file or folder exists in the folder which is saved the download file, the download is skipped. When the download is skipped, the command outputs messages and logs. When this option is omitted, even if the same name file or folder exists in the folder which is saved the download file, it is overwritten. |
5 |
-resumestatus |
Specify the folder path which is stored the information to resume receiving. When the receiving is suspended by the demand of the suspended from Data Highway - Server, the resumption information file is saved to the path which is specified by this option. If the resumption information file is already existed in the specified folder as this option, the file is overwritten. In addition, when the file transfer ended normally or the file transfer is cancelled by the demand of the cancellation from Data Highway - Server, the resumption information file is deleted. |
6 |
-getdeliveryinfo |
When you specify this option, the metadata folder is created under the folder which is specified as -savedir option and the delivery information file which is XML format is acquired per delivery (Delivery ID) at the time of download file. The file name which is created per delivery consists of the number maximum of 19 digits like Delivery ID. Even if the download file is failure and all of the files cannot be downloaded, the status of the delivery information shows that all download are completed. In addition, when the metadata folder already exists under the folder which is specified as -savedir option, delete it or save as another name before the command execution. When the same name folder is existed, it is overwritten. And, when this option is specified that the file or folder to download do not exist, the delivery information file is not outputted. |
7 |
-newarrivalexitcode |
When this option is specified, the command outputs the return code which is added 128 when it received the delivery which is included files or folders. When files or folders are not existed and the command delivers the message only, the command outputs the normal return code. When Java VM is terminated compulsorily, the return value is not added 128. |
8 |
-deliveryid |
|
9 |
-property |
Refer to 7.3.1(2) Common options. |
10 |
-concurrenttimeout |
(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
-
When files cannot be received because its' download restriction is exceeded for a month, the delivery or files are registered to the Received List File. After that, they are not downloaded even if the receiving file command is executed again.
In order to download such files, download them by Web after the download limitation value is loosed by the representation user.
- (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>
- Note:
-
-
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.
Element/Attribute |
Number |
Explanation |
|
---|---|---|---|
data Element |
1 |
It is always outputted. |
|
delivery Element |
1 |
The delivery information tag. |
|
id Attribute |
1 |
Delivery ID is outputted. |
|
send-date Attribute |
1 |
Date -time when the delivery (the sending) has completed is displayed. |
|
subject Attribute |
1 |
The subject of the delivery is outputted. |
|
sender Element |
1 |
The sender information tag. |
|
email Attribute |
1 |
The sender's email address is outputted. |
|
files Element |
1 |
The delivery file/folder list tag. |
|
file Element |
1 or more |
The delivery file/folder information tag. |
|
id Attribute |
1 |
ID of the delivery file/folder is outputted. |
|
type Attribute |
1 |
The type of the delivery file/folder is outputted.
|
|
name Attribute |
1 |
The name of the delivery file/folder is outputted. |
|
size Attribute |
1 |
The size of the delivery file/folder is outputted with a number of bytes. In folder, the total number of bytes before archiving the contents of the folder is outputted. |
|
message Element |
1 |
The input message of the sender. |
(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"
(3) Resumption of the file transfer which is under suspending
Resume the file transfer which is under suspending.
(a) Format
DWClient.batRESUME -propertythe path of the Command Property File -resumestatusthe folder which is stored the resumption information file
(b) Argument
No |
Option |
Explanation |
---|---|---|
1 |
-resumestatus |
Specify the folder path which is stored the information to resume the file transfer. |
2 |
-property |
Refer to 7.3.1(2) Common options. |
(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"