Förbereder AEM Forms för säkerhetskopiering

Senast uppdaterad: 13 juli 2024
  • Ämnen:

Skapat för:

  • Utvecklare

Exempel och exempel i det här dokumentet gäller endast för AEM Forms i JEE-miljö.

Om tjänsten Säkerhetskopiering och återställning

Med tjänsten Säkerhetskopiering och återställning kan du placera AEM Forms i säkerhetskopieringsläge, vilket gör att det går att utföra säkerhetskopiering under körning. Säkerhetskopierings- och återställningstjänsten utför inte någon säkerhetskopiering av AEM Forms eller återställning av systemet. I stället försätts servern i ett läge där det går att utföra konsekventa och tillförlitliga säkerhetskopieringar samtidigt som servern kan fortsätta att köras. Du ansvarar för åtgärderna för att säkerhetskopiera GDS (Global Document Storage) och databasen som är ansluten till Forms Server. GDS är en katalog som används för att lagra filer som används i en långvarig process.

Säkerhetskopieringsläget är ett läge som servern försätts i så att filer i GDS inte rensas när en säkerhetskopieringsprocedur utförs. I stället skapas underkataloger under GDS-katalogen för att behålla en post med filer som ska rensas när säkerhetskopieringsläget har avslutats. En fil är avsedd att överleva systemomstarter och kan sträcka sig över flera dagar eller till och med år. Dessa filer är en viktig del av det övergripande tillståndet för Forms Server och kan innehålla PDF-filer, profiler eller formulärmallar. Om någon av dessa filer förloras eller skadas kan processerna på Forms Server bli instabila och data gå förlorade.

Du kan välja att utföra säkerhetskopiering av ögonblicksbilder, där du vanligtvis aktiverar säkerhetskopieringsläget under en period och sedan lämnar säkerhetskopieringsläget när du har slutfört säkerhetskopieringsaktiviteterna. Du måste lämna säkerhetskopieringsläget så att filer kan rensas från GDS-systemet för att säkerställa att de inte växer i onödan. Du kan antingen lämna säkerhetskopieringsläget explicit eller vänta på att tiden ska gå ut i en session i säkerhetskopieringsläge.

Du kan också lämna servern i permanent säkerhetskopieringsläge, vilket är typiskt för strategier för säkerhetskopiering vid rullande säkerhetskopiering eller kontinuerlig systemtäckning. Läget för rullande säkerhetskopiering anger att systemet alltid är i säkerhetskopieringsläge, med en ny session som påbörjas så snart som föregående session släpps. I läget för kontinuerlig säkerhetskopiering töms en fil efter två sessioner med säkerhetskopieringsläge och refereras inte längre till den.

Du kan använda tjänsten Säkerhetskopiering och återställning för att lägga till i befintliga program eller nya program som du skapar för att utföra säkerhetskopieringar av GDS eller databasen som är ansluten till Forms Server.

NOTE
Precis som med andra aspekter av er AEM Forms-implementering bör er strategi för säkerhetskopiering och återställning utvecklas och testas i en utvecklings- eller staging-miljö innan den används i produktionen för att säkerställa att hela lösningen fungerar som förväntat utan dataförlust.

Du kan utföra följande åtgärder med tjänsten Säkerhetskopiera och återställ:

  • Gå till säkerhetskopieringsläge.
  • Lämna säkerhetskopieringsläget.
NOTE
Mer information om vad du bör tänka på när du gör säkerhetskopieringar för AEM Forms finns i administrationshjälpen.
NOTE
Mer information om tjänsten Säkerhetskopiering och återställning finns i Tjänstreferens för AEM Forms.

Läget för säkerhetskopiering på Forms Server aktiveras

Du aktiverar säkerhetskopieringsläget för att tillåta säkerhetskopiering av en Forms-server under en pågående säkerhetskopiering. När du aktiverar säkerhetskopieringsläge anger du följande information baserat på din organisations procedurer för säkerhetskopiering:

  • En unik etikett som identifierar den session i säkerhetskopieringsläget som kan vara användbar för dina säkerhetskopieringsprocesser.
  • Den tid det tar för säkerhetskopieringen att slutföras.
  • En flagga som anger om du ska vara i kontinuerligt säkerhetskopieringsläge, vilket bara är användbart om du utför rullande säkerhetskopiering.

Innan du skriver program som ska gå in i säkerhetskopieringsläge bör du känna till de säkerhetskopieringsprocedurer som används när du har placerat Forms Server i säkerhetskopieringsläge. Mer information om vad du bör tänka på när du gör säkerhetskopieringar för AEM Forms finns i administrationshjälpen.

