データローダガイド
jデータローダプロセスの設定パラメータ
| 使用可能なエディション: Salesforce Classic および Lightning Experience |
| 使用可能なエディション: Enterprise Edition、Performance Edition、Unlimited Edition、Developer Edition、および Database.com Edition |
コマンドラインからデータローダを実行するときに、次の設定パラメータを process-conf.xml ファイルに指定できます。場合によっては、 のグラフィカルユーザインターフェースにもパラメータが表示されます。
| パラメータ名 | データ型 | [設定] ダイアログにある同等のオプション | 説明 |
|---|---|---|---|
| dataAccess.readUTF8 | ブール型 | すべての CSV を UTF-8 エンコーディングで読み込む | このオプションを選択すると、保存されている文字コードの形式に関係なく、ファイルを強制的に UTF-8 文字コードで開きます。 サンプル値: true |
| dataAccess.writeUTF8 | ブール型 | すべての CSV を UTF-8 エンコーディングで書き出す | このオプションを選択すると、ファイルを強制的に UTF-8 文字コードで書き込みます。 サンプル値: true |
| dataAccess.name | 文字列型 | 該当データなし (N/A) | CSV ファイル名など、使用するデータソースの名前。データベースの場合、database-conf.xml にあるデータベース設定の名前を使用します。 サンプル値: c:\dataloader\data\extractLead.csv |
| dataAccess.readBatchSize | 整数 | なし | データベースから一度に読み取るレコード数。最大値は、200 です。 サンプル値: 50 |
| dataAccess.type | 文字列型 | なし | 標準またはカスタムのデータソース種別。標準タイプは、csvWriter、csvRead、databaseWrite、databaseRead です。 サンプル値: csvWrite |
| dataAccess.writeBatchSize | 整数 | なし | データベースから一度に書き込むレコード数。最大値は、2,000 です。パラメータ値が大きい場合、エラーが発生したときに、一括処理されているすべてのレコードがロールバックされることになるため、注意してください。それに対して、値が 1 に設定されていれば、レコードは (一括ではなく) 1 つずつ処理され、エラーはその 1 つのレコードに対してのエラーとなります。データベースへの書き込みの問題を診断する必要がある場合は、値を 1 に設定することをお勧めします。 サンプル値: 500 |
| process.enableExtractStatusOutput | ブール型 | エクスポート結果のステータスファイルを生成する | データをエクスポートするときに成功とエラーのファイルを生成する場合は、このオプションを選択します。 サンプル値: true |
| process.enableLastRunOutput | ブール型 | なし | データローダをバッチモードで実行しているときに、sendAccountsFile_lastRun.properties などの出力ファイルの生成を無効にできます。このタイプのファイルは、デフォルトで conf ディレクトリに保存されます。これらのファイルへの書き込みを停止するには、このオプションを false に設定します。 また、ファイルを保存するディレクトリの場所は、process.lastRunOutputDirectory を使用して変更できます。 サンプル値: true |
| process.encryptionKeyFile | 文字列 (ファイル名) | なし | 暗号化キーが入っているファイルの名前。「コマンドラインからの暗号化」を参照してください。 サンプル値: c:\dataloader\conf\my.key |
| process.initialLastRunDate | 日付 | なし |
process.lastRunDate パラメータの初期設定。SQL 文で使用でき、プロセスの実行が成功すると自動的に更新されます。日付形式の構文についての詳細は、「日付形式」を参照してください。 形式は yyyy-MM-ddTHH:mm:ss.SSS+/-HHmm です。たとえば、2006-04-13T13:50:32.423-0700 となります。 |
| process.lastRunOutputDirectory | 文字列 (ディレクトリ) | なし | データローダをバッチモードで実行しているときに、sendAccountsFile_lastRun.properties などの出力ファイルが書かれる場所を変更できます。このタイプのファイルは、デフォルトで \conf ディレクトリに保存されます。場所を変更するには、このオプションの値を、出力ファイルを書き込む場所のフルパスに変更します。 また、process.enableLastRunOutputを使用してファイルの書き込みを停止できます。 |
| process.loadRowToStartAt | 数字 | 開始行の位置 | 前回に実行した操作が失敗した場合に、最後に成功した操作の完了時点から開始するよう設定できます。 サンプル値: 1008 |
| process.mappingFile | 文字列 (ファイル名) | なし | 使用する項目の対応付けファイルの名前。「列の対応付け」を参照してください。 サンプル値: c:\dataloader\conf\accountExtractMap.sdl |
| process.operation | 文字列型 | なし | 実行する操作。「データローダのコマンドライン操作」を参照してください。 サンプル値: extract |
| process.statusOutputDirectory | 文字列 (ディレクトリ) | なし | 「成功」または「エラー」の出力ファイルを保存するディレクトリ。ファイル名は、process-conf.xml で他の方法を指定しない限り、操作ごとに自動的に生成されます。 サンプル値: c:\dataloader\status |
| process.outputError | 文字列 (ファイル名) | なし | 最新の操作によるエラーデータを保存する CSV ファイルの名前。 サンプル値: c:\dataloader\status\myProcessErrors.csv |
| process.outputSuccess | 文字列 (ファイル名) | なし | 最新の操作による成功データを保存する CSV ファイルの名前。「process.enableExtractStatusOutput」 も参照してください。 サンプル値: c:\dataloader\status\myProcessSuccesses.csv |
| process.useEuropeanDates | ブール型 | ヨーロッパの日付形式を使用 | このオプションを有効にすると、日付の形式として dd/MM/yyyy および dd/MM/yyyy HH:mm:ss が使用できます。 サンプル値: true |
| sfdc.assignmentRule | 文字列型 | 割り当てルール | 挿入、更新、更新/挿入に使う割り当てルールの ID を指定します。このオプションは、ケースとリードでの挿入、更新、更新/挿入に適用されます。また、取引先に対するテリトリー割り当てルールが組織にある場合、取引先の更新にも適用されます。割り当てルールは、CSV ファイルの [所有者] の値を上書きします。 サンプル値: 03Mc00000026J7w |
| sfdc.bulkApiCheckStatusInterval | 整数 | なし | 連続する次のチェックを待つ時間 (ミリ秒)。チェックでは、非同期の Bulk API 操作が完了しているかどうか、または処理したレコードの数を確認します。「sfdc.useBulkApi」を参照してください。値を 5000 にすることをお勧めします。 サンプル値: 5000 |
| sfdc.bulkApiSerialMode | ブール型 | 一括 API に対して順次モードを有効にする | このオプションを選択すると、Bulk API が並列処理ではなく、順次処理されます。並列処理を行うと、データベースの競合が生じる可能性があります。競合が激しいと、読み込みが失敗することがあります。順次モードを使用すれば、バッチは 1 つずつ確実に処理されます。ただし、このオプションを使用すると、読み込みの処理時間が大幅に増える場合があります。「sfdc.useBulkApi」を参照してください。 サンプル値: false |
| sfdc.bulkApiZipContent | ブール型 | Bulk API バッチを zip ファイルとしてアップロードする | Bulk API を使用して、添付ファイルレコードや Salesforce CRM Content などのバイナリ添付ファイルを含む zip ファイルをアップロードするには、このオプションを選択します。「sfdc.useBulkApi」を参照してください。 サンプル値: true |
| sfdc.connectionTimeoutSecs | 整数 | なし | API コール中の接続待ち時間 (秒)。 サンプル値: 60 |
| sfdc.debugMessages | ブール型 | なし | true の場合、SOAP メッセージデバッグを有効にします。デフォルトでは、sfdc.debugMessagesFile で他の場所を指定しない限り、メッセージは STDOUT に送信されます。 サンプル値: false |
| sfdc.debugMessagesFile | 文字列 (ファイル名) | なし |
「process.enableExtractStatusOutput」を参照してください。Salesforce で送受信する SOAP メッセージを保存します。メッセージを送信または受信すると、メッセージがファイルの最後に追加されます。ファイルにはサイズ制限がないため、使用できるディ���ク容量を監視してください。 サンプル値: \lexiloader\status\sfdcSoapTrace.log |
| sfdc.enableRetries | ブール型 | なし | true の場合、Salesforce サーバへの接続を繰り返し試行できます。「sfdc.maxRetries」および「sfdc.minRetrySleepSecs」を参照してください。 サンプル値: true |
| sfdc.endpoint | URL | サーバホスト | 通信対象となる Salesforce サーバの URL を入力します。たとえば、データを Sandbox に読み込む場合は、URL を https://test.salesforce.com に変更します。 本番のサンプル値: https://login.salesforce.com/services/Soap/u/40.0 |
| sfdc.entity | 文字列型 | なし | 操作で使用される Salesforce オブジェクト。 サンプル値: Lead |
| sfdc.externalIdField | 文字列型 | なし | 更新/挿入操作で使用されます。データを一致させるための一意の ID として使用される「External ID」(外部 ID) 属性を持つカスタム項目を指定します。 サンプル値: LegacySKU__c |
| sfdc.extractionRequestSize | 整数 | クエリ要求のサイズ | 一度のエクスポートまたはクエリ操作で Salesforce から返されるレコードは、このオプションで指定したサイズで増分されます。最大値は 2,000 です。値が大きいほどパフォーマンスは向上しますが、クライアントでのメモリ消費量が多くなります。 サンプル値: 500 |
| sfdc.extractionSOQL | 文字列型 | なし | データエクスポート用の SOQL クエリ。 サンプル値: SELECT Id, LastName, FirstName, Rating, AnnualRevenue, OwnerId FROM Lead |
| sfdc.insertNulls | ブール型 | null 値を挿入 | このオプションを選択すると、null 値として空白の対応値がデータ操作中に挿入されます。レコードを更新するときにこのオプションが有効になっていると、対応付けが行われた項目の既存データがデータローダによってすべて上書きされます。 サンプル値: false |
| sfdc.loadBatchSize | 整数 | バッチサイズ | 一度の挿入、更新、更新/挿入、削除操作で Salesforce に対して入出力されるレコードは、このオプションで指定したサイズで増分されます。最大値は、200 です。50 から 100 までの値をお勧めします。 サンプル値: 100 |
| sfdc.maxRetries | 整数 | なし | Salesforce への接続を繰り返し試行する場合の最大数。「sfdc.enableRetries」を参照してください。 サンプル値: 3 |
| sfdc.minRetrySleepSecs | 整数 | なし | 接続再試行の待ち時間の最少値 (秒数)。待ち時間は、試行ごとに増えていきます。「sfdc.enableRetries」 を参照してください。 サンプル値: 2 |
| sfdc.noCompression | ブール型 | 圧縮 | 圧縮はデータローダのパフォーマンスを向上させます。この機能はデフォルトで有効になっています。下層の SOAP メッセージのデバッグの際などには、圧縮の無効化が必要なこともあります。圧縮を無効にする場合は、このオプションを有効にします。 サンプル値: false |
| sfdc.password | 暗号化された文字列 | なし |
sfdc.username で指定したユーザ名に対応する暗号化された Salesforce パスワード。「コマンドラインからの暗号化」も参照してください。 サンプル値: 4285b36161c65a22 |
| sfdc.proxyHost | URL | プロキシホスト | プロキシサーバのホスト名です (該当する場合のみ)。 サンプル値: http://myproxy.internal.company.com |
| sfdc.proxyPassword | 暗号化された文字列 | プロキシパスワード |
sfdc.proxyUsername で指定したプロキシユーザ名に対応する暗号化されたパスワード。「コマンドラインからの暗号化」も参照してください。 サンプル値: 4285b36161c65a22 |
| sfdc.proxyPort | 整数 | プロキシポート | プロキシサーバのポートです。 サンプル値: 8000 |
| sfdc.proxyUsername | 文字列型 | プロキシユーザ名 | プロキシサーバ認証用のユーザ名です。 サンプル値: jane.doe |
| sfdc.resetUrlOnLogin | ブール型 | ログイン時に URL をリセット | デフォルトでは、Salesforce は sfdc.endpoint で指定した URL にログインした後、その URL をリセットします。この自動リセットを無効にするには、このオプションを false に設定して無効にします。 有効な値: true (デフォルト)、false |
| sfdc.timeoutSecs | 整数 | タイムアウト | 要求のエラーが返されるまでに、データローダがサーバからの応答を待つ時間を秒数で指定します。 サンプル値: 540 |
| sfdc.timezone | 文字列型 | タイムゾーン |
日付値にタイムゾーンが含まれない場合は、この値が使用されます。
Java で書かれている TimeZone.getDefault() メソッドを実行して、デフォルト値を取得できます。この値は、データローダがインストールされたコンピュータのタイムゾーンです。 |
| sfdc.truncateFields | ブール型 | 項目の切り捨てを許可 | このオプションを選択すると、データが Salesforce に読み込まれたときに、メール、複数選択の選択リスト、電話、選択リスト、テキスト、および暗号化テキストの項目のデータを切り捨てます。 バージョン 14.0 以前のデータローダでは、データが大きすぎる場合にはデータローダが、これらの種類の項目の値を切り捨てます。バージョン 15.0 以降のデータローダでは、指定された値が大きすぎる場合の読み込み処理がエラーになります。 このオプションを指定すると、バージョン 15.0 以降のデータローダでの新しい動作ではなく、以前の動作である切り取りを使用するように指定できます。このオプションはデフォルトで選択されており、バージョン 14.0 以前の製品には無効です。 [Bulk API を使用] オプションがオンの場合、このオプションは使用できません。この場合、項目に対して大きすぎる値が指定されると、その行の読み込み処理は失敗します。 サンプル値: true |
| sfdc.useBulkApi | ブール型 | Bulk API を使用 | このオプションを選択すると、Bulk API を使用して、レコードの挿入、更新、更新/挿入、削除、および物理削除が行われます。Bulk API は、多数のレコードを非同期で読み込みまたは削除するように最適化されます。この API は並列処理を行い、ネットワーク往復数を少なくすることで、デフォルトの SOAP ベースの API よりも高速に動作します。「sfdc.bulkApiSerialMode」も参照してください。 サンプル値: true |
| sfdc.username | 文字列型 | なし | Salesforce ユーザ名。「sfdc.password」を参照してください。 サンプル値: jdoe@mycompany.com |