intra-mart Accel Documents プログラミングガイド 第7版 2018-04-01

保管設定

概要

文書に保管責任者や保管期限日を設定する機能について記載します。

サンプルプログラム

文書(kn:document-01)に保管責任者(hayashi)、および、保管期限日を設定するサンプルコードを記載します。

// 対象とする文書のIDを指定します。
ObjectId documentId = ObjectId.fromIdString("kn:document-01");

// ユーザーコードから保管責任者として設定するユーザーのUgIdを生成します。
UgId ugId = KnUgIdUtil.getUserUgId("hayashi");

// 保管責任者を指定します。
List<UgId> ownerUgIds = new ArrayList<UgId>();
ownerUgIds.add(ugId);

// 保管期限日を指定します(要件にあわせて、Date型のオブジェクトを用意してください)。
Date expireDate = getExpireDate();

// タイムスタンプ対象とするかどうかを指定します。
boolean isCertChecked = true;

session.setDocumentRetentionParameter(documentId, ownerUgIds,
       expireDate, isCertChecked);

// 保管期限切れ予告通知をセットします。
session.addNoticeExpireDate(documentId);

以上のコードで文書に保管設定が付与されます。

注意

保管責任者および保管期限日を設定した場合は、必ず保管期限切れ予告通知をセットしてください。

コラム

タイムスタンプ対象とした文書に、すぐにタイムスタンプを付与する場合は、続けてタイムスタンプ付与のAPIを呼び出す必要があります。
タイムスタンプ付与については、「タイムスタンプ設定」を参照してください。