Pakethanteraren

Med paket kan du importera och exportera databasinnehåll. Du kan använda paket för att installera nytt innehåll, överföra innehåll mellan instanser och säkerhetskopiera databasinnehåll.

Med Package Manager kan du överföra paket mellan AEM och det lokala filsystemet i utvecklingssyfte.

Vad är paket?

Ett paket är en ZIP-fil som innehåller databasinnehåll i ett filsystemsserialiseringsformat, som kallas vaultserialisering, och som ger en lättanvänd och lättredigerad representation av filer och mappar. Innehåll som ingår i paketet definieras med hjälp av filter.

Ett paket innehåller även vaultmetainformation, inklusive filterdefinitioner och importkonfigurationsinformation. Ytterligare innehållsegenskaper, som inte används för paketextrahering, kan inkluderas i paketet, till exempel en beskrivning, en visuell bild eller en ikon. Dessa extra innehållsegenskaper är endast avsedda för innehållspaketkonsumenten och för informationsändamål.

OBSERVERA

Paket representerar den aktuella versionen av innehållet när paketet skapas. De innehåller inga tidigare versioner av det innehåll som AEM sparar i databasen.

Paket i AEM as a Cloud Service

Innehållspaket som skapas för AEM as a Cloud Service program måste ha en ren separation mellan oföränderligt och ändringsbart innehåll. Pakethanteraren kan därför bara användas för att hantera paket som innehåller innehåll. All kod måste distribueras via Cloud Manager.

OBSERVERA

Paket kan bara innehålla innehåll. Alla funktioner (t.ex. innehåll som lagras under /apps) måste vara distribueras med hjälp av CI/CD-pipeline i Cloud Manager.

VIKTIGT

Pakethanterarens gränssnitt kan returnera en undefined felmeddelande om ett paket tar längre tid än 10 minuter att installera.

Detta beror inte på ett fel i installationen, utan på en timeout som Cloud Servicen har för alla begäranden.

Försök inte installera igen om du ser ett sådant fel. Installationen fortsätter korrekt i bakgrunden. Om du startar om installationen kan vissa konflikter uppstå vid flera samtidiga importprocesser.

Mer information om hur du hanterar paket för AEMaaCS finns i dokumentet Distribuera till AEM as a Cloud Service i användarhandboken för distribution.

Pakethanteraren

Pakethanteraren hanterar paketen i AEM. Efter att du har har tilldelats nödvändiga behörigheter du kan använda Package Manager för olika åtgärder, som att konfigurera, bygga, hämta och installera dina paket.

Nödvändiga behörigheter

För att kunna skapa, ändra, överföra och installera paket måste användarna ha rätt behörighet på följande noder:

  • Fullständig behörighet exklusive radering /etc/packages
  • Noden som innehåller paketinnehållet
FÖRSIKTIGHET

Om du beviljar behörigheter för paket kan det leda till att känslig information röjs och att data går förlorade.

För att begränsa de här riskerna rekommenderar vi att du endast ger särskilda gruppbehörigheter för dedikerade underträd.

Åtkomst till Package Manager

Du kommer åt Package Manager på tre sätt:

  1. Från AEM huvudmeny -> verktyg -> Distribution -> Paket
  2. Från CRXDE Lite med hjälp av det övre växlingsfältet
  3. Direkt via åtkomst http://<host>:<port>/crx/packmgr/

Pakethanterarens användargränssnitt

Pakethanteraren är uppdelad i fyra huvudsakliga funktionsområden:

  • Vänster navigeringspanel - Med den här panelen kan du filtrera och sortera paketlistan.
  • Paketlista - Det här är listan med paket i din instans som filtrerats och sorterats efter val i den vänstra navigeringspanelen.
  • Aktivitetslogg - Den här panelen minimeras först och utökas för att beskriva aktiviteten i Package Manager, till exempel när ett paket skapas eller installeras. Det finns ytterligare knappar på fliken Aktivitetslogg för att:
    • Rensa logg
    • Visa/dölj
  • Verktygsfält - Verktygsfältet innehåller uppdateringsknappar för den vänstra navigeringspanelen och paketlistan samt knappar för sökning, skapande och överföring av paket.

