パッケージマネージャー

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

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

パッケージとは

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

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

メモ

パッケージは、そのパッケージを作成した時点におけるコンテンツの現在のバージョンを表しています。AEM がリポジトリに保持している以前のバージョンのコンテンツは含まれません。

Packages in AEM as a Cloud Service

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

メモ

パッケージには、コンテンツのみを含めることができます。 すべての機能 ( 例: /apps) は Cloud Manager の CI/CD パイプラインを使用してデプロイされます。

重要

パッケージマネージャー UI で 未定義 パッケージのインストールに 10 分以上かかる場合のエラーメッセージ。

これは、インストールのエラーによるものではなく、すべての要求に対してCloud Serviceが持つタイムアウトのためです。

このようなエラーが表示された場合は、インストールを再試行しないでください。 インストールはバックグラウンドで正しく進行しています。 インストールを再起動すると、複数の同時インポートプロセスによって競合が発生する可能性があります。

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

パッケージマネージャー

Package Manager manages the packages on your AEM installation. 🔗

必要な権限

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

  • 削除を除く完全な権限 /etc/packages
  • The node that contains the package contents
注意

パッケージに対する権限を付与すると、機密情報の開示やデータの損失が発生する場合があります。

これらのリスクを制限するには、専用のサブツリーに対してのみ特定のグループ権限を付与することを強くお勧めします。

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

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

  1. AEMのメインメニューから —> ツール -> 導入 -> パッケージ
  2. 送信者 CRXDE Lite 上部のスイッチャーバーの使用
  3. に直接アクセス http://<host>:<port>/crx/packmgr/

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

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

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

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

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

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

拡張されたパッケージの詳細

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

その他のアクションは、 詳細 」ボタンをクリックします。

パッケージステータス

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

パッケージのステータス

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

パッケージ設定

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

一般設定

You can edit a variety of package settings to define information such as the package description, dependencies, and provider details.

この パッケージ設定 ダイアログは、 編集 ボタンを 作成中 または 編集中 パッケージ。 変更が完了したら、「 保存.

パッケージを編集ダイアログ、一般設定

フィールド 説明
名前 The name of the package
グループ パッケージを整理するために、新しいグループの名前を入力するか、既存のグループを選択できます
バージョン Text to use for the version
説明 書式設定用のHTMLマークアップを許可するパッケージの簡単な説明
サムネール パッケージリストと共に表示されるアイコン

パッケージフィルター

を使用してルールを追加する + 」ボタンをクリックします。 次を使用してルールを削除: - 」ボタンをクリックします。

ルールは順序に従って適用され、必要に応じて および 矢印ボタン

Filters can include zero or more rules. When no rules are defined, the package contains all content below the root path.

You can define one or more filter definitions for a package. Use more than one filter to include content from multiple root paths.

「フィルター」タブ

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

Rule Type 説明
include
exclude Excluding a directory will exclude that directory and all files and folders in that directory (i.e. the entire subtree).

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

ヒント

One package can contain multiple filter definitions so that nodes from different locations can easily be combined into one package.

依存関係

「依存関係」タブ

フィールド 説明 例/詳細
Tested with このパッケージのターゲットまたは互換性のある製品名およびバージョン。 AEMaaCS
修正された問題 このパッケージで修正されたバグの詳細をリストするテキストフィールド。1 行に 1 つのバグが表示されます。 -
依存 現在のパッケージがインストール時に期待どおりに実行されるように、必要なその他のパッケージをリストします groupId:name:version
置き換え このパッケージで置き換えられる、廃止されたパッケージのリスト groupId:name:version

詳細設定

「詳細設定」タブ

フィールド 説明 例/詳細
名前 パッケージのプロバイダーの名前 WKND Media Group
URL URL of the provider https://wknd.site
リンク Package-specific link to a provider page https://wknd.site/package/
次を必要とする パッケージのインストール時に制限があるかどうかを定義します 管理者 — パッケージは管理者権限でのみインストールする必要があります​
再起動 - AEMはパッケージのインストール後に再起動する必要があります
AC の処理 Specifies how the access control information defined in the package is handled when the package is imported 無視 — リポジトリ内の ACL を保持​
上書き — リポジトリ内の ACL を上書き​
結合 — 両方の ACL セットをマージする​
MergePreserve — コンテンツ内に存在しないプリンシパルのアクセス制御エントリを追加して、コンテンツ内のアクセス制御をパッケージに付属するエントリと結合します​
クリア - ACL をクリア

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

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

「スクリーンショット」タブ

パッケージアクション

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

Creating a Package

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

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

    ヒント

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

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

    新規パッケージダイアログ

    • パッケージ名 — パッケージのコンテンツを(その他のユーザーが)簡単に識別できるように、説明的な名前を選択します。

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

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

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

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

  6. クリック 編集 を定義するには、 パッケージの内容。

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

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

パッケージのビルド

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

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

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

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

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

パッケージの編集

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

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

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

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

必要に応じて、 パッケージを再構築します。 をクリックして、変更に基づいてコンテンツを更新します。

パッケージを再度含める

Once a package has been built, it can be rewrapped. 再ラップは、パッケージのコンテンツを変更せずに、サムネール、説明などを含まずにパッケージ情報を変更します。

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

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

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

  4. クリック 保存 保存します。

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

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

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

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

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

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

