パッケージの使用方法

パッケージによって、リポジトリコンテンツの読み込みと書き出しが可能になります。例えば、パッケージを使用すると、新しい機能のインストール、インスタンス間でのコンテンツの転送、リポジトリコンテンツのバックアップが可能です。

パッケージは、以下のページからアクセスおよび保守できます。

• パッケージマネージャー：ローカルの AEM インスタンスでパッケージを管理する際に使用します。

• ソフトウェア配布：公開パッケージと会社の個人用パッケージの両方を一元的に管理します。 パブリックパッケージには、ホットフィックス、新機能、ドキュメントなどを含めることができます。

パッケージは、Package Manager、ソフトウェア配布、およびファイルシステムの間で転送できます。

What are Packages?

パッケージとは、ファイルシステムシリアル化（「vault」シリアル化）の形式でリポジトリコンテンツが格納されている zip ファイルです。これにより、使いやすく編集しやすい方法でファイルおよびフォルダーを表現できます。

パッケージには、フィルターを使用して選択された、ページコンテンツとプロジェクト関連コンテンツの両方のコンテンツが含まれます。

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

パッケージでは以下のアクションを実行できます。

• 新しいパッケージを作成し、必要に応じてパッケージ設定やフィルターを定義
• パッケージのコンテンツをプレビュー（ビルド前）
• パッケージをビルド
• パッケージ情報を表示
• パッケージのコンテンツを表示（ビルド後）
• 既存のパッケージの定義を変更
• 既存のパッケージを再ビルド
• パッケージを再度含める
• AEM からファイルシステムへパッケージをダウンロード
• ファイルシステムからローカルのAEMインスタンスにパッケージをアップロードする
• インストール前にパッケージの内容を検証
• ドライ作動のインストールを実行する
• パッケージをインストール（AEM はパッケージのアップロード後に自動インストールしません）
• パッケージを削除
• ホットフィックスなどのパッケージをソフトウェア配布ライブラリからダウンロードする
• Software Distribution Libraryの会社内部のセクションにパッケージをアップロードする

パッケージ情報

パッケージの定義は、次のような様々な種類の情報で構成されています。

• パッケージ設定
• パッケージフィルター
• パッケージスクリーンショット
• パッケージアイコン

パッケージ設定

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

パッケージ設定​ダイアログは、パッケージを​作成​または編集中に「編集」ボタンをクリックすると表示され、設定用のタブが 3 つ含まれます。変更をおこなったら、「OK」をクリックして保存します。

フィールド	説明
名前	パッケージの名前。
グループ	パッケージの追加先の、パッケージを整理するためのグループの名前。新しいグループの名前を入力するか、既存のグループを選択します。
バージョン	カスタムバージョンに使用するテキスト。
説明	パッケージの簡単な説明。書式設定に HTML マークアップを使用できます。
サムネール	パッケージリストと共に表示するアイコン。「参照」をクリックしてローカルファイルを選択します。

フィールド	説明	形式/例
名前	プロバイダーの名前。	AEM Geometrixx
URL	プロバイダーの URL。	https://www.aem-geometrixx.com
リンク	プロバイダーページへの、パッケージ専用のリンク。	https://www.aem-geometrixx.com/mypackage.html
次を必要とする	管理者：管理者権限のあるアカウントでのみパッケージがインストール可能な場合に選択します。 再起動：パッケージをインストール後にサーバーを再起動する必要がある場合に選択します。
AC の処理	パッケージ読み込み時の、パッケージで定義されているアクセス制御情報の処理方法を指定します。 無視 上書き 統合 消去 統合して保存 デフォルト値は Ignore です。	無視 - リポジトリ内の ACL を保持 上書き - リポジトリ内の ACL を上書き 統合 - 両方の ACL セットを統合 消去 - ACL を消去 統合して保存 - コンテンツ内に存在しないプリンシパルのアクセス制御エントリを追加し、コンテンツ内のアクセス制御をパッケージが提供するものとマージ