Pakethanterarens användargränssnitt

Om du klickar på ett alternativ i den vänstra navigeringspanelen filtreras paketlistan omedelbart.

När du klickar på ett paketnamn expanderas posten i paketlistan så att du får mer information om paketet.

Utökad paketinformation

Det finns ett antal åtgärder som kan utföras på ett paket via de verktygsfältsknappar som är tillgängliga när paketdetaljen expanderas.

Ytterligare åtgärder finns under Mer -knappen.

Paketstatus

Varje post i paketlistan har en statusindikator som gör att du snabbt kan se paketets status. När du hovrar över statusen visas verktygstipset med statusinformation.

Paketstatus

Om paketet har ändrats eller aldrig byggts visas statusen som en länk för att vidta snabba åtgärder för att återskapa eller installera paketet.

Paketinställningar

Ett paket är i princip en uppsättning filter och databasdata som baseras på dessa filter. Med hjälp av gränssnittet för pakethanteraren kan du klicka på ett paket och sedan på Redigera om du vill visa information om ett paket med följande inställningar.

Allmänna inställningar

Du kan redigera olika paketinställningar för att definiera information som paketbeskrivning, beroenden och providerinformation.

The Paketinställningar är tillgänglig via Redigera knapp när skapa eller redigera ett paket. Klicka på Spara.

Dialogrutan Redigera paket, allmänna inställningar

Fält Beskrivning
Namn Paketets namn
Grupp När du organiserar paket kan du ange namnet på en ny grupp eller välja en befintlig grupp
Version Text som ska användas för versionen
Beskrivning En kort beskrivning av paketet som tillåter formatering med HTML-kod
Miniatyrbild Ikonen som visas med paketlistan

Paketfilter

Filter identifierar databasnoderna som ska inkluderas i paketet. A Filterdefinition anger följande information:

  • The Rotsökväg av innehållet som ska inkluderas
  • Regler som innehåller eller exkluderar specifika noder under rotsökvägen

Lägg till regler med + -knappen. Ta bort regler med - -knappen.

Reglerna tillämpas i den ordning de har, så att de kan placeras efter behov med Upp och Ned pilknappar.

Filter kan innehålla noll eller flera regler. När inga regler har definierats innehåller paketet allt innehåll under rotsökvägen.

Du kan definiera en eller flera filterdefinitioner för ett paket. Använd mer än ett filter för att inkludera innehåll från flera rotsökvägar.

Fliken Filter

När du skapar filter kan du definiera en bana eller använda ett reguljärt uttryck för att ange alla noder som du vill ta med eller utesluta.

Regeltyp Beskrivning
include Om du tar med en katalog inkluderas den katalogen och alla filer och mappar i den katalogen (dvs. hela underträdet), men inte ta med andra filer eller mappar från den angivna rotsökvägen.
exclude Om du exkluderar en katalog exkluderas den katalogen och alla filer och mappar i den katalogen (dvs. hela underträdet).

Paketfilter definieras oftast först skapa paketet. De kan emellertid också redigeras senare, och därefter bör paketet byggas om för att uppdatera innehållet baserat på de nya filterdefinitionerna.

TIPS

Ett paket kan innehålla flera filterdefinitioner så att noder från olika platser enkelt kan kombineras till ett paket.

Beroenden

Fliken Beroenden

Fält Beskrivning Exempel/detaljer
Testat med Det produktnamn och den version som det här paketet har eller är kompatibelt med. AEMaaCS
Åtgärdade problem Ett textfält som innehåller information om fel som har åtgärdats med det här paketet, en bugg per rad -
Beroende på Visar andra paket som är nödvändiga så att det aktuella paketet körs som förväntat vid installationen groupId:name:version
Ersätter En lista över borttagna paket som det här paketet ersätter groupId:name:version

Avancerade inställningar

Fliken Avancerade inställningar

