8.4.1 Suspension and cancellation of the active file transfer
This command suspends or cancels the file transfer being executed by JP1/Data Highway - AJE and the data transfer command. Note that for file transfer using a command of JP1/Data Highway - AJE 10-00, you cannot use this command to suspend and cancel the processes.
- Organization of this subsection
(1) Format
DWAdminClient.bat SUSPEND|CANCEL
-property property-file
{ -deliveryid delivery-ID}
{ -receiver receiver-ID}
(2) Arguments
|
No. |
Option |
Description |
|---|---|---|
|
1 |
SUSPEND |
Suspends the file transfer being executed by JP1/Data Highway - AJE or the data transfer command. The client executing the suspended file transfer ends the process in response to the corresponding exit code (ended by suspension). To resume the suspended file transfer process, use the command for resuming the suspended file transfer on the client side. |
|
2 |
CANCEL |
Cancels the file transfer being executed by JP1/Data Highway - AJE or the data transfer command. The client executing the canceled file transfer ends the process in response to the corresponding exit code (ended by cancellation). The canceled file transfer cannot be resumed. If you cancel file transfer during their transmission, the delivery data in JP1/DH - Server is deleted. If you cancel file transfer during reception, the delivery data is not deleted. Note that you cannot cancel suspended file transfer. |
|
3 |
-deliveryid |
Specifies the delivery ID of the target file whose transfer is suspended or canceled. You can acquire the delivery ID by using the command for acquiring delivery information. If you omit specifying this option, all the files whose transfer is being executed by JP1/Data Highway - AJE or the data transfer command are to be suspended or canceled. If you specify this option and the -receiver option at the same time, you can suspend or cancel the file transfer to the user specified with the -receiver option. |
|
4 |
-receiver |
Specifies the user ID of the recipient to which you want to suspend or cancel the file transfer. If you specify any user ID that does not exist, the system assumes that there is no running file transfer to be suspended or canceled. If you specify this option and the -deliveryid option at the same time, you can suspend or cancel the file transfer of the delivery ID specified with the -deliveryid option. You can acquire the delivery ID of the file that a user transfers by using the command for acquiring delivery information. This option can be used in JP1/DH - Server 11-00 or later. If you use this option when using JP1/DH - Server whose version is earlier than 11-00, the following error occurs: DWCO1913_E The server returned an error. Server does not support this command. |
|
5 |
-property |
For details, see 8.3.2 Common options. |
(3) Description
The details of the command for suspending and canceling the active file transfer are described as follows:
- (a) Time required for command execution
-
After this command is executed, it might take time for the instruction to reach the client.
- (b) Storage expiration date
-
Delivery data of suspended file transfer is also deleted automatically when its storage period defined in the delivery policy expires. For that reason, we recommend setting a sufficiently long storage period.
- (c) When the server stops
-
When the server stops, the ongoing file transfer processes are suspended.
(4) Execution example
DWAdminClient.bat SUSPEND -property "C:\DWCLient\property.xml" -deliveryid 00000001 -receiver receiver@domain