フィールド	説明	形式／例
テスト環境	このパッケージのターゲットまたは互換性のある製品名およびバージョン。	AEM 6
修正された問題	このパッケージで修正されたバグの詳細をリストできるテキストフィールド。バグはそれぞれ別々の行に入力してください。	バグ番号と概要
依存	現在のパッケージを期待どおりに実行するために他のパッケージが必要な場合に配慮する必要のある依存関係情報をリストします。このフィールドはホットフィックスを使用する場合に重要です。	groupId:name:version
置き換え	このパッケージで置き換えられる廃止されたパッケージのリスト。インストール前に、古いパッケージの必要なコンテンツがすべてこのパッケージに含まれていることを確認し、コンテンツが上書きされないようにしてください。	groupId:name:version

パッケージフィルター

Filters identify the repository nodes to include in the package. A Filter Definition specifies the following information:

• 含めるコンテンツの​ルートパス。
• ルートパスの下に 、特定のノードを含めるか除外するルール。

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

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

次の表で、これらのルールについて説明し、例を示します。

ルールタイプ	説明	例
include	パスを定義するか、正規表現を使用して、含めるすべてのノードを指定できます。 ディレクトリを含めると、 そのディレクトリと、そのディレクトリ内のすべてのファイルおよびフォルダー（サブツリー全体）が含まれます。 指定したルートパスの下のその他のファイルやフォルダーは含まれません。	/libs/sling/install(/.*?lang=ja)?
exclude	パスを指定するか、正規表現を使用して、除外するすべてのノードを指定できます。 。 。 ディレクトリを除外すると、そのディレクトリと、そのディレクトリ内のすべてのファイルおよびフォルダー（サブツリー全体）が除外されます。	/libs/wcm/foundation/components(/.*?lang=ja)?

パッケージフィルターは多くの場合、初めてパッケージを作成するときに定義されますが、後から編集することもできます（その後パッケージを再ビルドする必要があります）。

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

パッケージにスクリーンショットを付加すると、コンテンツの外観を視覚的に表現できます。例えば、新機能のスクリーンショットを用意するなどです。

パッケージアイコン

また、パッケージにアイコンを付加すると、パッケージの内容をすぐに参照できるように視覚的に表現できます。これはパッケージリストに表示され、パッケージやパッケージのクラスを簡単に識別できます。

1 つのパッケージに含めることができるアイコンは 1 つなので、公式のパッケージには以下の規則が使用されます。

公式のホットフィックスパッケージ：

公式の AEM インストールまたは拡張パッケージ：

公式の機能パック：

パッケージマネージャー

パッケージマネージャーでは、ローカルの AEM インストール環境でパッケージが管理されます。必要な権限の割り当てをおこなってから、Package Manager を使用してパッケージの設定、構築、ダウンロード、インストールなど様々なアクションを実行できます。設定する主な要素は次のとおりです。

• パッケージ設定
• パッケージフィルター

パッケージマネージャーの使用に必要な権限

パッケージを作成、変更、アップロードおよびインストールする権限をユーザーに付与するには、以下の場所で適切な権限を指定する必要があります。

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

権限の変更手順については、権限の設定を参照してください。

新しいパッケージの作成

新しいパッケージ定義を作成するには：

1. On the AEM Welcome screen, click Packages (or from the Tools console double-click on Packages).

2. 次に「パッケージマネージャー」を選択します。

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

   メモ

   多数のパッケージを含むインスタンスの場合は、フォルダー構造が存在する可能性があるので、必要なターゲットフォルダーに移動してから新しいパッケージを作成できます。

4. 次のダイアログで、以下の操作をおこないます。

   

   以下を入力します。

   • Group Name

     ターゲットグループ（またはフォルダ）の名前。 グループは、パッケージの整理に役立つように意図されています。

     グループにフォルダーが存在しない場合は、フォルダーが作成されます。 グループ名を空白のままにすると、メインのパッケージリスト（ホーム/パッケージ）にパッケージが作成されます。

   • パッケージ名

     新しいパッケージの名前です。 パッケージの内容を簡単に識別できるように、わかりやすい名前を選択します。

   • バージョン

     バージョンを示すためのテキストフィールド。 これはパッケージ名に付加され、zipファイルの名前になります。
     「OK」をクリックしてパッケージを作成します。

