カスタムクラウドサービスの作成

デフォルトのクラウドサービスを、カスタムクラウドサービスタイプで拡張することができます。これにより、カスタムマークアップを構造的な方法でページに挿入できます。この手法は、Google Analytics や Chartbeat など、主としてサードパーティの分析プロバイダーに使用されます。クラウドサービスは、親ページから子ページに継承されますが、任意のレベルで継承を中断できます。

メモ

ここで紹介する手順は、Google Analytics を使用して新しいクラウドサービスを作成する場合の例です。この内容がそのまま実際のユースケースに当てはまるとは限りません。

CRXDE Liteで、/appsの下に新しいノードを作成します。
- 名前：acs
- 型：nt:folder
/apps/acsの下に新しいノードを作成します。
- 名前：analytics
- 型：sling:Folder
/apps/acs/analyticsの下に2つの新しいノードを作成：
- 名前:コンポーネント
- 型：sling:Folder
および
- 名前:templates
- 型：sling:Folder
/apps/acs/analytics/componentsを右クリックします。「作成…」を選択し、「コンポーネントを作成…」をクリックします。表示されるダイアログで、以下の項目を指定します。
- ラベル: googleanalyticspage
- タイトル: Google Analytics Page
- スーパータイプ: cq/cloudserviceconfigs/components/configpage
- グループ: .hidden
「次へ」を2回クリックし、次を指定します。
- 許可された親: acs/analytics/templates/googleanalytics
「次へ」を2回クリックし、「OK」をクリックします。
<a0/追加>に対するプロパティ：googleanalyticspage
- 名前：cq:defaultView
- 値: html

/apps/acs/analytics/components/googleanalyticspageの下にcontent.jspという名前の新しいファイルを作成し、次の内容を入力します。

<%@page contentType="text/html"
            pageEncoding="utf-8"%><%
%><%@include file="/libs/foundation/global.jsp?lang=ja"%><div>

<div>
    <h3>Google Analytics Settings</h3>
    <ul>
        <li><div class="li-bullet"><strong>accountID: </strong><br><%= xssAPI.encodeForHTML(properties.get("accountID", "")) %></div></li>
    </ul>
</div>

/apps/acs/analytics/components/googleanalyticspage/の下に新しいノードを作成します。
- 名前：dialog
- 型：cq:Dialog
- プロパティ：
  - 名前：title
  - 型：String
  - 値: Google Analytics Config
  - 名前：xtype
  - 型：String
  - 値: dialog
/apps/acs/analytics/components/googleanalyticspage/dialogの下に新しいノードを作成します。
- 名前：items
- 型：cq:Widget
- プロパティ：
  - 名前：xtype
  - 型：String
  - 値: tabpanel
/apps/acs/analytics/components/googleanalyticspage/dialog/itemsの下に新しいノードを作成します。
- 名前：items
- 型：cq:WidgetCollection
/apps/acs/analytics/components/googleanalyticspage/dialog/items/itemsの下に新しいノードを作成します。
- 名前：tab1
- 型：cq:Panel
- プロパティ：
  - 名前：title
  - 型：String
  - 値: Config
/apps/acs/analytics/components/googleanalyticspage/dialog/items/items/tab1の下に新しいノードを作成します。
- 名前：items
- 型：nt:unstructured
- プロパティ：
  - 名前：fieldLabel
  - 種類：string
  - 値：アカウント ID
  - 名前：fieldDescription
  - 型：String
  - 値: The account ID assigned by Google. Usually in the form UA-NNNNNN-N
  - 名前：name
  - 型：String
  - 値: ./accountID
  - 名前：validateOnBlur
  - 型：String
  - 値: true
  - 名前：xtype
  - 型：String
  - 値: textfield
/libs/cq/cloudserviceconfigs/components/configpage/body.jspを/apps/acs/analytics/components/googleanalyticspage/body.jspにコピーし、libsをappsに変更して、行34に対するスクリプト参照を完全修飾パスにします。
/apps/acs/analytics/templates/の下に新しいテンプレートを作成：
- リソースタイプ = acs/analytics/components/googleanalyticspageの
- ラベル = googleanalytics
- タイトル= Google Analytics Configuration
- allowedPath = /etc/cloudservices/googleanalytics(/.*?lang=ja)?の
- allowedChildren = /apps/acs/analytics/templates/googleanalyticsの
- sling:resourceSuperType = cq/cloudserviceconfigs/templates/configpage（テンプレートノードで、jcr:contentノードではなく）
- とcq:designPath = /etc/designs/cloudservices/googleanalytics(jcr:content)

新しいコンポーネントの作成：/apps/acs/analytics/components/googleanalytics.

次の内容を googleanalytics.jsp に追加します。

<%@page import="org.apache.sling.api.resource.Resource,
                org.apache.sling.api.resource.ValueMap,
                org.apache.sling.api.resource.ResourceUtil,
                com.day.cq.wcm.webservicesupport.Configuration,
                com.day.cq.wcm.webservicesupport.ConfigurationManager" %>
<%@include file="/libs/foundation/global.jsp?lang=ja" %><%

String[] services = pageProperties.getInherited("cq:cloudserviceconfigs", new String[]{});
ConfigurationManager cfgMgr = resource.getResourceResolver().adaptTo(ConfigurationManager.class);
if(cfgMgr != null) {
    String accountID = null;
    Configuration cfg = cfgMgr.getConfiguration("googleanalytics", services);
    if(cfg != null) {
        accountID = cfg.get("accountID", null);
    }

    if(accountID != null) {
    %>
<script type="text/javascript">

  var _gaq = _gaq || [];
  _gaq.push(['_setAccount', '<%= accountID %>']);
  _gaq.push(['_trackPageview']);

  (function() {
    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'https://www') + '.google-analytics.com/ga.js';
    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
  })();

</script><%
    }
}
%>

これによって、設定のプロパティに基づいたカスタムマークアップが出力されます。

http://localhost:4502/miscadmin#/etc/cloudservicesに移動し、新しいページを作成します。
- タイトル: Google Analytics
- 名前：googleanalytics
CRXDE Liteに戻り、/etc/cloudservices/googleanalyticsの下で次のプロパティをjcr:contentに追加します。
- 名前：componentReference
- 型：String
- 値: acs/analytics/components/googleanalytics
新しく作成したサービスページ(http://localhost:4502/etc/cloudservices/googleanalytics.html)に移動し、+をクリックして、新しい設定を作成します。
- 親設定: /etc/cloudservices/googleanalytics
- タイトル: My First GA Config
「Google Analytics 設定」を選択し、「作成」をクリックします。
アカウント ID（例：AA-11111111-1）を入力します。「OK」をクリックします。
ページに移動し、「クラウドサービス」タブで、新たに作成された設定をページプロパティに追加します。
このページにカスタムマークアップが追加されます。