tSalesforceInputの標準プロパティ

[Property Type] (プロパティタイプ)

接続の詳細を設定する方法を選択します。

• [Built-In] (組み込み): このコンポーネントの接続の詳細がローカルに設定されます。関連するすべての接続のプロパティ値を手動で指定する必要があります。

• [Repository] (リポジトリー): [Repository] (リポジトリー) > [Metadata] (メタデータ)で一元的に保存された接続の詳細が、このコンポーネントによって再使用されます。このチェックボックスの横にある [...] ボタンをクリックし、表示された [Repository Content] (リポジトリーのコンテンツ)ダイアログボックスで、再使用する接続の詳細を選択すると、関連するすべての接続のプロパティに値が自動的に入力されます。

[Connection Component] (接続コンポーネント)ドロップダウンリストから、他の接続コンポーネントを選択した場合、このプロパティは、利用できません。

[Connection Component] (接続コンポーネント)

このコンポーネントで再利用するデータベース接続を開くコンポーネントを選択します。

[Connection type] (接続タイプ)

ドロップダウンリストから、接続のタイプを選択します。接続のプロパティは、選択した接続タイプによって異なります。

• [Basic] (基本): Salesforceのユーザー名とパスワードを入力してSalesforceにアクセスするには、このオプションを選択します。

• OAuth: OAuth (Open Authorization) 2.0プロトコルを使ってSalesforceにアクセスし、ユーザーを認証するには、このオプションを選択します。表示される[Oauth2 flow type] (Oauth2フロータイプ)ドロップダウンリストから、[Json Web Token Flow] (Json Webトークンフロー)または[Implicit Flow (Deprecated)] (Implicitフロー(非推奨)) (ユーザーエージェントフロー)のいずれかのOAuth 2.0認証フロータイプを選択する必要があります。この方法でSalesforceで接続アプリケーションを作成して、Salesforce認証プロバイダーを設定する必要があります。

  OAuth認証フローの詳細は、Authenticate Apps with OAuth (英語のみ)をご覧ください。

  Salesforceで接続アプリケーションを作成する方法は、接続アプリケーションを作成 (英語のみ)をご覧ください。

[User Id] (ユーザーID)

Salesforceのユーザー名。

このプロパティは、[Basic] (基本)接続タイプが選択されている場合のみ利用できます。

[Password] (パスワード)

ユーザー名に関連付けられたSalesforceのパスワード。

このプロパティは、[Basic] (基本)接続タイプが選択されている場合のみ利用できます。

[Security Token] (セキュリティトークン)

Salesforceのセキュリティトークン。詳細は、セキュリティトークンのリセット (英語のみ)をご覧ください。

このプロパティは、[Basic] (基本)接続タイプが選択されている場合のみ利用できます。

[Mutual authentication] (相互認証)

このオプションを選択すると、Salesforceへの接続を確立するための相互認証を有効にできます。

このオプションは、[Connection type] (接続タイプ)ドロップダウンリストから、[Basic] (基本)を選択した場合に利用できます。

デフォルトでは、このオプションは選択されていません。

[Mutual auth keystore] (相互認証キーストア)

相互認証Keystoreファイル(キーと証明書を含むパスワードで保護されたファイル)へのパスを入力します。

このオプションは、[Mutual authentication] (相互認証)が選択されている場合に使用できます。

[Mutual auth keystore password] (相互認証キーストアパスワード)

相互認証Keystoreファイルのパスワードを入力します。

このオプションは、[Mutual authentication] (相互認証)が選択されている場合に使用できます。

[Issuer] (発行者)

接続アプリケーションが作成され、Salesforceの接続アプリケーションの詳細ページに表示される時に生成されるOAuthコンシューマーキー。詳細は、接続アプリケーションを作成 (英語のみ)をご覧ください。

このプロパティは、[Json Web Token Flow] (Json Webトークンフロー)タイプが選択されている場合のみ利用できます。

[Subject] (件名)

Salesforceのユーザー名。

