8.4.7 配送情報の取得
配送IDやファイル,受発信ユーザ名,日時などの配送情報の一覧を取得します。
(1) 形式
DWAdminClient.bat△GETDELIVERYINFO -property△プロパティファイル [-sender△送信元ユーザID] [-receiver△受信先ユーザID] -result△実行結果ファイル
(2) 引数
項番 |
オプション |
説明 |
---|---|---|
1 |
-sender |
送信元ユーザIDを指定して,配送情報を取得する場合に指定します。 指定を省略した場合は,すべての送信元ユーザが配送情報取得の対象となります。 |
2 |
-receiver |
受信先ユーザIDを指定して,配送情報を取得する場合に指定します。 指定を省略した場合は,すべての受信先ユーザが配送情報取得の対象となります。 |
3 |
-result |
実行結果ファイルの出力先のパスを指定します。 |
4 |
-property |
「8.3.2 共通オプション」を参照してください。 |
(3) 解説
(a) オプションの指定について
-senderオプションと-receiverオプションの両方を指定した場合は,AND条件でフィルタした結果を返却します。
(b) 承認ルートが設定されている配送の場合
承認ルートが設定されているかどうか,承認済みかどうかを実行結果ファイルで確認することはできません。
(c) 実行結果ファイルの形式
実行結果ファイルの出力例を次に示します。
<?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=”○○の件” message=”資料送付します。 日立太郎”> <sender id="user1@domain1" email="user1@domain1.co.jp"> <files> <file id=”27” type=”file” name=”××会議資料.txt” size=”1024524” path="C\digikatsuwide\data\domain1\user1\123\27\a.dat" /> <file id=”28” type=”file” name=”□□検討結果.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>
実行結果ファイルの要素の意味を次に示します。
要素/属性 |
個数 |
説明 |
|
---|---|---|---|
data要素 |
1 |
常に出力されます。 |
|
deliveries要素 |
1 |
常に出力されます。 |
|
delivery要素 |
0以上 |
配送情報が存在する場合に出力されます。配送が無い場合,delivery要素は0個になります。 |
|
id属性 |
1 |
配送IDが出力されます。 |
|
send-status属性 |
1 |
配送(送信)の状態が表示されます。
|
|
send-date属性 |
1 |
配送(送信)が完了した日時が表示されます。 配送が完了していない場合は""が表示されます。 |
|
subject属性 |
1 |
配送の件名が出力されます。 |
|
message属性 |
1 |
配送のメッセージが出力されます。 |
|
sender要素 |
1 |
送信者情報が出力されます。 |
|
id属性 |
1 |
送信者のユーザIDが出力されます。 |
|
email属性 |
1 |
送信者のメールアドレスが出力されます。 |
|
files要素 |
1 |
配送ファイル/フォルダリストが出力されます。 |
|
file要素 |
0以上 |
配送ファイル/フォルダ情報が存在する場合に出力されます。配送中のファイル/フォルダが存在しない場合は,0個となります。 |
|
id属性 |
1 |
配送ファイル/フォルダのIDが出力されます。 |
|
type属性 |
1 |
配送ファイル/フォルダの種別が出力されます。
|
|
name属性 |
1 |
配送ファイル/フォルダ名が出力されます。 |
|
size属性 |
1 |
配送ファイル/フォルダのサイズが,バイト数で出力されます。フォルダの場合,フォルダの内容をアーカイブする前の合計バイト数が出力されます。 |
|
path属性 |
1 |
JP1/DH - Server上に格納されている,配送ファイル/フォルダのデータファイルの実ファイルパスが,絶対パス形式で出力されます。 type="folder"の場合,フォルダの内容をアーカイブしたアーカイブファイルとなります。 |
|
receivers要素 |
1 |
受信者情報リストが出力されます。 |
|
receiver要素 |
1以上 |
受信者情報が出力されます。受信者が複数存在する場合は,receiver要素が複数出力されます。 |
|
id属性 |
1 |
受信者のユーザIDが出力が出力されます。 |
|
email属性 |
1 |
受信者のメールアドレスが出力されます。 |
|
files要素 |
1 |
配送ファイル/フォルダリストが出力されます。 |
|
file要素 |
0以上 |
配送ファイル/フォルダの情報が存在する場合に出力されます。配送中のファイル/フォルダが存在しない場合は,0個となります。 |
|
download-date属性 |
1 |
配送ファイル/フォルダのダウンロードが完了した日時が出力されます。ダウンロードが完了していない場合は""が表示されます。 |
- 重要
-
-
send-status属性が「in-progress」で配送が送信中の場合,file要素には送信中,または送信済みのファイルだけが表示されます。送信を開始する前のファイルは表示されません。送信済みのファイルを取得する場合は,send-status属性が「complated」となっているかを確認してください。
-
送信元のユーザが削除された場合,送信したファイルも削除されます。この場合,sender要素のid要素,file要素のpath情報には,""と表示されます。
-
send-status属性が「suspended」となるのは,実行中ファイル転送の一時停止コマンドの実行により,JP1/DH - Serverからの一時停止命令でファイル送信が停止された場合だけです。通信障害などで送信が失敗した場合は,send-status属性には「in-progress」が表示されます。
-
(4) 実行例
DWAdminClient.bat GETDELIVERYINFO -property "C:\DWCLient\property.xml" -sender hitachi01 -result C:\temp\result.xml