Web サイトコンソールのカスタマイズ（クラシック UI）

Web サイト（サイト管理）コンソールにカスタム列を追加

カスタム列を表示するように Web サイト管理コンソールを拡張できます。このコンソールは JSON オブジェクトをベースに構築されており、これを拡張するには ListInfoProvider インターフェイスを実装する OSGI サービスを作成します。このサービスが、コンソール構築のためにクライアントに送信される JSON オブジェクトを修正します。

このステップバイステップのチュートリアルでは、ListInfoProvider インターフェイスを実装して Web サイト管理コンソールに新しい列を表示する方法について説明します。主な手順は次のとおりです。

OSGI サービスを作成し、そのサービスを含むバンドルを AEM サーバーにデプロイします。
（オプション）コンソールの構築に使用される JSON オブジェクトをリクエストする JSON 呼び出しを発行して、新しいサービスをテストします。
リポジトリ内のコンソールのノード構造を拡張して、新しい列を表示します。

メモ

このチュートリアルは、次のような管理コンソールの拡張にも利用できます。

デジタルアセットコンソール
コミュニティコンソール

OSGI サービスの作成

ListInfoProvider インターフェイスは、次の 2 つのメソッドを定義します。

リストのグローバルプロパティを更新する updateListGlobalInfo
単一のリスト項目を更新する updateListItemInfo

どちらのメソッドにも次の引数があります。

request：関連付けられた Sling HTTP リクエストオブジェクト
info：更新する JSON オブジェクト。グローバルリストまたは現在のリスト項目に 1 つずつ
resource、Sling リソース。

次の実装例では、

各項目に starred プロパティを追加します。ページ名が「truee 」で始まる場合はで、それ以外の場合は false です。
starredCount プロパティを追加します。このプロパティはリストに対してグローバルで、星印の付いたリスト項目の数が格納されます。

OSGI サービスの作成手順

CRXDE Lite でバンドルを作成します。
次のサンプルコードを追加します。
バンドルをビルドします。

新しいサービスが起動し、実行されます。

package com.test;

import com.day.cq.commons.ListInfoProvider;
import com.day.cq.i18n.I18n;
import com.day.cq.wcm.api.Page;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.commons.json.JSONException;
import org.apache.sling.commons.json.JSONObject;

@Component(metatype = false)
@Service(value = ListInfoProvider.class)
public class StarredListInfoProvider implements ListInfoProvider {

    private int count = 0;

    public void updateListGlobalInfo(SlingHttpServletRequest request, JSONObject info, Resource resource) throws JSONException {
        info.put("starredCount", count);
        count = 0; // reset for next execution
    }

    public void updateListItemInfo(SlingHttpServletRequest request, JSONObject info, Resource resource) throws JSONException {
        Page page = resource.adaptTo(Page.class);
        if (page != null) {
            // Consider starred if page name starts with 'e'
            boolean starred = page.getName().startsWith("e");
            if (starred) {
                count++;
            }
            I18n i18n = new I18n(request);
            info.put("starred", starred ? i18n.get("Yes") : i18n.get("No"));
        }
    }

}

注意

指定されたリクエストやリソースに基づいて、情報を JSON オブジェクトに追加すべきかどうかを実装が判断する必要があります。
ListInfoProvider の実装が、応答オブジェクト内に既に存在するプロパティを定義している場合、そのプロパティの値は、指定した値で上書きされます。
サービスランキングを使用して、複数の ListInfoProvider 実装の実行順序を管理できます。

新しいサービスのテスト

Web サイト管理コンソールを開いてサイトを閲覧すると、ブラウザーがコンソールの構築に使用されている JSON オブジェクトを取得するための ajax 呼び出しを発行します。例えば、 /content/geometrixx フォルダーに保存された場合、次のリクエストがAEMサーバーに送信され、コンソールが構築されます。

http://localhost:4502/content/geometrixx.pages.json?start=0&limit=30&predicate=siteadmin

新しいサービスを含むバンドルのデプロイ後に、そのサービスが実行されていることを確認するには、以下をおこないます。

ブラウザーで次の URL を参照します。

http://localhost:4502/content/geometrixx.pages.json?start=0&limit=30&predicate=siteadmin
応答によって、新しいプロパティが次のように表示されます。

screen_shot_2012-02-13at163046

新しい列の表示

最後の手順では、Web サイト管理コンソールのノード構造を適応させ、すべてのGeometrixxページの新しいプロパティをオーバーレイして表示します /libs/wcm/core/content/siteadmin. 以下の手順を実行します。

CRXDE Liteで、ノード構造を作成します。 /apps/wcm/core/content タイプのノード sling:Folder 構造を反映する /libs/wcm/core/content.
ノードをコピーします。 /libs/wcm/core/content/siteadmin をクリックし、以下に貼り付けます。 /apps/wcm/core/content.
ノードをコピーします。 /apps/wcm/core/content/siteadmin/grid/assets から /apps/wcm/core/content/siteadmin/grid/geometrixx プロパティを変更します。
- pageText を削除
- 設定 pathRegex から /content/geometrixx(/.*)?
  
  に設定すべての Geometrixx Web サイトに対してグリッド設定が有効になります。
- 設定 storeProxySuffix から .pages.json
- 複数値プロパティ storeReaderFields を編集し、starred 値を追加します。
- MSM 機能を有効にするには、次の MSM パラメーターを multi-String プロパティに追加します。 storeReaderFields:
  - msm:isSource
  - msm:isInBlueprint
  - msm:isLiveCopy
を追加します。 starred ノード ( タイプ nt:unstructured) （以下） /apps/wcm/core/content/siteadmin/grid/geometrixx/columns を次のプロパティと共に使用します。
- dataIndex: starred 文字列型
- ヘッダー: Starred 文字列型
- xtype: gridcolumn 文字列型
（オプション）表示しない列を次の場所にドロップします。 /apps/wcm/core/content/siteadmin/grid/geometrixx/columns
/siteadmin は、デフォルトでは次を指すバニティーパスです。 /libs/wcm/core/content/siteadmin.

次のバージョンの siteadmin にリダイレクトする： /apps/wcm/core/content/siteadmin プロパティを定義する sling:vanityOrder の値が次の値より大きくなる /libs/wcm/core/content/siteadmin. デフォルト値は 300 なので、それより大きい値が適しています。
Web サイト管理コンソールに移動し、Geometrixxサイトに移動します。

http://localhost:4502/siteadmin#/content/geometrixx.
「Starred」という新しい列が使用可能になり、次のようにカスタム情報が表示されます。