HSRSRemoveMessageビジネスメッセージ削除

形式

HSRSRemoveMessage [-sid ドキュメント送信者識別子]
                 [-rid ドキュメント受信者識別子]
                 [-mid ドキュメント識別子]
                 [-sd 開始日時]
                 [-ed 終了日時]
                 [-force]

機能

"取得済み"状態のビジネスメッセージのうち,ビジネスメッセージ保持期間を過ぎたビジネスメッセージをデータベースから削除します。

オプション

オプションを指定すると,指定した条件で絞り込まれた"取得済み"状態のビジネスメッセージを削除します。すべてのオプションを省略した場合は,削除できるすべてのビジネスメッセージを削除します。

-sid ドキュメント送信者識別子
ビジネスメッセージのドキュメント送信者識別子を指定します。このオプションは省略できます。
-rid ドキュメント受信者識別子
ビジネスメッセージのドキュメント受信者識別子を指定します。このオプションは省略できます。
-mid ドキュメント識別子
ビジネスメッセージのドキュメント識別子を指定します。このオプションは省略できます。
-sd 開始日時
検索したい期間の開始日時を指定します。このオプションを指定すると,開始日時以降にデータベースに登録されたビジネスメッセージを削除できます。このオプションは省略できます。
開始日時の形式はYYYYMMDDhhmmss形式で,"YYYY"は必ず指定してください。"YYYY"以外を省略した場合,"YYYY0101000000"が指定されます。
  • YYYY:年(1970~2038)
  • MM:月(01~12)
  • DD:日(01~31)
  • hh:時(00~23)
  • mm:分(00~59)
  • ss:秒(00~59)
-ed 終了日時
検索したい期間の終了日時を指定します。このオプションを指定すると,終了日時以前にデータベースに登録されたビジネスメッセージを削除できます。このオプションは省略できます。
終了日時には,開始日時よりもあとの日時を指定してください。指定形式は開始日時と同じで,"YYYY"以外を省略した場合,"YYYY1231235959"が指定されます。
-force
このオプションを指定すると,"取得済み"状態でビジネスメッセージ保持期間を過ぎたビジネスメッセージに加え,"未取得"状態でビジネスメッセージ保持期間を過ぎたビジネスメッセージもデータベースから強制的に削除できます。このオプションは省略できます。

戻り値

戻り値内容
0正常終了
削除対象のビジネスメッセージを全件データベースから削除しました。または,条件に合うビジネスメッセージがありませんでした。
2異常終了(システム定義エラー)
3異常終了(引数エラー)
4異常終了(実行時エラー)
削除対象のビジネスメッセージを全件削除する前に,処理が中断されました。要因を次に示します。
  • データベースへの接続に失敗した。
  • 処理を継続できないデータベースアクセスエラーが発生した。
  • メモリ不足などの内部エラーが発生した。
なお,処理の途中で実行時エラーになった場合,それまでに削除に成功したビジネスメッセージはロールバックされません。

注 このコマンドでは,戻り値1は出力されません。


実行例

"取得済み"状態のビジネスメッセージのうち,ビジネスメッセージ保持期間を過ぎたすべてのビジネスメッセージを削除する場合の実行例を,次に示します。

HSRSRemoveMessage.bat

送信元のクライアント企業を特定して,"取得済み"状態でかつビジネスメッセージ保持期間を過ぎたビジネスメッセージを削除する場合の実行例を,次に示します。

HSRSRemoveMessage.bat -sid C000000000000001

"取得済み"状態でかつビジネスメッセージ保持期間を過ぎたビジネスメッセージを,ドキュメント送信者識別子およびドキュメント識別子で特定して削除する場合の実行例を,次に示します。

HSRSRemoveMessage.bat -sid C000000000000001 -rid S000000000000000 -mid 20060418063642-4227063e2a664f4299b4440e07833adf@C000000000000001.com

2006/04/01から2006/04/30までの期間にデータベースに登録されたビジネスメッセージのうち,"取得済み"状態でかつビジネスメッセージ保持期間を過ぎたすべてのビジネスメッセージを削除する場合の実行例を,次に示します。

HSRSRemoveMessage.bat -sd 20060401 -ed 20060430