Bulk Editor の開発

ここでは、Bulk Editor ツールを開発する方法と、Bulk Editor に基づく製品リストコンポーネントを拡張する方法について説明します。

Bulk Editor のクエリパラメーター

Bulk Editor を操作するときに、特定の設定で Bulk Editor を呼び出すために URL に追加できるクエリパラメーターがいくつかあります。製品リストコンポーネントなどで、Bulk Editor を常に特定の設定で使用するには、 (/libs/wcm/core/components/bulkeditor にある)bulkeditor.jsp を変更するか、特定の設定でコンポーネントを作成する必要があります。クエリパラメーターを使用した変更は、永続的ではありません。

例えば、ブラウザーのURLに次のように入力するとします。

https://<servername><port_number>/etc/importers/bulkeditor.html?rootPath=/content/geometrixx/en&queryParams=geometrixx&initialSearch=true&hrp=true

「hrp=true」によってフィールドが非表示になるので、Bulk Editor は「ルートパス」フィールドなしで表示されます。パラメーター「hrp=false」を使用すると、フィールドが表示されます(デフォルト値)。

以下に Bulk Editor のクエリパラメーターリストを示します。

メモ

各パラメーターには、長い名前と短い名前を指定できます。 例えば、検索ルートパスの長い名前はrootPath、短い名前はrpです。 長い名前が定義されていない場合、短い名前がリクエストから読み取られます。

パラメーター

(正式名称/短縮名)

タイプ
説明
rootPath / rp
文字列 検索ルートパス
queryParams / qp
文字列 検索クエリ
contentMode / cm
ブール値 trueの場合、コンテンツモードは有効です。
colsValue / cv
String[] 検索対象のプロパティ(チェックボックスとして表示されるcolsSelectionのチェックボックス値)
extraCols / ec
String[] 追加の検索済みプロパティ(コンマ区切りテキストフィールドで表示)
initialSearch / is
ブール値 trueの場合、ページの読み込み時にクエリが実行されます。
colsSelection / cs
String[] 検索されたプロパティの選択(チェックボックスとして表示)
showGridOnly / sgo
ブール値 trueの場合、検索パネル
ではなく、グリッドのみが表示されます。
searchPanelCollapsed / spc ブール値 trueの場合、読み込み時に検索パネルが折りたたまれます
hideRootPath / hrp ブール値 trueの場合は、ルートパスフィールドが非表示
hideQueryParams / hqp ブール値 trueの場合は、クエリフィールドが非表示
hideContentMode / hcm ブール値 trueの場合は、コンテンツモードフィールドが非表示
hideColsSelection / hcs ブール値 trueの場合は、列選択フィールドを非表示にします
hideExtraCols / hec ブール値 trueの場合は、追加の列フィールドが非表示
hideSearchButton ブール値 trueの場合は、検索ボタンが非表示
hideSaveButton / havep ブール値 trueの場合は、「保存」ボタンが非表示
hideExportButton / hexpb ブール値 trueの場合は、書き出しボタンが非表示
hideImportButton / hib ブール値 trueの場合は、「読み込み」ボタンが非表示
hideResultNumber / hrn ブール値 trueの場合は、グリッド検索結果番号のテキストを非表示にします
hideInsertButton / hinsertb ブール値 trueの場合は、グリッドの挿入ボタンが非表示
hideDeleteButton / hdelb ブール値 trueの場合は、グリッドの削除ボタンが非表示
hidePathCol / hpc ブール値 trueの場合は、グリッドの「パス」列が非表示

Bulk Editor ベースのコンポーネントの作成:製品リストコンポーネント

ここでは、Bulk Editor の使用方法の概要について説明します。また、Bulk Editor に基づく既存の Geometrixx コンポーネントである製品リストコンポーネントについても説明します。

製品リストコンポーネントを使用すると、ユーザーがデータのテーブルを表示および編集できます。例えば、製品リストコンポーネントを使用して、カタログの商品を表現できます。情報は標準のHTMLテーブルに表示され、編集は​編集​ダイアログ(BulkEditorウィジェットを含む)で実行されます。 (この Bulk Editor は、 /etc/importers/bulkeditor.html またはツールメニューからアクセスできるものとまったく同じです)。製品リストコンポーネントは、特定の制限された Bulk Editor 機能を使用するように設定されています。Bulk Editorのすべての部分(またはBulk Editorから派生したコンポーネント)を設定できます。

