カスタム文書プロパティーを定義する

カスタム文書プロパティーを使用して、ジョブ内の各文書からデータを抽出できます。まず、RICOH ProcessDirector でカスタム文書プロパティーを定義し、次に文書内のデータを文書プロパティーにマッピングします。ジョブがワークフローを進むとき、 IdentifyPDFDocumentsステップ (PDF ファイル) または IdentifyDocumentsステップ (AFP ファイル) によってデータが抽出されます。

文書から抽出するデータを識別します。RICOH ProcessDirector により適切な文書プロパティーが用意されている場合、カスタム文書プロパティーを定義する代わりにその文書プロパティーを使用します。

例えば、ジョブ内の各文書から、アカウント番号、カスタマー名、メールアドレス、および明細書の日付を抽出するとします。 メールアドレスを抽出するため、RICOH ProcessDirector により メールアドレス文書プロパティーが用意されます。カスタム文書プロパティーでは、アカウント番号、カスタマー名、明細書の日付を定義します。

    注意:
  • バージョン3.11.2以降、カスタム文書プロパティーを使用する場合は、管理タブでオブジェクト ⇒ カスタムプロパティーを使用して作成できます。

    データベース名と、プロパティーノートブックと列見出しに表示されるラベルを選択できます。また、docCustomDefinitions.xmlファイルに追加することなしに、プロパティーに格納されるデータの種類と、異なるユーザーグループがプロパティーに対して持つデフォルトのアクセスも選択できます。

    詳しくは、カスタムジョブプロパティーと文書プロパティーおよびカスタムプロパティーを作成/アクティベートする の関連トピックを参照してください。

  • docCustomDefinitions.xmlファイルで定義されているカスタム文書プロパティーがある場合は、そのプロパティーを継続して使用することができます。 管理タブから再作成しないでください。このタブは、新しいジョブまたはドキュメントのプロパティーを作成する場合にのみ使用します。
  • バージョン3.11.2のRICOH ProcessDirectorで利用可能になった新機能を使用してカスタムプロパティーを作成するには、以下の操作を⾏います。
カスタム文書プロパティーを定義するには、次の手順に従います。
  1. カスタム文書プロパティーのタイプを選択します。
    • データベースプロパティー
    • 制限プロパティー

    docCustomDefinitions.xml ファイルの詳細については、docCustomDefinitions.xml ファイルを参照してください。

  2. カスタム文書プロパティーのデータベース (内部) 名を選択します。

    例えば、データベース名がDoc.Custom.AccountNumberのカスタム文書プロパティーを定義するとします。

      注意:

    • カスタム文書プロパティーのデータベース名は先頭にDoc.Customを付加することをお勧めします。この命名規則を使用しない場合は、RICOH ProcessDirector によって用意された文書プロパティーと同じデータベース名がカスタム文書プロパティーにないことを確認してください。

    • データベース名のピリオド (.) の直後には数字を使用しないでください。例えば、データベース名Doc.3rdLineAddressは無効です。

    • docCustomDefinitions.xml ファイルに追加したカスタム文書プロパティーは、削除しないでください。

    • カスタム文書プロパティーの name (データベース名)、dataType、または dbType は変更しないでください。システムでは、caption (ユーザーインターフェース名)、shortCaption、description、access を変更することができます。

  3. カスタム文書プロパティーのユーザーインターフェース名 (キャプション) を選択します。

    例えば、ユーザーインターフェース名がAccount numberのカスタム文書プロパティーを定義するとします。

      注意:
    • RICOH ProcessDirector によって用意された文書プロパティーと同じユーザーインターフェース名を持つカスタム文書プロパティーを定義しないことをお勧めします。
  4. カスタム文書プロパティーのデータタイプ（dataType）を選択します。

    例えば、String、Integer、IntegerNonNeg、Timestamp などです。

  5. データベースプロパティーの場合:
    1. データベースタイプ (dbType) を選択します。

      Stringデータタイプの場合、データベースタイプはchar、varchar、long varcharです。

      Integerデータイプの場合、データベースタイプはsmallint、bigint、integerです。

      Timestampデータタイプの場合、データベースタイプはTimestampです。

    2. カスタム文書プロパティーに対するユーザーのアクセスレベルを選択します。

      • attrWriteAdmin

        管理者セキュリティーグループのメンバーには、書き込みアクセス権限があります。モニター、オペレーター、スーパーバイザーセキュリティーグループのメンバーには、読み取りアクセス権限があります。

      • attrWriteAdminSuper

        スーパーバイザーと管理者には、書き込みアクセス権限があります。モニターとオペレーターには、読み取りアクセス権限があります。

      • attrWriteAdminSuperOper

        オペレーター、スーパーバイザー、管理者には、書き込みアクセス権限があります。モニターには、読み取りアクセス権限があります。

      アクセスレベルを指定しない場合、管理者には書き込みアクセス権限があります。モニター、オペレーター、スーパーバイザーには、読み取りアクセス権限があります。

        注意:
      • 独自のセキュリティーグループを作成した場合、カスタム文書プロパティーへのアクセス権限は、グループを作成するためにコピーした RICOH ProcessDirector セキュリティーグループと同じになります。

    3. 短いキャプションを選択します。

      短いキャプションは、テーブル列見出しに表示されます。

      例えば、短いキャプションAcct Nmbrを含むカスタム文書プロパティーを定義するとします。

    4. 説明を選択します。

      ユーザーインターフェースに、カスタム文書プロパティーのヘルプとして説明が表示されます。

      例えば、説明Customer account numberを含むカスタム文書プロパティーを定義するとします。

  6. 文書プロパティー構成ファイルを編集します。
    • 初めてカスタム文書プロパティーを定義するときは、用意されたサンプルファイルのコピーを作成します。次のディレクトリーに移動します。

      • /aiw/aiw1/samples/config (Linux)

      • C:\AIW\AIW1\samples\rules (Windows)

    • 追加の文書プロパティーを定義するときは、アクティブファイルのコピーを作成します。次のディレクトリーに移動します。

      • /aiw/aiw1/config (Linux)

      • C:\aiw\aiw1\config (Windows)

  7. docCustomDefinitions.xml ファイルを作業ディレクトリーにコピーし、ファイルを編集します。

    リカバリーのために、編集したファイルのバックアップコピーを保存しておいてください。

    たとえば、これらの行は、データベース名がDoc.Custom.AccountNumberと Doc.Custom.StatementDateの2つのデータベース文書プロパティーをファイルに追加します。 

    <docProperty name="Doc.Custom.AccountNumber"
   datatype="String"
   dbType="varchar (32)"
   access="attrWriteAdmin"
   shortCaption="Acount number"
   caption="Account number"
   description="Customer account number"/>

