Så här arbetar du med paket how-to-work-with-packages
Med paket kan du importera och exportera databasinnehåll. Du kan till exempel använda paket för att installera nya funktioner, överföra innehåll mellan instanser och säkerhetskopiera databasinnehåll.
Paket kan öppnas och/eller underhållas från följande sidor:
-
Pakethanterarensom du använder för att hantera paketen i den lokala AEM instansen.
-
Paketresurs, en centraliserad server som innehåller både offentligt tillgängliga paket och sådana som är privata för ditt företag. De publika paketen kan innehålla snabbkorrigeringar, nya funktioner, dokumentation m.m.
Du kan överföra paket mellan Package Manager, Package Share och ditt filsystem.
Vad är paket? what-are-packages
Ett paket är en zip-fil som innehåller databasinnehåll i form av en filsystemserialisering (kallas vault-serialisering). Detta ger en lättanvänd och redigerbar representation av filer och mappar.
Paket innehåller innehåll, både sidinnehåll och projektrelaterat innehåll, som väljs med 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 egenskaper är avsedda för innehållspaketkonsumenten och endast för informationsändamål.
Du kan utföra följande åtgärder på eller med paket:
- Skapa nya paket; definiera paketinställningar och filter efter behov
- Förhandsgranska paketinnehåll (före bygge)
- Skapa paket
- Visa paketinformation
- Visa paketinnehåll (efter bygget)
- Ändra definitionen för befintliga paket
- Återskapa befintliga paket
- Radbryt paket
- Hämta paket från AEM till filsystemet
- Överför paket från filsystemet till den lokala AEM
- Validera paketinnehåll före installation
- Utför en torr installation
- Installera paket (AEM installerar inte paket automatiskt efter överföring)
- Ta bort paket
- Hämta paket, till exempel snabbkorrigeringar, från paketdelningsbiblioteket
- Överför paket till den företagsinterna sektionen i biblioteket Paketresurs
Paketinformation package-information
En paketdefinition består av olika typer av information:
Paketinställningar package-settings
Du kan redigera olika paketinställningar för att definiera aspekter som paketbeskrivning, relaterade fel, beroenden och providerinformation.
The Paketinställningar är tillgänglig via Redigera knapp när skapa eller redigera ett paket och innehåller tre flikar för konfiguration. När du har gjort ändringarna klickar du OK för att spara dessa.
Paketfilter package-filters
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.
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.
Följande tabell beskriver dessa regler och innehåller exempel:
Paketfilter definieras oftast först skapa paketet, men de kan redigeras vid ett senare tillfälle (efter vilket paketet ska återskapas).
Paketskärmbilder package-screenshots
Du kan bifoga skärmbilder till ditt paket för att få en visuell representation av hur innehållet ser ut; genom att t.ex. tillhandahålla skärmbilder av nya funktioner.
Paketikoner package-icons
Du kan även bifoga en ikon till paketet för att få en snabb visuell representation av vad paketet innehåller. Detta visas sedan i paketlistan och kan hjälpa dig att enkelt identifiera paketet eller paketklassen.
Eftersom ett paket kan innehålla en ikon används följande konventioner för officiella paket:
Officiellt snabbkorrigeringspaket:
AEM eller tilläggspaket:
Officiella funktionspaket:
Pakethanteraren package-manager
Pakethanteraren hanterar paketen i din lokala AEM. Efter att du har har tilldelats nödvändiga behörigheter du kan använda pakethanteraren för olika åtgärder, bland annat för att konfigurera, bygga, hämta och installera dina paket. Nyckelelementen som ska konfigureras är:
Behörigheter som krävs för att använda Pakethanteraren permissions-needed-for-using-the-package-manager
Om du vill ge användarna rätt att skapa, ändra, överföra och installera paket måste du ge dem rätt behörighet på följande platser:
- /etc/paket (fullständiga rättigheter exklusive radering)
- noden som innehåller paketets innehåll
Se Ange behörigheter för instruktioner om hur du ändrar behörigheter.
Skapa ett nytt paket creating-a-new-package
Så här skapar du en ny paketdefinition:
-
På AEM välkomstskärm klickar du på Paket (eller från verktyg dubbelklicka på konsolen Paket).
-
Välj sedan Pakethanteraren.
-
Klicka Skapa paket.
note note NOTE Om din instans har många paket kan det finnas en mappstruktur på plats, så du kan navigera till den önskade målmappen innan du skapar det nya paketet. -
I dialogrutan:
Ange följande:
-
Gruppnamn
Målgruppens (eller mappens) namn. Grupper är avsedda att användas för att hjälpa dig att ordna dina paket.
En mapp skapas för gruppen om den inte redan finns. Om du lämnar gruppnamnet tomt skapas paketet i huvudpaketlistan (Hem > Paket).
-
Paketnamn
Namnet på det nya paketet. Välj ett beskrivande namn som hjälper dig (och andra) att enkelt identifiera innehållet i paketet.
-
Version
Ett textfält där du kan ange en version. Detta läggs till paketnamnet för att bilda zip-filens namn.
Klicka OK för att skapa paketet.
-
-
AEM listar det nya paketet i lämplig gruppmapp.
Klicka på ikonen eller paketnamnet som du vill öppna.
note note NOTE Du kan vid behov gå tillbaka till den här sidan senare. -
Klicka Redigera för att redigera paketinställningar.
Här kan du lägga till information och/eller definiera vissa inställningar. dessa innehåller till exempel en beskrivning, icon, relaterade buggar och lägg till providerinformation.
Klicka OK när du är klar med redigeringen av inställningarna.
-
Lägg till Skärmbilder till paketet efter behov. En instans är tillgänglig när paketet skapas. Lägg till fler om det behövs genom att använda Package Screenshot från sidosparken.
Lägg till den faktiska bilden genom att dubbelklicka på bildkomponenten i Skärmbilder område, lägga till en bild och klicka OK.
-
Definiera Paketfilter genom att dra instanser av Filterdefinition från sidosparken och dubbelklicka sedan för att öppna för redigering:
Ange:
-
Rotsökväg
Det innehåll som ska förpackas. kan vara roten i ett underträd. -
Regler
Reglerna är frivilliga. för enkla paketdefinitioner är det inte nödvändigt att ange inkluderings- eller exkluderingsregler.Om det behövs kan du definiera antingen Inkludera eller Exkludera regler för att exakt definiera paketets innehåll.
Lägg till regler med + symbol, ta bort regler med - symbol. Reglerna tillämpas i den ordning de har, så att de kan placeras efter behov med Upp och Ned knappar.
Klicka sedan på OK för att spara filtret.
note note NOTE Du kan använda så många filterdefinitioner du behöver, men du måste se till att de inte hamnar i konflikt. Använd Förhandsgranska för att bekräfta vad innehållet i förpackningen ska vara. -
-
För att bekräfta vad paketet innehåller kan du använda Förhandsgranska. Detta utför en torr körning av byggprocessen och visar allt som kommer att läggas till i paketet när det byggs.
-
Nu kan du Bygge ditt paket.
note note NOTE Det är inte obligatoriskt att bygga paketet just nu, det kan göras vid en senare tidpunkt.
Bygga ett paket building-a-package
Ett paket skapas ofta samtidigt som du skapa paketdefinitionen, 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.
-
Öppna paketdefinitionen från Pakethanteraren (klicka på paketikonen eller -namnet).
-
Klicka Bygge. En dialogruta där du uppmanas bekräfta att du vill skapa paketet.
note note NOTE Detta är särskilt viktigt när du återskapar ett paket eftersom paketinnehållet skrivs över. -
Klicka OK. AEM skapar paketet med allt innehåll som läggs till i paketet. 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.
Rewrapping a Package rewrapping-a-package
När ett paket har byggts kan det vid behov rewrappas.
När du packar om ändras paketinformationen - utan ändra paketinnehållet. Paketinformationen är miniatyrbilden, beskrivningen osv., med andra ord allt du kan redigera med Paketinställningar dialogruta (för att öppna den här klickningen Redigera).
Ett viktigt användningsområde för ombrytning är när du förbereder ett paket för paketresursen. Du kan till exempel ha ett befintligt paket och bestämma dig för att dela det med andra. För det vill du lägga till en miniatyrbild och lägga till en beskrivning. I stället för att återskapa hela paketet med alla dess funktioner (vilket kan ta en stund och innebär att paketet inte längre är identiskt med originalpaketet) kan du kapsla in det och bara lägga till miniatyrbilden och beskrivningen.
-
Öppna paketdefinitionen från Pakethanteraren (klicka på paketikonen eller -namnet).
-
Klicka Redigera och uppdatera Paketinställningar efter behov. Klicka OK att spara.
-
Klicka Radbryt visas en dialogruta där du uppmanas bekräfta åtgärden.
Visa och redigera paketinformation viewing-and-editing-package-information
Så här visar eller redigerar du information om en paketdefinition:
-
Gå till det paket du vill visa i Pakethanteraren.
-
Klicka på paketikonen för det paket som du vill visa. Paketsidan med information om paketdefinitionen öppnas:
note note NOTE Du kan även redigera och utföra vissa åtgärder på paketet från den här sidan. Vilka knappar som är tillgängliga beror på om paketet redan har skapats eller inte. -
Om paketet redan har byggts klickar du Innehåll öppnas ett fönster där allt innehåll i paketet visas:
Innehåll och testinstallation för visning av paket viewing-package-contents-and-testing-installation
När ett paket har skapats kan du visa innehållet:
-
Gå till det paket du vill visa i Pakethanteraren.
-
Klicka på paketikonen för det paket som du vill visa. Detta öppnar paketsidan med information om paketdefinitionen.
-
Om du vill visa innehållet klickar du Innehåll öppnas ett fönster där allt innehåll i paketet visas:
-
Om du vill göra en torr installation klickar du Testinstallation. När du har bekräftat åtgärden öppnas ett fönster där resultatet visas som om installationen utfördes:
Hämtar paket till filsystemet downloading-packages-to-your-file-system
I det här avsnittet beskrivs hur du hämtar ett paket från AEM till filsystemet med hjälp av Pakethanteraren.
-
hämta paket från Paketera Dela direkt i den lokala AEM instansen.
När du laddar ned paketet importeras det till din databas. Därefter kan du omedelbart installera det på din lokala instans med Pakethanteraren. Dessa paket innehåller snabbkorrigeringar och andra delade paket. -
hämta paket från Paketera Dela till filsystemet.
-
På AEM välkomstskärm klickar du på Paket väljer Pakethanteraren.
-
Navigera till paketet som du vill hämta.
-
Klicka på länken som utgörs av zip-filens namn (understruken) för paketet som du vill hämta; till exempel
export-for-offline.zip
.AEM hämtar paketet till datorn (med en standarddialogruta för hämtning av webbläsare).
Överför paket från filsystemet uploading-packages-from-your-file-system
Med en paketöverföring kan du överföra ett paket från filsystemet till AEM Package Manager.
Så här överför du ett paket:
-
Navigera till Pakethanteraren. Till den gruppmapp som du vill att paketet ska överföras till.
-
Klicka Överför paket.
-
Fil
Du kan antingen skriva filnamnet direkt eller använda Bläddra… för att välja det paket som krävs från det lokala filsystemet (efter markeringen klickar du på OK).
-
Tvinga överföring
Om det redan finns ett paket med det här namnet kan du klicka på det här om du vill framtvinga en överföring (och skriva över det befintliga paketet).
Klicka OK så att det nya paketet överförs och visas i pakethanterarlistan.
note note NOTE Om du vill göra innehållet tillgängligt för AEM ska du se till att installera paketet. -
Verifierar paket validating-packages
Innan du installerar ett paket kanske du vill verifiera dess innehåll. Eftersom paket kan ändra överlagrade filer under /apps
och/eller lägga till, ändra och ta bort åtkomstkontrollistor, är det ofta användbart att validera dessa ändringar innan du installerar.
Valideringsalternativ validation-options
Valideringsmekanismen kan kontrollera följande egenskaper hos paketet:
- OSGi-paketimporter
- Övertäckningar
- ACL
Dessa alternativ beskrivs nedan.
-
Validera OSGi-paketimporter
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 instansen exporterar dessa beroenden med rätt versioner.Hur det rapporteras
Alla versionshanteringsberoenden som inte kan uppfyllas av den AEM instansen visas i Aktivitetslogg 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 OSGi-paket som inte startats i sin tur inte fungerar som det ska.
Felupplösning
För att åtgärda fel på grund av att OSGi-paketen inte är nöjd måste beroendeversionen i paketet med otillfredsställande importer justeras.
-
Validera övertäckningar
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.jsp
så att den befintliga filen ändras på/libs/sling/servlet/errorhandler/404.jsp
.Hur det rapporteras
Alla sådana övertäckningar beskrivs i Aktivitetslogg 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äckningsfilens innehåll 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.note note NOTE Observera att valideringsfunktionen inte kan 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 Aktivitetslogg 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.
note caution CAUTION Som god praxis rekommenderas att paket inte påverkar AEM-tillhandahållna åtkomstkontrollistor eftersom detta kan leda till oväntade produktbeteenden.
Utför validering performing-validation
Paketvalidering kan göras på två olika sätt:
- Via pakethanterarens gränssnitt
- Via HTTP-POST-begäran, till exempel med cURL
Paketvalidering via Pakethanteraren
-
Öppna packningshanteraren på
https://<server>:<port>/crx/packmgr
-
Markera paketet i listan och välj sedan Mer rullgardinsmeny från rubriken och sedan Validera i listrutan.
note note NOTE Detta bör göras efter att du har överfört innehållspaketet, men innan du installerar paketet. -
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. Du kan även klicka Avbryt.
-
De valda valideringarna körs sedan. 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
type
parametern kan vara en kommaseparerad osorterad lista som består av:osgiPackageImports
overlays
acls
type
standardvärdet är osgiPackageImports
om det inte godkänns.Följande är ett exempel på hur du använder cURL för att köra en paketvalidering.
-
Om du använder cURL kör du en programsats som liknar följande:
code language-shell 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'
-
Den begärda valideringen körs och svaret skickas tillbaka som ett JSON-objekt.
Installerar paket installing-packages
När du har överfört ett paket måste du installera innehållet. Om paketinnehållet ska vara installerat och fungera måste det vara både:
-
läses in i AEM (antingen överförda från ditt filsystem eller hämtat från paketresurs)
-
installerat
-
Gör en testinstallation av paketet utan att ändra något av innehållet:
Öppna paketet (klicka på paketikonen eller paketnamnet) och klicka på Testa installationen. -
Se en lista med paketets innehåll:
Öppna paketet och klicka på Innehåll.
-
Inaktivera först WorkflowLauncher.
Använd menyalternativet Komponenter i OSGi-konsolen för att inaktiveracom.day.cq.workflow.launcher.impl.WorkflowLauncherImpl
. -
När installationen är klar återaktiverar du WorkflowLauncher.
-
Gå till det paket du vill installera i Pakethanteraren.
An Installera visas på sidan om paket som ännu inte har installerats.
note note NOTE Du kan även öppna paketet genom att klicka på dess ikon för att öppna Installera där. -
Klicka Installera för att starta installationen. En dialogruta begär bekräftelse och visar alla ändringar som görs. När du är klar klickar du Stäng i dialogrutan.
Ordet Installerad visas bredvid paketet när det har installerats.
Filsystembaserad överföring och installation file-system-based-upload-and-installation
Det finns ett annat sätt att överföra och installera paket till din instans. I filsystemet har du en crx-quicksart
och license.properties
-fil. Du måste skapa en mapp med namnet install
under crx-quickstart
. Du kommer då att få något sådant: <aem_home>/crx-quickstart/install
I den här installationsmappen kan du lägga till dina paket direkt. De laddas automatiskt upp och installeras på din instans. När du är klar kan du se paketen i Package Manager.
Om instansen körs lägger du till ett paket i install
-mappen startar direkt vid överföringen och installationen på instansen. Om din instans inte körs, kommer paketen du placerar i install
-mappen installeras vid start i alfabetisk ordning.
crx-quickstart
skapa mappen manuellt install
och placera paketen där. När du sedan startar instansen första gången installeras paketen i alfabetisk ordning.Avinstallerar paket uninstalling-packages
AEM kan du avinstallera paket. Den här åtgärden återställer innehållet i databasen som påverkas av ögonblicksbilden som skapades omedelbart före paketinstallationen.
- Gå till det paket som du vill avinstallera i Pakethanteraren.
- Klicka på paketikonen för det paket som du vill avinstallera.
- Klicka Avinstallera om du vill ta bort innehållet i det här paketet från databasen. En dialogruta begär bekräftelse och visar alla ändringar som görs. När du är klar klickar du Stäng i dialogrutan.
Ta bort paket deleting-packages
Så här tar du bort ett paket från pakethanterarlistan:
-
I verktyg konsol, expandera Paket för att visa ditt paket i den högra rutan.
-
Klicka på det paket som du vill ta bort så att det är markerat och sedan antingen:
- Klicka Ta bort i verktygsfältmenyn.
- Högerklicka och välj Ta bort.
-
AEM ber om en bekräftelse på att du vill ta bort paketet. Klicka OK för att bekräfta borttagningen.
Replikerar paket replicating-packages
Replikera innehållet i ett paket för att installera det på publiceringsinstansen:
-
I Pakethanteraren navigera till det paket som du vill replikera.
-
Klicka på ikonen eller på namnet på det paket som du vill replikera för att expandera det.
-
I Mer nedrullningsbar meny i verktygsfältet väljer Replikera.
Paketdelning package-share
Paketresursen var en centraliserad server som är allmänt tillgänglig för delning av innehållspaket.
Den har ersatts med Programvarudistribution.
Programvarudistribution software-distribution
Programvarudistribution är det nya användargränssnittet som förenklar sökning och hämtning av AEM.
Mer information finns i Dokumentation om programvarudistribution.