NOTE
Mer information om tjänsten Säkerhetskopiering och återställning finns i Tjänstreferens för AEM Forms.

Sammanfattning av steg

Så här skapar du ett program som övergår till säkerhetskopieringsläge:

  1. Inkludera projektfiler.
  2. Skapa ett BackupService-klientobjekt.
  3. Bestäm en unik etikett, hur lång tid säkerhetskopieringen ska utföras och om den ska vara i kontinuerligt säkerhetskopieringsläge.
  4. Gå till säkerhetskopieringsläge.
  5. (Valfritt) Hämta information om sessionen för säkerhetskopieringsläge på servern.
  6. Säkerhetskopiera GDS (Global Data Store) och databasen.

Inkludera projektfiler

Inkludera nödvändiga filer i utvecklingsprojektet. Dessa filer är viktiga att inkludera i ditt projekt för att kompilera koden på rätt sätt och använda API:t för tjänsten Backup and Restore.

Mer information om platsen för dessa filer finns i Inkludera AEM Forms Java-biblioteksfiler.

Skapa ett BackupService Client API-objekt

Om du vill lämna säkerhetskopieringsläget programmatiskt skapar du ett BackupService-klientobjekt som ska använda API:t för tjänsten för säkerhetskopiering och återställning.

Bestäm dig för en unik etikett, bestäm hur lång tid det tar att utföra säkerhetskopieringen och bestäm om du ska vara i kontinuerligt säkerhetskopieringsläge

Innan du går in i säkerhetskopieringsläget bör du bestämma en unik etikett, fastställa hur lång tid du vill tilldela för att utföra säkerhetskopieringen och bestämma om du vill att Forms Server ska vara i säkerhetskopieringsläge. Dessa överväganden är viktiga att integrera med de säkerhetskopieringsprocedurer som din organisation har fastställt. (Se Administrationshjälp.)

Ange säkerhetskopieringsläge

Använd säkerhetskopieringsläget med de parametrar som överensstämmer med de säkerhetskopieringsprocedurer som används i organisationen.

Hämta information om sessionen för säkerhetskopieringsläge på servern

När du har aktiverat säkerhetskopieringsläget kan du hämta information om sessionen. Den här informationen kan användas för att integrera med dina säkerhetskopieringsprocedurer

Säkerhetskopiera GDS och databasen

När du har aktiverat säkerhetskopieringsläget kan du säkerhetskopiera GDS (Global Document Storage) och den databas som Forms Server är ansluten till. Det här steget är specifikt för din organisation eftersom du kan utföra det här steget manuellt eller köra andra verktyg för att utföra säkerhetskopieringsproceduren.

Ange säkerhetskopieringsläge med Java API

