docCustomDefinitions.xml ファイル

文書プロパティー構成ファイル (docCustomDefinitions.xml) は、文書を管理するために使用されるプロパティーを定義します。インストールのプロセスによって、サンプルファイルが /aiw/aiw1/samples/config (UNIX ベースのオペレーティングシステム) および C:\aiw\aiw1\samples\config (Windows) に配置されます。

    注意:
  • 高度な文書プール、AFP SupportまたはPDF Document Supportのインストール後に docCustomDefinitions.xmlファイルを変更した場合:
    • docCustom ユーティリティーを実行し、 カスタム文書プロパティー機能をインストールまたはアップグレードします。
    • PDF Document Support 機能に関しては、RICOH ProcessDirector Plug-in for Adobe Acrobat に文書プロパティーを読み込みます。
    • AFP Support 機能に関しては、RICOH ProcessDirector ユーザーインターフェースから RICOH Visual Workbench にアクセスします。新しい文書プロパティーは、RICOH Visual Workbenchをワークステーションで開くと、読み込まれます。

データベースプロパティーと制限プロパティー

文書プロパティーは 2 つのタイプを定義できます。

  • データベースプロパティー
  • プリンタープロパティー

文書プロパティーファイルでは、両方のタイプのプロパティーを保存および操作できますが、データベースに保存されるのはデータベースプロパティーのみです。

両方のタイプのプロパティーを使用すると、次のような作業ができます。

  • ワークフローのステップ (例えば、SortDocuments ステップテンプレート) で文書をグループ化またはソートするために使用できます。
  • RICOH Visual Workbench Document Property Designer を使用して、プロパティーを AFP 索引タブにリンクできます。
  • RICOH ProcessDirector Plug-in for Adobe Acrobat を使用して、PDF ジョブの文書データをプロパティーにマップできます。
  • Archive 機能がインストールされている場合は、リポジトリーにプロパティーを保存できます。保存したプロパティーは、リポジトリーの検索やジョブ、文書、履歴情報の取得に使用できます。プロパティーの値は、［結果］テーブルの 詳細を表示をクリックすると、［プロパティー］タブに表示されます。
  • Preference Management 機能がインストールされている場合は、外部の参照ファイルを使用して、プロパティーの値を設定できます。

制限プロパティーではできませんが、データベースプロパティーを使用すれば次のような作業ができます。

  • ユーザーインターフェースのメインページの文書ポートレットで、データベースプロパティーを使用して文書を検索できます。
  • 文書ポートレットの文書を選択すると、データベースプロパティーの値が表示されます。
  • データベースプロパティーを使用して、ビューアーに表示される文書を検索できます。
  • あるジョブでデータベースプロパティーの値を決定し、別のジョブでそのプロパティーの値を更新してから、更新した値をオリジナルジョブで使用できます。
  • Automated Verification またはインサーター機能がインストールされている場合は、データベースプロパティーを使用して、調整または再印刷する文書を検索できます。
  • 高度な文書プール 拡張機能がインストールされている場合は、セレクターを使用して、プロパティー値に基づいて文書を操作できます。

制限プロパティーには次のようなメリットがあります。

  • 社会保障番号や小切手の金額など、機密性の高いプロパティー値をユーザーインターフェースに表示しないようにできます。
  • システムのパフォーマンスを最大化します。多数の文書を処理する場合には、データベースプロパティーの操作によってパフォーマンスが低下する可能性があります。

サポート担当者と協力して、データベースプロパティーと制限プロパティーの必要性を決定してください。

サンプルファイルのセクション

サンプルの docCustomDefinitions.xml ファイルには複数のセクションが含まれています。次のテーブルに、セクションをまとめて示します。

docCustomDefinitions.xml ファイルのセクション