このプロパティは、[Json Web Token Flow] (Json Webトークンフロー)タイプが選択されている場合のみ利用できます。

[Audience] (オーディエンス)

Json Webトークンのオーディエンス。

独自のJson Webトークンオーディエンスを設定できます。

このプロパティは、[Connection type] (接続タイプ)ドロップダウンリストから、[OAuth]が、[Oauth2 flow type] (Oauth2フロータイプ)ドロップダウンリストから、[Json Web Token Flow] (Json Webトークンフロー)が選択されている場合のみ利用できます。

[Expiration time (in seconds)] (有効期限(秒))

5分以内のアサーションの有効期限(秒)。

このプロパティは、[Json Web Token Flow] (Json Webトークンフロー)タイプが選択されている場合のみ利用できます。

[Key store] (キーストア)

Java KeyStore (JKS)形式のキーストアファイルへのパス。

Keystoreファイルは、Salesforceによって署名された証明書を作成し、それをKeystoreにエクスポートすることで生成できます。詳細は、自己署名証明書の生成 (英語のみ)をご覧ください。

このプロパティは、[Json Web Token Flow] (Json Webトークンフロー)タイプが選択されている場合のみ利用できます。

[KeyStore password] (KeyStoreパスワード)

Keystoreのパスワード。

このプロパティは、[Json Web Token Flow] (Json Webトークンフロー)タイプが選択されている場合のみ利用できます。

[Certificate alias] (証明書の別名)

Salesforceによって署名された証明書の一意の名前。

このプロパティは、[Json Web Token Flow] (Json Webトークンフロー)タイプが選択されている場合のみ利用できます。

[Client Id] (クライアントID)

接続アプリケーションが作成され、Salesforceの接続アプリケーションの詳細ページに表示される時に生成されるOAuthコンシューマーキー。詳細は、接続アプリケーションを作成 (英語のみ)をご覧ください。

このプロパティは、[Implicit Flow] (Implicitフロー)タイプが選択されている場合のみ利用できます。

[Client Secret] (クライアントシークレット)

接続アプリケーションが作成され、Salesforceの接続アプリケーションの詳細ページに表示される時に生成されるOAuthコンシューマーシークレット。詳細は、接続アプリケーションを作成 (英語のみ)をご覧ください。

このプロパティは、[Implicit Flow] (Implicitフロー)タイプが選択されている場合のみ利用できます。

[Callback Host] (コールバックホスト)

接続アプリケーションの作成中に定義され、Salesforceの接続アプリケーション詳細ページのAPI (OAuth設定の有効化)エリアに表示されるOAuth認証コールバックURLのホスト値。

このプロパティは、[Implicit Flow] (Implicitフロー)タイプが選択されている場合のみ利用できます。

[Callback Port] (コールバックポート)

接続アプリケーションの作成中に定義され、Salesforceの接続アプリケーション詳細ページのAPI (OAuth設定の有効化)エリアに表示されるOAuth認証コールバックURLのポート値。

このプロパティは、[Implicit Flow] (Implicitフロー)タイプが選択されている場合のみ利用できます。

[Token File] (トークンファイル)

認証なしでのアクセストークンの取得に使う更新トークンを保管するトークンファイルへのパス。

このプロパティは、[Implicit Flow] (Implicitフロー)タイプが選択されている場合のみ利用できます。

[Module Name] (モジュール名)

フィールドの横にある[...]ボタンをクリックし、表示されたダイアログボックスで、使われるモジュールを選択します。または、[Use custom object] (カスタムオブジェクトの使用)チェックボックスをオンにして、[Object Name] (オブジェクト名)フィールドにモジュール名を指定します。

[Schema] (スキーマ)と[Edit schema] (スキーマを編集)

スキーマとは行の説明のことです。処理して次のコンポーネントに渡すフィールド(カラム)数を定義します。Sparkジョブを作成する場合、フィールドの命名時は予約語のlineを避けます。

スキーマを変更するには[Edit schema] (スキーマを編集)をクリックします。現在のスキーマがリポジトリータイプの場合は、3つのオプションを利用できます。