Ange säkerhetskopieringsläge med API:t för säkerhetskopiering och återställning:

  1. Inkludera projektfiler

    Inkludera nödvändiga JAR-klientfiler, t.ex. adobe-backup-restore-client-sdk.jar, i klassökvägen för Java-projektet. Om du vill skapa Java-klientprogrammet måste följande JAR-filer läggas till i projektets klasssökväg:

    • adobe-backup-restore-client-sdk.jar
    • adobe-livecycle-client.jar
    • adobe-usermanager-client.jar
    • adobe-utilities.jar (krävs om AEM Forms körs på JBoss Application Server)
    • jbossall-client.jar (krävs om AEM Forms körs på JBoss Application Server)

  2. Skapa ett BackupService Client API-objekt

    Du använder ett ServiceClientFactory-objekt och BackupService-klient-API-objektet tillsammans.

    • Skapa ett ServiceClientFactory-objekt som innehåller anslutningsegenskaper. (Se Ange anslutningsegenskaper.)
    • Skapa ett BackupService-objekt med hjälp av dess konstruktor och skicka ServiceClientFactory-objektet.

  3. Bestäm på en unik etikett, bestäm hur lång tid säkerhetskopieringen ska utföras och bestäm om den ska vara i kontinuerligt säkerhetskopieringsläge

    Bestäm på en unik etikett, bestäm hur lång tid du vill tilldela för att utföra säkerhetskopieringen och bestäm om du vill att Forms Server ska vara i kontinuerligt säkerhetskopieringsläge.

  4. Ange säkerhetskopieringsläge

    Öppna säkerhetskopieringsläget genom att anropa metoden enterBackupMode med följande parametrar:

    • Ett String-värde som anger en unik läsbar etikett som identifierar säkerhetskopieringslägessessionen. Du bör inte använda blanksteg eller tecken som inte kan kodas i XML-format.

    • Ett int-värde som anger antalet minuter som ska behållas i säkerhetskopieringsläge. Du kan ange ett värde mellan 1 och 10080 (antalet minuter i en vecka). Detta värde ignoreras när läget för kontinuerlig säkerhetskopiering används.

    • Ett Boolean-värde som anger om det ska vara i kontinuerligt säkerhetskopieringsläge. Värdet True anger att det ska vara i kontinuerligt säkerhetskopieringsläge. I läget för kontinuerlig säkerhetskopiering ignoreras det värde du anger för hur många minuter som ska vara kvar i läget för säkerhetskopiering.

      Kontinuerligt säkerhetskopieringsläge innebär att en ny session i säkerhetskopieringsläge startas när den aktuella sessionen har slutförts. Värdet False innebär att kontinuerligt säkerhetskopieringsläge inte används och att rensning av filer från GDS återupptas efter att säkerhetskopieringsläget har avslutats.

  5. Hämta information om sessionen för säkerhetskopieringsläge på servern

    Hämta information med objektet BackupModeEntryResult som returneras efter att metoden enterBackupMode anropats. Den information du kan hämta när du har aktiverat säkerhetskopieringsläget kan vara användbar för integrering med dina säkerhetskopieringsprocedurer. Etiketten, säkerhetskopierings-ID:t och starttiden kan till exempel vara användbara som indata för filnamn för säkerhetskopieringsproceduren.

  6. Säkerhetskopiera GDS och databasen

    Säkerhetskopiera GDS (Global Document Storage) och den databas som din Forms Server är ansluten till. Säkerhetskopieringsåtgärderna ingår inte i AEM Forms SDK och kan till och med innehålla manuella steg som är specifika för säkerhetskopieringsprocesserna i din organisation.

Ange säkerhetskopieringsläge med webbtjänstens API

Ange säkerhetskopieringsläge med webbtjänsten som tillhandahålls av API:t för tjänsten Backup and Restore:

  1. Inkludera projektfiler

    • Skapa en Microsoft .NET-klientsammansättning som använder WSDL för API:t för tjänsten för säkerhetskopiering och återställning.
    • Referera till Microsoft .NET-klientsammansättningen.

  2. Skapa ett BackupService Client API-objekt

    Skapa ett BackupServiceService-objekt med Microsoft .NET-klientsammansättningen genom att anropa dess standardkonstruktor och ange autentiseringsuppgifterna med metoden Credentials.

  3. Bestäm på en unik etikett, bestäm hur lång tid säkerhetskopieringen ska utföras och bestäm om den ska vara i kontinuerligt säkerhetskopieringsläge

    Bestäm på en unik etikett, bestäm hur lång tid du vill tilldela för att utföra säkerhetskopieringen och bestäm om du vill att Forms Server ska vara i kontinuerligt säkerhetskopieringsläge.

  4. Ange säkerhetskopieringsläge

    Aktivera metoden enterBackupMode och skicka följande värden för att aktivera säkerhetskopieringsläget:

    • Ett String-värde som anger en unik läsbar etikett som identifierar säkerhetskopieringslägessessionen. Du bör inte använda blanksteg eller tecken som inte kan kodas i XML-format.

    • Ett Uint32-värde som anger antalet minuter som ska behållas i säkerhetskopieringsläge. Du kan ange ett värde mellan 1 och 10080 (antal minuter i en vecka). Detta värde ignoreras när läget för kontinuerlig säkerhetskopiering används.

    • Ett Boolean-värde som anger om det ska vara i kontinuerligt säkerhetskopieringsläge. Värdet True anger att det ska vara i kontinuerligt säkerhetskopieringsläge. I läget för kontinuerlig säkerhetskopiering ignoreras det värde du anger för hur många minuter som ska vara kvar i läget för säkerhetskopiering. Kontinuerligt säkerhetskopieringsläge innebär att en ny session i säkerhetskopieringsläge startas när den aktuella sessionen har slutförts.

      Värdet False innebär att kontinuerligt säkerhetskopieringsläge inte används och att rensning av filer från GDS återupptas efter att säkerhetskopieringsläget har avslutats.

  5. Hämta information om sessionen för säkerhetskopieringsläge på servern

    Hämta information om säkerhetskopieringsläget när du har anropat metoden enterBackupMode från BackupModeEntryResult som returneras för att bekräfta att den lyckades. Den information du kan hämta när du har aktiverat säkerhetskopieringsläget kan vara användbar för integrering med dina säkerhetskopieringsprocedurer. Etiketten, säkerhetskopierings-ID:t och starttiden kan till exempel vara användbara som indata för filnamn för säkerhetskopieringsproceduren.

  6. Säkerhetskopiera GDS och databasen

    Säkerhetskopiera GDS (Global Document Storage) och den databas som din Forms Server är ansluten till. Säkerhetskopieringsåtgärderna ingår inte i AEM Forms SDK och kan till och med innehålla manuella steg som är specifika för säkerhetskopieringsprocesserna i din organisation.

