パッケージマネージャー

パッケージを使用すると、リポジトリコンテンツのインポートとエクスポートが可能になります。パッケージを使用すると、新しいコンテンツのインストール、インスタンス間でのコンテンツの転送、リポジトリコンテンツのバックアップを行うことができます。

パッケージマネージャーを使用すると、開発目的で、AEM インスタンスとローカルファイルシステムの間でパッケージを転送できます。

パッケージとは

パッケージは、リポジトリコンテンツをファイルシステムのシリアル化形式で保持する zip ファイルであり（vault のシリアル化と呼ばれます）、使いやすく編集しやすい形式でファイルやフォルダーを表現します。 パッケージに含まれるコンテンツは、フィルターを使用して定義します。

パッケージには、フィルター定義やインポート設定情報などの Vault メタ情報も含まれています。説明、視覚的な画像、アイコンなど、パッケージの抽出には使用されないその他のコンテンツプロパティをパッケージに含めることができます。これらの追加のコンテンツプロパティは、コンテンツパッケージのコンシューマー向けのもので、情報提供だけを目的としています。

AEM as a Cloud Service のパッケージ

AEM as a Cloud Service のアプリケーション用に作成されたコンテンツパッケージでは、不変コンテンツと可変コンテンツを明確に分離する必要があります。そのため、パッケージマネージャーは、コンテンツを含むパッケージの管理にのみ使用できます。すべてのコードは、Cloud Manager を使用してデプロイする必要があります。

AEMaaCS 用のパッケージを管理する方法について詳しくは、デプロイユーザーガイドの AEM as a Cloud Service へのデプロイ のドキュメントを参照してください。

パッケージマネージャー

パッケージマネージャーでは、AEM インストール上のパッケージを管理します。必要な権限の割り当て を行ってから、パッケージマネージャーを使用してパッケージの設定、ビルド、ダウンロード、インストールなど様々なアクションを実行できます。

必要な権限

パッケージを作成、変更、アップロード、インストールするには、次のノードに対する適切な権限が必要です。

• /etc/packages での削除を除く完全な権限
• パッケージコンテンツを含むノード

パッケージマネージャーへのアクセス

パッケージマネージャーには次の 3 つの方法でアクセスできます。

1. AEM のメインメニュー／ツール／デプロイメント／パッケージ から
2. 上部のスイッチャーバーの使用して CRXDE Lite から
3. http://<host>:<port>/crx/packmgr/ にアクセスして直接

パッケージマネージャー UI

パッケージマネージャーは、次の 4 つの主な機能領域に分かれています。

• 左側のナビゲーションパネル - このパネルでは、パッケージのリストをフィルタリングおよび並べ替えることができます。
• パッケージリスト - これは、左側のナビゲーションパネルでの選択に従ってフィルタリングおよび並べ替えられた、インスタンス上のパッケージのリストです。
• アクティビティログ - このパネルは最初は最小化されていますが、パッケージのビルド時やインストール時など、パッケージマネージャーのアクティビティの詳細を表示するために展開できます。「アクティビティログ」タブには、次の操作を行うための追加のボタンがあります。
  • ログを消去
  • 表示／非表示
• ツールバー - ツールバーには、左側のナビゲーションパネルとパッケージリスト用の更新ボタン、およびパッケージを検索、作成、アップロードするためのボタンが含まれています。

左側のナビゲーションパネルでオプションをクリックすると、パッケージリストが直ちにフィルタリングされます。

パッケージ名をクリックすると、パッケージリストのエントリが展開され、パッケージの詳細が表示されます。

パッケージの詳細を展開する際に使用できるツールバーボタンを使用して、パッケージで実行できるアクションは多数あります。

• 編集
• ビルド
• 再インストール
• ダウンロード

「その他」ボタンの下にあるその他のアクションを利用できます。

• 削除
• カバレッジ
• コンテンツ
• 再折り返し
• その他のバージョン
• アンインストール
• インストールをテスト
• Validate（検証）
• レプリケーション

パッケージステータス

パッケージリスト内の各エントリには、パッケージのステータスを一目で把握できるステータスインジケーターが表示されます。ステータスの上にマウスポインターを置くと、ステータスの詳細を示すツールチップが表示されます。

パッケージが変更された、または作成されなかった場合、ステータスは、パッケージを再作成またはインストールするためのクイックアクションを実行するためのリンクとして表示されます。

パッケージ設定