Bulk Editor を使用すると、行の追加、変更、削除、フィルターおよび書き出し、変更内容の保存および複数行の読み込みをおこなうことができます。各行は、製品リストコンポーネントインスタンス以下の 1 つのノードとして格納されます。すべてのセルは、各ノードのプロパティです。 これはデザインの選択として簡単に変更できます。例えば、リポジトリの他の場所にノードを格納することもできます。クエリサーブレットの役割は、表示するノードリストを返すことです。検索パスは製品リストインスタンスとして定義されます。

製品リストコンポーネントのソースコードは、 /apps/geometrixx/components/productlistに含まれ、すべてのAEMコンポーネントのような複数の部分で構成されます。

  • HTML レンダリング。このレンダリングは JSP ファイル(/apps/geometrixx/components/productlist/productlist.jsp)で実行されます。JSP は現在の製品リストコンポーネントのサブノードを読み取り、HTML テーブルの行として各サブノードを表示します。
  • 編集ダイアログ(Bulk Editor設定を定義する場所)。 コンポーネントのニーズに合わせてダイアログを設定します。使用可能な列と、グリッドまたは検索で実行できるアクション。 すべての設定プロパティについて詳しくは、Bulk Editor の設定プロパティを参照してください。

以下はダイアログのサブノードの XML 表現です。

        <editor
            jcr:primaryType="cq:Widget"
            colsSelection="[ProductId,ProductName,Color,CatalogCode,SellingSku]"
            colsValue="[ProductId,ProductName,Color,CatalogCode,SellingSku]"
            contentMode="false"
            exportURL="/etc/importers/bulkeditor/export.tsv"
            extraCols="Selection"
            hideColsSelection="false"
            hideContentMode="true"
            hideDeleteButton="false"
            hideExportButton="false"
            hideExtraCols="true"
            hideImportButton="false"
            hideInsertButton="false"
            hideMoveButtons="false"
            hidePathCol="true"
            hideRootPath="true"
            hideSaveButton="false"
            hideSearchButton="false"
            importURL="/etc/importers/bulkeditor/import"
            initialSearch="true"
            insertedResourceType="geometrixx/components/productlist/sku"
            queryParams=""
            queryURL="/etc/importers/bulkeditor/query.json"
            saveURL="/etc/importers/bulkeditor/save"
            xtype="bulkeditor">
            <saveButton
                jcr:primaryType="nt:unstructured"
                text="Save modifications"/>
            <searchButton
                jcr:primaryType="nt:unstructured"
                text="Apply filter"/>
            <queryParamsInput
                jcr:primaryType="nt:unstructured"
                fieldDescription="Enter here your filters"
                fieldLabel="Filters"/>
            <searchPanel
                jcr:primaryType="nt:unstructured"
                height="200">
                <defaults
                    jcr:primaryType="nt:unstructured"
                    labelWidth="150"/>
            </searchPanel>
            <grid
                jcr:primaryType="nt:unstructured"
                height="275"/>
            <store jcr:primaryType="nt:unstructured">
                <sortInfo
                    jcr:primaryType="nt:unstructured"
                    direction="ASC"
                    field="CatalogCode"/>
            </store>
            <colModel
                jcr:primaryType="nt:unstructured"
                width="150"/>
            <colsMetadata jcr:primaryType="nt:unstructured">
                <Selection
                    jcr:primaryType="nt:unstructured"
                    checkbox="true"
                    forcedPosition="0"
                    headerText=""/>
                <ProductId
                    jcr:primaryType="nt:unstructured"
                    cellCls="productlist-cell-productid"
                    headerText="Product Id"/>
                <ProductName
                    jcr:primaryType="nt:unstructured"
                    cellStyle="background-color: #FFCC99;"
                    headerText="Product Name"/>
                <CatalogCode
                    jcr:primaryType="nt:unstructured"
                    cellStyle="background-color: #EDEDED;"
                    headerText="Catalog Code"/>
                <Color jcr:primaryType="nt:unstructured">
                    <editor
                        jcr:primaryType="nt:unstructured"
                        store="[Blue,Red,Yellow]"
                        triggerAction="all"
                        typeAhead="true"
                        xtype="combo"/>
                </Color>
                <SellingSku
                    jcr:primaryType="nt:unstructured"
                    headerText="Sku Id"/>
            </colsMetadata>
        </editor>

Bulk Editor の設定プロパティ

Bulk Editorのすべての部分を設定できます。 次の表に、Bulk Editorのすべての設定プロパティを示します。

