AEM Formsのバックアップの準備

このドキュメントのサンプルと例は、JEE上のAEM Forms環境に限られています。

バックアップと復元サービスについて

バックアップと復元サービスを使用すると、AEM Formsを​バックアップモード​にすることができ、これによりホットバックアップを実行できます。 バックアップと復元サービスは、実際にはAEM Formsのバックアップを実行したり、システムを復元したりしません。 代わりに、サーバを一貫性と信頼性の高いバックアップの状態にし、サーバを引き続き実行できるようにします。 グローバルドキュメントストレージ(GDS)とformsサーバーに接続されたデータベースをバックアップするアクションは、ユーザーが担当します。 GDSは、長期間有効なプロセス内で使用されるファイルの保存に使用されるディレクトリです。

バックアップモードとは、バックアップ手順の実行中にGDS内のファイルがパージされないように、サーバーが起動する状態です。 代わりに、GDSディレクトリの下にサブディレクトリが作成され、保存バックアップモードの終了後にパージされるファイルの記録が維持されます。 ファイルは、システムの再起動後も何日もまたは何年も続く可能性があり、 これらのファイルは、formsサーバーの全体的な状態の重要な部分であり、PDFファイル、ポリシー、フォームテンプレートなどが含まれる場合があります。 これらのファイルが失われたり破損したりした場合は、formsサーバー上のプロセスが不安定になり、データが失われる可能性があります。

スナップショット・バックアップを実行する場合は、通常、一定期間バックアップ・モードに入り、バックアップ・アクティビティの完了後にバックアップ・モードを終了します。 バックアップモードを終了すると、ファイルが不必要に大きくならないようにGDSからパージされる必要があります。 バックアップモードを明示的に終了するか、バックアップモードセッションで期限が切れるまで待つことができます。

また、サーバを永続バックアップモードのままにすることもできます。これは、ローリングバックアップや継続的なシステム有効範囲のバックアップ戦略に典型的なものです。 ローリングバックアップモードは、システムが常にバックアップモードになり、前のセッションが解放されるとすぐに新しいバックアップモードセッションが開始されることを示します。 連続バックアップモードの場合、ファイルは2回のバックアップモードセッションの後にパージされ、参照されなくなります。

Backup and Restoreサービスを使用して、既存のアプリケーションや、Formsサーバーに接続されたGDSまたはデータベースのバックアップを実行するために作成する新しいアプリケーションに追加できます。

バックアップと復元サービスを使用して、次のタスクを実行できます。

• バックアップモードに入ります。
• バックアップモードを終了します。

formsサーバーのバックアップモードに入ります

formsサーバーのホットバックアップを許可するには、バックアップモードに入ります。 バックアップモードに入ると、組織のバックアップ手順に基づいて次の情報を指定します。

• バックアップ・プロセスに役立つバックアップ・モード・セッションを識別する一意のラベル。
• バックアップ手順が完了する時刻。
• 連続バックアップモードにするかどうかを示すフラグ。ローリングバックアップを実行する場合にのみ役立ちます。

アプリケーションをバックアップモードにする前に、formsサーバーをバックアップモードにした後に使用するバックアップ手順を理解しておくことをお勧めします。 AEM Formsのバックアップを実行する際に考慮すべき点について詳しくは、管理ヘルプを参照してください。

手順の概要

バックアップ・モードに入るアプリケーションを作成するには、次の手順を実行します。

1. プロジェクトファイルを含めます。
2. BackupServiceクライアントオブジェクトを作成します。
3. 一意のラベル、バックアップの実行時間、継続的なバックアップ・モードにするかどうかを決定します。
4. バックアップモードに入ります。
5. （オプション）サーバー上のバックアップモードセッションに関する情報を取得します。
6. GDS（グローバルデータストア）とデータベースのバックアップを実行します。

プロジェクトファイルを含める