セクション 目的
Schema schema セクションは、カスタム文書プロパティーのスキーマおよび固有の文字ストリングを識別します。サポート担当者でない限り、このセクションを編集しないでください。
データベースプロパティー このセクションは、データベース文書プロパティーを定義します。
プリンタープロパティー このセクションは、制限文書プロパティーを定義します。
User authorization properties この手順は任意です。ユーザー認証プロパティーは、データベースプロパティーへのアクセスのためのカスタム権限グループを指定します。

タイセクション

Schema セクションには、1 つの docCustomDefinitions エレメントと 1 つの schema エレメントが含まれています。サポート担当者でない限り、schema セクションを編集しないでください。

Database properties セクション

Database properties セクションには docProperty エレメントが含まれています。

    注意:
  • 1 つのプロパティーをデータベースプロパティーと制限プロパティーの両方として定義しないでください。予期しない動作が発生する可能性があります。
  • 同じ名前を持つ文書プロパティーを、RICOH ProcessDirector が自動的に定義するプロパティーとして定義しないでください。リストについては、 自動的に定義される文書プロパティーを参照してください。
<docProperty>
データベースに入っている文書プロパティーを定義します。

docProperty エレメントの属性

docProperty 属性 必須 注
名前 はい プロパティーのデータベース名 (内部名)。プロパティーを読み込みまたは書き込みするプログラムは、この名前を使用します。カスタムプロパティー名がシステム全体で固有になるように、カスタムプロパティー名に一貫性のある命名規則を使用することをお勧めします。例えば、サンプルの docCustomDefinitions.xml ファイルは、接頭部 Doc.Custom を使用して、基本製品でそのプロパティーを固有にします。

