エレメントの作成¶

Search Blueprints に同梱されている system Elements はたくさんあります. システムエレメントで対応できない場合は、サーチブループリントのエレメントを独自に作成する方法もあります。

Custom JSON Element を使用して、Search Blueprints Query Builder から Element を作成します。
Add Element source editor を使用すると、便利なプレビュー機能やシステム内の定義済みテンプレート変数のリストなど、より堅牢なElementエディタを使用してElementを記述することができます。
システムのElement を複製して、独自のカスタムElementを開発するためのスタートラインに立つことができます。
Paste Any Elasticsearch Query system Element クエリDSL の使い方に慣れていて、Elasticsearchクエリを元に素早くElementを作り上げたい場合は、この方法を使用します。

カスタムJSON要素の使用¶

他のブループリントで再利用されることを意図していない要素は、ブループリントの作業中に Query Builder で追加することができます。これらは、原点のブループリントでのみ利用可能で、ブループリントの検索の要素セクションには表示されません。

Custom JSON Elementをビルダーに追加し、定型的なJSONの編集を開始します。

{
   "description_i18n": {
      "en_US": "Editable JSON Text Area"
   },
   "elementDefinition": {
      "category": "custom",
      "configuration": {},
      "icon": "custom-field"
   },
   "title_i18n": {
      "en_US": "Custom JSON Element"
   }
}

JSONエディタに入力すると、オートコンプリートにより、利用可能なプロパティが表示されます。利用可能なJSONプロパティをさらに理解するには、スキーマを理解するを参照してください。

どのような要素でもカスタムJSON要素で記述することができますが、通常、この方法は、クエリ句とおそらく条件を追加する単純な要素にのみ使用するのが最適です。多くの場合、 uiConfiguration セクションは必要なく、Element で使用できる定義済みのテンプレート変数を広範囲に使用することはありません。より複雑なケースでは、 Element source editor をご利用ください。

例えば、以下のExclude Journal Articles Elementは、Custom JSON Elementをベースにしています。 exclude.journal_articles というパラメータが trueのときだけ、Element のクエリが適用されるように条件を追加しています。このクエリでは、 must_not term クエリ句を追加して、結果が Web Content article の entryClassName フィールドと一致しないことを確認しています。

{
   "description_i18n": {
      "en_US": "Exclude journal articles from the search."
   },
   "elementDefinition": {
      "category": "hide",
      "configuration": {
         "queryConfiguration": {
            "queryEntries": [
               {
                  "clauses": [
                     {
                        "context": "query",
                        "occur": "filter",
                        "query": {
                           "bool": {
                              "should": [
                                 {
                                    "bool": {
                                       "must_not": [
                                          {
                                             "term": {
                                                "entryClassName": {
                                                "value": "com.liferay.journal.model.JournalArticle"}
                                             }
                                          }
                                       ]
                                    }
                                 },
                                 {
                                    "bool": {
                                       "must": [
                                          {
                                             "term": {
                                                "discussion": false
                                             }
                                          }
                                       ]
                                    }
                                 }
                              ]
                           }
                        }
                     }           
                  ],
                  "condition": {
                     "contains": {
                        "parameterName": "exclude.journal_articles",
                        "value": "true"
                     }
                  }
               }
            ]
         }
      },
      "icon": "hidden"
   },
   "title_i18n": {
      "en_US": "Exclude Journal Articles"
   }
}

この要素は、ブループリントのパラメータ構成を使用して追加できるカスタム変数に依存します。ブループリントにカスタム変数を追加する方法については、 Search Blueprints Configuration Reference を参照してください。

要素ソース追加エディターを使う¶

Elementsを構築するために、より強固な編集環境を提供します。 Search BlueprintsのElementsセクションから、Add()ボタンをクリックします。

要素に名前を付けて、 Create をクリックします。 Element Sourceエディタが表示され、エディタ左側のペインにPredefined Variablesが表示されます。 JSONエディタに入力すると、オートコンプリートにより、利用可能なプロパティが表示されます。利用可能なJSONプロパティをさらに理解するには、スキーマを理解するを参照してください。

エレメントソースエディタでエレメントを作成します。

UI設定オプションは、Element JSON内の uiConfiguration プロパティで定義されます。要素の設定ウィンドウがクエリビルダでどのように表示されるかをプレビューするには、 プレビュー リンク（キャンセルボタンの隣）をクリックします。

要素設定ウィンドウをプレビューします。

定義済み変数¶

要素ソースエディタで要素に定義済み変数を追加するには、変数を配置する場所にカーソルを置き、左側のサイドバーで変数をクリックして挿入させます。 Custom JSON Elementでは、エディタに直接変数を入力する必要があります。

詳しくは、定義済み要素変数リファレンスをご覧ください。

要素スキーマの理解¶

警告

要素スキーマは変更されることがあります。 Liferayのバージョン間でスキーマが変更された場合、古いエレメントのJSONのインポートに失敗することがあります。

Search Blueprint Elements のスキーマは、 sxp-query-element.schema.json ファイルに定義されています。 REST API Explorerにアクセスできるユーザーは、より便利にスキーマを参照することができます。 Liferayにログインした状態で、次のページにアクセスします。

http://localhost:8080/o/api?endpoint=http://localhost:8080/o/search-experiences-rest/v1.0/openapi.json

POST /v1.0/sxp-blueprints エンドポイントエントリを展開します。下にスクロールして、 Schema リンク（Example Value リンクの隣）をクリックします。

APIエクスプローラーからElementスキーマを探索します。

Tip

システム要素の構文を確認し、スキーマ要素を使用して要素がどのように構築されるかをよりよく理解することができます。

各要素は、次の2つの必須トップレベル特性を持つ： elementDefinition and title_i18n. elementDefinition には、 category と configuration → queryConfiguration のプロパティを含める必要があります。

{
    "elementDefinition": {
        "category": "custom",
        "configuration": {
            "queryConfiguration": {}
        }
    },
    "title_i18n": {
        "en_US": "Custom JSON Element"
    }
}

タイトル欄には、要素のタイトルテキストを必要な数だけ言語設定します。