5. AEMは、新しいパッケージを適切なグループフォルダーにリストします。

   

   アイコンまたはパッケージ名をクリックして開きます。

   

   メモ

   必要に応じて、後からこのページに戻ることができます。

6. 「編集」をクリックして、パッケージ設定を編集します。

   ここで、情報の追加や一定の設定の定義ができます。これには、説明、アイコン、関連するバグ、プロバイダーの詳細などが含まれます。

   設定の編集が完了したら、「OK」をクリックします。

7. 必要に応じて、スクリーンショット​をパッケージに追加します。パッケージ作成時は、インスタンスは 1 つです。必要に応じて、サイドキックの​パッケージスクリーンショット​を使用して追加します。

   実際の画像を追加するには、「スクリーンショット」領域で画像コンポーネントをダブルクリックし、画像を追加して、「OK」をクリックします。

8. パッケージフィルター​を定義するには、サイドキックから​フィルター定義​のインスタンスをドラッグし、ダブルクリックして編集用に開きます。

   

   以下を指定します。

   • ルートパス
     パッケージ化するコンテンツ。サブツリーのルートを指定できます。

   • Rules Rulesはオプションです。単純なパッケージ定義の場合、「含む」または「除外する」のルールを指定する必要はありません。

     必要に応じて、「 含める 」または「 除外する」のルールを定義し、パッケージの内容を正確に定義できます 。

     ルール追加を「 +」記号で囲むか、ルールを「 - ​​」記号で囲むか、削除します。 ルールは順序に従って適用され、 上へボタンと 下へ ​​ボタンを使用して、必要に応じてルールを配置します。
     「OK」をクリックして、フィルターを保存します。

   メモ

   フィルター定義は必要に応じていくつでも使用できますが、競合しないように注意する必要があります。プレビュー​を使用して、パッケージのコンテンツがどうなるかを確認します。

9. パッケージの内容を確認するには、プレビュー​を使用できます。ビルドプロセスのドライランが実行され、実際のビルド時にパッケージに追加されるものがすべてリストされます。

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

    メモ

    この時点でパッケージをビルドしなければならないわけではありません。後からビルドしても構いません。

Building a Package

パッケージは多くの場合、パッケージ定義の作成と同時にビルドされますが、後から戻ってパッケージをビルドまたは再ビルドできます。これは、リポジトリ内のコンテンツが変更された場合に便利です。

1. パッケージマネージャー​からパッケージ定義を開きます（パッケージのアイコンまたは名前をクリック）。

2. 「ビルド」をクリックします。パッケージをビルドすることを確認するダイアログが表示されます。

   メモ

   これは、パッケージを再ビルドする場合は特に重要です。パッケージのコンテンツが上書きされるからです。

3. 「OK」をクリックします。パッケージが構築されます。パッケージに追加されたすべてのコンテンツがリストされます。パッケージの構築が完了すると、パッケージが構築されたことを示すダイアログが表示されます。また、（このダイアログを閉じると）パッケージリストの内容が更新されます。

パッケージを再度含める

パッケージは、ビルド後に必要に応じて再度含めることができます。

再ラップは、パッケージの内容を変更 せずに 、パッケージ情報を変更します。パッケージ情報は、サムネール、説明などです。つまり、 パッケージ設定 (Package Settings )ダイアログで編集できるものはすべて(このダイアログボックスで「​編集」をクリックします)。

再ラップの主な使用例は、パッケージの準備時です。 例えば、既存のパッケージを持っていて、他のユーザーと共有することを決定したとします。 サムネールを追加し、説明を追加する場合は、 すべての機能を含むパッケージ全体を再作成する代わりに（時間がかかり、パッケージが元のものと同じでなくなる可能性があります）、パッケージを再ラップして、サムネールと説明を追加するだけで済みます。