After a package has been built, you can view the contents.

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

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

  3. コンテンツを表示するには、 詳細 -> 内容、およびパッケージマネージャーには、パッケージのコンテンツ全体がアクティビティログにリストされます。

    パッケージコンテンツ

  4. インストールのドライランを実行するには、をクリックします。 詳細 -> インストールをテスト 「パッケージマネージャー」レポートと「 」アクティビティで、インストールが実行された場合と同じように結果がログに記録されます。

    インストールのテスト

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

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

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

  3. 次をクリック: ダウンロード ボタンまたはパッケージのリンクされたファイル名(パッケージの詳細領域内)

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

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

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

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

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

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

    パッケージのアップロードダイアログ

    • パッケージ - 参照… ボタンをクリックして、必要なパッケージをローカルファイルシステムから選択します。
    • アップロードを強制 — この名前のパッケージが既に存在する場合は、このオプションを選択すると、アップロードが強制され、既存のパッケージが上書きされます。
  5. クリック OK 選択したパッケージがアップロードされ、それに応じてパッケージリストが更新されます。

パッケージコンテンツがAEMに存在しますが、コンテンツを使用できるようにするには、必ず パッケージをインストール.

パッケージの検証

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

検証オプション

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

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

AEMaaCS でのコードのデプロイにパッケージを使用できないので、 OSGi パッケージのインポート 検証は不要です。

チェック内容

manifest.xml

レポート方法

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

エラーの状態

未解決の依存関係がある場合、それらの依存関係を持つパッケージ内の OSGi バンドルは開始しません。This results in a broken application deployment as anything relying on the unstarted OSGi bundle will in turn not function properly.

エラーの解決

To resolve errors due to unsatisfied OSGi bundles, the dependency version in the bundle with unsatisfied imports must be adjusted.

オーバーレイを検証
メモ

AEMaaCS でのコードのデプロイにパッケージを使用できないので、 オーバーレイ 検証は不要です。

確認内容

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

/apps/sling/servlet/errorhandler/404.jsp /libs/sling/servlet/errorhandler/404.jsp /libs/sling/servlet/errorhandler/404.jsp

レポートの内容

Any such overlays are described in the Activity Log of Package Manager.

エラー状態

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

エラーの解決

/apps /libs /apps

メモ

The validation mechanism has no way to reconcile if the overlaid content has been properly incorporated into the overlay file. したがって、この検証では、必要な変更が加えられた後も競合についてレポートし続けます。

ACL を検証

確認内容

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

レポートの内容

The permissions are described in the Activity Log of Package Manager.

エラー状態

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

エラーの解決

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

注意

As best practice it is recommended that packages should not affect AEM-provided ACLs as this may result in unexpected behavior.

検証の実行

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

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

Package Validation Via Package Manager
  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

When using cURL, execute a statement similar to the following:

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. 有効範囲の詳細は、アクティビティログにリストされます。

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

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

注意

パッケージをインストールすると、既存のコンテンツが上書きまたは削除される可能性があります。必要なコンテンツが削除または上書きされないと確認できる場合にのみ、パッケージをアップロードしてください。

パッケージをインストールする前に、上書きされるコンテンツを含むスナップショットパッケージがパッケージマネージャーによって自動的に作成されます。 This snapshot will be reinstalled if you uninstall your package.

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

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

  3. 次のいずれかをクリックします。 インストール 項目の詳細または インストール リンクをクリックします。

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

    • 抽出のみ — スナップショットが作成されず、アンインストールができないように、パッケージのみを抽出します
    • サブパッケージを抽出 — サブパッケージの自動抽出を有効にする
    • アクセス制御の処理 — パッケージのインストール時に、パッケージで定義されたアクセス制御情報を処理する方法を指定します ( オプションは 詳細パッケージ設定)
    • 依存関係の処理 — インストール中の依存関係の処理方法を指定します
  5. インストール」をクリックします。

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

インストールが完了し、成功すると、パッケージリストが更新され、「 インストール済み パッケージのステータスに表示されます。

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

パッケージの再インストールは、既にインストール済みのパッケージに対して実行されます。この手順は、 パッケージを初めてインストールします。

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

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

  1. AEMのインストールフォルダーに、 crx-quicksart jar と license.properties ファイル。 という名前のフォルダーを作成します。 install under crx-quickstart 結果としてパスが生成されます <aem-home>/crx-quickstart/install.

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

  3. アップロードとインストールが完了すると、パッケージマネージャーで、パッケージマネージャー UI を使用してインストールした場合と同じようにパッケージを確認できます。

インスタンスが実行中の場合、パッケージに追加すると、アップロードとインストールが直ちに開始されます。 install フォルダー

インスタンスが実行されていない場合、 install フォルダは、起動時にアルファベット順にインストールされます。

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

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

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

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

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

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

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

Deleting Packages

パッケージを削除すると、その詳細のみがパッケージマネージャーから削除されます。 If this package was already installed, then the installed content will not be deleted.

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

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

  3. AEM asks for confirmation that you want to delete the package. 「OK」をクリックして削除を確認します。

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

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

Replicate the contents of a package to install it on the publish instance.

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

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

  3. クリック 詳細 -> 複製.

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

Software Distribution

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

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

詳しくは、 ソフトウェア配布ドキュメント.

このページ