パッケージとは、基本的に、一連のフィルターとそれらのフィルターに基づいたリポジトリデータです。 パッケージマネージャーの UI を使用し、パッケージをクリックして「編集」ボタンをクリックすると、次の設定を含むパッケージの詳細が表示されます。

• 一般設定
• パッケージフィルター
• パッケージの依存関係
• 詳細設定
• パッケージスクリーンショット

一般設定

様々なパッケージ設定を編集して、パッケージの説明、依存関係、プロバイダー情報などの情報を定義できます。

パッケージ設定 ダイアログは、パッケージを 作成 または 編集 するときに「編集」ボタンから使用できます。変更が完了したら、「保存」をクリックします。

パッケージフィルター

フィルターは、パッケージに含めるリポジトリノードを識別します。フィルター定義​によって、以下の情報が指定されます。

• 含めるコンテンツの ルートパス
• ルートパスの下で特定のノードを含める、または除外する ルール。

ルールを追加するには、「+」ボタンを使用します。ルールを削除するには、「-」ボタンを使用します。

ルールは順序に従って適用されるため、必要に応じて 上向き および 下向き の矢印ボタンを使用してルールを配置します。

フィルターにはルールを含めないことも、いくつか含めることもできます。ルールを何も定義しない場合、パッケージにはルートパスの下のすべてのコンテンツが含まれます。

1 つのパッケージに対して 1 つまたは複数のフィルター定義を指定できます。複数のルートパスのコンテンツを含めるには、複数のフィルターを使用します。

フィルターを作成する場合、パスを定義するか、正規表現を使用することにより、含めたり除外したりするすべてのノードを指定できます。

パッケージフィルターが定義されるのは、ほとんどの場合、最初に パッケージを作成するときです。 ただし、後で編集することもできますが、その後でパッケージを再作成して、新しいフィルター定義に基づいてその内容を更新する必要があります。

依存関係

詳細設定

パッケージスクリーンショット

パッケージに複数のスクリーンショットを添付して、コンテンツがどのように表示されるかを視覚的に示すことができます。

パッケージアクション

1 つのパッケージで実行できるアクションは多数あります。

パッケージの作成

1. パッケージマネージャーにアクセスします。

2. 「パッケージを作成」をクリックします。

   ヒント

   インスタンスに多数のパッケージがある場合は、フォルダー構造が存在する可能性があります。そのような場合は、新しいパッケージを作成する前に必要なターゲットフォルダーに移動する方が簡単です。

3. 新規パッケージ ダイアログで、次のフィールドを入力します。

   

   • パッケージ名 - パッケージのコンテンツを（自分と他の人が）簡単に識別できるように、わかりやすい名前を選択します。

   • バージョン - これは、バージョンを示すためのテキストフィールドです。 これがパッケージ名に追加され、zip ファイルの名前が形成されます。

   • グループ - ターゲットグループ（またはフォルダー）の名前です。グループは、パッケージの整理に役立ちます。 グループのフォルダーがまだ存在しない場合は作成されます。グループ名を空白のままにすると、メインのパッケージリストにパッケージが作成されます。

4. 「OK」をクリックしてパッケージを作成します。

5. AEM では、新しいパッケージがパッケージのリストの最上部に表示されます。

   

6. 「編集」をクリックすると、パッケージのコンテンツを定義できます。 設定の編集が完了したら、「保存」をクリックします。

7. これで、パッケージを ビルド できます。

パッケージを作成した後すぐにビルドする必要はありません。未ビルドパッケージにはコンテンツが含まれず、フィルターデータとパッケージの他のメタデータのみで構成されます。

パッケージのビルド

多くの場合、パッケージは パッケージの作成 と同時に作成されますが、後で戻ってパッケージを作成または再作成することができます。これは、リポジトリ内のコンテンツが変更された場合や、パッケージフィルターが変更された場合に役立ちます。

1. パッケージマネージャーにアクセスします。

2. パッケージリストでパッケージ名をクリックして、パッケージの詳細を開きます。

3. 「ビルド」をクリックします。パッケージをビルドすると既存のパッケージの内容が上書きされるので、実行するかどうかを確認するダイアログが表示されます。

4. 「OK」をクリックします。AEM によってパッケージがビルドされ、パッケージに追加されたすべてのコンテンツがアクティビティリストに表示されます。ビルドが完了すると、パッケージが作成されたことを示すダイアログが表示されます。そのダイアログを閉じると、パッケージリストの内容が更新されます。