Fält Beskrivning Exempel/detaljer
Namn Namnet på paketets leverantör WKND Media Group
Webbadress URL för providern https://wknd.site
Länk Paketspecifik länk till en providersida https://wknd.site/package/
Kräver Definierar om det finns några begränsningar när paketet installeras Administratör - Paketet får bara installeras med administratörsbehörighet
Starta om - AEM måste startas om efter att paketet har installerats
AC-hantering Anger hur åtkomstkontrollsinformationen som definieras i paketet hanteras när paketet importeras Ignorera - Bevara åtkomstkontrollistor i databasen
Skriv över - Skriv över åtkomstkontrollistor i databasen
Sammanfoga - Sammanfoga båda uppsättningar åtkomstkontrollistor
MergePreserve - Lägg samman åtkomstkontrollen i innehållet med den som ingår i paketet genom att lägga till åtkomstkontrollposter för objekt som inte finns i innehållet
Rensa - Rensa åtkomstkontrollistor

Paketskärmbilder

Du kan bifoga flera skärmbilder till ditt paket för att få en visuell representation av hur innehållet ser ut.

Fliken Skärmbilder

Paketåtgärder

Det finns många åtgärder som kan utföras på ett paket.

Skapa ett paket

  1. Access Package Manager.

  2. Klicka Skapa paket.

    TIPS

    Om din instans har många paket kan det finnas en mappstruktur på plats. I sådana fall är det enklare att navigera till den önskade målmappen innan du skapar det nya paketet.

  3. I Nytt paket anger du följande fält:

    Dialogrutan Nytt paket

    • Paketnamn - Välj ett beskrivande namn som hjälper dig (och andra) att enkelt identifiera innehållet i paketet.

    • Version - Det här är ett textfält där du kan ange en version. Detta läggs till paketnamnet för att bilda zip-filens namn.

    • Grupp - Det här är målgruppens (eller mappens) namn. Med grupper kan du ordna dina paket. En mapp skapas för gruppen om den inte redan finns. Om du lämnar gruppnamnet tomt skapas paketet i huvudpaketlistan.

  4. Klicka OK för att skapa paketet.

  5. AEM listar det nya paketet högst upp i paketlistan.

    Nytt paket

  6. Klicka Redigera för att definiera paketinnehåll. Klicka Spara när du är klar med redigeringen av inställningarna.

  7. Nu kan du Bygge ditt paket.

Det är inte obligatoriskt att omedelbart skapa paketet efter att det har skapats. Ett obyggt paket innehåller inget innehåll och består endast av filterdata och andra metadata för paketet.

Bygga ett paket

Ett paket skapas ofta samtidigt som du skapa paketet, men du kan gå tillbaka vid ett senare tillfälle för att antingen skapa eller återskapa paketet. Detta kan vara användbart om innehållet i databasen har ändrats eller om paketfiltren har ändrats.

  1. Access Package Manager.

  2. Öppna paketinformationen från paketlistan genom att klicka på paketnamnet.

  3. Klicka Bygge. En dialogruta där du uppmanas bekräfta att du vill skapa paketet eftersom allt befintligt paketinnehåll skrivs över.

  4. Klicka OK. AEM skapar paketet och visar allt innehåll som lagts till i paketet på samma sätt som i aktivitetslistan. När AEM är klar visas en bekräftelse på att paketet har skapats och (när du stänger dialogrutan) information om paketlistan uppdateras.

Redigera ett paket

När ett paket har överförts till AEM kan du ändra dess inställningar.

  1. Access Package Manager.

  2. Öppna paketinformationen från paketlistan genom att klicka på paketnamnet.

  3. Klicka Redigera och uppdatera Paketinställningar efter behov.

  4. Klicka Spara att spara.

Du kan behöva återskapa paketet för att uppdatera innehållet baserat på de ändringar du har gjort.

Rewrapping a Package