• [View schema] (スキーマを表示): スキーマのみを表示する場合は、このオプションを選択します。

• [Change to built-in property] (組み込みのプロパティに変更): ローカルで変更を行うためにスキーマを組み込みに変更する場合は、このオプションを選択します。

• [Update repository connection] (リポジトリー接続をアップデート): リポジトリーに保存されているスキーマに変更を加え、変更後にそのコンテンツをすべてのジョブにプロパゲートするかどうかを決める場合は、このオプションを選択します。変更を現在のジョブにのみ反映する場合は、変更後、[No] (いいえ)を選択し、[Repository Content] (リポジトリーコンテンツ)ウィンドウで再びこのスキーマのメタデータを選択します。

このコンポーネントでは、スキーマは選択したモジュールに関連しています。

リンクされたモジュールからカラムを取得するには、[Edit schema] (スキーマを編集)ビューで特定の方法でカラムを定義する必要があります。そうしないと関係クエリーが機能しません。正しい構文は次のとおりです: NameofCurrentModule_Nameof-

LinkedModule_NameofColumnofInterest

このコンポーネントは、ダイナミックスキーマ機能の利点を備えているので、ソースファイルから不明なカラムを取得したり、各カラムを個別にマッピングしなくてもソースからカラムを一括してコピーしたりできます。ダイナミックスキーマの詳細は、Talend Studioユーザーガイドをご覧ください。

ダイナミックスキーマ機能は、モジュールの不明なカラムを取得するしくみになっており、その他の目的には使用しないことをお勧めします。モジュールの作成には推奨しません。

[Query Mode] (クエリーモード)

ドロップダウンリストからクエリーモードを選択します。[Query] (クエリー)、[Bulk] (バルク)、またはBulkV2のいずれかです。

• [Query] (クエリー): 通常のクエリー。

• [Bulk] (バルク): 大規模なデータセットを効率的にクエリーし、APIリクエストの数を減らすために使われるバルククエリー。

• BulkV2: さらに大量のデータをクエリーするために使うバルククエリーです。関連情報はBULK API 2.0 (英語のみ)をご覧ください。

[Condition] (条件)

たとえば"name='Talend'"または"name like '%talend_user%'"のように、抽出するデータの選択に使うクエリーを二重引用符で囲んで入力します。

このプロパティは、[Manual Query] (手動クエリー)チェックボックスがオンになっている場合は利用できません。

[Manual Query] (手動クエリー)

このチェックボックスをオンにして、表示される[Full SOQL query string] (完全なSOQLクエリーの文字列)フィールドで、取得するデータの選択に使う完全なSOQL (Salesforce Object Query Language)ステートメントを二重引用符の間に入力します。SOQLの詳細は、Salesforce Object Query Language (SOQL) (英語のみ)をご覧ください。

このボタンをクリックすると、[Full SOQL query string] (完全なSOQLクエリーの文字列)フィールドで指定されたクエリーに基づいてスキーマカラムが生成されます。ネットワークプロキシを使用している場合、この機能はSOCKSプロキシでのみ使用できます。SOCKSプロキシを作成するには、[Use Proxy] (プロキシの使用)オプションを選択し、[Advanced settings] (詳細設定)ビューで関連するパラメーターを入力します。

このプロパティは、[Manual Query] (手動クエリー)チェックボックスがオンになっている場合のみ利用できます。

この機能を使う場合は、注意が必要ないくつかの制限があります。詳細は、リリースノートで既知の制限をご覧ください。

このボタンをクリックすると、定義されたモジュールとスキーマに基づいて[Full SOQL query string] (完全なSOQLクエリーの文字列)フィールドにクエリーが生成されます。

SOQLクエリを生成する際にモジュールとスキーマを正しく設定する方法の詳細は、tSalesforceInputの推測クエリー機能のスキーマを設定する方法をご覧ください。

このプロパティは、[Manual Query] (手動クエリー)チェックボックスがオンになっている場合のみ利用できます。

この機能を使う場合は、注意が必要ないくつかの制限があります。詳細は、リリースノートで既知の制限をご覧ください。