パッケージの編集

パッケージを AEM にアップロードした後は、その設定を変更できます。

1. パッケージマネージャーにアクセスします。

2. パッケージリストでパッケージ名をクリックして、パッケージの詳細を開きます。

3. 必要に応じて、「編集」をクリックして パッケージ設定 を更新します。

4. 「保存」をクリックして、保存します。

変更した内容を反映するには、 パッケージを再作成 する必要がある場合があります。

パッケージを再度含める

パッケージは、ビルド後に再度含めることができます。再度含めると、パッケージのコンテンツは変更されずに、サムネールや説明などを含まないパッケージの情報が変更されます。

1. パッケージマネージャーにアクセスします。

2. パッケージリストでパッケージ名をクリックして、パッケージの詳細を開きます。

3. 必要に応じて、「編集」をクリックして パッケージ設定 を更新します。

4. 「保存」をクリックして、保存します。

5. その他／再度含める をクリックすると、確認のダイアログが表示されます。

他のパッケージバージョンの表示

パッケージのすべてのバージョンは別のパッケージとしてリストに表示されるので、パッケージマネージャーは選択したパッケージの他のバージョンを検索できます。

1. パッケージマネージャーにアクセスします。

2. パッケージリストでパッケージ名をクリックして、パッケージの詳細を開きます。

3. その他／その他のバージョン をクリックすると、ダイアログが開き、同じパッケージの他のバージョンとステータス情報が表示されます。

パッケージコンテンツの表示とインストールのテスト

パッケージがビルドされたら、コンテンツを表示できます。

1. パッケージマネージャーにアクセスします。

2. パッケージリストでパッケージ名をクリックして、パッケージの詳細を開きます。

3. コンテンツを表示するには、その他／コンテンツ をクリックします。パッケージマネージャーには、パッケージのコンテンツ全体がアクティビティログにリストされます。

   

4. インストールのドライランを実行するには、 その他／インストールをテスト をクリックします。パッケージマネージャーは、インストールが実行されたかのように結果をアクティビティログにレポートします。

   

ファイルシステムへのパッケージのダウンロード

1. パッケージマネージャーにアクセスします。

2. パッケージリストでパッケージ名をクリックして、パッケージの詳細を開きます。

3. パッケージの詳細領域内にある「ダウンロード」ボタンまたはリンクが付いたパッケージのファイル名をクリックします。

4. AEM がお使いのコンピューターにパッケージをダウンロードします。

ファイルシステムからのパッケージのアップロード

1. パッケージマネージャーにアクセスします。

2. パッケージのアップロード先となるグループフォルダーを選択します。

3. 「パッケージをアップロード」ボタンをクリックします。

4. アップロードしたパッケージに関する必要な情報を入力します。

   

   • パッケージ - 「参照…」ボタンを使用して、必要なパッケージをローカルファイルシステムから選択します。
   • アップロードを強制 - この名前のパッケージが既に存在する場合は、このオプションを選択すると、アップロードが強制され、既存のパッケージが上書きされます。

5. 「OK」をクリックすると、選択したパッケージがアップロードされ、それに応じてパッケージリストが更新されます。

パッケージのコンテンツは現在 AEM に存在しますが、コンテンツを使用できるようにするには、必ず パッケージをインストール してください。

パッケージの検証

パッケージは既存のコンテンツを変更する可能性があるので、多くの場合、インストール前にこれらの変更を検証すると便利です。

検証オプション

パッケージマネージャーは次の検証を実行できます。

• OSGi パッケージの読み込み
• オーバーレイ
• ACL

OSGi パッケージの読み込みを検証

チェック内容

この検証では、パッケージ内のすべての JAR ファイル（OSGi バンドル）を調べ、それらの manifest.xml（OSGi バンドルが依存しているバージョン付きの依存関係が含まれているファイル）を抽出し、AEM インスタンスが正しいバージョンで依存関係を書き出すかを確認します。

レポート方法

AEM インスタンスで解決できないバージョン付きの依存関係は、パッケージマネージャーのアクティビティログに記載されます。

エラーの状態

未解決の依存関係がある場合、それらの依存関係を持つパッケージ内の OSGi バンドルは開始しません。開始しない OSGi バンドルに依存しているものはすべて正しく機能しなくなるため、これによりアプリケーションのデプロイメントが破損します。

エラーの解決