Avslutar säkerhetskopieringsläge på Forms Server

Du lämnar säkerhetskopieringsläget så att Forms Server fortsätter att tömma filer från GDS (Global Document Storage) på Forms Server.

Innan du skriver program för att gå över till viloläge rekommenderar vi att du förstår de säkerhetskopieringsprocedurer som används med AEM Forms. Mer information om vad du bör tänka på när du gör säkerhetskopieringar för AEM Forms finns i administrationshjälpen.

NOTE
Mer information om tjänsten Säkerhetskopiering och återställning finns i Tjänstreferens för AEM Forms.

Sammanfattning av steg

Så här lämnar du säkerhetskopieringsläget:

  1. Inkludera projektfiler.
  2. Skapa ett BackupService-klientobjekt.
  3. Lämna säkerhetskopieringsläget.
  4. (Valfritt) Hämta information om sessionen för säkerhetskopieringsläge som kördes på Forms Server.

Inkludera projektfiler

Inkludera alla nödvändiga filer i utvecklingsprojektet. De här filerna är viktiga för att kompilera koden på rätt sätt och för att använda API:t för tjänsten för säkerhetskopiering och återställning.

Mer information om platsen för dessa filer finns i Inkludera AEM Forms Java-biblioteksfiler.

Skapa ett BackupService Client API-objekt

Om du vill lämna säkerhetskopieringsläget programmatiskt skapar du ett BackupService-klientobjekt som ska använda API:t för tjänsten för säkerhetskopiering och återställning.

Lämna säkerhetskopieringsläge

Lämna säkerhetskopieringsläget för att återuppta normal rensning av filer från GDS (Global Document Storage). Innan du lämnar säkerhetskopieringsläget bör du kontrollera att dina säkerhetskopieringsprocedurer har slutförts.

Hämta information om sessionen för säkerhetskopieringsläget som avslutades

När du lämnar säkerhetskopieringsläget kan du hämta information om sessionen. Den här informationen kan användas för att integrera med dina säkerhetskopieringsprocedurer.

Lämna säkerhetskopieringsläget med Java API

Lämna säkerhetskopieringsläget med hjälp av API:t för säkerhetskopiering och återställning (Java):

  1. Inkludera projektfiler

    Inkludera nödvändiga JAR-klientfiler, t.ex. adobe-backup-restore-client-sdk.jar, i klassökvägen för Java-projektet. Om du vill skapa ett Java-klientprogram måste följande JAR-filer läggas till i projektets klasssökväg:

    • adobe-backup-restore-client-sdk.jar
    • adobe-livecycle-client.jar
    • adobe-usermanager-client.jar
    • adobe-utilities.jar (krävs om AEM Forms körs på JBoss Application Server)
    • jbossall-client.jar (krävs om AEM Forms körs på JBoss Application Server)

  2. Skapa ett BackupService Client API-objekt

    Du använder ett ServiceClientFactory-objekt och BackupService-klient-API-objektet tillsammans.

    • Skapa ett ServiceClientFactory-objekt som innehåller anslutningsegenskaper. (Se Ange anslutningsegenskaper.)
    • Skapa ett BackupService-objekt med hjälp av dess konstruktor och skicka ServiceClientFactory-objektet som parameter.

  3. Ange säkerhetskopieringsläge

    Lämna säkerhetskopieringsläget genom att anropa metoden leaveBackupMode.

  4. Hämta information om sessionen för säkerhetskopieringsläge på servern

    Hämta information om åtgärden med det BackupModeResult-objekt som returneras. Den information du kan hämta när du har aktiverat säkerhetskopieringsläget kan vara användbar för integrering med dina säkerhetskopieringsprocedurer. Etiketten, säkerhetskopierings-ID:t och starttiden kan till exempel vara användbara som indata för filnamn för säkerhetskopieringsproceduren.