tSalesforceInput標準プロパティ - 7.3

Salesforce

EnrichVersion
Cloud
7.3
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for ESB
Talend Real-Time Big Data Platform
EnrichPlatform
Talend Studio
task
ジョブデザインと開発 > サードパーティーシステム > ビジネスアプリケーション > Salesforce
データガバナンス > サードパーティーシステム > ビジネスアプリケーション > Salesforce
データクオリティとプレパレーション > サードパーティーシステム > ビジネスアプリケーション > Salesforce

このプロパティはStandardジョブフレームワークで実行されているtSalesforceInputを設定するために使います。

Standard tSalesforceInputコンポーネントはビジネスファミリーとCloudファミリーのコンポーネントです。

このフレームワーク内のコンポーネントは、すべてのTalend製品で使用できます。

基本設定

[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] (基本)接続タイプが選択されている場合にのみ利用できます。

セキュリティトークン

Salesforceのセキュリティトークン。詳細については、セキュリティトークンのリセットを参照してください。

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

[Mutual authentication] (相互認証)

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

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

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

注: このオプションは、TalendのR2021-04以降のStudio月次アップデートをインストールした時のみ利用できます。詳細は管理者にお問い合わせください。

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

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

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

注: このオプションは、TalendのR2021-04以降のStudio月次アップデートをインストールした時のみ利用できます。詳細は管理者にお問い合わせください。

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

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

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

注: このオプションは、TalendのR2021-04以降のStudio月次アップデートをインストールした時のみ利用できます。詳細は管理者にお問い合わせください。

発行者

接続アプリケーションが作成され、Salesforceの接続アプリケーションの詳細ページに表示される時に生成されるOAuthコンシューマーキー。詳細については、接続アプリケーションの作成を参照してください。

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

[Subject] (件名)

Salesforceのユーザー名。

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

対象ユーザー

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

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

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

有効期限(秒)

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

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

キーストア

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

キーストアファイルは、Salesforceによって署名された証明書を作成し、それをキーストアにエクスポートすることで生成できます。詳細については、自己署名証明書の生成を参照してください。

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

[Key store password] (キーストアのパスワード)

キーストアのパスワード。

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

証明書の別名

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

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

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

接続アプリケーションが作成され、Salesforceの接続アプリケーションの詳細ページに表示される時に生成されるOAuthコンシューマーキー。詳細については、接続アプリケーションの作成を参照してください。

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

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

接続アプリケーションが作成され、Salesforceの接続アプリケーションの詳細ページに表示される時に生成されるOAuthコンシューマーシークレット。詳細については、接続アプリケーションの作成を参照してください。

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

コールバックホスト

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

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

コールバックポート

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

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

トークンファイル

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

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

モジュール名

フィールドの横にある[...]ボタンをクリックし、表示されたダイアログボックスで、使われるモジュールを選択します。または、[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] (クエリー)[Bulk] (バルク)、またはBulkV2のいずれかです。

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

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

  • BulkV2: さらに大量のデータをクエリーするために使うバルククエリーです。関連情報はBULK API 2.0を参照してください。
注: BulkV2オプションは、TalendのR2020-08以降のStudio月次アップデートをインストールした場合にのみ利用できます。詳細は管理者にお問い合わせください。

[Condition] (条件)

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

このプロパティは、[Manual Query] (手動クエリー)チェックボックスが選択されている場合は使用できません。

手動クエリー

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

[Guess schema] (スキーマの推測)

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

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

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

[Guess query] (クエリーの推測)

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

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

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

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

削除済みレコードを含める

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

注: このオプションは、TalendのR2021-04以降のStudio月次アップデートをインストールした場合のみ、Queryモードに加え、BulkBulkV2のクエリーモードで利用できます。詳細は管理者にお問い合わせください。

詳細設定

[Salesforce URL] (SalesforceのURL)

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

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

Salesforce APIバージョン。

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

接続セッションを使用または保存

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

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

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

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

圧縮が必要

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

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プロキシサーバーの接続パラメーターを指定します。

注: 許可されているタイプのプロキシ(HTTPプロキシ、HTTPSプロキシ、SOCKSプロキシ、FTPプロキシを含む)を使用するには、tSetProxyコンポーネントを使用します。

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

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

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

正規化の区切り文字

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

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

カラム名の区切り文字

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

このプロパティは、[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を選択した場合に利用できます。

注: このオプションは、TalendのR2020-08以降のStudio月次アップデートをインストールした場合のみ利用できます。詳細は管理者にお問い合わせください。

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チャンクを使用してオブジェクトの共有テーブルを照会できます。親オブジェクトを指定すると、チャンクの境界が定義され、クエリーがより効率的になります。関連情報については、Use PK Chunking to Extract Large Data Sets from Salesforceを参照してください。

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

注: このオプションは、TalendのR2021-04以降のStudio月次アップデートをインストールした時のみ利用できます。詳細は管理者にお問い合わせください。

[tStatCatcher Statistics] (tStatCatcher統計)

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

グローバル変数

NB_LINE

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

ERROR_MESSAGE

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

使用方法

使用ルール

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