依存関係が未解決の OSGi バンドルによるエラーを解決するには、未解決の読み込みがあるバンドルの依存関係バージョンを調整する必要があります。

オーバーレイを検証

チェック内容

この検証では、インストールするパッケージに、宛先の AEM インスタンスにすでにオーバーレイされているファイルが含まれているかどうかを確認します。

例えば、既存のオーバーレイ /apps/sling/servlet/errorhandler/404.jsp があり、既存のファイル /libs/sling/servlet/errorhandler/404.jsp を変更するような /libs/sling/servlet/errorhandler/404.jsp がパッケージに含まれている場合です。

レポート方法

そのようなオーバーレイは、パッケージマネージャーのアクティビティログに記載されます。

エラーの状態

パッケージがすでにオーバーレイされているファイルをデプロイしようとしています。したがって、パッケージ内の変更はオーバーレイによって上書きされ（つまり「非表示」となり）、有効になりません。

エラーの解決

この問題を解決するために、/apps のオーバーレイファイルのメンテナンス者は、/libs のオーバーレイしたファイルへの変更を確認する必要があります。必要に応じて変更をオーバーレイ（/apps）に組み込み、オーバーレイしたファイルを再デプロイします。

ACL を検証

チェック内容

この検証では、どの権限が追加されるか、それらがどのように処理されるか（マージ／置換）、および現在の権限が影響を受けるかどうかを確認します。

レポート方法

権限については、パッケージマネージャーのアクティビティログに記載されます。

エラーの状態

明示的なエラーはありません。この検証は、パッケージをインストールすることで新しい ACL 権限が追加されるか、または影響があるかどうかを示すだけです。

エラーの解決

検証によって提供された情報を使用して、影響を受けたノードを CRXDE で確認したり、必要に応じて ACL をパッケージ内で調整したりできます。

検証の実行

パッケージの検証は 2 とおりの方法で行うことができます。

• パッケージマネージャーの UI から
• cURL などの HTTP POST リクエストを介して

検証は、パッケージをアップロードした後、インストールする前に必ず行う必要があります。

パッケージマネージャーによるパッケージ検証

1. パッケージマネージャーにアクセスします。

2. パッケージリストでパッケージ名をクリックして、パッケージの詳細を開きます。

3. パッケージを検証するには、 その他／検証 をクリックします。

4. 表示されるモーダルダイアログボックスで、チェックボックスを使用して検証の種類を選択し、「検証」をクリックして検証を開始します。

5. 選択した検証が実行され、結果がパッケージマネージャーのアクティビティログに表示されます。

HTTP POST リクエストを介したパッケージ検証

POST リクエストの形式は以下のとおりです。

https://<host>:<port>/crx/packmgr/service.jsp?cmd=validate&type=osgiPackageImports,overlays,acls

type パラメーターは、カンマで区切った順不同リストで、次のもので構成されます。

• osgiPackageImports
• overlays
• acls

明示的に渡されない場合、type のデフォルト値は osgiPackageImports に設定されます。

cURL を使用している場合は、次のようなステートメントを実行してください。

curl -v -X POST --user admin:admin -F file=@/Users/SomeGuy/Desktop/core.wcm.components.all-1.1.0.zip 'http://localhost:4502/crx/packmgr/service.jsp?cmd=validate&type=osgiPackageImports,overlays,acls'

POST リクエストを介して検証する場合、応答は JSON オブジェクトとして返されます。

パッケージカバレッジの表示

パッケージは、フィルターによって定義されます。パッケージマネージャーで既存のリポジトリコンテンツにパッケージのフィルターを適用して、パッケージのフィルター定義でカバーされるリポジトリのコンテンツを表示できます。

1. パッケージマネージャーにアクセスします。

2. パッケージリストでパッケージ名をクリックして、パッケージの詳細を開きます。

3. その他／カバレッジ をクリックします。

4. カバレッジの詳細は、アクティビティログにリストされます。

パッケージのインストール

パッケージをアップロードしても、パッケージのコンテンツがリポジトリに追加されるだけで、アクセスできません。パッケージのコンテンツを使用するには、アップロードしたパッケージをインストールする必要があります。

パッケージをインストールする前に、上書きされるコンテンツを含むスナップショットパッケージがパッケージマネージャーによって自動的に作成されます。 このスナップショットは、パッケージをアンインストールした場合に再インストールされます。

1. パッケージマネージャーにアクセスします。