När ett paket har byggts kan det paketeras om. När du gör om en förpackning ändras paketinformationen utan att t.ex. en miniatyrbild, beskrivning osv. ändras, utan att paketinnehållet ändras.

  1. Access Package Manager.

  2. Öppna paketinformationen från paketlistan genom att klicka på paketnamnet.

  3. Klicka Redigera och uppdatera Paketinställningar efter behov.

  4. Klicka Spara att spara.

  5. Klicka Mer -> Radbryt och en dialogruta med en fråga om bekräftelse.

Visa andra paketversioner

Eftersom alla versioner av ett paket visas i listan som alla andra paket, kan pakethanteraren hitta andra versioner av ett valt paket.

  1. Access Package Manager.

  2. Öppna paketinformationen från paketlistan genom att klicka på paketnamnet.

  3. Klicka Mer -> Andra versioner och en dialogruta öppnas med en lista över andra versioner av samma paket med statusinformation.

Innehåll och testinstallation för visning av paket

När du har skapat ett paket kan du visa innehållet.

  1. Access Package Manager.

  2. Öppna paketinformationen från paketlistan genom att klicka på paketnamnet.

  3. Om du vill visa innehållet klickar du på Mer -> Innehåll och Package Manager visar hela innehållet i paketet i aktivitetsloggen.

    Paketet innehåller

  4. Om du vill göra en torr installation klickar du Mer -> Testa installationen och Package Manager rapporterar i aktivitetsloggen resultatet som om installationen utfördes.

    Testinstallation

Hämtar paket till filsystemet

  1. Access Package Manager.

  2. Öppna paketinformationen från paketlistan genom att klicka på paketnamnet.

  3. Klicka på Hämta eller paketets länkade filnamn i paketinformationsområdet.

  4. AEM hämtar paketet till datorn.

Överför paket från filsystemet

  1. Access Package Manager.

  2. Välj den gruppmapp som du vill att paketet ska överföras till.

  3. Klicka på Överför paket -knappen.

  4. Ange nödvändig information om det överförda paketet.

    Dialogrutan Paketöverföring

    • Paket - Använd Bläddra… för att välja det paket som krävs från det lokala filsystemet.
    • Tvinga överföring - Om det redan finns ett paket med det här namnet framtvingar det här alternativet överföringen och skriver över det befintliga paketet.
  5. Klicka OK och det valda paketet överförs och paketlistan uppdateras därefter.

Paketinnehållet finns nu på AEM, men för att göra innehållet tillgängligt för användning måste du installera paketet.

Verifierar paket

Eftersom paket kan ändra befintligt innehåll är det ofta användbart att validera dessa ändringar innan du installerar.

Valideringsalternativ

Pakethanteraren kan utföra följande valideringar:

Validera OSGi-paketimporter
OBSERVERA

Eftersom paket inte kan användas för att distribuera kod i AEMaaCS, OSGi-paketimporter validering behövs inte.

Vad är markerat

Den här valideringen undersöker paketet för alla JAR-filer (OSGi-paket) och extraherar deras manifest.xml (som innehåller de versionshanteringsberoenden som OSGi-paketet är beroende av) och verifierar den AEM instansens export av dessa beroenden med rätt versioner.

Hur det rapporteras

Alla versionshanteringsberoenden som inte kan uppfyllas av den AEM instansen visas i aktivitetsloggen för Package Manager.

Fellägen

Om beroenden inte uppfylls startar inte OSGi-paketen med dessa beroenden. Detta resulterar i en trasig programdistribution eftersom allt som förlitar sig på det ostartade OSGi-paketet i sin tur inte fungerar som det ska.

Felupplösning

För att åtgärda fel på grund av att OSGi-paket inte är nöjda måste beroendeversionen i paketet med otillfredsställande importer justeras.

Validera övertäckningar
OBSERVERA

Eftersom paket inte kan användas för att distribuera kod i AEMaaCS, Övertäckningar validering behövs inte.

Vad är markerat

Valideringen avgör om det paket som installeras innehåller en fil som redan finns i AEM.

Med en befintlig övertäckning vid /apps/sling/servlet/errorhandler/404.jsp, ett paket som innehåller /libs/sling/servlet/errorhandler/404.jspså att den befintliga filen ändras på /libs/sling/servlet/errorhandler/404.jsp.

