Uppgradera Adobe Experience Manager Guides On Premise (version 4.4.0 och tidigare)
Den här artikeln innehåller anvisningar om hur du uppgraderar Adobe Experience Manager Guides versioner före 4.6.0 (till och med 4.4.0).
Om du har en version som är tidigare än 3.8.5 kan du läsa avsnittet Uppgradera Experience Manager Guides i den produktspecifika installationsguiden som finns i Adobe Experience Manager Guides Help PDF archive.
Uppgraderingsinstruktioner för nyare versioner finns i Uppgradera Adobe Experience Manager Guides för version 4.6.0 och senare.
Innan du börjar
Uppgraderingssökvägar som omfattas av den här artikeln
Denna artikel innehåller procedurer för
Globala förutsättningar (gäller för alla uppgraderingar om inte annat anges i proceduren)
Utför följande uppgifter innan du kör uppgraderingsprocessen:
- Importera granskningskommentarer i ämnen som är öppna för granskning.
- Stäng alla aktiva granskningar.
- Stäng alla översättningsåtgärder.
- Avinstallera eventuella Experience Manager Guides-snabbkorrigeringar som installerats ovanpå den tidigare versionen (större version eller korrigeringsversion).
Vissa uppgraderingar kräver också att loggnivån ställs in på INFO för en uppgraderingsklass för översättning och loggning till en separat fil. Dessa krav anges i de relevanta uppgraderingsprocedurerna.
Uppgradera från version 3.8.5 till version 4.0
Om du använder Experience Manager Guides version 3.8.5 kan du uppgradera till version 4.0 utan att avinstallera den tidigare versionen.
Innan du installerar version 4.0
- Kontrollera att Experience Manager Guides är i version 3.8.5.
- Hämta uppgraderingsskriptpaketet: sök efter "XML Documentation solution 4.0 Upgrade Package" på Adobe Software Distribution Portal (hämtar ett
.zip). - Överför paketet till AEM via Package Manager och installera det.
- När uppgraderingspaketet har installerats kör du skripten i den ordning som beskrivs nedan.
Kontrollera API:t för uppgraderingskompatibilitet
Detta API är utformat för att utvärdera den aktuella systemstatusen och rapportera om uppgraderingen är möjlig eller inte. Om du vill köra det här skriptet utlöser du slutpunkten nedan:
Obs! Du kan använda en webbläsare där du är inloggad som administratör på AEM-instansen.
- Om det finns en nod på målplatsen får du ett relevant fel. Rensa databasen (delete node /var/dxml) och installera om uppgraderingspaketet och utlösa sedan den här slutpunkten igen.
Obs! Detta är inte ett vanligt fel eftersom målplatsen inte används tidigare av 3.x Experience Manager Guides.
- Om det här manuset inte lyckas ska du inte fortsätta och rapportera till ditt kundframgångsteam.
API för systemdatamigrering
Detta API är utformat för att migrera systemdata enligt avsnittet Migreringsmappning.
- Kör inte det här skriptet om API:t för kontroll av kompatibilitet misslyckas (fortsätt inte).
- När API:t för kontroll av uppgraderingskompatibilitet returneras kan du köra uppgraderingsskriptet.
Obs! Det här skriptet är en POST-begäran och ska därför köras via agenter som Postman.
- Om fel uppstår återställer du till den senaste kontrollpunkten och delar felloggarna med API-utdata till kundens framgångsgrupp.
Migreringsmappning
Detta API migrerar alla data under källplatsen till målplatsen.
Installera version 4.0
-
Installera endast version 4.0 om uppgraderingsstegen lyckades.
-
Hämta versionspaket 4.0 från Adobe Software Distribution Portal:
-
Om du använder UUID-versionen av programmet söker du efter"4.0 UID Release for XML Documentation solution for AEM 6.5".
-
Om du använder en icke-UID-version av programmet söker du efter"4.0 Non-UUID Release for XML Documentation solution for AEM 6.5".
Överför paketet till den befintliga AEM-serverinstansen med CRX Package Manager och installera det.note note NOTE Vänta tills alla systemkomponenter har startats.
-
-
Rensa webbläsarcachen när paketet har installerats.
-
Om en dispatcher har konfigurerats på en AEM Author-instans utför du följande steg:
- Kontrollera att följande hanteras i dispatcherregler:
- URL-mönstret /home/users/*/preferences är vitlistat.
- URL-mönstret /libs/cq/security/userinfo.json är inte cachelagrat.
-
Rensa dispatchercachen (för att rensa alla
clientlibscachelagrade).
Uppgradera till version 4.2
Du kan uppgradera till version 4.2 direkt om du använder version 4.0, 4.1 eller 4.1.x.
Innan du installerar version 4.2
Innan du startar uppgraderingsprocessen för Experience Manager Guides 4.2 bör du kontrollera att du har:
-
Uppgraderat till Experience Manager Guides 4.0, 4.1 eller 4.1.x.
-
Alla översättningsuppgifter stängdes.
-
Ange loggnivån till
INFOförcom.adobe.fmdita.translationservices.TranslationMapUpgradeScriptoch logga till en ny loggfil (till exempellogs/translation_upgrade.log).note note NOTE Du bör stänga alla aktiva granskningar. Om granskningarna inte stängs när du uppgraderar till 4.2 kan äldre pågående granskningsuppgifter fortsätta att öppna äldre granskningssidor. Nya granskningsuppgifter som skapas efter uppgraderingen visar de senaste funktionsuppdateringarna.
Installera version 4.2
-
Hämta paketet 4.2 från Adobe Software Distribution Portal.
-
Installera 4.2-paketet.
-
Efter installationen väntar du på följande meddelande i loggarna:
Completed the post deployment setup scriptOvanstående meddelande anger att alla installationssteg har slutförts.
Om du råkar ut för något av följande fel ska du rapportera dem till Customer Success:
Error in post deployment setup scriptException while porting the translation MAPUnable to port translation map from v1 to v2 for property
-
(Valfritt) Plugin-programmet för uppgradering av syreanslutning släppt med version 4.2.
-
Rensa webbläsarcachen när paketet har installerats.
-
Fortsätt uppgradera anpassningarna enligt anvisningarna i nästa avsnitt.
Efter installation av version 4.2
/libs/fmdita/pdf/Hi-Tech Mål: /content/dam/dita-templates/pdf.Fortsätt sedan med de delade efteruppgraderingsuppgifterna i Vanliga efteruppgraderingsuppgifter (alla versioner).
Uppgradera till version 4.2.1
Du kan uppgradera till version 4.2.1 direkt om du använder 4.1, 4.1.x eller 4.2.
Innan du installerar version 4.2.1
- Uppgradera till Experience Manager Guides 4.1, 4.1.x eller 4.2.
- Stäng alla översättningsåtgärder.
- Ange loggnivån till
INFOförcom.adobe.fmdita.translationservices.TranslationMapUpgradeScriptoch logga till en ny fil (till exempellogs/translation_upgrade.log).
Installera version 4.2.1
-
Hämta paketet 4.2.1 från Adobe Software Distribution Portal.
-
Installera 4.2.1-paketet.
-
Du kan också aktivera uppgraderingsjobbet för översättningskartan. Mer information finns i Aktivera utlösare för skript via en server.
-
Efter installationen väntar du på:
Completed the post deployment setup scripti loggar.Rapportera felen till Kundens framgång:
Error in post deployment setup scriptException while porting the translation MAPUnable to port translation map from v1 to v2 for property
-
(Valfritt) Plugin-programmet för uppgradering av syreanslutning har släppts med version 4.2
-
Rensa webbläsarcachen.
-
Fortsätt med Vanliga efteruppgraderingsuppgifter (alla versioner).
Efter installation av version 4.2.1
/libs/fmdita/pdf/Hi-Tech Mål: /content/dam/dita-templates/pdf.Fortsätt med Vanliga efteruppgraderingsuppgifter (alla versioner) och (om det behövs) Indexera befintligt innehåll för kartsökning och ersättning.
Uppgradera till version 4.3.0
Uppgradering till version 4.3.0 beror på vilken version av Experience Manager Guides du har. Om du använder version 4.2 eller 4.2.x kan du uppgradera direkt till version 4.3.0.
Innan du installerar version 4.3.0
Innan du startar uppgraderingsprocessen för Experience Manager Guides 4.3.0 bör du kontrollera att du har:
- Uppgraderat till Experience Manager Guides version 4.2 eller 4.2.x och slutfört respektive installationssteg.
- Alla översättningsuppgifter stängdes.
Installera version 4.3.0
- Hämta versionspaket 4.3.0 från Adobe Software Distribution Portal.
- Installera paket för version 4.3.0.
- Rensa webbläsarcachen när paketet har installerats.
- Uppgradera filen
ui_config.jsonfrån fliken XML-redigerarkonfiguration i mappprofilen.
Efter installation av version 4.3.0
Fortsätt med:
Uppgradera till version 4.3.1
Uppgradering till version 4.3.1 beror på vilken version av Experience Manager Guides som är aktuell. Om du använder version 4.3.0, 4.2 eller 4.2.1 kan du uppgradera direkt till version 4.3.1.
Innan du installerar version 4.3.1
Innan du startar uppgraderingsprocessen för Experience Manager Guides 4.3.1 bör du kontrollera att du har:
- Uppgraderat till Experience Manager Guides version 4.3.0, 4.2 eller 4.2.1 och slutfört respektive installationssteg.
- (Valfritt) Avslutade alla översättningsuppgifter.
- Loggnivån har ändrats till INFO för klassen
com.adobe.fmdita.translationservices.TranslationMapUpgradeScriptoch loggarna läggs till i en ny loggfil, till exempellogs/translation_upgrade.log.
Installera version 4.3.1
- Hämta versionspaketet 4.3.1 från Adobe Software Distribution Portal.
- Installera paket för version 4.3.1.
- Du kan också aktivera uppgraderingsjobbet för översättningskartan. Mer information finns i Aktivera utlösare för skript via en server.
- Efter installationen väntar du på:
Completed the post deployment setup scripti loggar.
Rapportera felen till Kundens framgång:Error in post deployment setup script,Exception while porting the translation MAP,Unable to port translation map from v1 to v2 for property - (Valfritt) Plugin-programmet för uppgradering av syreanslutning släpptes med version 4.2.
- Rensa webbläsarcachen.
Efter installation av version 4.3.1
Fortsätt med:
Uppgradera till version 4.3.1.5
Du kan uppgradera till 4.3.1.5 direkt om du använder version 4.3.1.
Installera version 4.3.1.5
- Hämta paketet 4.3.1.5 från Adobe Software Distribution Portal.
- Installera paketet 4.3.1.5.
- Vänta tills installationsprocessen har slutförts.
- Fortsätt uppgradera anpassningarna enligt anvisningarna i nästa avsnitt.
Efter installation av version 4.3.1.5
- Gå till
<server>:<port>/system/console/bundles - Sök efter org.apache.speed.
- Avinstallera det sökta paketet.
- Installera det hastighetspaket som krävs.
-
När uppgraderingen är klar kontrollerar du att alla anpassningar/övertäckningar har validerats och uppdaterats så att de matchar den nya programkoden. Nedan följer några exempel:
- Alla komponenter som överlappas från
/libs/fmditaeller/libsska jämföras med den nya produktkoden och uppdateringar ska göras i överlagrade filer under/apps. - Alla kategorier av klientlib som används från produkten bör granskas för ändringar. Alla åsidosatta konfigurationer (exempel nedan) bör jämföras med de senaste för att få de senaste funktionerna:
elementmapping.xmlui\_config.json\(kan ha angetts i mappprofiler)- ändrade
com.adobe.fmdita.config.ConfigManager
- Alla komponenter som överlappas från
Uppgradera till version 4.4.0
Du kan uppgradera till 4.4.0 direkt om du använder: 4.3.1, 4.3.0, 4.2 eller 4.2.1 (programfix 4.2.1.3).
Innan du installerar version 4.4.0
Innan du startar uppgraderingsprocessen för Experience Manager Guides 4.4.0 bör du kontrollera att du har:
- Uppgraderat till Experience Manager Guides version 4.3.1, 4.3.0 eller 4.2.1 (programfix 4.2.1.3) och slutförde respektive installationssteg.
- (Valfritt) Avslutade alla översättningsuppgifter.
- Loggnivån har ändrats till INFO för klassen
com.adobe.fmdita.translationservices.TranslationMapUpgradeScriptoch loggarna läggs till i en ny loggfil, till exempellogs/translation_upgrade.log.
Installera version 4.4.0
-
Hämta versionspaketet 4.4.0 från Adobe Software Distribution Portal.
-
Installera 4.4.0-paketet.
-
Du kan också aktivera uppgraderingsjobbet för översättningskartan. Mer information finns i Aktivera utlösare för skript via en server.
-
När du har slutfört paketinstallationen väntar du på följande meddelande i loggarna:
Completed the post deployment setup scriptOvanstående meddelande anger att alla installationssteg är slutförda.
Om du råkar ut för något av följande felkorrigeringar ska du rapportera dem till ditt kundteam:
Error in post deployment setup scriptException while porting the translation MAPUnable to port translation map from v1 to v2 for property
-
(Valfritt) Plugin-programmet för uppgradering av syreanslutning släpptes med version 4.4.0.
-
Rensa webbläsarcachen.
-
Fortsätt med:
- Vanliga uppgifter efter uppgradering (alla versioner)
- Indexera befintligt innehåll för kartans sök och ersätt (endast om tillämpligt)
- Efterbearbeta befintligt innehåll för rapport om brutna länkar (endast om tillämpligt)
- Uppgradering av översättningskarta (serverutlösare) (endast om tillämpligt)
Vanliga uppgifter efter uppgradering (alla versioner)
När du har installerat Experience Manager Guides kan du behöva sammanfoga konfigurationer som gäller från den nyinstallerade versionen till din installation.
Validera arbetsflödet för DAM-uppdatering (ändringar efter bearbetning)
-
Öppna användargränssnittet för AEM Workflow Models (exemplet visas i källan):
http://<host>:4502/libs/cq/workflow/admin/console/content/models.html -
Välj DAM-uppdateringsarbetsflöde.
-
Välj Redigera.
-
Om komponenten DXML Post Process Initiator finns kontrollerar du att anpassningarna synkroniseras.
-
Om komponenten inte finns infogar du den:
- Klicka på Infoga komponent (ansvarar för efterbearbetning av stödlinjer som det sista steget).
- Konfigurera processsteget:
fliken Allmänt
- Titel:
DXML Post Process Initiator - Beskrivning:
DXML post process initiator step which will trigger a sling job for DXML post-processing of the modified/created asset
Fliken Process - Process: välj
DXML Post Process Initiator - Välj
Handler Advance - Välj
Done
3. Klicka på Synkronisera överst till höger när du har slutfört ändringarna. Du får ett meddelande om att åtgärden lyckades.
Validera startkonfigurationer
- Gå till AEM Workflow-gränssnittet och öppna Startprogram.
http://localhost:4502/libs/cq/workflow/content/console.html
-
Sök efter och ändra (om det behövs) till följande två startprogram (som ska vara aktiva) som motsvarar DAM Update Asset workflow:
-
Startprogrammet för noden har skapats för arbetsflödet DAM Update Asset - för villkoret
"jcr:content/jcr:mimeType!=video"ska värdet Globbing vara:code language-json /content/dam(/((?!/subassets|/translation_output).)*/)renditions/originalexcludeListska ha"event-user-data:changedByWorkflowProcess".- Startprogram för Nod ändrad för DAM Update Asset workflow - för villkoret
jcr:content/jcr:mimeType!=video. Värdet Globbing ska vara:
code language-json /content/dam(/((?!/subassets|/translation_output).)*/)renditions/originalexcludeListska ha"event-user-data:changedByWorkflowProcess".
Validera övertäckningar och anpassningar
När uppgraderingen är klar:
-
När uppgraderingen är klar kontrollerar du att alla anpassningar/övertäckningar har validerats och uppdaterats så att de matchar den nya programkoden. Nedan följer några exempel:
- Alla komponenter som överlappas av/libs/fmditor/libsska jämföras med den nya produktkoden och uppdateringar ska göras i överlagrade filer under/i appar.
- Alla kategorier av klientlib som används från produkten bör granskas för ändringar. Alla åsidosatta konfigurationer (exempel nedan) bör jämföras med de senaste för att få de senaste funktionerna:
- elementmapping.xml
- ui_config.json(kan ha angetts i mappprofiler)
- ändrade
com.adobe.fmdita.config.ConfigManager
-
Om du har lagt till anpassningar i damAssetLucene kan du behöva använda dem igen. När du har gjort ändringarna anger du reindex som true. Detta indexerar om alla befintliga noder med anpassningarna. När du är klar anges omindexeringsflaggan till false igen. Detta kan ta några timmar beroende på antalet resurser i systemet.
Indexera befintligt innehåll för att söka och ersätta kartor
I det här avsnittet konsolideras den upprepade indexeringsproceduren som används för att aktivera de nya mappningsnivåfunktionerna för sök och ersätt.
När du kan hoppa över indexering
Källan innehåller"hoppa över"-anteckningar beroende på din uppgraderingssökväg (t.ex."Du behöver inte utföra dessa steg om du uppgraderar från 4.3.0 eller 4.3.1" och liknande anteckningar). Följ överhoppningsanvisningarna som finns i uppgraderingsavsnittet.
Utför följande steg för att indexera det befintliga innehållet och använd den nya sök- och ersätt-texten på mappningsnivå:
- Kör en POST-begäran (med autentisering):
POST http://<server:port>/bin/guides/map-find/indexing
Valfria parametrar som stöds i källan:
-
Indexera specifika mappningssökvägar (som standard indexeras alla mappningar):
code language-http POST http://<server:port>/bin/guides/map-find/indexing?paths=<map_path_in_repository> -
Indexera DITA-mappningar under en rotmapp (och dess undermappar):
code language-http POST http://<server:port>/bin/guides/map-find/indexing?root=/content/dam/testnote note NOTE Om både pathsochrootskickas beaktas barapaths.
-
API:t returnerar
jobId. Skicka en GET-förfrågan om du vill kontrollera status:code language-http GET http://<server:port>/bin/guides/map-find/indexing?jobId={jobId}Förväntat slutförandebeteende:
- När allt är klart svarar GET med framgång och anger om några kartor misslyckades.
- Indexerade mappningar i serverloggar har bekräftats.
Kontrollera att damAssetLucene-indexeringen är slutförd (där det är tillämpligt)
Källan noterar att indexering av damAssetLucene kan ta timmar beroende på datastorleken, och du kan bekräfta slutförandet när reindex är false under:
http://<server:port>/oak:index/damAssetLucene
Om du har lagt till anpassningar i damAssetLucene kan du behöva tillämpa dem igen när indexeringen har slutförts.
Tillfällig lösning för"fråga som har lästs eller gått igenom mer än 100000 noder" (om jobbet misslyckas)
Om indexeringsjobbet misslyckas och felet visar:
"Frågan läste eller gick igenom mer än 100000 noder. Bearbetningen avbröts för att undvika att andra uppgifter påverkas."
Prova den här lösningen från källan:
-
Lägg till den booleska egenskapen
damAssetLuceneiindexNodeName=truei/oak:index/damAssetLucene/indexRules/dam:Asset-ekindexet. -
Lägg till en ny nod med namnet
excerptunder/oak:index/damAssetLucene/indexRules/dam:Asset/propertiesoch ange egenskaper som visas i källan:name=rep:excerptpropertyIndex=truenotNullCheckEnabled=true
-
Indexera om
damAssetLucenegenom att angereindex=trueoch vänta tills det blirfalseigen (kan ta timmar). -
Kör indexeringsskriptet igen (upprepa POST och jobbspårning).
Efterbearbeta befintligt innehåll för rapport om bruten länk
I det här avsnittet konsolideras den upprepade efterbearbetningsproceduren som används för att aktivera den brutna länkrapporten.
När du kan hoppa över efterbearbetning
Källan innehåller"hoppa över"-anteckningar beroende på din uppgraderingssökväg (t.ex."Du behöver inte utföra dessa steg om du uppgraderar från 4.3.0" eller"från 4.3.0 eller 4.3.1"). Följ överhoppningsanvisningarna som finns i uppgraderingsavsnittet.
Följ de här stegen för att aktivera rapporten för bruten länk:
-
(Valfritt) Öka Oak queryLimitReads för stora databaser
Om det finns fler än 100 000 DITA-filer uppdaterar du
queryLimitReadsunderorg.apache.jackrabbit.oak.query.QueryEngineSettingsServicetill ett värde som är större än antalet resurser (exempel:200000), omdistribuerar och fortsätter.table 0-row-3 1-row-3 PID Egenskapsnyckel Egenskapsvärde org.apache.jackrabbit.oak.query.QueryEngineSettingsService queryLimitReads Värde: 200000
standardvärde: 100000 -
Kör följande API:er för efterbearbetning av alla filer:
table 0-row-2 1-row-2 2-row-2 Slutpunkt /bin/guides/reports/upgrade Typ av begäran POST Det här skriptet är en POST-begäran och ska därför köras via agenter som Postman. Förväntat svar API:t returnerar ett jobId. Om du vill kontrollera jobbets status kan du skicka en GET-förfrågan med jobb-ID till samma slutpunkt.
Exempel-URL:http://<server:port>/bin/guides/reports/upgradetable 0-row-2 1-row-2 2-row-2 3-row-2 Slutpunkt /bin/guides/reports/upgrade Typ av begäran GET Param jobId: Skicka det jobId som togs emot från föregående post-begäran. Förväntat svar - När jobbet är klart svarar GET-begäran med framgång.
- Om det uppstår fel kan du dela felloggarna tillsammans med API-utdata med kundens framgångsgrupp.
Exempel-URL:http://<server:port>/bin/guides/reports/upgrade?jobId=2022/9/15/7/27/7dfa1271-981e-4617-b5a4-c18379f11c42_678 -
Återgå till standardvärdet eller det tidigare befintliga värdet
queryLimitReadsom du har ändrat det i steg 1.
Aktivera utlösare för skript via en serverenhet
Flera versioner innehåller ett valfritt steg som utlöser ett uppgraderingsjobb för översättningskarta via en server. I det här avsnittet konsolideras den upprepade proceduren och innehåller alla detaljer som anges i källan.
POST:
http://localhost:4503/bin/guides/script/start?jobType=translation-map-upgrade
Svar:
{
"msg": "Job is successfully submitted and lock node is created for future reference",
"lockNodePath": "/var/dxml/executor-locks/translation-map-upgrade/1683190032886",
"status": "SCHEDULED"
}
I ovanstående svar-JSON innehåller nyckeln lockNodePath sökvägen till noden som skapades i databasen som pekar på jobbet som skickats. Den tas automatiskt bort när jobbet är klart, tills dess kan du referera till den här noden för aktuell status för jobbet.
Sök efter com.adobe.fmdita.translationservices.TranslationMapUpgradeScript Completed porting of translation map from V1 to V2 och com.adobe.fmdita.xmltranslation.ots.TranslationMapUpgradeOTS Completed the thread to upgrade translation map from V1 to V2 innan du fortsätter till nästa steg.
GET: http://<aem_domain>/var/dxml/executor-locks/translation-map-upgrade/1683190032886.json
Steg för att hantera konflikten med "fmdita rewriter"
Experience Manager Guides innehåller en anpassad modul för Sling-omskrivning (fmditarewriter) för hantering av länkar som genererats för korsmappslänkning.
Om du har en annan anpassad Sling-rewriter i din kodbas:
- Använd ett
order-värde som är större än 50 eftersom stödlinjerna använderorder=50. - Under den här uppgraderingen ändras värdet
orderfrån1000till50, så du måste sammanfoga din befintliga anpassade omskrivare (om sådan finns) medfmditarewriter.