2. パッケージリストでパッケージ名をクリックして、インストールするパッケージのパッケージ詳細を開きます。

3. 項目の詳細の「インストール」ボタンをクリックするか、パッケージステータスの「インストール」リンクをクリックします。

4. 確認を求めるダイアログが表示され、追加のオプションを指定できます。

   • 抽出のみ - パッケージの抽出のみを行い、スナップショットは作成されずアンインストールはできません
   • しきい値を保存 - 自動保存がトリガーされるまでの一時的なノード数です（同時修正の例外が発生した場合に増加します）
   • サブパッケージを抽出 - サブパッケージの自動抽出を有効にします
   • アクセス制御の処理 - パッケージのインストール時に、パッケージで定義されたアクセス制御情報を処理する方法を指定します（オプションは詳細パッケージ設定と同じです）
   • 依存関係の処理 - インストール中の依存関係の処理方法を指定します

5. 「インストール」をクリックします。

6. インストールの進行状況の詳細は、アクティビティログに記録されます。

インストールが正常に完了すると、パッケージリストが更新され、パッケージのステータスに インストール済み という文字が表示されます。

パッケージの再インストール

パッケージの再インストールでは、すでにインストールされているパッケージに対して、 最初にパッケージをインストールした 時の処理と同じ手順を実行します。

ファイルシステムベースのアップロードおよびインストール

パッケージをインストールする際に、完全にパッケージマネージャーなしで済ませることができます。AEM は、ホストマシンのローカルファイルシステム上の特定の場所に配置されたパッケージを検出し、それらを自動的にアップロードしてインストールできます。

1. AEM インストールフォルダーに、 jar ファイルや license.properties ファイルと並んで crx-quicksart フォルダーがあります。 パス <aem-home>/crx-quickstart/install で生成された crx-quickstart の下に install という名前のフォルダーを作成します。

2. このフォルダーに、パッケージを追加します。 追加したパッケージは、インスタンスに自動的にアップロードおよびインストールされます。

3. アップロードとインストールが完了すると、パッケージマネージャー UI を使用してパッケージをインストールしたかのように、パッケージマネージャーにパッケージが表示されます。

インスタンスを実行している場合、install フォルダーへのパッケージにインスタンスを追加すると、直ちにアップロードとインストールが始まります。

インスタンスを実行していない場合、install フォルダーに配置されたパッケージは、起動時にアルファベット順にインストールされます。

パッケージのアンインストール

パッケージをアンインストールすると、リポジトリの内容は、インストール前にパッケージマネージャーが自動的に作成したスナップショットに戻ります。

1. パッケージマネージャーにアクセスします。

2. パッケージリストでパッケージ名をクリックして、アンインストールするパッケージの詳細を開きます。

3. その他／アンインストール をクリックして、リポジトリからこのパッケージのコンテンツを削除します。

4. 確認を求めるダイアログが表示され、行われているすべての変更が一覧表示されます。

5. パッケージが削除され、スナップショットが適用されます。 プロセスの進行状況は、アクティビティログに表示されます。

パッケージの削除

パッケージを削除すると、パッケージマネージャーからその詳細のみが削除されます。このパッケージが既にインストールされている場合、インストール済みのコンテンツは削除されません。

1. パッケージマネージャーにアクセスします。

2. パッケージリストからパッケージ名をクリックして、削除するパッケージのパッケージ詳細を開きます。

3. パッケージを削除してよいかどうか確認するダイアログが表示されます。「OK」をクリックして削除を確認します。

4. パッケージ情報が削除され、詳細がアクティビティログに報告されます。

パッケージのレプリケーション

パッケージのコンテンツをレプリケートして、パブリッシュインスタンスにインストールします。

1. パッケージマネージャーにアクセスします。

2. パッケージリストからパッケージ名をクリックして、レプリケートするパッケージのパッケージ詳細を開きます。

3. その他／レプリケート をクリックします。

4. パッケージがレプリケートされ、詳細がアクティビティログにレポートされます。

ソフトウェア配布

AEM パッケージを使用すると、コンテンツを作成して AEMaaCS 環境全体で共有できます。

ソフトウェア配布 は、ローカル開発の AEM SDK で使用するための AEM パッケージを提供します。ソフトウェア配布で提供される AEM パッケージは、アドビサポートが明示的に承認しない限り、AEMaaCS クラウド環境にインストールできません。

詳しくは、 ソフトウェア配布ドキュメント を参照してください。