Salesforce データ アーカイバーの設定
Salesforce Data Archiver の設定は、次の情報を含むアーカイブ セットとして保存されます。
- プロジェクトの詳細
- スケジュールと保存期間
- データを選択するための Salesforce Object Query Language (SOQL) クエリ
- 通知
- バイパスしたい検証
はじめに
Salesforce Data Archiver の適切なライセンスがあることを確認してください。詳細については、ライセンスの詳細を参照してください。
[ Data Archiver ] タブが表示されない場合は、追加設定が必要です。
Salesforce の設定
Salesforce AppExchange からSalesforce アプリをインストールする新規のお客様の場合、追加の手順は必要ありません。Salesforce アプリ管理パッケージのインストール プロセスでは、システム管理者、標準ユーザーなどの標準プロファイルに必要な権限が設定されます。
すでにSalesforce Appを使用している場合、Salesforce AppExchange からインストールされた管理パッケージをアップグレードすると、[ Data Archiver ] タブが表示されないことがあります。これは、Salesforce がアップグレード時にシステム管理者、標準ユーザーなどの標準プロファイルの権限を更新することを許可していないためです。
次の 2 つの方法のいずれかを使用して、Salesforce 環境の権限を手動で設定する必要があります。
-
管理パッケージを再インストールする
-
プロファイルの権限を手動で更新する
管理パッケージを再インストールする
管理パッケージをアップグレードする代わりに、再インストールを行います。
注: 再インストールしても、既存のデータや構成は削除されません。権限のみが更新されます。
この手順の後、 Salesforce AppにData Archiverタブが表示されます。
アクセス許可を手動で更新する
手順
-
Salesforce 環境にログインし、[Settings] に移動します。
-
左側のQuick Find (クイック検索) ボックスで、プロファイルの入力を開始し、Salesforce Data Archiver に使用するプロファイルを選択します。
-
[Apex Class Access] を選択し、[Edit] をクリックします。
-
DataArchivalAuraControllerクラスを追加し、 [Save] をクリックします。
-
左側のQuick Find (クイック検索) ボックスで、プロファイルの入力を開始し、Salesforce Data Archiver に使用するプロファイルを選択します。
-
プロファイルの検索ボックスにData Archiverと入力し、[Edit] をクリックして、[Tab Settings] を [Default On] に変更します。
外部リソース
アーカイブ セットを作成する
Data Archiver をクリックし、Salesforce アプリケーション コンソールで [新しいアーカイブ セット] をクリックします。手順 1 ~ 5 に従って、新しいアーカイブ セットを作成します。
アーカイブ セットは必要な数だけ作成できます。
手順 1. アーカイブ セットの基本的な詳細
オプション | 説明 |
---|---|
Project |
アーカイブに使用するプロジェクトを選択します。 プロジェクトの詳細については、プロジェクトの作成を参照してください。 |
Region |
アーカイブ データの保存リージョンは、プロジェクト レベルで定義されているため、変更できません。 プロジェクトの詳細については、プロジェクトの作成を参照してください。 |
Source Organization | アーカイブするレコードを含む組織 (Organization) を選択します。 |
Archive Set Name |
アーカイブ セット名は自動的に生成されますが、編集することができます。 |
手順 2: スケジュールと保存期間を指定する
[ Schedule and Retention ] タブを使用して、データ アーカイブをいつ実行し、どのくらいの頻度で繰り返すかを構成します。
スケジュールされたジョブの開始を待ちたくない場合、アーカイブ タスクを手動で実行できます。詳細については、「手動アーカイブのトリガー」を参照してください。
オプション | 説明 |
---|---|
Scheduling Frequency (スケジューリング頻度) |
頻度は次のいずれかに設定できます。
|
Start Day and Start Time (開始日と開始時刻) |
日付と時刻のセレクターを使用して、最初の実行をスケジュールできます。
|
Retention (保存期間) |
保存期間は、1 年から 10 年の間で指定できます。また、forever (永久) として選択することもできます。
|
手順 3: アーカイブするレコードを選択する
[アーカイブ コンテンツ] タブを使用して、アーカイブするオブジェクトを構成します。つまり、SOQL (Salesforce Object Query Language)クエリを作成して、オブジェクトごとにアーカイブするレコードを選択します。
手順
-
アーカイブするオブジェクトを選択します。
オブジェクトを選択すると、クエリ ビルダー画面が表示されます。 -
クエリのwhere 句とレコード制限を指定し ます。
詳細については、クエリ ビルダーの使用を参照してください。 -
除外するフィールド、インデックス フィールド、子オブジェクトなどの高度な設定情報を指定します。
詳細については、高度な構成を参照してください。 -
必要に応じて、このクエリで選択されたレコードをプレビューします。
詳細については、「レコードのプレビュー」を参照してください。 -
アーカイブするすべてのオブジェクトが構成されるまで、手順 1 ~ 4 を繰り返します。
クエリ ビルダーの使用
クエリビルダーは、SOQL クエリとレコード制限のwhere 句を作成します。すべてのフィールドがアーカイブされるため、個々のフィールドを指定する必要はありません。
注: デフォルトでは、すべてのフィールドが選択されています。特定のフィールドを除外する場合は、詳細設定を参照してください。
オブジェクトを選択すると、クエリ ビルダーは、アーカイブするレコードを選択する 2 つの方法を提供します。
- Basic - 基本クエリビルダーによって、単純なインターフェースを使用して SOQL クエリ のwhere 句 を構築します。
- Advanced - Advanced オプションによって、 SOQL構文 を使用してwhere句とレコード制限を記述します。
記録制限
オプション |
説明 |
---|---|
Record Limit |
クエリを使用して取得するレコードの最大数を選択します。
アーカイブされるレコードの最大数は、この手順で設定されたレコード制限によって決まります。 |
フィールドの設定
追加するフィールドごとに、次のオプションを使用できます。
オプション |
説明 |
---|---|
Field Name |
フィールド名は、選択したオブジェクトに基づいて使用できます。 |
Operator |
演算子は、選択したフィールドのデータ型に基づいて使用できます。 日時フィールドを選択した場合、使用可能な演算子は次のとおりです。
他のフィールドを選択すると、使用可能な演算子は次のようになります。
すべての演算子がすべてのフィールド タイプで機能するとは限りません。プレビュー オプションを使用して、クエリが期待どおりに機能していることを確認します。 |
Date Time Operator |
使用可能な値は次のとおりです。
|
Relative Value |
Date Time演算子の値を指定します。 たとえば、 5 年以上前のレコードを選択 するwhere句を作成するには、Date Time OperatorとしてLAST_N_YEARSを選択し、Relative Valueとして5を選択します。 |
Date |
カレンダー アイコンを使用して、希望の日付を選択します。 |
Value |
前述のDate Time演算子セレクターの値を指定します。 |
Delete |
フィールドと、関連する選択基準をクエリから削除できます。 各フィールドの削除アイコンが表示されます。 |
項目値を更新すると、SOQLクエリのプレビューが表示されます。このクエリをクイック リファレンス ガイドとして使用して、クエリが目的のレコードを選択するかどうかを検証できます。
論理演算子とグループ
AND & OR の 2 つの論理演算子のいずれかを指定することで、さらにフィールドを追加できます。
ブラケットのペアを作成するグループを作成することもできます。その後、個々のフィールドを追加できます。
AND & OR演算子には 、 SOQLクエリ構文でいくつかの注意事項があります。詳細については、考慮事項を参照してください。
手順を含む SOQLクエリ の例
次の例では、 Accountオブジェクト が選択されていることを前提としています。
詳細オプションを使用している場合は、 SELECT ... FROM Account WHERE でクエリを開始 しないでください。これは、アプリケーションによって追加されます。同様に Limit オプションは使用しないでください。クエリ ビルダーは、where句を作成するためだけのものです。これは、BasicオプションとAdvancedオプションの両方に適用されます。
詳細オプションのクエリ |
基本オプションの手順 |
---|---|
CreatedDate < LAST_N_YEARS:2 AND BillingState = 'TX' |
|
BillingState = 'TX' OR BillingState = 'SC' |
|
CreatedDate < LAST_N_YEARS:2 AND ( BillingState = 'TX' OR BillingState = 'SC') |
|
注: クエリ ビルダからオブジェクトを削除すると、作成中のクエリだけが変更されます。このアクションでは、以前にアーカイブされたデータの変更は行われません。
プレビュー レコード
基本クエリ ビルダまたは高度なクエリ ビルダを使用してフィールドを指定した後、 [Preview & Verify Content]を選択して、クエリの結果をプレビューできます。
常にクエリをプレビューして確認してください。作成したクエリが正しいことを確認するのに役立ちます。詳細については、 考慮事項を参照してください。
この画面では、次のフィールドを使用できます。
オプション |
説明 |
---|---|
Summary |
最初のセクションには、オブジェクト名、SOQLクエリ、および選択されたレコードの合計数が表示されます |
Preview Table |
このテーブルは、SOQLクエリによって選択されたレコードを示しています。
|
Where Clause |
where句を使用して、選択したレコードのサブセットを表示します。
|
Column Selection |
プレビューに表示される列をカスタマイズできます。 |
Advanced configuration (詳細設定)
このセクションでは、次の構成を指定できます。
オプション |
説明 |
---|---|
Exclude Fields |
デフォルトでは、すべてのフィールドがアーカイブされます。 特定のフィールドをアーカイブから除外する場合は、それらすべてのフィールドを 1 つずつ選択します。 特定のフィールドをアーカイブから除外するように指定すると、それらのフィールドの値はアーカイブ データで使用できなくなります。このレコードはアーカイブ後に Salesforce から削除されます。その結果、この値はどこにも存在しなくなります。 |
Index Fields |
Salesforce Data Archiver は、デフォルトで次のフィールドをインデックス化します。
インデックス作成用に最大 4 つのフィールドを追加できます。 |
Child Objects to Archived |
デフォルトでは、アプリケーションは必須の子オブジェクトをすべてアーカイブします。 これらのオブジェクトは事前に選択され、強調表示されます。 他の子オブジェクトをアーカイブする場合は、それらすべてのオブジェクトを 1 つずつ選択できます。
|
手順 4: 通知
[Notification] タブを使用して、誰にいつ通知するかを設定します。
次のイベントで通知を受け取るユーザーを選択できます。
- Successful Archival (アーカイブ成功)
- Failed Archival (アーカイブ失敗)
- Successful Archival Restore (アーカイブの復元成功)
- Failed Archival Restore (アーカイブの復元失敗)
すべてのユーザーに対して、SMS または電子メールのいずれかを選択する必要があります。そうしないと、通知が送信されません。
手順 5: 検証
Salesforce での検証では、レコードを保存する前に、定義されたフィールド ガイドラインを満たすようにデータを評価します。アーカイブ処理中にレコードが Salesforce から削除されない場合は、検証を無効にすると改善されることがあります。
検証を無効にするには、次の手順を実行します。
-
アーカイブ中に検証を無効にするチェックボックスを選択します
-
ドロップダウン リストから検証タイプを選択します。選択した検証タイプのメタデータ リストが表示されます。
-
リストから項目を選択します。
-
必要なすべての検証タイプについて、手順 2 と 3 を繰り返します。
詳細については、 検証を参照してください。
手順 6: アーカイブ セットを保存する
アーカイブ セットを保存すると、アーカイブ ジョブがスケジュールされます。
アーカイブされたデータを確認し、いつでもアーカイブ ジョブのステータスを確認できます。詳細については、「アーカイブ セットの管理」を参照してください。
次のアーカイブ ジョブは、[Schedule] タブで選択したスケジュールされたタブで実行されます。
考慮事項
SOQLクエリの検証
かっこを使用してグループ化されていない限り、 SOQL クエリに AND 演算子を OR 演算子と共に含めることはできません。たとえば、次のクエリは有効なSOQLクエリではありません。
SELECT .. FROM Account WHERE type='Customer' AND BillingState='NY' OR ShippingState='NY'
かっこを使用して、OR 演算子と AND 演算子の両方を使用する有効なクエリを作成できます。
SELECT .. FROM Account WHERE type='Customer' AND (BillingState='NY' OR ShippingState='NY')
クエリ ビルダーは、このような無効なクエリの作成を阻止しません。作成しているクエリが有効な SOQL クエリであることを確認してください。Salesforce Data Archiver は、クエリ ビルダー ページの [Preview and Verity Content] オプションを使用してクエリを検証するのに役立ちます。
必要なクエリを作成できない場合は 、高度なクエリ オプションでクエリのwhere句を入力します。
ContentDocumentオブジェクトのアーカイブ
Accountなどのアーカイブ対象のオブジェクトを選択すると、子オブジェクトもアーカイブされます。必要なのは、クエリ ビルダーの [Advanced Configuration] セクションで子オブジェクトが選択されていることを確認することだけです。
ContentDocumentオブジェクトは例外であり、 アーカイブ用に個別に選択する必要があります。
1 つのアーカイブ セットに、複数のオブジェクトに対するクエリを含めることができます。たとえば、新しいアーカイブ セットの [Archival Content] タブで、 Account オブジェクトとContentDocumentオブジェクトの両方を選択できます。