[Include deleted records] (削除済みレコードを含める)

削除されたレコードを含むすべてのレコードをクエリーするには、このチェックボックスをオンにします。

Salesforce URL

Salesforceへの接続に必要なWebService URL。

[API version] (APIバージョン)

Salesforce APIバージョン。

このプロパティは、OAuth接続タイプが選択されている場合のみ利用できます。

[Use or save the connection session] (接続セッションを使用または保存)

このチェックボックスをオンにして、[Session directory] (セッションディレクトリー)フィールドが表示されたら、保存または使用する接続セッションファイルへのパスを指定します。

このセッションファイルは、コンポーネントによって正しいユーザーIDが提供されている限り、異なる複数のジョブが共有して接続セッションを取得できます。このため、セッションを取得するためにサーバーに接続する必要はありません。

期限切れのセッションが検出された場合は、正しい接続情報(ユーザーID、パスワード、セキュリティキー)を入力すれば、コンポーネントは、サーバーに接続して新しいセッション情報を取得し、接続セッションファイルをアップデートします。

このプロパティは、[Basic] (基本)接続タイプが選択されている場合のみ利用できます。

[Need compression] (圧縮が必要)

SOAPメッセージ圧縮を有効にする場合は、このチェックボックスを選択します。これにより、パフォーマンスが向上する場合があります。

[Trace HTTP message] (HTTPメッセージをトレース)

コンソールでのHTTPインタラクションを出力する場合は、このチェックボックスを選択します。

このオプションは、[Query Mode] (クエリーモード)ドロップダウンリストから、[Bulk] (バルク)が選択されている場合のみ利用できます。

[Use HTTP Chunked] (HTTP Chunkedを使用)

HTTP Chunkedデータ転送メカニズムを使う場合は、このチェックボックスを選択します。

このプロパティは、[Query Mode] (クエリーモード)ドロップダウンリストから、[Query] (クエリー)が選択されている場合のみ利用できます。

[Client Id] (クライアントID)

Salesforce Webサイトへのアクセスに同じアカウントとパスワードを使うユーザーを区別するには、実際のユーザーのIDを入力します。

[Timeout] (タイムアウト)

Salesforceでクエリータイムアウトの予定数をミリ秒で入力します。

[Use Proxy] (プロキシを使用)

SOCKSプロキシサーバーを使う場合は、このチェックボックスをオンにして、表示された[Host] (ホスト)、[Port] (ポート)、[User Id] (ユーザーID)、[Password] (パスワード)フィールドで、SOCKSプロキシサーバーの接続パラメーターを指定します。

[Batch Size] (バッチサイズ)

処理された各バッチの登録数を入力します。

このプロパティは、[Query Mode] (クエリーモード)ドロップダウンリストから、[Query] (クエリー)が選択されている場合のみ利用できます。

[Normalize Delimiter] (正規化の区切り文字)

さまざまな階層型Salesforceオブジェクトに設定されたクエリーによって収集されるデータを正規化するために使われる文字、文字列、または正規表現を入力します。

このプロパティは、[Query Mode] (クエリーモード)ドロップダウンリストから、[Query] (クエリー)が選択されている場合のみ利用できます。

[Column Name Delimiter] (カラム名の区切り文字)

さまざまなSalesforceオブジェクト間の階層関係でクエリーを使う場合、親オブジェクトの名前と子オブジェクトの名前を区切るために使われる文字、文字列、または正規表現を入力します。

結果カラム名の競合が起きないよう、カラム名の区切り記号を慎重に選択します。たとえば、Caseという名前の親SalesforceオブジェクトにRegion_cとCase_Region_cという2つのカラムがあり、カラム名の区切り文字として_が使用されている場合、クエリーによるCase_Region_cカラムからのデータ取得が失敗します。これは、Case_Region_cがこの場合のRegion_cカラムを識別するためです。

このプロパティは、[Query Mode] (クエリーモード)ドロップダウンリストから、[Query] (クエリー)が選択されている場合のみ利用できます。