必要なファイルを開発プロジェクトに含めます。 これらのファイルは、コードを正しくコンパイルし、バックアップと復元サービスAPIを使用するために、プロジェクトに含めることが重要です。

これらのファイルの場所については、AEM Forms Java ライブラリファイルを含めるを参照してください。

BackupService Client APIオブジェクトの作成

プログラムによるバックアップモードを終了するには、Backup and Restore Service APIを使用するBackupServiceクライアントオブジェクトを作成します。

一意のラベルを決定し、バックアップを実行する時間を決定し、連続バックアップ・モードにするかどうかを決定

バックアップモードに入る前に、固有のラベルを決定し、バックアップの実行に割り当てる時間を決定し、formsサーバーをバックアップモードのままにするかどうかを決定する必要があります。 これらの考慮事項は、お客様の組織が確立したバックアップ手順と統合する際に重要です。 （管理ヘルプを参照）。

バックアップモードの開始

組織のバックアップ手順と一致するパラメータを使用して、バックアップモードに入ります。

サーバ上のバックアップ・モード・セッションに関する情報を取得する

バックアップモードに入った後、セッションに関する情報を取得できます。 この情報は、バックアップ手順との統合に使用できます

GDSとデータベースのバックアップの実行

バックアップモードに正常に入ったら、グローバルドキュメントストレージ(GDS)とformsサーバーが接続されているデータベースのバックアップを実行できます。 この手順は組織に固有のものです。これは、この手順を手動で実行するか、他のツールを実行してバックアップ手順を実行できるからです。

Java APIを使用してバックアップモードに入ります

バックアップと復元サービスAPIを使用して、バックアップモードに入ります。

1. プロジェクトファイルを含める

   必要なクライアントJARファイル（ adobe-backup-restore-client-sdk.jarなど）をJavaプロジェクトのクラスパスに含めます。 Javaクライアントアプリケーションを作成するには、次のJARファイルをプロジェクトのクラスパスに追加する必要があります。

   • adobe-backup-restore-client-sdk.jar
   • adobe-livecycle-client.jar
   • adobe-usermanager-client.jar
   • adobe-utilities.jar(AEM FormsがJBoss Application Serverにデプロイされている場合に必要)
   • jbossall-client.jar(AEM FormsがJBoss Application Serverにデプロイされている場合に必要)

2. BackupService Client APIオブジェクトの作成

   ServiceClientFactoryオブジェクトとBackupServiceクライアントAPIオブジェクトを一緒に使用します。

   • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。（接続プロパティの設定を参照。）
   • コンストラクターを使用してBackupServiceオブジェクトを渡し、ServiceClientFactoryオブジェクトを作成します。

3. 一意のラベルを決定し、バックアップを実行する時間を決定し、連続バックアップ・モードにするかどうかを決定

   一意のラベルを決定し、バックアップの実行に割り当てる時間を決定し、formsサーバーを連続バックアップモードにするかどうかを決定します。

4. バックアップモードの開始

   enterBackupModeメソッドを次のパラメーターで呼び出して、バックアップモードに入ります。

   • バックアップモードセッションを識別する、人間が読み取り可能な一意のラベルを指定するString値。 XML形式にエンコードできないスペースや文字は使用しないことをお勧めします。

   • バックアップモードで維持する時間（分）を指定するint値。 1 ～ 10080の値（1週間の分数）を指定できます。 連続バックアップモードを使用する場合、この値は無視されます。

   • 連続バックアップモードにするかどうかを指定するBoolean値。 Trueの値は連続バックアップモードであることを指定します。 連続バックアップモードの場合、バックアップモードに維持する分数に指定した値は無視されます。

     連続バックアップモードとは、現在のバックアップモードが完了した後に、新しいバックアップモードセッションが開始されることを意味します。 値Falseは、連続バックアップモードが使用されないことを意味し、バックアップモードを終了した後、GDSからのファイルのパージが再開されます。

