インストール
CMPガバナンスパックの配置、システム設定、公開前確認の手順を説明します。
- 対象製品
- CMPガバナンスパック
導入前の確認
導入前に次の項目を確定してください。
- 対象CMSが対応バージョンであること
- 制御する
scriptとiframeの一覧 - CMSで生成しているページと、CMS外で公開しているページの範囲
STRIGHT
- STRIGHTの設置と起動確認
- STRIGHT自身を変換対象から除外する設定
サイト構成とCookieの利用状況によっては、利用者側でCookie提供元の調査や構成変更が必要になる場合があります。
プラグインの配置
使用するCMS向けパッケージのplugins/CMPGovernancePackを、CMSのpluginsディレクトリ直下へ配置します。
CMSのインストール先/
└── plugins/
└── CMPGovernancePack/
├── CMPGovernancePack.pl
├── lib/
└── tmpl/
このプラグインには、別途配置するmt-static配下のファイルはありません。配置後、システムのプラグイン一覧に「CMPGovernancePack」バージョン1.0.2が表示されることを確認してください。
設定場所
システムスコープのプラグイン設定で「CMPGovernancePack」を開きます。設定はCMS全体へ適用されます。サイトスコープの設定画面はありません。
| 設定 | 動作 |
|---|---|
| iframeの変換チェックボックス | 認識できるiframeのsrcをdata-srcへ変換します |
| iframeの「URL毎の置換ルール」 | iframe用の既定属性とドメイン別ルールをYAMLで指定します |
| scriptの変換チェックボックス | 認識できるscriptをtype="text/plain"へ変換します |
| scriptの「URL毎の置換ルール」 | script用の既定属性とドメイン別ルールをYAMLで指定します |
YAMLを準備する
URLごとの属性追加やドメイン置換を行う場合は、変換を有効にする前にYAMLを設定します。ルールを使用しない場合、rulesは省略できます。設定の構造を明示する場合は空配列を指定してください。
iframe用の最小構造は次のとおりです。
iframe:
defaults: {}
rules: []
script用の最小構造は次のとおりです。
script:
defaults: {}
rules: []
YAMLの詳しい構造は、タグ制御を参照してください。
導入手順
- CMSの検証環境へプラグインを配置します。
- システムのプラグイン設定を開きます。
- iframe用とscript用のYAMLを入力し、必要なタグ種類の変換を有効にします。
- 対象ページを再構築します。
- 生成されたHTMLが想定どおり変換されていることを確認します。
- 未同意、同意、拒否、同意撤回、STRIGHTを読み込めない状態を確認します。
- 対象サイト全体を再構築し、ページ範囲を確認してから公開します。
更新時
プラグインを更新するときは、同じCMS向けパッケージのplugins/CMPGovernancePackを置き換えます。設定はCMSのプラグイン設定として保存されますが、更新前にYAMLを控えてください。
更新後はプラグインのバージョンと設定値を確認し、対象ページを再構築して確認手順を実施します。
注意事項
- 変換チェックボックスを有効にすると、特定ドメインだけでなく、実装が認識できる同種タグ全体が対象になります。
- script変換は、CMSが出力したSTRIGHTのスクリプト自身にも適用される可能性があります。スクリプトの配置と変換後の起動方法を公開前に確認してください。
- YAMLは設定画面を表示するときに検証されます。構文または構造に問題がある場合は各入力欄の下にエラーが表示されるため、修正して保存してください。不正な設定が残っている間はページ生成時に空の設定として扱われ、YAMLによる属性追加とドメイン置換は行われません。
iframeのsrc変更とscriptのtype変更は、変換設定が有効であれば継続します。 - システム設定の変更だけでは既存の公開ファイルは更新されません。再構築が必要です。
- CMS外の静的ファイル、別CMS、外部ホスティングのページには適用されません。