Workplace XT 検索オプションのカスタマイズ

簡易検索ページまたは拡張検索ページに表示される Workplace XT の検索オプション・チェック・ボックスをカスタマイズすることができます。検索オプションは、 「オプション」リストと「ドキュメント・タイプ」リストに表示されます。これらのリストは、以下の方法でカスタマイズできます。

検索を実行する前に、Workplace XT は検索条件を SQL 照会に変換します。各検索オプション・チェック・ボックスは、SQL ステートメントの WHERE 節に追加される 1 つの条件を表します。チェック・ボックスは <WPXT_deploy_path>/FileNet/Config/WC/SimpleSearch.xml ファイルで定義されます。以下の XML スニペットに示すように、各チェック・ボックスは searchOption オブジェクト・エレメント内に記述されます。

<object key="searchOptionGroup">
  <setting key="id">options</setting>
  <list key="searchOptions">
    <object key="searchOption">
      <label key="label" localizationKey="server.SimpleSearch.createdByMe">
        <resource>Added by me</resource>
      </label>
      <setting key="symname">Creator</setting>
      <setting key="value">{CURRENT_USER}</setting>
      <setting key="type">typestring</setting>
      <setting key="operator">eq</setting>
      <setting key="join">and</setting>
      <array key="objectTypes">
        <value>document</value>
        <value>folder</value>
      </array>
      <array key="objectStores"></array>
      <array key="roles"></array>
    </object>

...

 

以下の表では、「自分の追加分 (Added by me)」チェック・ボックスを例に使用して、 SimpleSearch.xml の各エレメントについて説明します。 エレメントはキー属性によって識別されます。特に指定のない限り、以下のエレメントは必須です。

設定
<object key="searchOptionGroup">
  <setting key="id">options</setting>
searchOptionGroup エレメントは、検索オプションを簡易検索ページおよび拡張検索ページ上「オプション」リストと「ドキュメント・タイプ」リストに編成します。id エレメントはリストを指定します。値が options のエレメントは「オプション」リストに表示され、値が docTypes のエレメントは 「ドキュメント・タイプ」リストに表示されます。
<object key="searchOption">
  <label key="label"
    localizationKey=
      "server.SimpleSearch.createdByMe">
    <resource>
      Added by me
    </resource>
    <resource locale=fr_FR" >
      Créé par moi
    </resource>
  </label>
searchOption エレメントは検索オプションを定義します。 label エレメントは、チェック・ボックスの説明に使用するテキストの各種属性を定義します。

label エレメントは localizationKey 属性を必要とします。新しい検索オプションの作成時に localizationKey 属性の値を指定するには、ストリング server.SimpleSearch を使用し、記述名を付加します localizationKeySimpleSearch.xml 内で固有でなければなりません。 チェック・ボックスの説明に使用するテキストを指定するには、resource エレメントを使用します。

label エレメントには、ローカライズされたストリングを使用できます。 必要に応じて、locale 属性を持つ resource エレメントを 1 つ以上設定することができます。 この属性の値には、ブラウザーでサポートされている標準の ISO 言語コードおよび国別コードを使用する必要があります。
<setting key="symname">
  Creator
</setting>
symname エレメントは、チェック・ボックスに関連付けられたプロパティーのシンボル名 (プログラムの識別子) を指定します。 Enterprise Manager を使用して、プロパティーのシンボル名を取得することができます。
<setting key="value">
  {CURRENT_USER}
</setting>
value エレメントは、SQL 照会で指定されたプロパティーの値を指定します。適用可能な場合は、以下のマクロがサポートされます。
  • {CURRENT_USER} は、現在ログインしているユーザーを表す短い形式の名前です。
  • {DATE}[ + | - ][days] は、現在日付 +/- 指定した日数です。例えば、" {DATE}-7" は、現在の日付マイナス 7 日を意味します。スペースは使用できません。
<setting key="type">
  typestring
</setting>
type エレメントは、プロパティーのデータ型を指定します。有効なデータ型は、 typestringtypebooleantypedate です。Enterprise Manager を使用すると、プロパティーのデータ型を判別できます。
<setting key="operator">
  eq
</setting>
operator エレメントは、SQL 照会で使用される関係演算子を指定します。有効な値は以下のとおりです。eqltgtltegteneqinisnullisnotnulllike
<setting key="join">
  and
</setting>
join エレメントは、この検索オプションを他の検索オプションとどのように結合するかを指定します。このオプションのデフォルトは、「ドキュメント・タイプ」チェック・ボックスでは or、それ以外は and に設定されています。例えば、ユーザーが Word、Excel、および PDF の各ドキュメント・タイプを選択して検索した場合は、Word または Excel または PDF タイプと一致するドキュメントが返されます。あるいは、ユーザーが「自分の作成分」チェック・ボックスと 「チェックアウト済み」チェック・ボックスを選択して検索した場合は、ユーザー自身が作成したもので、なおかつチェックアウト済みのドキュメントが返されます。

Workplace XT が検索オプションを SQL 照会に変換する際には、すべての and 条件をグループ化した後で、すべての or 条件をグループ化します。例えば、デフォルト設定を使用して、ユーザーが「Word」、 「PDF」「、自分の作成分」、および 「チェックアウト済み」を選択して検索した場合は、 "created by me and checked out and (Word or PDF)" のような照会が送信されます。

<array key="objectTypes">
  <value>document</value>
  <value>folder</value>
</array>
objectTypes エレメントは、この検索オプションが有効となるオブジェクト・タイプのリストを指定します。サポートされる値は document および folder です。
<array key="objectStores">
  <value>Claims</value>
</array>
objectStores エレメントは、このプロパティーが有効となるオブジェクト・ストアのリストを指定します。ユーザーが検索するオブジェクト・ストアでこのプロパティーが無効になっている場合、それに関連する検索オプションは表示されません。すべてのオブジェクト・ストアに対して検索オプションを表示するには、 value オブジェクト・エレメントを省略します。
<array key="roles">
  <value>Adjustor</value>
</array>
roles エレメントは、この検索オプションへのアクセス権を持つロールのリストを指定します。ユーザーが指定されたロールのメンバーでない場合、それに関連する検索オプションは表示されません。すべてのユーザーに対して検索オプションを表示するには、 value オブジェクト・エレメントを省略します。