検索ブループリントの作成と管理
Search Blueprints は、Global メニューの Applications セクション → Search Experiences から作成できます。 もし既にブループリントを持っていて、その機能をLiferay ページの検索 に適用したい場合は、 検索ブループリントを検索ページで使用する をご覧ください。
検索ブループリントを作成するには、
-
Global Menu → Applications (Search Experiences) から Blueprints をクリックして、Blueprints アプリケーションを開きます。
-
Add(
) をクリックしてブループリントを追加します。
-
［新規検索ブループリント］ウィンドウで、ブループリントに［name］ (必須) と［description］(オプション) を指定します。
-
ブループリントの計画に応じて、次にこれらのメニューを使用して ブループリント の構築を継続することになります。
-
ブループリントを構築し、構成しながらテストします。 Preview_をクリックし、検索キーワードを入力します。
詳しくは、 Testing a Blueprint を参照してください。
-
最初のブループリント作成が終わったら、 Save をクリックします。
ブループリントの作成プロセスは迅速かつシンプルに行えますが、反復とテストが必要になることもあります。 ブループリントを頻繁に保存して、作業内容を確実に保存してください。
アクションメニューからブループリントを編集または削除します (
).
また、 検索ブループリントをインポートおよびエクスポートすることもできます。
クエリビルダーの使用
クエリビルダーの使用して
ブループリントに要素を追加する
要素を追加してブループリントにクエリ句の追加を開始します。
-
Query Elements画面で Add(
) をクリックして、Add Query Elementsサイドバーを開きます。
-
探検したい要素カテゴリーを展開する。
-
要素にカーソルを合わせ、 Add をクリックする。
-
この要素は、［Query Builder］に追加され、設定できるようになります。
-
検索クエリを設定するために必要な数の要素を追加します。
既成の各要素の説明については、 検索ブループリント要素のリファレンス を参照してください。
-
カスタム要素が必要な場合は、クエリビルダーにカスタムJSON要素を追加し、必要なクエリ句を記述します。
カスタムJSON要素の作成については、 エレメントを作る を参照してください。
一部の要素は、クエリビルダでブループリントに追加する以上のアクションを必要とします。 たとえば、「Boost Longer Contents」エレメントや「Boost Contents with More Versions」エレメントを使用するには、コントロールパネル → Search → Index Actions で以下のエントリのインデックスを再作成する必要があります：
com.liferay.blogs.model.BlogsEntrycom.liferay.document.library.kernel.model.DLFileEntrycom.liferay.journal.model.JournalArticlecom.liferay.knowledge.base.model.KBArticlecom.liferay.wiki.model.WikiPage
その他のエレメントは、ジオロケーション機能を提供するエレメント（例：Boost Proximity）のように、追加のセットアップが必要です。 詳しくは、 Elements Reference をご覧ください。
要素を追加した後、ブループリントを保存していることを確認してください。
どのLiferayアセットを検索するかを選択
ブループリントのクエリにどのLiferayアセットタイプを含めるかを決定します。 ［クエリ設定］ → ［Searchable Types］を使用します。
- デフォルトでは、すべてのアセットタイプとオブジェクトタイプが選択されています。
- 特定のタイプを削除するには、 Select Asset Types をクリックしてSelect Typesを開き、対応するチェックボックスの選択を解除します。
Searchble Types] モーダルですべてのアセットの選択を解除すると、すべてのタイプを選択した場合と同じように、すべてのアセットおよびオブジェクト タイプが検索されます。 Configuring Query Clause Contributors を参照して、Liferay のほとんどの検索句を無効にする方法を学んでください。
［Searchable Types］の設定を編集した後は、必ずブループリントを保存してください。
［Searchable Types］設定でアセットタイプを無効にすると、通常そのインデックス作成コードによって提供されるクエリ句が除外されることになります。 このタイプは検索可能ではなく、ブループリントが検索に適用されても、エンドユーザは除外されたタイプの結果を見ることはできません。
検索可能な型(Searchable Types)の設定は、他の節貢献者(Clause Contributors)の設定オプションに重要な影響を与えるため、詳細は後述します。
詳細：クエリ句のコントリビューターを設定する
Liferayのバックエンドのコード（そしてあなたのLiferayインスタンスにデプロイされたカスタムアプリケーションの可能性もあります）は、進行中の検索にクエリ句を提供します。
バックエンドから提供されるこれらの条項は、Search Blueprintsを介して設定することができます。 しかし、ほとんどのユーザーは2つの設定に触れることはないはずだ：
- 検索フレームワークのインデクサー条件
- 検索フレームワークのクエリコントリビューター
通常はデフォルトの設定で十分です。 Searchable Types を使用する以上に、この動作を微調整しなければならないと確信するのであれば、これらのバックエンド貢献者の動作方法を理解しなければならない：
-
個々のインデクサを検索に参加させないようにするには、 検索可能なタイプ を使用します。 型のインデクサを無効にすると、その型のクエリ・コントリビュータが選択されていても、その型の句は検索クエリに追加されません。 これらのタイプの結果は、ユーザーには表示されない。
-
Search Framework Indexer Clauses を使用して、Liferay のすべてのインデクサが検索に句を提供しないようにします。 すべてのインデクサを無効にする唯一の理由は、検索クエリをゼロから構築し、すべてのクエリコントリビューターと検索可能なアセットを同様に無効にすることです。
-
特定の投稿者を検索に参加させないようにするには、 Search Framework Query Contributors セクションを使用します。 独自のBlueprints設定を使用してそれらを上書きしたい場合は、特定の条項の貢献者を無効にするか、Liferayの検索動作を完全に上書きするためにすべての条項を無効にし、LiferayのIndexersとSearchable Typesも無効にします。
-
すべてのインデクサと条件コントリビューターを無効にした場合でも、Liferayの検索フレームワークによって特定の必須句が常に追加されます。 そのため、ブループリントでクエリを一から作ることはありません。
-
LiferayのIndexerフレームワークはLiferay 7.2でリファクタリングされました。 Web Content ArticlesやFoldersのようなLiferayのコア資産の一部は、新しいパターンに更新されていません。 これは、これらのアセットにはクエリコントリビュータが存在しないため、検索ブループリントに影響を及ぼします。 そのため、Liferay Indexer Clausesが有効になっている場合、アセットの標準句は常に検索クエリに追加されます。 したがって、Webコンテンツ記事の句を完全にオーバーライドすることはできません。 しかし、より多くの節を上に重ねることによって、これらのアセットの検索動作を微調整することができる（例えば、特定の節のマッチを後押しする）。
-
内部的な制限のため、Liferayのすべての
Indexerを有効にするか無効にするかを選択する必要があります。 他の条件コントリビューターは、より柔軟に管理できます。すべてのコントリビューターを含めるか、まったく含めないか、または希望するコントリビューターのサブセットを選択します。
条件コントリビューターやインデクサー動作を編集したら、必ずブループリントを保存してください。
構成の追加
検索クエリを細かく設定するだけでなく、検索ブループリント設定を追加すると、次のようなJSON設定が追加されます。
- 集計
- ハイライト
- ソート
- パラメーター
- 詳細設定
これらを追加するには、 Configuration タブをクリックし、目的のコンフィギュレーションのテキスト入力ボックスを見つけてください。 JSONを入力し、ブループリントを保存します。
以下は、検索結果を name フィールドで降順（アルファベット逆順–Z-A）にソートするソートの例である：
{
"sorts": [
{
"title_sortable": "desc"
}
]
}
詳細については、 検索ブループリント設定のリファレンス を参照してください。
ブループリントのインポートとエクスポート
ブループリントは、JSONオブジェクトです。 ある環境からブループリントの JSON をエクスポートし、別の環境にインポートします。 これは、ステージングおよびテスト環境から本番環境にブループリントを移行する際に便利です。
ブループリントのJSONをエクスポートするには。
-
［グローバルメニュー］ → ［アプリケーション］ → ［ブループリント］(［Search Experiences］セクション) からブループリントアプリケーションを開いてください。
-
ブループリントのリストから、ブループリントの\ **Actions**(
) メニューを開き、\ *Export* をクリックします。
ブループリントのJSON定義をインポートする。
-
［グローバルメニュー］ → ［アプリケーション］ → ［ブループリント］(［Search Experiences］セクション) からブループリントアプリケーションを開いてください。
-
メインのブループリント Actions(
) メニューを開き、 Import をクリックします。 -
有効なブループリント JSON ファイルを選択します。 有効な要素のJSONファイルもこの画面からインポートすることができます。
-
インポート」をクリックする。
プレビューサイドバーでブループリントをテストする
実行中のブループリントに裏付けされた検索結果を調べるのに便利なプレビューサイドバーがあります。 Edit Blueprint画面から Preview ボタンをクリックしてプレビューにアクセスします。
ここでは、これらの機能にアクセスできます。
-
7.4 U52+の場合、 View Raw Request をクリックすると、検索リクエスト文字列全体が表示されます。 ［Raw Request］モーダルから、リクエストをクリップボードにコピーするか、JSONファイルとしてダウンロードすることができます。 これは、検索ページの ［検索インサイト］ ウィジェットで見られるリクエストと同じです。
-
View Raw Response をクリックすると、検索応答文字列全体が表示されます。 ここで、レスポンスをクリップボードにコピーするか、JSONファイルとしてダウンロードすることができる。 これは、検索ページの 検索インサイト ウィジェットに表示される文字列と同じです。
-
各結果のスコアは、結果タイトルの左側に表示される。 スコアをクリックするとスコア解説が表示されます。
-
結果を展開して、返されたドキュメントのすべてのフィールドを見るには、結果のタイトルの右側にある右向きの角括弧をクリックします。
いくつかの要素 は、手動で提供またはオーバーライドできる検索コンテキスト属性を読み取ります。 これらの要素を含むブループリントをテストするには、歯車のアイコン (
) をクリックして、ブループリントのプレビュー検索に検索コンテキスト属性を追加します。 属性のキーと値のペアを入力し、 Done をクリックします。 このアトリビュートはブループリントのプレビューにのみ設定され、ブループリント自体には保存されないことに注意してください。 これらの属性は、ページの検索で設定することができます。 詳しくは、 検索ブループリントを検索ページで使用する を参照してください。
例えば、
-
カテゴリー 「administrative」を持つ新しい 語彙を追加する。
-
Webコンテンツの記事 を2つ追加する。両方ともタイトルフィールドに test があることを確認する。 そのうちの1つを、作成したカテゴリーに関連付けます。
-
新しいブループリントを作成し、条件要素 Hide Contents in a Category for Guest Users を追加します。 作成したカテゴリのアセットカテゴリIDが必要ですが、それはプレビューウィンドウで確認することができます。
-
プレビューで administrative を検索。 ウェブコンテンツ記事のドキュメントをカテゴリーとともに展開し、
assetCategoryId（例：43013）を見つける。 -
要素の設定にあるIDを使用します。
-
プレビュー・サイドバーの「属性」を開き、次のように入力する。
キー:
user.is_signed_in値:
false -
Done をクリックし、 test の検索を入力する。
これで、未分類のWebコンテンツだけが返されるようになりました。 もう1つは、検索ユーザーがゲストであるかのように検索を動作させる検索コンテキスト属性のため、非表示になっています。
この例では、コンテキスト変数 user.is_signed_in を読み込む Element を使っている。 値を手動で設定することにより、既存の値をオーバーライドして、ブループリントが特定の動作を示すことができます。 値はすでに検索コンテキストに存在するため、手動での設定は任意です。 その他の要素では、通常の検索リクエストのコンテキスト内に存在しないカスタムパラメータが必要です。 プレビューサイドバーからブループリントをテストする場合でも、検索ページで使用するためにブループリントを設定する場合でも、要素/ブループリントが正しく機能するように、これらを手動で検索コンテキストに渡す必要があります。
外部参照コード（ERC）の設定
ライフェライ2023.Q4+/GA102+について
ブループリントは編集可能なERCで参照でき、可能な限りこれを推奨する。 便宜上、ERCを覚えやすく人間が読めるものに設定することができる。 ブループリント・エディターから、 Edit をクリックします！ Edit をクリックします：
この人間が読めるERCは、検索ページ や ヘッドレス検索リクエスト でブループリント を設定するときに便利です。