1. パッケージマネージャー​からパッケージ定義を開きます（パッケージのアイコンまたは名前をクリック）。

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

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

Viewing and Editing Package Information

パッケージ定義に関する情報を表示または編集するには：

1. パッケージマネージャーで、表示するパッケージに移動します。

2. 表示するパッケージのパッケージアイコンをクリックします。パッケージページが開き、パッケージ定義に関する情報が表示されます。

   

   メモ

   このページからも、パッケージに対する編集や一定のアクションを実行できます。

   使用可能なボタンは、パッケージがビルド済みかどうかによって異なります。

3. パッケージがビルド済みの場合は、「コンテンツ」をクリックします。ウィンドウが開き、パッケージのコンテンツ全体が表示されます。

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

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

1. パッケージマネージャーで、表示するパッケージに移動します。

2. 表示するパッケージのパッケージアイコンをクリックします。パッケージページが開き、パッケージ定義に関する情報が表示されます。

3. コンテンツを表示するには、「コンテンツ」をクリックします。ウィンドウが開き、パッケージのコンテンツ全体が表示されます。

   

4. インストールのドライランを実行するには、「インストールをテスト」をクリックします。アクションを確定すると、ウィンドウが開き、インストールが実行されたかのように結果が表示されます。

   

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

ここでは、パッケージマネージャー​を使用して AEM からファイルシステムへパッケージをダウンロードする方法について説明します。

1. On the AEM Welcome screen, click Packages, then select Package Manager.

2. ダウンロードするパッケージに移動します。

   

3. ダウンロードするパッケージの、zip ファイルの名前から形成された（下線付きの）リンク（export-for-offline.zip など）をクリックします。

   AEMは、（標準のブラウザダウンロードダイアログを使用して）パッケージをコンピュータにダウンロードします。

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

パッケージのアップロードでは、ファイルシステムからAEM Package Managerにパッケージをアップロードできます。
パッケージをアップロードするには：

1. パッケージマネージャー​に移動します。次に、パッケージのアップロード先のグループフォルダーに移動します。

   

2. 「パッケージをアップロード」をクリックします。

   

   • File

     You can either type the file name directly, or use the Browse… dialog to select the required package from your local file system (after selection click OK).

   • アップロードを強制

     この名前のパッケージが既に存在する場合は、このボタンをクリックして、強制的にアップロードします（そして既存のパッケージを上書きします）。
     「OK」をクリックすると、新しいパッケージがアップロードされ、パッケージマネージャーのリストに表示されます。

   メモ

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

パッケージの検証

パッケージをインストールする前に、内容を確認することが可能です。Because packages can modify overlaid files under /apps and/or add, modify, and remove ACLs, it is often useful to validate these changes before installing.

検証オプション

検証メカニズムは、次のようなパッケージの特性を確認できます。

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

これらのオプションについて、以下に説明します。

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

  チェック内容

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

  レポート方法

  Any versioned dependencies that cannot be satisfied by the AEM instance are listed in the Activity Log of the Package Manager.

  エラーの状態

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

  エラーの解決

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

• オーバーレイを検証

  チェック内容

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

  For example, given an existing overlay at /apps/sling/servlet/errorhandler/404.jsp, a package that contains /libs/sling/servlet/errorhandler/404.jsp, such that it will change the existing file at /libs/sling/servlet/errorhandler/404.jsp.

  レポート方法

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

  エラーの状態

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

  エラーの解決

  To resolve this issue, the maintainer of the of the overlay file in /apps must review the changes to the overlaid file in /libs and incorporate the changes as needed into the overlay ( /apps), and redeploy the overlaid file.

  メモ

  オーバーレイされたコンテンツがオーバーレイファイルに適切に組み込まれている場合、検証メカニズムで調整を行うことはできません。 したがって、この検証では、必要な変更が加えられた後も競合についてレポートし続けます。

