8.4.7 Acquiring delivery information
You can acquire a delivery information list containing information such as delivery IDs, files, sender/recipient user names, and dates and times.
- Organization of this subsection
(1) Format
DWAdminClient.bat GETDELIVERYINFO
-property property-file
{-sender sender-user-ID}
{-receiver recipient-user-ID}
-result execution-result-file
(2) Arguments
|
No. |
Option |
Description |
|---|---|---|
|
1 |
-sender |
Used to acquire delivery information with a sender user ID specified. If you omit specifying this option, all sender users are set as targets for acquiring the delivery information. |
|
2 |
-receiver |
Used to acquire delivery information with a recipient user ID specified. If you omit specifying this option, all recipient users are set as targets for acquiring the delivery information. |
|
3 |
-result |
Specifies the path to the output destination of the execution result file. |
|
4 |
-property |
For details, see 8.3.2 Common options. |
(3) Description
(a) Specifying options
When the -sender option and the -receiver option are specified together, the result that is filtered with AND condition for both option is returned.
(b) Delivery with the approval route specified
You cannot check whether the approval route is specified or whether approval has been made, by using the execution result file.
(c) Format of the execution result file
An output example of the execution result file is as follows:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
<deliveries>
<delivery id="123"
send-status="in-progress | suspended | completed"
send-date="2012-11-20T02:25:09+09:00"
subject="xxx" message="Sending a document Taro Hitachi">
<sender id="user1@domain1" email="user1@domain1.co.jp">
<files>
<file id="27" type="file" name="document for xx meeting.txt" size="1024524"
path="C\digikatsuwide\data\domain1\user1\123\27\a.dat" />
<file id="28" type="file" name="xxstudyresult.doc" size="3134562"
path="C\digikatsuwide\data\domain1\user1\123\28\a.dat" />
</files>
</sender>
<receivers>
<receiver id="user2@domain1" email="user2@domain1.co.jp">
<files>
<file id="27" download-date="2012-11-21T10:15:33+09:00" />
<file id="28" download-date="" />
</files>
</receiver>
<receiver id="user3@domain1" email="user3@domain1.co.jp">
<files>
<file id="27" download-date="" />
<file id="28" download-date="" />
</files>
</receiver>
</receivers>
</delivery>
</deliveries>
</data>The following table describes the meanings of the elements of the execution result file.
|
Element/attribute |
Number of elements |
Description |
|
|---|---|---|---|
|
data element |
1 |
Always output. |
|
|
deliveries element |
1 |
Always output. |
|
|
delivery element |
0 or more |
Output when delivery information exists. If there is no delivery information, no delivery element is included. |
|
|
id attribute |
1 |
The delivery ID is output. |
|
|
send-status attribute |
1 |
The following delivery (transfer) status is displayed:
|
|
|
send-date attribute |
1 |
The date the delivery (transfer) was completed is displayed. If the delivery is not completed, empty double quotation marks ("") are displayed. |
|
|
subject attribute |
1 |
The subject of the delivery is output. |
|
|
message attribute |
1 |
The message included in the delivery is output. |
|
|
sender element |
1 |
The sender information is output. |
|
|
id attribute |
1 |
The user ID of the sender is output. |
|
|
email attribute |
1 |
The email address of the sender is output. |
|
|
files element |
1 |
A list of delivery files or folders is output. |
|
|
file element |
0 or more |
Output when delivery file or folder information exists. If no delivery file or folder exists, this element is not output. |
|
|
id attribute |
1 |
The ID of the delivery file or folder is output. |
|
|
type attribute |
1 |
One of the following delivery type is output:
|
|
|
name attribute |
1 |
The name of the delivery file or folder is output. |
|
|
size attribute |
1 |
The size of the delivery file or folder is output in bytes. For a folder, the total number of bytes before archiving the contents of the folder is output. |
|
|
path attribute |
1 |
The actual file path of the delivery file or folder data stored on JP1/DH - Server is output in absolute file path format. If the type attribute is "folder", the delivery data is an archive file created by archiving the contents of the folder. |
|
|
receivers element |
1 |
A list of recipient information is output. |
|
|
receiver element |
1 or more |
Recipient information is output. If there are multiple recipients, multiple receiver elements are output. |
|
|
id attribute |
1 |
The user ID of the recipient is output. |
|
|
email attribute |
1 |
The email address of the recipient is output. |
|
|
files element |
1 |
A list of delivery files or folders is output. |
|
|
file element |
0 or more |
Output when delivery file or folder information exists. If no delivery file or folder exists, this element is not output. |
|
|
download-date attribute |
1 |
The date on which the delivery file or folder download completed is output. If the downloading is not completed, empty double quotation marks ("") are displayed. |
|
- Important
-
-
When the displayed send-status attribute is in-progress and the delivery is in progress, for the file element, only files being sent and files already sent are displayed. A file whose transfer has not started is not displayed. When you acquire information about files already sent, make sure that their send-status attribute are completed.
-
When the sender user is deleted, the files sent by that user are also deleted. In this case, empty double quotation marks ("") are displayed for the id attribute of the sender element and for the path attribute of the file element.
-
The send-status attribute is displayed as suspended only when a file transmission process is stopped by a suspension instruction from JP1/DH - Server generated through execution of the command for suspending the active file transfer. If a transmission process fails due to such a cause as a communication error, in-progress is displayed for the send-status attribute.
-
(4) Execution example
DWAdminClient.bat GETDELIVERYINFO -property "C:\DWCLient\property.xml" -sender hitachi01 -result C:\temp\result.xml