Hur det rapporteras

Alla sådana övertäckningar beskrivs i aktivitetsloggen för Package Manager.

Fellägen

Ett feltillstånd innebär att paketet försöker distribuera en fil som redan är överlagrad, vilket innebär att ändringarna i paketet åsidosätts (och därmed"döljs") av övertäckningen och inte börjar gälla.

Felupplösning

För att lösa det här problemet måste du ha kvar övertäckningsfilen i /apps måste granska ändringarna i den överlagrade filen i /libs och lägg in de ändringar som behövs i övertäckningen ( /apps) och distribuera om den överlagrade filen.

OBSERVERA

Valideringsfunktionen kan inte stämma av om det överlagda innehållet har integrerats korrekt i överläggsfilen. Valideringen fortsätter därför att rapportera om konflikter även efter att nödvändiga ändringar har gjorts.

Validera åtkomstkontrollistor

Vad är markerat

Valideringen kontrollerar vilka behörigheter som läggs till, hur de hanteras (sammanfoga/ersätt) och om de aktuella behörigheterna påverkas.

Hur det rapporteras

Behörigheterna beskrivs i aktivitetsloggen för Package Manager.

Fellägen

Inga explicita fel kan anges. Valideringen anger bara om nya ACL-behörigheter kommer att läggas till eller påverkas av att paketet installeras.

Felupplösning

Med hjälp av den information som valideringen ger kan de påverkade noderna granskas i CRXDE och åtkomstkontrollistorna kan justeras i paketet efter behov.

FÖRSIKTIGHET

Som god praxis rekommenderas att paket inte påverkar AEM-tillhandahållna åtkomstkontrollistor eftersom detta kan leda till oväntat beteende.

Utför validering

Paketvalidering kan göras på två olika sätt:

Validering ska alltid ske efter att paketet har överförts, men innan det installeras.

Paketvalidering via Pakethanteraren
  1. Access Package Manager.

  2. Öppna paketinformationen från paketlistan genom att klicka på paketnamnet.

  3. Validera paketet genom att klicka på Mer -> Validera,

  4. I den modala dialogrutan som visas använder du kryssrutorna för att välja valideringstyp(er) och börja valideringen genom att klicka Validera.

  5. De valda valideringarna körs sedan och resultaten visas i aktivitetsloggen för Package Manager.

Paketvalidering via HTTP-POST-begäran

Begäran om POST har följande format.

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

The type kan vara vilken kommaavgränsad, osorterad lista som helst som består av:

  • osgiPackageImports
  • overlays
  • acls

Värdet för type standardvärdet är osgiPackageImports om det inte uttryckligen skickas.

När du använder cURL kör du en programsats som liknar följande:

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'

Vid validering via POST skickas svaret tillbaka som ett JSON-objekt.

Täckning för visningspaket

Paket definieras av sina filter. Du kan låta Pakethanteraren tillämpa filter från ett paket på det befintliga databasinnehållet för att visa vilket innehåll i databasen som omfattas av paketets filterdefinition.

  1. Access Package Manager.

  2. Öppna paketinformationen från paketlistan genom att klicka på paketnamnet.

  3. Klicka Mer -> Täckning.

  4. Täckningsinformationen visas i aktivitetsloggen.

Installerar paket

När du överför ett paket läggs bara paketinnehållet till i databasen, men det är inte tillgängligt. Du måste installera det överförda paketet för att kunna använda paketets innehåll.

FÖRSIKTIGHET

Om du installerar ett paket kan befintligt innehåll skrivas över eller tas bort. Överför bara ett paket om du är säker på att det inte tar bort eller skriver över innehåll som du behöver.