• ACL を検証

  チェック内容

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

  レポート方法

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

  エラーの状態

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

  エラーの解決

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

  注意

  ベストプラクティスとして、予期しない製品の動作を引き起こす可能性があるため、パッケージは AEM 提供の ACL に影響を与えないようにすることをお勧めします。

検証の実行

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

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

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

1. Open the Package Manager at https://<server>:<port>/crx/packmgr

2. Select the package in the list and then select More dropdown from the heading and then Validate from the drop-down menu.

   メモ

   これは、コンテンツパッケージをアップロードした後、パッケージをインストールする前に実行する必要があります。

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

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

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

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

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

以下は、cURL を使用してパッケージ検証を実行する例です。

1. 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'
   

2. 要求された検証が実行され、応答が JSON オブジェクトとして送り返されます。

Installing Packages

パッケージをアップロードしたら、コンテンツをインストールする必要があります。パッケージコンテンツがインストールされ、機能する状態になるには、以下の両方の条件が満たされている必要があります。

• loaded into AEM (either uploaded from your filesystem or downloaded from Software Distribution)

• インストールされていること

1. パッケージマネージャーで、インストールするパッケージに移動します。

   まだインストールされていないパッケージの横に、「インストール」ボタンが表示されます。

   メモ

   また、パッケージのアイコンをクリックしてパッケージを開き、そこで「インストール」ボタンにアクセスすることもできます。

2. 「インストール」をクリックしてインストールを開始します。確認のダイアログが開き、おこなわれているすべての変更が表示されます。完了したら、ダイアログで「閉じる」をクリックします。

   インストールが完了すると、そのパッケージの横に「インストール済み」と表示されます。

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

別の方法でパッケージをインスタンスにアップロードおよびインストールすることもできます。In your file system, you have a crx-quicksart folder alongside with your jar and license.properties file. You need to create a folder named install under crx-quickstart. You will then have something like this: <aem_home>/crx-quickstart/install

この install フォルダーにパッケージを直接追加できます。追加したパッケージは、インスタンスに自動的にアップロードおよびインストールされます。完了すると、パッケージマネージャーにそれらのパッケージが表示されるようになります。

インスタンスが実行中の場合、install フォルダーにパッケージを追加すると、ただちにそのインスタンスに対してアップロードおよびインストールが開始されます。インスタンスが実行中でない場合、install フォルダーに追加したパッケージは起動時にアルファベット順にインストールされます。

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

AEMでは、パッケージをアンインストールできます。 このアクションにより、パッケージのインストール直前に作成されたスナップショットに含まれているリポジトリのコンテンツが元に戻ります。

1. パッケージマネージャーで、アンインストールするパッケージに移動します。
2. アンインストールするパッケージのパッケージアイコンをクリックします。
3. 「アンインストール」をクリックして、このパッケージのコンテンツをリポジトリから削除します。確認のダイアログが開き、おこなわれているすべての変更が表示されます。完了したら、ダイアログで「閉じる」をクリックします。

パッケージの削除

パッケージマネージャーのリストからパッケージを削除するには：

1. In the Tools console, expand the Packages folder to show your package in the right-hand pane.

2. 削除するパッケージをクリックして強調表示し、以下のいずれかの手順を実行します。

   • Click Delete in the toolbar menu.
   • 右クリックして「削除」を選択します。

   

3. パッケージの削除を確認するメッセージが表示されます。 「OK」をクリックして削除を確認します。

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

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

1. パッケージマネージャー​で、レプリケートするパッケージに移動します。

2. レプリケートするパッケージのアイコンまたは名前をクリックして展開します。

3. ツールバーの「詳細」ドロップダウンメニューで、「レプリケーション」を選択します。

パッケージ共有

パッケージ共有は、コンテンツパッケージを共有できるように一元化されたサーバです。

Software Distribution( ソフトウェア配布)に置き換えられました。

ソフトウェア配布

ソフトウェア配布 (Software Distribution)は、AEMパッケージの検索とダウンロードを簡単にするように設計された新しいユーザーインターフェイスです。

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