プロパティ名 定義
rootPath 検索のルートパス
queryParams 検索クエリー
contentMode true の場合は、コンテンツモードが有効(プロパティを検索結果ノードではなく jcr:content ノードで読み取り)
colsValue 検索対象プロパティ(チェックボックスとして表示される colsSelection で選択した値)
extraCols 追加の検索対象プロパティ(コンマ区切りでテキストフィールドに表示)
initialSearch true の場合は、ページの読み込み時にクエリーを実行
colsSelection 検索対象プロパティの選択(チェックボックスとして表示)
showGridOnly true の場合は、グリッドのみを表示し、検索パネルは非表示(必ず initialSearch を true に設定)
searchPanelCollapsed true の場合は、デフォルトで検索パネルを折りたたみ
hideRootPath ルートパスフィールドを非表示
hideQueryParams クエリーフィールドを非表示
hideContentMode コンテンツモードフィールドを非表示
hideColsSelection 列選択フィールドを非表示
hideExtraCols 任意選択の列フィールドを非表示
hideSearchButton 検索ボタンを非表示
hideSaveButton 保存ボタンを非表示
hideExportButton 書き出しボタンを非表示
hideImportButton 読み込みボタンを非表示
hideResultNumber グリッドの検索結果番号テキストを非表示
hideInsertButton グリッドの挿入ボタンを非表示
hideDeleteButton グリッドの削除ボタンを非表示
hidePathCol グリッドの「パス」列を非表示
queryURL クエリーサーブレットへのパス
exportURL 書き出しサーブレットへのパス
importURL 読み込みサーブレットへのパス
insertedResourceType 行が挿入されるとノードに追加されるリソースタイプ
saveButton 保存ボタンウィジェット設定
searchButton 検索ボタンウィジェット設定
exportButton 書き出しボタンウィジェット設定
importButton 読み込みボタンウィジェット設定
searchPanel 検索パネルウィジェット設定
grid グリッドウィジェット設定
store ストア設定
colModel グリッドの列モデル設定
rootPathInput rootPath ウィジェット設定
queryParamsInput queryParams ウィジェット設定
contentModeInput contentMode ウィジェット設定
colsSelectionInput colsSelection ウィジェット設定
extraColsInput extraCols ウィジェット設定
colsMetadata 列のメタデータ設定です。以下のプロパティを設定できます(列のすべてのセルに適用されます)。
  • cellStyle:HTML スタイル
  • cellCls:CSS クラス
  • readOnly:true の場合は、値を変更できません。
  • checkbox:true の場合は、列のすべてのセルをチェックボックス(true/false 値)として定義します。
  • forcedPosition:グリッド内での列の位置を指定する整数値(0 ~列 -1 の数)


列メタデータ設定

列ごとに以下を設定できます。

  • 表示プロパティ:html スタイル、CSS クラスおよび読み取り専用

  • チェックボックス

  • 強制位置

CSS および読み取り専用の列

Bulk Editor には以下の 3 つの列の設定があります。

  • セル CSS クラス名(cellCls):設定する列の各セルに追加される CSS クラス名。
  • セルスタイル(cellStyle):設定する列の各セルに追加される HTML スタイル。
  • 読み取り専用(readOnly):設定する列の各セルに読み取り専用が設定されます。

設定は以下のように定義する必要があります。

"colsMetadata": {
"Column name": {
     "cellStyle": "html style",
     "cellCls": "CSS class",
     "readOnly": true/false
}
}

次の例は、productlist コンポーネント(/apps/geometrixx/components/productlist/dialog/items/editor/colsMetadata)にあります。

            <colsMetadata jcr:primaryType="nt:unstructured">
                <Selection
                    jcr:primaryType="nt:unstructured"
                    checkbox="true"
                    forcedPosition="0"
                    headerText=""/>
                <ProductId
                    jcr:primaryType="nt:unstructured"
                    cellCls="productlist-cell-productid"
                    headerText="Product Id"/>
                <ProductName
                    jcr:primaryType="nt:unstructured"
                    cellStyle="background-color: #FFCC99;"
                    headerText="Product Name"/>
                <CatalogCode
                    jcr:primaryType="nt:unstructured"
                    cellStyle="background-color: #EDEDED;"
                    headerText="Catalog Code"/>
                <Color jcr:primaryType="nt:unstructured">
                    <editor
                        jcr:primaryType="nt:unstructured"
                        store="[Blue,Red,Yellow]"
                        triggerAction="all"
                        typeAhead="true"
                        xtype="combo"/>
                </Color>
                <SellingSku
                    jcr:primaryType="nt:unstructured"
                    headerText="Sku Id"/>
            </colsMetadata>