クエリーするモジュールのカラムの長さが100,000文字を超える場合は、このチェックボックスをオフにします。デフォルトでは、このチェックボックスは過剰なメモリ使用を防ぐためにオンになっています。

これらのプロパティは、[Query Mode] (クエリーモード)ドロップダウンリストで[Bulk] (バルク)またはBulkV2が選択されている場合に利用できます。

[All return null if value is empty] (値が空の場合はすべてNullを返す)

空の値にNullを返す場合は、このオプションを選択します。

これらのプロパティは、[Query Mode] (クエリーモード)ドロップダウンリストで[Bulk] (バルク)またはBulkV2が選択されている場合に利用できます。

バルククエリージョブを完了する制限時間を決めるタイムアウト値(秒単位)。デフォルトでは、値は0に設定されています。これは、ジョブが完了するまでの時間制限がないことを意味します。

Salesforceには、バルククエリーに対して独自の制限があります。バッチの処理にSalesforceのタイムアウト制限よりも長い時間がかかる場合、バッチはキューに入れられて後で処理されるため、ジョブの実行に時間がかかりすぎる可能性があります。この場合、完了ジョブのタイムアウト値を定義して、ジョブを事前に終了させることができます。Salesforce自体の制限の詳細は、Bulk API Limits - Batch processing time (英語のみ)をご覧ください。

これらのプロパティは、[Query Mode] (クエリーモード)ドロップダウンリストで[Bulk] (バルク)またはBulkV2が選択されている場合に利用できます。

[Split query results into small sets] (クエリー結果を小さなセットに分割)

クエリー結果をデータセットに分割する場合は、このオプションを選択します。データセットが保持できる最大レコード数は、[Maximum number of records per set] (セットあたりの最大レコード数)フィールドで設定します。

このオプションは、[Basic settings] (基本設定)ビューで[Query Mode] (クエリーモード)ドロップダウンリストからBulkV2を選択した場合に利用できます。

PK Chunkingを有効化

このチェックボックスを選択すると、大量のレコードを抽出する時、またはクエリーが一貫してタイムアウトする時に、PK (プライマリキー、つまりオブジェクトのレコードID)チャンクが有効になります。表示された[Chunk size] (チャンクサイズ)フィールドで、各チャンクのID境界内のレコード数を指定します。詳細については、Use PK Chunking to Extract Large Data Sets from Salesforceをご覧ください。

このオプションは、[Query Mode] (クエリーモード)ドロップダウンリストから、[Bulk] (バルク)が選択されている場合のみ利用できます。

[Specify the parent object] (親オブジェクトを指定)

親オブジェクトのレコードIDを使用してチャンク境界を決定するには、このオプションを選択します。[Parent object] (親オブジェクト)フィールドに親オブジェクトの名前を入力します。

オブジェクトがサポートされている場合は、PK Chunkingを使って、オブジェクトの共有テーブルをクエリーできます。親オブジェクトを指定すると、チャンクの境界が定義され、クエリーがより効率的になります。関連情報については、Use PK Chunking to Extract Large Data Sets from Salesforceをご覧ください。

このオプションは、[Query Mode] (クエリーモード)ドロップダウンリストから、[Bulk] (バルク)が選択されている場合のみ利用できます。

[Use UTC time for datetime] (datetimeにUTC時間を使用)

datetime型のデータにUTC時間を使用する場合は、このオプションを選択します。このオプションが選択されていない場合はローカルタイムが使用されます。

[tStatCatcher Statistics] (tStatCatcher統計)

このチェックボックスを選択すると、ジョブレベルおよび各コンポーネントレベルでジョブ処理メタデータが収集されます。

NB_LINE

処理された行数。これはAfter変数で、整数を返します。

ERROR_MESSAGE

エラー発生時にコンポーネントによって生成されるエラーメッセージ。これはAfter変数で、文字列を返します。

使用ルール

このコンポーネントは、通常、ジョブまたはサブジョブの開始コンポーネントとして使い、常に出力リンクが必要です。