Innan du installerar paketet skapas ett ögonblicksbildspaket som innehåller det innehåll som ska skrivas över automatiskt av Package Manager. Den här ögonblicksbilden installeras om du avinstallerar paketet.

  1. Access Package Manager.

  2. Öppna paketinformationen för det paket som du vill installera från paketlistan genom att klicka på paketnamnet.

  3. Klicka på Installera knappen i artikelinformationen eller Installera i paketets status.

  4. En dialogruta begär bekräftelse och tillåter att ytterligare alternativ anges.

    • Endast extrahera - Extrahera endast paketet så att ingen ögonblicksbild skapas och därför inte kan avinstalleras
    • Spara tröskelvärde - Antal tillfälliga noder tills automatiskt sparande aktiveras (öka om du stöter på undantag för samtidig redigering)
    • Extrahera delpaket - Aktivera automatisk extrahering av delpaket
    • Hantering av åtkomstkontroll - Anger hur åtkomstkontrollsinformationen som definieras i paketet hanteras när paketet installeras (alternativen är desamma som avancerade paketinställningar)
    • Beroendehantering - Ange hur beroenden hanteras under installationen
  5. Klicka Installera.

  6. Aktivitetsloggen visar installationsförloppet.

När installationen är klar och slutförd uppdateras paketlistan och ordet Installerad visas i paketstatusen.

Paket installeras om

När du installerar om paket utförs samma steg på ett redan installerat paket som bearbetas när installerar paketet.

Filsystembaserad överföring och installation

Du kan helt och hållet avstå från Package Manager när du installerar paket. AEM kan identifiera paket som placerats på en viss plats i värddatorns lokala filsystem och överföra och installera dem automatiskt.

  1. Under AEM installationsmapp finns en crx-quicksart och license.properties -fil. Skapa en mapp med namnet install under crx-quickstart vilket resulterar i banan <aem-home>/crx-quickstart/install.

  2. Lägg till dina paket i den här mappen. De laddas automatiskt upp och installeras på din instans.

  3. När överföringen och installationen är klar kan du se paketen i Package Manager som om du hade använt gränssnittet i Package Manager för att installera dem.

Om instansen körs börjar överföringen och installationen omedelbart när du lägger till den i paketet på install mapp

Om instansen inte körs placeras paket i install -mappen installeras vid start i alfabetisk ordning.

Avinstallerar paket

När du avinstallerar paketet återställs innehållet i databasen till ögonblicksbilden som gjorts automatiskt av Package Manager före installationen.

  1. Access Package Manager.

  2. Öppna paketinformationen för det paket som du vill avinstallera från paketlistan genom att klicka på paketnamnet.

  3. Klicka Mer -> Avinstallera, för att ta bort innehållet i det här paketet från databasen.

  4. En dialogruta begär bekräftelse och visar alla ändringar som görs.

  5. Paketet tas bort och ögonblicksbilden tillämpas. Processens förlopp visas i aktivitetsloggen.

Tar bort paket

Om du tar bort ett paket tas endast dess information bort från Pakethanteraren. Om det här paketet redan har installerats tas det installerade innehållet inte bort.

  1. Access Package Manager.

  2. Öppna paketinformationen för det paket som du vill ta bort från paketlistan genom att klicka på paketnamnet.

  3. AEM ber om en bekräftelse på att du vill ta bort paketet. Klicka OK för att bekräfta borttagningen.

  4. Paketinformationen tas bort och information rapporteras i aktivitetsloggen.

Replikerar paket

Replikera innehållet i ett paket för att installera det på publiceringsinstansen.

  1. Access Package Manager.

  2. Öppna paketinformationen för det paket som du vill replikera från paketlistan genom att klicka på paketnamnet.

  3. Klicka Mer -> Replikera.

  4. Paketet replikeras och information rapporteras i aktivitetsloggen.

Programvarudistribution

AEM kan användas för att skapa och dela innehåll i AEMaaCS-miljöer.

Programvarudistribution innehåller AEM paket som kan användas på den lokala utvecklingen AEM SDK. AEM som tillhandahålls vid programvarudistribution får inte installeras i AEMaaCS-molnmiljöer om inte Adobe Support uttryckligen har godkänt detta.

Mer information finns i Dokumentation om programdistribution.

På denna sida