<docProperty name="Doc.Custom.StatementDate"
   datatype="Timestamp"
   dbType="Timestamp"
   access="attrWriteAdmin"
   shortCaption="Statement date"
   caption="Statement date"
   description="The date the statement was created"/>
      注意:
    • name 行はデータベース名を定義しています。caption 行はユーザーインターフェース名を定義しています。

    以下の行は、内部名がDoc.Custom.SSNumberおよび Doc.Custom.CheckAmtの 2 つの制限文書プロパティーをファイルに追加します。

    <limitedProperties>

   <docProperty name="Doc.Custom.SSNumber"
      datatype="String"
      caption="Social Security number"/>

   <docProperty name="Doc.Custom.CheckAmt"
      datatype="String"
      caption="Check total"/>

</limitedProperties>
  8. 構文の妥当性検査には XML エディターを使用してください。
  9. 編集したファイルを以下にコピーします。
    • /aiw/aiw1/config/docCustomDefinitions.xml (Linux)
    • C:\aiw\aiw1\config\docCustomDefinitions.xml（Windows）
  10. 新しい文書プロパティーをユーザーインターフェースに正しく表示するには、docCustomDefinitions.propertiesファイルを各言語に編集します。このファイルの新しいプロパティーのラベルを定義しない場合、ユーザーインターフェースにはプロパティーのデータベース名のみが表示されます。ファイルを編集する手順は、複数の言語でのカスタム文書プロパティーに名前をつけるを参照してください。
  11. 定義したカスタム文書プロパティーを RICOH ProcessDirector から使用できるようにします。
    1. docCustom ユーティリティーを実行します。
      docCustom ユーティリティーを初めて実行するときは、カスタム文書プロパティー機能が作成され、Feature Manager に追加されます。ユーティリティーを次に実行するときは、カスタム文書プロパティー機能が Feature Manager に追加されます。
    2. Feature Manager を使用して、カスタム文書プロパティー機能をインストールまたは更新します。
  12. RICOH ProcessDirector の更新されたカスタム文書プロパティーを、文書プロパティーの構成に使用するツールに読み込みます。
    • PDF Document Support 機能がインストールされている場合は、RICOH ProcessDirector に RICOH ProcessDirector Plug-in for Adobe Acrobat 文書プロパティーを読み込みます。

      インフォメーションセンターで関連情報を参照してください。

    • AFP Support 機能がインストールされている場合、次の 3 つのうちいずれかの方法を使用して RICOH Visual Workbench を起動します。

      • RICOH Visual Workbench を RICOH ProcessDirector サーバーから起動します。

      • RICOH Visual Workbench アプリケーションをデスクトップに戻します。

        • VisualWorkbench.zip ファイルと、ZIP 圧縮されていないすべてのファイルを削除します。

        • VisualWorkbench.zip ファイルを RICOH ProcessDirector ユーザーインターフェイスからダウンロードします。

        • ファイルを解凍し、新しい RICOH Visual Workbench デスクトップアプリケーションを起動します。

      文書プロパティーが自動的に読み込まれます。

Related information:

docCustomDefinitions.xml ファイル
複数言語のシステムに関する考慮事項
カスタム文書プロパティーを更新する
複数の言語でのカスタム文書プロパティーに名前をつける
ジョブを手動で調整できるように設定する
上位層のトピック： RICOH ProcessDirector 1 次コンピューターに機能をインストールする