プロパティー名には、特殊文字 (@、#、$、%、- (ダッシュ) など) やスペースを使用しないでください。ピリオドとアンダースコアは使用できます。

プロパティーデータベース名のピリオド (.) の直後には数字を使用しないでください。例えば、プロパティー Doc.3rdLineAddress は無効です。
access いいえ プロパティーのユーザーアクセスレベル。製品にすでに定義されているアクセスレベルを使用するか、既存のアクセスレベルがニーズに合わない場合はカスタムアクセスレベルを作成できます。詳しくは、Access セクションを参照してください。
datatype はい プロパティーに使用するデータタイプ。次の表を参照してください。
dbType いいえ データのタイプを指定する、データベースパラメーター。
    注意:
  • dbTypeプロパティーは使用不可になり、使用されなくなりました。代わりに datatypeプロパティーを使用してください。
caption はい プロパティーのユーザーインターフェース名 (デフォルトのキャプション)。1 つの言語のみでキャプションをセットアップする場合は、このファイルで定義します。複数の言語でユーザーインターフェース名を設定する場合は、他の言語用に追加の文書プロパティー名ファイル (docCustomDefinitions_language.properties) を作成します。
shortCaption はい 表の列見出しなど、必要な箇所でこのプロパティーについて表示されるデフォルトの短いキャプション。1 つの言語のみで短いキャプションをセットアップする場合は、このファイルで定義します。複数の言語で短いキャプションをセットアップする場合は、他の言語用に追加の文書プロパティー名ファイル (docCustomDefinitions_language.properties) を作成します。
説明 はい 文書プロパティーのデフォルトの説明。ユーザーインターフェースにヘルプテキストとして表示されます。1 つの言語のみで説明をセットアップする場合は、このファイルで定義します。複数の言語で説明をセットアップする場合は、他の言語用に追加の文書プロパティー名ファイル (docCustomDefinitions_language.properties) を作成します。

プロパティー定義では以下のデータタイプとデータベースタイプを使用することをお勧めします。この表に示す妥当性検査規則に加え、データベース定義により、保管できる値がさらに制限される場合があることに注意してください。例えば、SMALLINTは0から32,767までの整数を保管できます。データベースタイプ値では、大/小文字は区別されません。

プロパティー定義で推奨されるデータタイプとデータベースタイプ

データタイプ データベースタイプ (SQL で使用) データタイプの妥当性検査
ストリング VARCHAR(128) VARCHAR：可変長、1～128文字
IntegerNonNeg SMALLINTBIGINTINTEGER SMALLINT：2バイトBIGINT：4バイトINTEGER：8バイト最小長=0
タイムスタンプ TIMESTAMP TIMESTAMP：日（D）、月（M）、年（Y）の値を含める必要があります。これらのコンポーネントは、次のいずれかの形式で表示されます。MM DD YYYYDD MM YYYYYYYY MM DD日と月は2桁の数字で表す必要があります。次の形式で時刻を追加できます。hh:mm:ss
XdkString10 VARCHAR(10) VARCHAR：可変長、1～10文字

    注意:
  • これらの値は、Stringデータタイプのバリエーションであり、Stringの代わりに使用することで、プロパティー値に対してデータベースで予約されるスペースの量を削減できます。
XdkString20 VARCHAR(20) VARCHAR：可変長、1～20文字

    注意:
  • これらの値は、Stringデータタイプのバリエーションであり、Stringの代わりに使用することで、プロパティー値に対してデータベースで予約されるスペースの量を削減できます。
XdkString30 VARCHAR(30) VARCHAR：可変長、1～30文字

    注意:
  • これらの値は、Stringデータタイプのバリエーションであり、Stringの代わりに使用することで、プロパティー値に対してデータベースで予約されるスペースの量を削減できます。
XdkString40 VARCHAR(40) VARCHAR：可変長、1～40文字

    注意:
  • これらの値は、Stringデータタイプのバリエーションであり、Stringの代わりに使用することで、プロパティー値に対してデータベースで予約されるスペースの量を削減できます。
XdkString50 VARCHAR(50) VARCHAR：可変長、1～50文字

    注意:
  • これらの値は、Stringデータタイプのバリエーションであり、Stringの代わりに使用することで、プロパティー値に対してデータベースで予約されるスペースの量を削減できます。
XdkString128 VARCHAR(128) VARCHAR：可変長、1～128文字

    注意:
  • これらの値は、Stringデータタイプのバリエーションであり、Stringの代わりに使用することで、プロパティー値に対してデータベースで予約されるスペースの量を削減できます。

Limited properties セクション

Limited properties セクションには、1 つ以上の docProperty エレメントが含まれています。

    注意:
  • 1 つのプロパティーをデータベースプロパティーと制限プロパティーの両方として定義しないでください。予期しない動作が発生する可能性があります。
  • 同じ名前を持つ文書プロパティーを、RICOH ProcessDirector が自動的に定義するプロパティーとして定義しないでください。リストについては、 自動的に定義される文書プロパティーを参照してください。
<docProperty>
文書プロパティーファイルにはあるが、データベースにはない文書プロパティーまたはジョブプロパティーを識別します。

docProperty エレメントの属性

docProperty 属性 必須 注
名前 はい InfoPrint では、カスタムプロパティー名がシステム全体で固有になるように、カスタムプロパティー名に一貫性のある命名規則を使用することをお勧めします。例えば、サンプルの docCustomDefinitions.xml ファイルは、接頭部 Doc.Custom を使用して、基本製品でそのプロパティーを固有にします。

プロパティー名には、特殊文字 (@、#、$、%、- (ダッシュ) など) やスペースを使用しないでください。ピリオドとアンダースコアは使用できます。

プロパティーデータベース名のピリオド (.) の直後には数字を使用しないでください。例えば、プロパティー Doc.3rdLineAddress は無効です。
datatype いいえ 次の表を参照してください。
caption いいえ このプロパティーについてユーザーインターフェースのリストに表示されるキャプション。1 つの言語のみでキャプションをセットアップする場合は、このファイルで定義します。複数の言語でキャプションをセットアップする場合は、他の言語用に文書プロパティー名ファイル (docCustomDefinitions_language.properties) を作成します。詳しくは、関連するインフォメーションセンターのトピックを参照してください。

これらのデータタイプを docProperty 定義に使用できます。

docProperty エレメントの属性

データタイプ データタイプの妥当性検査
ストリング 
なし
IntegerNonNeg 
0 から 2147483647 までの整数
タイムスタンプ TIMESTAMP：日（D）、月（M）、年（Y）の値を含める必要があります。これらのコンポーネントは、次のいずれかの形式で表示されます。MM DD YYYYDD MM YYYYYYYY MM DD日と月は2桁の数字で表す必要があります。次の形式で時刻を追加できます。hh:mm:ss

User authorization properties セクション

User authorization properties セクションはオプションです。ユーザー認証プロパティーは、データベースプロパティーへのアクセスのためのカスタム権限グループを指定します。このセクションには、1 つ以上の access エレメントが含まれます。

<access>
カスタムプロパティーを読み取ったり編集したりする能力を定義するために使用されます。docProperty エレメントではこれらのアクセスレベルを使用します。RICOH ProcessDirector に用意されているデフォルトのセキュリティーグループの一つを使用することも、独自に定義することもできます。以下に属性を示します。

access エレメントの属性

access 属性 注
名前 アクセスレベルの名前。
groupAttributeAccess 属性を読み取ったり編集したりするためのユーザーグループの能力。
RICOH ProcessDirector に用意されているデフォルトのアクセスレベルと許可を以下に示します。

デフォルトのアクセスレベルと許可

アクセス名 グループ名 アクセスレベル
汎用 AnyAuthenticated 属性アクセス: 読み取り
演算子 属性アクセス: 読み取り
スーパーバイザー 属性アクセス: 読み取り
管理者 属性アクセス: 書き込み
attrWriteAdmin 演算子 属性アクセス: 読み取り
スーパーバイザー 属性アクセス: 読み取り
管理者 属性アクセス: 書き込み
全員 属性アクセス: 読み取り
モニター 属性アクセス: 読み取り
attrWriteAdminSuper 演算子 属性アクセス: 読み取り
スーパーバイザー 属性アクセス: 書き込み
管理者 属性アクセス: 書き込み
全員 属性アクセス: 読み取り
モニター 属性アクセス: 読み取り
attrWriteAdminSuperOper 演算子 属性アクセス: 書き込み
スーパーバイザー 属性アクセス: 書き込み
管理者 属性アクセス: 書き込み
全員 属性アクセス: 読み取り
モニター 属性アクセス: 読み取り
actionAdmin 演算子 アクションアクセス: false
スーパーバイザー アクションアクセス: false
管理者 アクションアクセス: true
全員 アクションアクセス: false
モニター アクションアクセス: false
actionAdminSuper 演算子 アクションアクセス: false
スーパーバイザー アクションアクセス: true
管理者 アクションアクセス: true
全員 アクションアクセス: false
モニター アクションアクセス: false
actionAdminSuperOper 演算子 アクションアクセス: true
スーパーバイザー アクションアクセス: true
管理者 アクションアクセス: true
全員 アクションアクセス: false
モニター アクションアクセス: false

自動的に定義される文書プロパティー

このテーブルには、インストール中に RICOH ProcessDirector が自動的に定義する文書プロパティーがリストされます。これらのプロパティーを docCustomDefinitions.xml ファイルで定義しないでください。

自動的に定義される文書プロパティー

プロパティーデータベース名 パッケージ対象 注
Doc.Address.1 Postal Enablement 文書内のアドレスブロックの最初の行を指定します。
Doc.Address.Company Postal Enablement 文書内の会社名を指定します。
Doc.Address.PostalCode Postal Enablement 文書内の郵便番号を指定します。
Doc.Address.ZipCode Postal Enablement 文書内の郵便番号を指定します。
Doc.AV.ScanCount Automated Verification 文書上のバーコードがスキャンされた回数を表示します。
Doc.ChildJobID すべての文書処理機能 子ジョブのグループ ID。この値は最初に IdentifyDocuments または IdentifyPDFDocuments で定義されますが、SplitDocuments または CreateJobsFromDocuments などの文書プロパティーファイルを変更するすべてのステップで更新できます。
Doc.CurrentFirstPage すべての文書処理機能 現在の印刷ファイルの文書の最初のページのページ番号です。
Doc.CurrentJobID すべての文書処理機能 関連付けされたジョブ番号。
Doc.CurrentPages すべての文書処理機能 現在のジョブ内の文書のページ数です。
Doc.CurrentSequence すべての文書処理機能 現在のジョブ内の文書の順序。
Doc.CurrentSheets すべての文書処理機能 現在のジョブ内の文書のシート数です。
Doc.Custom.MemberLevel Electronic Presentment 明細書の作成時点の顧客のメンバーシップレベル。
Doc.Custom.PURL Electronic Presentment 顧客が明細書を取得可能な場所にリンクする個人用 URL。
Doc.Custom.StatementDate Electronic Presentment 明細書が最初に発行された日付。
Doc.DataLen すべての文書処理機能 印刷ファイル内の文書の長さ (バイト単位)です。
Doc.DataOffset すべての文書処理機能 オリジナルジョブの印刷ファイル内の文書のバイトオフセットです。この値は、オリジナルジョブから抽出うる AFP を見つけるために BuildAFPFromDocuments および CreateAFPJobsFromDocuments で使用されます。
Doc.DocSize.PieceThickness Postal Enablement ジョブに含まれる郵便物の厚さが異なる場合に郵便物の厚さを指定します。
Doc.DocSize.PieceWeight Postal Enablement ジョブに含まれる郵便物の重量が異なる場合に郵便物の重量を指定します。
Doc.Email.Sent すべての文書処理機能 ワークフローの EmailDocuments ステップで、文書が添付された E メールが作成されて、SMTP サーバーに配信されるかどうかを指定します。
Doc.EmailAddress すべての文書処理機能 文書に関連付けられている E メールアドレス。
Doc.ID すべての文書処理機能 文書の固有 IDです。
Doc.Insert.BinTriggers インサーター 文書用の挿入物を供給する必要があるインサータービンです。
Doc.Insert.DivertBin インサーター 挿入後の文書の方向転換先となるインサーター出力ビンの番号。
Doc.Insert.OriginalBarCode インサーター 文書の挿入を制御するオリジナルのバーコードのデータです。
Doc.Insert.RecipientName インサーター この文書のメール転送先の人物の名前です。
Doc.Insert.ReprintJobId インサーター インサーター再印刷ジョブの場合の、ジョブを作成した親ジョブ IDです。
Doc.Member.Number アーカイブ 文書でメンバー番号を指定します。RepositorySample が用意されているワークフローが、このプロパティーを使用します。
Doc.OriginalFirstPage すべての文書処理機能 文書の最初のページのページ番号です。
Doc.OriginalJobID すべての文書処理機能 オリジナルジョブのジョブ IDです。
Doc.OriginalPages すべての文書処理機能 文書のページ数です。
Doc.OriginalSequence すべての文書処理機能 オリジナルジョブ内の文書の順序です。このシステムによって、最初の文書にシーケンス値 1 が与えられ、次の文書にシーケンス値 2 が与えられ、以下同様です。
Doc.OriginalSheets すべての文書処理機能 文書を印刷する必要なシート数です。
Doc.Postal.AddressProcessingRC Postal Enablement 郵便ソフトウェアから返される値で、文書の住所変更が使用可能かどうかを示します。
Doc.Postal.Category Postal Enablement 文書のパレット仕分けマークを示します。
Doc.Postal.ChangeAddressRC Postal Enablement 文書のパレット番号を指定します。
Doc.Postal.ContainerBreakMark Postal Enablement 文書のコンテナ仕分けマークを指定します。
Doc.Postal.ContainerNumber Postal Enablement 文書のコンテナ番号を指定します。
Doc.Postal.HandlingUnitBreakMark Postal Enablement 文書のパッケージ仕分けマークを指定します。
Doc.Postal.HandlingUnitNumber Postal Enablement 文書のパッケージ番号を指定します。
Doc.Postal.PackageBreakMark Postal Enablement 文書の郵便料金を指定します。
Doc.Postal.PackageNumber Postal Enablement 文書の郵便料金コードを指定します。
Doc.Postal.PostageRate Postal Enablement 文書のソート前のシーケンス番号を指定します。
Doc.Postal.PostageRateCode Postal Enablement 郵便ソートソフトウェアから返される値で、処理の結果を示します。
Doc.Postal.SequenceNumber Postal Enablement 子ジョブ内の文書の順序です。
Doc.Postal.SequencingProcessingRC Postal Enablement 文書の状態です。
Doc.Pref.Member Preference Management プロパティーマッピングオブジェクトとともに使用して、ジョブ内の文書を識別できます。DelimitedSample が用意されているプロパティーマッピングオブジェクトと PreferencesSample が用意されているワークフローが、このプロパティーを使用します。
Doc.Pref.Output Preference Management プロパティーマッピングオブジェクトとともに使用して 、文書の出力タイプ (E メール、印刷、抑制など) を示すことができます。DelimitedSample が用意されているプロパティーマッピングオブジェクトと PreferencesSample が用意されているワークフローが、このプロパティーを使用します。
Doc.Pull すべての文書処理機能 SetDocPropsFromList ステップテンプレートとともに使用して、ジョブから削除しなければならない文書であることを示すことができます。PullPDFSample と PullAFPSample が用意されているワークフローが、このプロパティーを使用します。
Doc.PullProp すべての文書処理機能 SetDocPropsFromList ステップテンプレートとともに使用して、ジョブから削除される文書を決定する文書プロパティーを識別できます。PullPDFSample と PullAFPSample が用意されているワークフローが、このプロパティーを使用します。
Doc.SequenceInChild すべての文書処理機能 子ジョブ内の文書の順序です。この値は最初に IdentifyDocuments で定義されますが、SortDocuments または CreateJobsFromDocuments などの文書プロパティーファイルを変更するすべてのステップで更新できます。
Doc.SourceFileName すべての文書処理機能 文書を含んでいた入力ファイルの名前。
Doc.State すべての文書処理機能 文書の現行状態です。
Doc.TT.BarcodeStatus1 Automated Verification 文書上のバーコードが、ReadBarcodeData ステップに関連付けられているカメラまたはバーコードスキャナーによって正しく読み取られたかどうかを示します。
Doc.TT.BarcodeStatus2 Automated Verification 文書上のバーコードが、ReadBarcodeData ステップに関連付けられているカメラまたはバーコードスキャナーによって正しく読み取られたかどうかを示します。
Doc.TT.BarcodeStatus3 Automated Verification 文書上のバーコードが、ReadBarcodeData ステップに関連付けられているカメラまたはバーコードスキャナーによって正しく読み取られたかどうかを示します。
Doc.TT.BarcodeStatus4 Automated Verification 文書上のバーコードが、ReadBarcodeData ステップに関連付けられているカメラまたはバーコードスキャナーによって正しく読み取られたかどうかを示します。
Doc.TT.BarcodeStatus5 Automated Verification 文書上のバーコードが、ReadBarcodeData ステップに関連付けられているカメラまたはバーコードスキャナーによって正しく読み取られたかどうかを示します。
Doc.Verification.Recipient Automated Verification 文書を識別するための情報 (アカウント名など) を指定します。

Related information:

カスタム文書プロパティーを更新する
カスタム文書プロパティーを定義する
RICOH ProcessDirector に用意されているセキュリティーグループ
Reports
上位層のトピック： 文書処理機能の制御ファイル