# tSAPODataInput

OData Webサービスからデータを取得します。このコンポーネントを使用すると、URLおよびボディにパラメーターを送信してOData Webサービスから必要な情報を取得できます。

## tSAPODataInputの標準プロパティ

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

標準のtSAPODataInputコンポーネントは、ビジネスファミリーに属しています。

このフレームワーク内のコンポーネントは、すべてのサブスクリプションベースのTalend製品で利用できます。

このコンポーネントは、Talendが提供する8.0.1-R2025-06以降のTalend Studioマンスリーアップデートをインストール済みである場合のみ利用できます。詳細は管理者にお問い合わせください。

## 基本設定

| [Properties] (プロパティ) | 説明 |
| --- | --- |
| [Property type] (プロパティタイプ) | [Built-in] (組み込み)と[Repository] (リポジトリー)のいずれかです。<br><br><ul> <li> <span>[Built-In] (組み込み)</span>: 一元的に保存されるプロパティデータはありません。</li> <li> <span>[Repository] (リポジトリー)</span>: プロパティが保管されるリポジトリーファイルを選択します。後続フィールドは、取得されたデータを使用して自動的に入力されます。</li> </ul> |
| [OData version] (ODataバージョン) | 使用するODataプロトコルのバージョンを選択します。 |
| [Root URL] (ルートURL) | アクセスしたいSAP ODataサービスのベース URLを示すURLアドレス、つまりSAPサーバーのホストとポートを入力します。 |
| [Username] (ユーザー名)と[Password] (パスワード) | サーバーへのアクセスに基本認証として使う認証情報を入力します。<br><br>情報メモヒント: パスワード、トークン、クライアントシークレットキーを入力するためには、該当するフィールドの横にある[...]ボタンをクリックし、[Enter a new password] (新しいパスワードを入力)ダイアログボックスを表示させ、テキストフィールドにパスワード、トークン、シークレットのいずれかを入力してOKをクリックします。[pure password] (純粋なパスワード)モードであればJSON文字列を、JavaモードであればJava式を入力できます。テキストフィールドの上部にある[switch to Java mode] (Javaモードに切り替え)または[switch to pure password mode] (純粋なパスワードに切り替え)をクリックすることで、2つのモードの間で切り替えられます。 |
| [Path] (パス) | カタログサービスパスを入力します。<br><br>例:<br><br>[Root URL] (ルートURL) = http://&lt;server&gt;:&lt;port&gt;および[Path] (パス) = /sap/opu/odata4/IWFND/config/default/iwfnd/CATALOGSERVICE |
| [Guess catalog service path] (カタログサービスパスを推測) | このボタンをクリックすると、SAP ODataカタログサービスのデフォルトパスを取得できます。詳細は、[Catalog service](https://help.sap.com/doc/saphelp_nw74/7.4.16/en-US/7c/a326519eff236ee10000000a445394/content.htm?no_cache=true)をご覧ください。 |
| [OData V4 parameters] (OData V4パラメーター) (オプション) | サービスへのリクエストを微調整するために必要な、次の追加パラメーターを指定します:<br><br><ul> <li> <p><span>[Search by API group ID] (APIグループIDで検索)</span>: このフィールドを使い、値の先頭または末尾にアスタリスク( * )を追加して、APIグループ識別子でリストをフィルタリングします。 </p> </li> <li> <p><span>[Search by API description] (APIの説明で検索)</span>: このフィールドを使い、値の先頭または末尾にアスタリスク( * )を追加して、APIの説明でリストをフィルタリングします。 </p> </li> <li> <p><span>[API group ID] (APIグループID)</span>: 取得したいグループの識別子を選択します。このリストは、前の2つのパラメーターに基づいて入力されています。</p> </li> </ul><br><br>詳細は、[The Groups and related API](https://help.sap.com/docs/SAP_JAM_COLLABORATION/9981b6fb8453459d8103a04d674ebe0f/cc2bb683ad4a445b95e296be924ea3f0.html)をご覧ください。 |
| [OData V2 parameters] (OData V2パラメーター) (オプション) | サービスへのリクエストを微調整するために必要な、次の追加パラメーターを指定します:<br><br><ul> <li> <p><span>[Search by service ID] (サービスIDで検索)</span>: このフィールドを使い、値の先頭または末尾にアスタリスク( * )を追加することでサービス識別子でリストをフィルタリングします。 </p> </li> <li> <p><span>[Search by service description] (サービスの説明で検索)</span>: このフィールドを使い、値の先頭または末尾にアスタリスク( * )を追加することでサービスの説明でリストをフィルタリングします。</p> </li> <li> <p><span>[Search by service type] (サービスタイプで検索)</span>: このフィールドを使い、値の先頭または末尾にアスタリスク( * )を追加することでサービスのタイプでリストをフィルタリングします。</p> </li> <li> <p><span>[Search by service version] (サービスバージョンで検索)</span>: このフィールドを使い、値の先頭または末尾にアスタリスク( * )を追加することでサービスのバージョンでリストをフィルタリングします。</p> </li> <li> <p><span>[Search by service author] (サービス作成者で検索)</span>: このフィールドを使い、値の先頭または末尾にアスタリスク( * )を追加することでサービスの作成者でリストをフィルタリングします。</p> </li> </ul> |
| [Service URL] (サービスURL) | リストからサービスURLを選択します。値は、OData v4の場合は選択されたAPIグループに基づき、OData v2の場合はフィルターパラメーターを使って生成されます。 |
| [Entity set] (エンティティセット) | サービスから取得したい特定のエンティティセットを入力または選択します。詳細は、[Addressing Entities](https://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part2-url-conventions/odata-v4.0-errata03-os-part2-url-conventions-complete.html#_Toc453752340)をご覧ください。<br><br>情報メモヒント: 使用可能なエンティティセットをすべて表示させる場合は、対応するフィールドの横にある[...]ボタンをクリックして[Retrieve values] (値を取得)ダイアログボックスを開き、[Run in background] (バックグラウンドで実行)をクリックします。新しいダイアログボックスが開き、選択できる取得済みエンティティセットがすべて表示されます。[Use custom value] (カスタム値を使用)チェックボックスをオンにすれば、カスタム値を指定することもできます。<br><br>このオプションは、このコンポーネントの出力フローのスキーマに影響します。このオプションを使ってテーブルでキー-値ペアを設定した後、[Guess schema] (推測スキーマ)ボタンをクリックしてスキーマをアップデートすることをお勧めします。 |
| [Specify entity key] (エンティティキーを指定) | このチェックボックスをオンにすると、特定のエンティティセットを一意識別するために使用するキーを入力できます。詳細は、[Addressing Entities](https://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part2-url-conventions/odata-v4.0-errata03-os-part2-url-conventions-complete.html#_Toc453752340)をご覧ください。<br><br>このオプションは、このコンポーネントの出力フローのスキーマに影響します。このオプションを使ってテーブルでキー-値ペアを設定した後、[Guess schema] (推測スキーマ)ボタンをクリックしてスキーマをアップデートすることをお勧めします。 |
| [Use $filter] ($filterを使用) | このチェックボックスをオンにすると、リクエストURLで指定されたリソースのコレクションをフィルタリングするクエリーを入力できます。詳細は、[System Query Option $filter](https://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part2-url-conventions/odata-v4.0-errata03-os-part2-url-conventions-complete.html#_Filter_System_Query)をご覧ください。<br><br>同じリクエストに[Use $filter] ($filterを使用)オプションと[Use $search] ($searchを使用)オプションの両方を適用すると、結果には両方の条件に一致するエンティティだけが含まれます。<br><br>このオプションは、このコンポーネントの出力フローのスキーマに影響します。このオプションを使ってテーブルでキー-値ペアを設定した後、[Guess schema] (推測スキーマ)ボタンをクリックしてスキーマをアップデートすることをお勧めします。 |
| [Use $search] ($searchを使用) | このチェックボックスをオンにすると、リクエストURLに適用され、コレクションで一致するエンティティをすべて返すクエリーを入力できます。詳細は、[System Query Option $search](https://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part2-url-conventions/odata-v4.0-errata03-os-part2-url-conventions-complete.html#_Toc453752364)をご覧ください。<br><br>同じリクエストに[Use $filter] ($filterを使用)オプションと[Use $search] ($searchを使用)オプションの両方が適用されると、結果には両方の条件に一致するエンティティだけが含まれます。<br><br>このオプションは、このコンポーネントの出力フローのスキーマに影響します。このオプションを使ってテーブルでキー-値ペアを設定した後、[Guess schema] (推測スキーマ)ボタンをクリックしてスキーマをアップデートすることをお勧めします。 |
| [Use $select] ($selectを使用) | このチェックボックスをオンにすると、リクエストURLに適用され、各エンティティや複合タイプの特定のプロパティセットを返すクエリーを入力できます。詳細は、[System Query Option $select](https://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part2-url-conventions/odata-v4.0-errata03-os-part2-url-conventions-complete.html#_Toc453752360)をご覧ください。<br><br>同じリクエストに[Use $select] ($selectを使用)オプションと[Use $expand] ($expandを使用)オプションの両方が適用されると、結果には$selectの条件に一致するエンティティのみが含まれます。そのため、期待されるプロパティがすべて返されるようにするためには、$selectクエリーに$expand条件を含める必要があります。<br><br>このオプションは、このコンポーネントの出力フローのスキーマに影響します。このオプションを使ってテーブルでキー-値ペアを設定した後、[Guess schema] (推測スキーマ)ボタンをクリックしてスキーマをアップデートすることをお勧めします。 |
| [Use $expand] ($expandを使用) | このチェックボックスをオンにすると、リクエストURLに適用され、行に含まれる関連の拡張リソースを検索されたリソースと共に返すクエリーを入力できます。詳細は、[System Query Option $expand](https://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part2-url-conventions/odata-v4.0-errata03-os-part2-url-conventions-complete.html#_Toc453752359)をご覧ください。<br><br>同じリクエストに[Use $select] ($selectを使用)オプションと[Use $expand] ($expandを使用)オプションの両方が適用されると、結果には$selectの条件に一致するエンティティのみが含まれます。そのため、期待されるプロパティがすべて返されるようにするためには、$selectクエリーに$expand条件を含める必要があります。<br><br>このオプションは、このコンポーネントの出力フローのスキーマに影響します。このオプションを使ってテーブルでキー-値ペアを設定した後、[Guess schema] (推測スキーマ)ボタンをクリックしてスキーマをアップデートすることをお勧めします。 |
| [Return type] (戻り値のタイプ) | サーバーから返されるデータを解析する方法に応じてオプションを選択します。<br><br><ul> <li> <p> <span>[Record] (レコード)</span>: レスポンスボディを解析し、レコード(1行につき1エンティティ)を生成します。</p> </li> <li> <span>[Raw] (ロー)</span>: レスポンスボディをそのまま<span>body</span>カラムに返します。</li> </ul> |
| [Schema] (スキーマ)と[Edit schema] (スキーマを編集) | スキーマとは行の説明で、処理された後に次のコンポーネントに渡されるフィールドの数を定義するものです。スキーマは[Built-in] (組み込み)か、[Repository] (リポジトリー)にリモートで保存されます。<br><br><ul> <li> <p> <span>[Built-in] (組み込み)</span>: そのコンポーネントに対してのみスキーマを作成し、ローカルに保管します。<span>[Basic settings] (基本設定)</span>タブにあるコンポーネントスキーマの詳細は、<a href="https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/basic-settings-tab" target="_blank">[Basic settings] (基本設定)</a>をご覧ください。</p> </li> <li> <p> <span>[Repository] (リポジトリー)</span>: スキーマは作成済みで、<span>リポジトリー</span>に保存されており、さまざまなプロジェクトやジョブデザインで再利用できます。<span>[Basic settings] (基本設定)</span>タブにあるコンポーネントスキーマの詳細は、<a href="https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/basic-settings-tab" target="_blank">[Basic settings] (基本設定)</a>をご覧ください。</p> </li> </ul><br><br>スキーマを変更するには[Edit schema] (スキーマを編集)をクリックします。現在のスキーマがリポジトリータイプの場合は、3つのオプションを利用できます。<br><br><ul> <li> <p> <span>[View schema] (スキーマを表示)</span>: スキーマのみを表示する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Change to built-in property] (組み込みのプロパティに変更)</span>: ローカルで変更を行うためにスキーマを<span>組み込み</span>に変更する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Update repository connection] (リポジトリー接続をアップデート)</span>: リポジトリーに保存されているスキーマに変更を加え、変更後にそのコンテンツをすべてのジョブにプロパゲートするかどうかを決める場合は、このオプションを選択します。</p> <p>変更を現在のジョブにのみ反映する場合は、変更後、<span>[No] (いいえ)</span>を選択し、<span>[Repository Content] (リポジトリーコンテンツ)</span>ウィンドウで再びこのスキーマのメタデータを選択します。</p> </li> </ul> |
| [Guess Schema] (推測スキーマ) | このボタンをクリックすると、設定に応じたスキーマを取得できます。<br><br>ODataからデータを取得する時は、スキーマ、[Guess schema] (スキーマを推測)ボタン、[Entity set] (エンティティセット)オプション、[Specify entity key] (エンティティキーを指定)オプション、$filter/search/select/expandオプション、[Return type] (戻り値のタイプ)オプションを使い、取得するデータの形式とコンテンツを指定できます。 |

## 詳細設定

| [Properties] (プロパティ) | 説明 |
| --- | --- |
| [tStatCatcher Statistics] (tStatCatcher統計) | ジョブレベルおよび各コンポーネントレベルでジョブ処理メタデータを収集するには、このチェックボックスをオンにします。 |
| [Connection timeout (ms)] (接続タイムアウト(ミリ秒)) | コネクターがサーバーへの接続を確立するまでのタイムアウト期間(ミリ秒)を設定するために使われます。接続の確立に失敗した場合はエラーが発生します。 |
| [Receive timeout (ms)] (受信タイムアウト(ミリ秒)) | レスポンスデータ受信のタイムアウト期間(ミリ秒)を設定するために使われます。読み取りタイムアウト期間が経過してもデータが受信されない場合は、エラーが発生します。 |
| [Use a proxy] (プロキシを使用) | このオプションをオンにすると、HTTPやSOCKSプロキシを使用できます。<br><br><ul> <li> <span>[Proxy type] (プロキシタイプ)</span>: 使用したいプロキシのタイプとして、<span>HTTP</span>または<span>SOCKS</span>を選択します。HTTPプロキシでは基本認証がサポートされています。</li> <li> <span>[Proxy host] (プロキシホスト)</span>と<span>[Proxy port] (プロキシポート)</span>: プロキシのアドレスとポートを入力します。</li> <li> <span>[Proxy login] (プロキシログイン)</span>と<span>[Proxy password] (プロキシパスワード)</span>: プロキシへの認証に必要な認証情報を入力します。これら2つのフィールドは、<span>[Proxy type] (プロキシタイプ)</span>ドロップダウンリストで<span>HTTP</span>が選択されている場合に利用できます。</li> </ul> |
| [Use $skip] ($skipを使用) | このチェックボックスをオンにすると、クエリーされたコレクションでスキップされ、結果に含まれない項目の数を指定できます。詳細は、[System Query Option $top and $skip](https://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part2-url-conventions/odata-v4.0-errata03-os-part2-url-conventions-complete.html#_Top_and_Skip)をご覧ください。<br><br>同じリクエストに[Use $skip] ($skipを使用)オプションと[Use $top] ($topを使用)オプションの両方を適用すると、結果には両方の条件に一致するエンティティだけが含まれます。<br><br>このオプションは、このコンポーネントの出力フローのスキーマに影響します。このオプションを使ってテーブルでキー-値ペアを設定した後、[Guess schema] (推測スキーマ)ボタンをクリックしてスキーマをアップデートすることをお勧めします。 |
| [Use $top] ($topを使用) | このチェックボックスをオンにすると、クエリーされたコレクションでスキップされ、結果に含まれる最初の項目の数を指定できます。詳細は、[System Query Option $top and $skip](https://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part2-url-conventions/odata-v4.0-errata03-os-part2-url-conventions-complete.html#_Top_and_Skip)をご覧ください。<br><br>同じリクエストに[Use $skip] ($skipを使用)オプションと[Use $top] ($topを使用)オプションの両方を適用すると、結果には両方の条件に一致するエンティティだけが含まれます。<br><br>このオプションは、このコンポーネントの出力フローのスキーマに影響します。このオプションを使ってテーブルでキー-値ペアを設定した後、[Guess schema] (推測スキーマ)ボタンをクリックしてスキーマをアップデートすることをお勧めします。 |
| [Use $orderBy] ($orderByを使用) | このチェックボックスをオンにすると、リクエストURLに適用され、関連するリソースを特定の順序で返すクエリーを入力できます。詳細は、[System Query Option $orderby](https://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part2-url-conventions/odata-v4.0-errata03-os-part2-url-conventions-complete.html#_OrderBy_System_Query)をご覧ください。<br><br>このオプションは、このコンポーネントの出力フローのスキーマに影響します。このオプションを使ってテーブルでキー-値ペアを設定した後、[Guess schema] (推測スキーマ)ボタンをクリックしてスキーマをアップデートすることをお勧めします。 |

## [Global Variables] (グローバル変数)

| 変数 | 説明 |
| --- | --- |
| グローバル変数 | ERROR\_MESSAGE: エラーが発生した時にコンポーネントによって生成されるエラーメッセージ。これはAfter変数で、文字列を返します。この変数はコンポーネントにこのチェックボックスが存在し、[Die on error] (エラー発生時に強制終了)がオフになっている場合のみ機能します。<br><br>NB\_LINE: 入力コンポーネントによって読み取られた行の数、または出力コンポーネントに転送された行の数。これはAfter変数で、整数を返します。 |

## 使用方法

| 使用方法のガイダンス | 説明 |
| --- | --- |
| **使用ルール** | このコンポーネントは通常、ジョブまたはサブジョブの開始コンポーネントとして使い、常に出力リンクが必要です。 |
| **制限事項** | <ul> <li>現在、tSAPODataコンポーネントではヘッダーパラメーターを使用することはできません。具体的には、これらのコンポーネントには、<span>sap-client</span>(SAPクライアントID)やs<span>ap-language</span>(SAP言語)といったSAPパラメーターを指定するための専用フィールドがありません。</li> <li> <p>OData v4: このコンポーネントの現在の実装では、サービスが$count機能をサポートしている必要があります。</p> </li> <li> <div>OData v2の場合:<ul> <li>@odata.countの戻り値は、現在の<span>NB_Line</span>変数と同一です。</li> <li><span>$skip</span>と<span>$top</span>を使ったページネーションは、指定されたキーがリクエストに含まれていない場合のみサポートされます。</li> <li><span>Edm.DateTime</span>型は、OData v2で有効な型です。ただし、このコンポーネントはOData v4用にデザインされたOlingo 4ライブラリーを使用しており、この型はサポートしていません。そのため、このコンポーネントの現在の実装ではこのタイプはサポートされていません。代わりに<span>Edm.DateTimeOffset</span>を使用してください。</li> </ul></div> </li> </ul> |

**関連タスク**

* [SAP ODataデータセットでレコードを挿入またはアップデート](https://help.qlik.com/talend/ja-JP/components/8.0/sap/tfixedflowinput-tmap-tsapodatainput-tlogrow-tsapodataoutput-inserting-and-updating-records-in-sapodata-dataset-standard-component)