8.3.2 データ送受信管理コマンド一覧
データ送受信管理コマンドの一覧を次の表に示します。なお,Linuxの場合は,コマンド名の拡張子「bat」を「sh」と読み替えてください。
項番 |
機能 |
コマンド |
説明 |
参照先 |
---|---|---|---|---|
1 |
送受信ボックス一覧取得 |
DWClientUtil.bat△GETOUTBOX |
送信ボックスの配送一覧を取得します。 |
|
2 |
DWClientUtil.bat△GETINBOX |
受信ボックスの配送一覧を取得します。 |
||
3 |
配送キャンセル |
DWClientUtil.bat△CANCEL |
実行中の送受信を中断します。 |
|
4 |
配送削除 |
DWClientUtil.bat△DELETEDELIVERY |
送信完了した特定の配送を指定して削除します。 |
|
- 〈この項の構成〉
(1) 送信ボックス一覧取得
送信ボックスの配送一覧を取得し,実行結果ファイルに出力します。配送状況(送信状況)を配送のステータスで確認する場合や,「配送キャンセル」,「配送削除」のコマンドで指定する配送IDを特定する場合などに使用します。
(a) 形式
DWClientUtil.bat△GETOUTBOX [△-recieverid△配送先ユーザID | -receivermail△配送先ユーザメールアドレス] [△-detail] [△-inprogress] △-fromdate△取得配送情報開始日 △-todate△取得配送情報終了日 △-result△実行結果ファイルパス △-property△コマンドプロパティファイルパス
(b) 引数
項番 |
オプション |
説明 |
---|---|---|
1 |
-receiverid |
送信ボックス中の配送を取得する際に,限定したい配送先ユーザIDを指定します。未登録のユーザを指定する場合は”anonymous”を指定します。 このオプションを省略した場合は,このコマンドの実行ユーザ(-propertyオプションで指定されたプロパティファイルに記載されたユーザ)が配送したすべての配送が対象となります(未登録宛先も含みます)。 -receivermailオプションと同時に指定することはできません。 |
2 |
-receivermail |
送信ボックス中の配送を取得する際に,限定したい配送先ユーザメールアドレスを指定します。未登録のユーザも指定できます。 このオプションを省略した場合は,このコマンドの実行ユーザ(-propertyオプションで指定されたプロパティファイルに記載されたユーザ)が配送したすべての配送が対象となります(未登録宛先も含みます)。 -receiveridオプションと同時に指定することはできません。 |
3 |
-detail |
詳細情報を取得します。詳細情報には配送情報に加えてファイル情報が含まれます。 指定しない場合はファイル情報を含まない情報を取得します。 |
4 |
-inprogress |
送信中の配送だけを取得します。送信中とは転送中,一時停止中の状態を指し,転送完了後の承認待ちは含みません。 このオプションを省略した場合は,このコマンドの実行ユーザ(-propertyオプションで指定されたプロパティファイルに記載されたユーザ)が配送したすべての配送が対象となります。 |
5 |
-fromdate |
取得する配送を,配送の作成日(create-date)※で限定します。取得する期間の開始日をJP1/DH - ServerのローカルタイムでYYYY/MM/DDの形式で指定します。 |
6 |
-todate |
取得する配送を,配送の作成日(create-date)※で限定します。取得する期間の終了日をJP1/DH - ServerのローカルタイムでYYYY/MM/DDの形式で指定します。出力される配送情報は指定日を含みます。 |
7 |
-result |
実行結果ファイルのパスを指定します。 ファイルは,XML形式で出力されます。 |
8 |
-property |
「8.3.1(2) 共通オプション」を参照してください。 |
- 注※
-
配送の作成日は,ユーザが送信を開始した日です。
(c) 解説
- (i)引数-detailを指定した場合について
-
引数-detailを指定した場合に出力される実行結果ファイルの形式を次に示します。
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <data> <deliveries> <delivery id="154" send-status="on-approving" create-date="2014/07/29 11:40" send-date="" shelf-life-time="2014/08/29 23:59" subject="XX開発プロジェクトの件" message="資料送付します。" total-size="2364662"> <sender id="user1@domain1" email="user1@domain1.co.jp"> <files> <file id="130" type="file" name="XX報告書.doc" size="266752"/> <file id="131" type="file" name="XX開発資料一式.zip" size="2097910"/> </files> </sender> <receivers> <receiver id="user2@domain1" to-type="TO" url="https://jp1dhserver.co.jp/receipt.jspx?servlet-action=receipt&id=389&cc=8014d12f457e410b09bffdfbd629dcc821d2896e" email="user2@domain1.co.jp"> <files> <file id="130" download-date=""/> <file id="131" download-date=""/> </files> </receiver> </receivers> <approvers> <approver email="approver01@domain1.co.jp" id="approver01@domain1"/> </approvers> </delivery> </deliveries> </data>
- (ii)引数-detailを指定しなかった場合について
-
引数-detailを指定しなかった場合に出力される実行結果ファイルの形式を次に示します。引数-detailを指定した場合と異なり,file要素,approvers要素,message属性を出力しません。また,受信者情報はメールアドレスだけを出力します。
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <data> <deliveries> <delivery id="154" send-status="on-approving" create-date="2014/07/29 11:40" send-date="" shelf-life-time="2014/08/29 23:59" subject="XX開発プロジェクトの件" total-size="2364662"> <sender id="user1@domain1" email="user1@domain1.co.jp"/> <receivers> <receiver email="user2@domain1.co.jp"/> </receivers> </delivery> </deliveries> </data>
- (iii)実行結果ファイル形式詳細
-
実行結果ファイルに出力される要素の意味を次の表に示します。なお,XMLでの特殊な記号はエンティティ参照(エスケープ文字)に置き換えて出力されます。
表8‒3 実行結果ファイルの意味 要素/属性
個数
説明
data/deliveries要素
1
常に出力されます。
delivery要素
n
配送情報タグ
id属性
1
配送IDが出力されます。
配送を特定するために使用します。
send-status属性
1
配送のステータスが出力されます。
in-progress:送信中
failed:送信失敗
suspended:一時停止
on-approving:承認待ち
rejected:承認却下
completed:配送済み
create-date属性
1
配送の作成日時が出力されます。
send-date属性
1
配送の送信日時が出力されます。
未承認の場合は出力されません。
subject属性
1
配送の件名が出力されます。
message属性
1
送信者の入力したメッセージが出力されます。
shelf-life-time属性
1
保管期限が出力されます。
total-size属性
1
総データサイズ(バイト数)が出力されます。
sender要素
1
送信者情報タグ
id属性
1
送信者のユーザIDが出力されます。
email属性
1
送信者のメールアドレスが出力されます。
files要素
1
送信ファイル/フォルダ情報タグ
file要素
n
送信ファイル/フォルダ単位の送信ファイル/フォルダ情報タグ
id属性
1
ファイル/フォルダのIDが出力されます。
type属性
1
ファイル/フォルダの種別が出力されます。
-
ファイル:"file"
-
フォルダ:"folder"
name属性
1
ファイル/フォルダの名称が出力されます。
size属性
1
ファイル/フォルダのサイズ(バイト数)が出力されます。
receivers要素
1
受信者情報タグ
receiver要素
n
受信者が出力されます。配送に複数の受信者がいる場合はその数だけ出力されます。-receiveridオプションを使用した場合もすべての受信者が出力されます。
id属性
1
受信者のユーザIDが出力されます。
url属性
1
受信者の開封URLが出力されます。
to-type属性
1
受信者の宛先タイプ(TO|CC|BCC)が出力されます。
email属性
1
受信者のメールアドレスが出力されます。
files要素
1
受信ファイル/フォルダ情報タグ
file要素
n
受信ファイル/フォルダの単位の受信ファイル/フォルダ情報タグ
id属性
1
ファイル/フォルダのIDが出力されます。
download-date属性
1
ファイル/フォルダをダウンロードした日付が出力されます。
approvers要素
1
承認者情報タグ(承認者がいない場合はこのタグを出力しません。)
approver要素
n
承認者単位の承認者情報タグ
id属性
1
承認者のユーザIDが出力されます。
email属性
1
承認者のメールアドレスが出力されます。
-
|
(d) 実行例
DWClientUtil.bat GETOUTBOX -fromdate "2014/06/01" -todate "2014/06/30" -result "C:\DWCLient\OUTBOX-result.xml" -property "C:\DWCLient\property.xml"
(2) 受信ボックス一覧取得
受信ボックスの配送一覧を取得し,実行結果ファイルに出力します。配送状況(受信状況)を配送のステータスで確認する場合や,「ファイルの受信」で指定する配送IDを特定する場合などに使用します。
(a) 形式
DWClientUtil.bat△GETINBOX [△-senderid△送信元ユーザID | -sendermail△送信元メールアドレス] [△-detail] [△-inprogress] △-fromdate△取得配送情報開始日 △-todate△取得配送情報終了日 △-result△実行結果ファイルパス △-property△コマンドプロパティファイルパス
(b) 引数
項番 |
オプション |
説明 |
---|---|---|
1 |
-senderid |
受信ボックス中の配送を取得する際に,送信元ユーザを限定したい場合にユーザIDを指定します。このオプションを省略した場合は,すべての送信元ユーザが対象となります。 -sendermailオプションと同時に指定することはできません。 |
2 |
-sendermail |
受信ボックス中の配送を取得する際に,送信元ユーザを限定したい場合にメールアドレスを指定します。このオプションを省略した場合は,すべての送信元ユーザが対象となります。 -senderidオプションと同時に指定することはできません。 |
3 |
-detail |
詳細情報を取得します。詳細情報には配送情報に加えてファイル情報が含まれます。 詳細情報を取得したあと,その配送に対する「開封」処理が行われます。 実行結果ファイルには開封前のステータスが出力されます。 「開封」処理では,監査ログが出力され,開封通知が有効であれば通知メールが送信され,受信ボックスのステータスも開封済みとなります。 指定しない場合はファイル情報を含まない情報を取得します。 |
4 |
-inprogress |
未受信の配送を取得します。指定しない場合は実行ユーザ宛の配送すべてを取得します。 ここでの未受信の配送とは受信済み配送リストへの記載有無ではなく,該当ユーザの受信記録がJP1/DH - Server側にない配送を指します。 |
5 |
-fromdate |
取得する配送を,配送の送信日(send-date)で限定します。取得する期間の開始日をJP1/DH - ServerのローカルタイムでYYYY/MM/DDの形式で指定します。 |
6 |
-todate |
取得する配送を,配送の送信日(send-date)で限定します。取得する期間の終了日をJP1/DH - ServerのローカルタイムでYYYY/MM/DDの形式で指定します。出力される配送情報は指定日を含みます。 |
7 |
-result |
実行結果ファイルのパスを指定します。 ファイルは,XML形式で出力されます。 |
8 |
-property |
「8.3.1(2) 共通オプション」を参照してください。 |
(c) 解説
- (i)引数-detailを指定した場合について
-
引数-detailを指定した場合に出力される実行結果ファイルの形式を次に示します。
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <data> <deliveries> <delivery id="154" download-status="downloaded" send-date="2014/07/29 11:43" shelf-life-time="2014/08/29 23:59" subject="XX開発プロジェクトの件" total-size="2364662"> <sender id="user1@domain1" email="user1@domain1.co.jp"> <files> <file id="130" type="file" name="XX報告書.doc" size="266752"/> <file id="131" type="file" name="XX開発資料一式.zip" size="2097910"/> </files> </sender> <message>資料送付します。</message> </delivery> </deliveries> </data>
- (ii)引数-detailを指定しなかった場合について
-
引数-detailを指定しなかった場合に出力される実行結果ファイルの形式を次に示します。引数-detailを指定した場合と異なり,file要素,message属性,total-size属性を出力しません。
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <data> <deliveries> <delivery id="154" download-status="downloaded" send-date="2014/07/29 11:43" shelf-life-time="2014/08/29 23:59" subject="XX開発プロジェクトの件"> <sender id="user1@domain1" email="user1@domain1.co.jp"/> </delivery> </deliveries> </data>
- (iii)実行結果ファイル形式詳細
-
実行結果ファイルに出力される要素の意味を次の表に示します。なお,XMLでの特殊な記号はエンティティ参照(エスケープ文字)に置き換えて出力されます。
表8‒5 実行結果ファイルの意味 要素/属性
個数
説明
data要素
n
常に出力されます。
delivery要素
n
配送単位の配送情報タグ
id属性
1
配送IDが出力されます。
配送を特定するために使用します。
download-status属性
1
配送のステータスが出力されます。
not-opened:未開封
opened:開封済み
downloaded:ダウンロード済み
send-date属性
1
送信日時が出力されます。
shelf-life-time属性
1
保管期限が出力されます。
subject属性
1
配送の件名が出力されます。
total-size属性
1
総データサイズ(バイト数)が出力されます。
sender要素
1
送信者情報タグ
id属性
1
送信者のユーザIDが出力されます。
email属性
1
送信者のメールアドレスが出力されます。
files要素
1
送信ファイル/フォルダ情報タグ
file要素
n
送信ファイル/フォルダ単位の送信ファイル/フォルダ情報タグ
id属性
1
ファイル/フォルダのIDが出力されます。
type属性
1
ファイル/フォルダの種別が出力されます。
-
ファイル:"file"
-
フォルダ:"folder"
name属性
1
ファイル/フォルダの名称が出力されます。
size属性
1
ファイル/フォルダのサイズ(バイト数)が出力されます。
message属性
1
送信者の入力したメッセージが出力されます。
-
|
(d) 実行例
DWClientUtil.bat GETINBOX -fromdate "2014/06/01" -todate "2014/06/30" -result "C:\DWCLient\INBOX-result.xml" -property "C:\DWCLient\property.xml"
(3) 配送キャンセル
配送IDの指定により特定の配送を対象として,実行中の配送(ファイルの送信/ファイルの受信)を中止します。
(a) 形式
DWClientUtil.bat△CANCEL [△-deliveryid△配送ID] △-property△コマンドプロパティファイルパス
(b) 引数
項番 |
オプション |
説明 |
---|---|---|
1 |
-deliveryid |
キャンセルしたい配送の配送IDを指定します。指定可能な配送IDは1つです(複数の配送IDを指定することはできません)。このオプションに指定する配送IDは,データ送受信管理コマンドの送信ボックス一覧取得(GETOUTBOX)または受信ボックス一覧取得(GETINBOX)を使用して取得します。 このオプションを省略した場合は,このコマンドの実行ユーザ(-propertyオプションで指定されたプロパティファイルに記載されたユーザ)が配送しているすべての送信/受信をキャンセルの対象とします。 |
2 |
-property |
「8.3.1(2) 共通オプション」を参照してください。 |
(c) 解説
- (i)前提条件
-
この機能によって配送をキャンセルするためには,配送IDで指定された転送の実行ユーザが,このコマンドの実行ユーザ(-propertyオプションで指定されたプロパティファイルに記載されたユーザ)と同一ユーザである必要があります。同一ユーザでない場合はエラーとなります。
ユーザIDが同一であれば,送信/受信コマンドと配送キャンセルコマンドの実行端末は異なっていても構いません。
- 注意
-
-
配送キャンセルされた配送を再開することはできません。
-
送信/受信コマンドの実行中に,配送IDを省略した配送キャンセルを行うと,エラーが発生する場合があります。この場合,再度,配送キャンセルを実行してください。
-
(4) 配送削除
配送IDの指定により特定の配送を対象として,送信完了した配送を削除します。
誤って配送した送信データを削除する場合などに使用します。
(a) 形式
DWClientUtil.bat△DELETEDELIVERY △-deliveryid△配送ID △-property△コマンドプロパティファイルパス
(b) 引数
項番 |
オプション |
説明 |
---|---|---|
1 |
-deliveryid |
削除したい配送の配送IDを指定します。指定可能な配送IDは1つです(複数の配送IDを指定することはできません)。このオプションに指定する配送IDは,データ送受信管理コマンドの送信ボックス一覧取得(GETOUTBOX)を使用して取得します。 |
2 |
-property |
「8.3.1(2) 共通オプション」を参照してください。 |
(c) 解説
- (i)前提条件
-
この機能により配送を削除するためには,配送IDで指定された配送が,このコマンドの実行ユーザ(-propertyオプションで指定されたプロパティファイルに記載されたユーザ)と同一ユーザである必要があります。同一ユーザでない場合はエラーとなります。
ユーザIDが同一であれば,ファイルの送信コマンドと配送削除コマンドの実行端末は異なっていても構いません。
- 注意
-
-
JP1/DH - ServerがWindows版の場合,指定した配送がダウンロード中の場合は削除できません。Linux版の場合,ダウンロード中でも配送を削除できますが,ダウンロードは継続されます。
-
配送IDが存在しない場合や,指定した配送IDの配送を削除できる権限がない場合はエラーとなります。
-