5. サーバ上のバックアップ・モード・セッションに関する情報を取得する

   enterBackupModeメソッドを呼び出した後に返されるBackupModeEntryResultオブジェクトを使用して情報を取得します。 バックアップモードに入った後に取得できる情報は、バックアップ手順との統合に役立つ場合があります。 例えば、ラベル、バックアップID、開始時刻は、バックアップ手順のファイル名の入力として役立つ場合があります。

6. GDSとデータベースのバックアップの実行

   グローバルドキュメントストレージ(GDS)と、Formsサーバーが接続されているデータベースをバックアップします。 バックアップを実行するアクションは、AEM Forms SDKには含まれておらず、組織内のバックアップ手順に固有の手動手順も含まれている場合があります。

WebサービスAPIを使用してバックアップモードに入ります

バックアップと復元サービスAPIが提供するWebサービスを使用して、バックアップモードに入ります。

1. プロジェクトファイルを含める

   • Backup and Restore Service API WSDLを使用するMicrosoft .NETクライアントアセンブリを作成します。
   • Microsoft .NETクライアントアセンブリを参照します。

2. BackupService Client APIオブジェクトの作成

   Microsoft .NETクライアントアセンブリを使用して、デフォルトのコンストラクタを呼び出し、Credentialsメソッドを使用して資格情報を指定して、BackupServiceServiceオブジェクトを作成します。

3. 一意のラベルを決定し、バックアップを実行する時間を決定し、連続バックアップ・モードにするかどうかを決定

   一意のラベルを決定し、バックアップの実行に割り当てる時間を決定し、formsサーバーを連続バックアップモードにするかどうかを決定します。

4. バックアップモードの開始

   バックアップモードに入るには、 enterBackupModeメソッドを呼び出して、次の値を渡します。

   • バックアップモードセッションを識別する、人間が読み取り可能な一意のラベルを指定するString値。 XML形式にエンコードできないスペースや文字は使用しないことをお勧めします。

   • バックアップモードで維持する時間（分）を指定するUint32値。 1 ～ 10080の値（1週間の分数）を指定できます。 連続バックアップモードを使用する場合、この値は無視されます。

   • 連続バックアップモードにするかどうかを指定するBoolean値。 Trueの値は連続バックアップモードであることを指定します。 連続バックアップモードの場合、バックアップモードに維持する分数に指定した値は無視されます。 連続バックアップモードとは、現在のバックアップモードが完了した後に、新しいバックアップモードセッションが開始されることを意味します。

     値Falseは、連続バックアップモードが使用されないことを意味し、バックアップモードを終了した後、GDSからのファイルのパージが再開されます。

5. サーバ上のバックアップ・モード・セッションに関する情報を取得する

   成功したことを検証するために返されるBackupModeEntryResultからenterBackupModeメソッドを呼び出した後、バックアップモードセッションに関する情報を取得します。 バックアップモードに入った後に取得できる情報は、バックアップ手順との統合に役立つ場合があります。 例えば、ラベル、バックアップID、開始時刻は、バックアップ手順のファイル名の入力として役立つ場合があります。

6. GDSとデータベースのバックアップの実行

   グローバルドキュメントストレージ(GDS)と、Formsサーバーが接続されているデータベースをバックアップします。 バックアップを実行するアクションは、AEM Forms SDKには含まれておらず、組織内のバックアップ手順に固有の手動手順も含まれている場合があります。

formsサーバーへのバックアップモードの終了

FormsサーバーがFormsサーバー上のGDS（グローバルドキュメントストレージ）からのファイルのパージを再開できるように、バックアップモードを終了します。

アプリケーションを終了モードにする前に、AEM Formsで使用されるバックアップ手順を理解しておくことをお勧めします。 AEM Formsのバックアップを実行する際に考慮すべき点について詳しくは、管理ヘルプを参照してください。

手順の概要

バックアップモードを終了するには、次の手順を実行します。