チェックボックス

checkbox 設定プロパティを true に設定すると、その列のすべてのセルがチェックボックスとしてレンダリングされます。ボックスがオンの場合は true がサーバーの Save サーブレットに送信され、オフの場合は false が送信されます。ヘッダーメニューで、すべて​を選択するか、なし​を選択することもできます。 選択したヘッダーがチェックボックス列のヘッダーの場合、これらのオプションは有効になります。

前の例で、selection 列には、checkbox="true" のチェックボックスのみが含まれます。

強制された位置

強制された位置メタデータ forcedPosition を使用すると、グリッド内での列の位置を指定できます。0 が先頭位置で、<列の数>-1 が最終位置です。その他の値は無視されます。

前の例で、selection 列は forcedPosition="0" の最初の列です。

クエリサーブレット

デフォルトでは、クエリサーブレットは/libs/wcm/core/components/bulkeditor/json.javaにあります。 別のパスを設定して、データを取得できます。

Query サーブレットには、GQL クエリおよび返す列を受信し、結果を計算し、結果を JSON ストリームとして Bulk Editor に送信するという機能があります。

製品リストコンポーネントの場合、Query サーブレットに送信される 2 つのパラメーターは以下のとおりです。

  • クエリ:"path:/content/geometrixx/en/customers/jcr:content/par/productlist Cube"
  • cols:"Selection,ProductId,ProductName,Color,CatalogCode,SellingSku"

返されるJSONストリームは次のようになります。

{
  "hits": [{
      "jcr:path": "/content/geometrixx/en/products/jcr:content/par/productlist/1258674828905",
      "ProductId": "21",
      "ProductName": "Cube",
      "Color": "Blue",
      "CatalogCode": "43244",
      "SellingSku": "32131"
    }
  ],
  "results": 1
}

各ヒットは1つのノードとそのプロパティに対応し、グリッドに行として表示されます。

クエリサーブレットを拡張して、複雑な継承モデルを返したり、特定のロジックの場所に保存されたノードを返したりできます。 クエリサーブレットを使用すると、あらゆる複雑な計算を実行できます。 次に、グリッドには、リポジトリ内の複数のノードの集合である行を表示できます。 これらの行の変更と保存は、その場合はSave Servletで管理する必要があります。

保存サーブレット

Bulk Editorのデフォルト設定では、各行がノードで、このノードのパスが行レコードに格納されます。 Bulk Editorは、jcrパスを介して行とノードの間のリンクを保持します。 ユーザーがグリッドを編集すると、すべての変更のリストが作成されます。 ユーザーが「保存」をクリックすると、更新されたプロパティ値と共に POST クエリが各パスに送信されます。これはSlingの概念の基礎で、各セルがノードのプロパティの場合に適切に機能します。 ただし、継承計算を行うためにクエリサーブレットが実装されている場合、このモデルは、クエリサーブレットが返すプロパティとして機能しません。別のノードから継承できます。

「サーブレットを保存」の概念は、変更が各ノードに直接投稿されるのではなく、保存ジョブを実行する1つのサーブレットに投稿されるという点です。 これにより、このサーブレットは、変更を分析し、適切なノードにプロパティを保存できます。

更新された各プロパティは、次の形式でサーブレットに送信されます。

  • パラメータ名:<jcr path>/<property name>

    例:/content/geometrixx/en/products/jcr:content/par/productlist/1258674859000/SellingSku

  • 値:<値>

    例 : 12123

サーブレットは、catalogCode プロパティが格納されている場所を認識している必要があります。

デフォルトの保存サーブレットの実装は、 /libs/wcm/bulkeditor/save/POST.jspで利用でき、製品リストコンポーネントで使用されます。 リクエストからすべてのパラメーターを取得し(<jcr path>/<property name>形式)、JCR APIを使用してノードにプロパティを書き込みます。 また、存在しない場合は、ノードも作成されます(グリッドが挿入された行)。

デフォルトのコードは、サーバーがネイティブに実行する操作(<jcr path>/<property name>上のPOST)を再実装するので、そのまま使用しないでください。したがって、プロパティ継承モデルを管理するSaveサーブレットを構築するのに適した出発点になります。

このページ