1. プロジェクトファイルを含めます。
2. BackupServiceクライアントオブジェクトを作成します。
3. バックアップモードを終了します。
4. （オプション）formsサーバー上で実行されていたバックアップモードセッションに関する情報を取得します。

プロジェクトファイルを含める

開発プロジェクトに必要なファイルをすべて含めます。 これらのファイルは、コードを正しくコンパイルし、バックアップと復元サービスAPIを使用する際に重要です。

これらのファイルの場所については、AEM Forms Java ライブラリファイルを含めるを参照してください。

BackupService Client APIオブジェクトの作成

プログラムによるバックアップモードを終了するには、Backup and Restore Service APIを使用するBackupServiceクライアントオブジェクトを作成します。

バックアップモードを終了

バックアップモードを終了すると、グローバルドキュメントストレージ(GDS)からのファイルの通常のパージが再開されます。 バックアップモードを終了する前に、バックアップ手順が完了したことを確認する必要があります。

終了したバックアップモードセッションに関する情報を取得します

バックアップモードを終了した後、セッションに関する情報を取得できます。 この情報は、バックアップ手順との統合に使用できます。

Java APIを使用してバックアップモードを終了します

バックアップと復元サービスAPI(Java)を使用して、バックアップモードを終了します。

1. プロジェクトファイルを含める

   必要なクライアントJARファイル（ adobe-backup-restore-client-sdk.jarなど）をJavaプロジェクトのクラスパスに含めます。 Javaクライアントアプリケーションを作成するには、次のJARファイルをプロジェクトのクラスパスに追加する必要があります。

   • adobe-backup-restore-client-sdk.jar
   • adobe-livecycle-client.jar
   • adobe-usermanager-client.jar
   • adobe-utilities.jar(AEM FormsがJBoss Application Serverにデプロイされている場合に必要)
   • jbossall-client.jar(AEM FormsがJBoss Application Serverにデプロイされている場合に必要)

2. BackupService Client APIオブジェクトの作成

   ServiceClientFactoryオブジェクトとBackupServiceクライアントAPIオブジェクトを一緒に使用します。

   • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。（接続プロパティの設定を参照。）
   • コンストラクターを使用し、ServiceClientFactoryオブジェクトをパラメーターとして渡して、BackupServiceオブジェクトを作成します。

3. バックアップモードの開始

   leaveBackupModeメソッドを呼び出して、バックアップモードを終了します。

4. サーバ上のバックアップ・モード・セッションに関する情報を取得する

   返されるBackupModeResultオブジェクトを使用して、操作に関する情報を取得します。 バックアップモードに入った後に取得できる情報は、バックアップ手順との統合に役立つ場合があります。 例えば、ラベル、バックアップID、開始時刻は、バックアップ手順のファイル名の入力として役立つ場合があります。

WebサービスAPIを使用してバックアップモードを終了します

バックアップと復元サービスAPI（Webサービス）を使用して、バックアップモードを終了します。

1. プロジェクトファイルを含める

   Webサービスを使用するには、必ずプロキシファイルを含める必要があります。 バックアップと復元サービスAPIをWebサービスとして使用するようにプロジェクトを設定するには、次の手順に従います。

   • Backup and Restore Service API WSDLを使用するMicrosoft .NETクライアントアセンブリを作成します。
   • Microsoft .NETクライアントアセンブリを参照します。

2. BackupService Client APIオブジェクトの作成

   Microsoft .NETクライアントアセンブリを使用して、デフォルトのコンストラクタを呼び出してBackupServiceServiceオブジェクトを作成します。

3. バックアップモードの開始

   leaveBackupMode Webサービス操作を呼び出して、バックアップモードを終了します。

4. サーバ上のバックアップ・モード・セッションに関する情報を取得する

   操作後にバックアップモード識別子を取得し、正常に実行されたことを確認します。 バックアップモードを終了した後に取得できる情報は、バックアップ手順との統合に役立つ場合があります。